From 232e5ec9d797bff21946d88057047ce831b29071 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 14:24:57 +0000 Subject: [PATCH 01/10] Initial plan From 4df7dcd34d82bc849f4448b5b5bfd11f413d796e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 14:30:06 +0000 Subject: [PATCH 02/10] Enhanced protocol documentation with TypeScript examples and overview pages Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- .../docs/references/ai/agent/AIKnowledge.mdx | 27 +++ .../references/ai/agent/AIModelConfig.mdx | 26 +++ content/docs/references/ai/agent/AITool.mdx | 27 +++ content/docs/references/ai/agent/Agent.mdx | 29 +++ .../ai/conversation/ConversationAnalytics.mdx | 29 +++ .../ai/conversation/ConversationContext.mdx | 26 +++ .../ai/conversation/ConversationMessage.mdx | 29 +++ .../ai/conversation/ConversationSession.mdx | 29 +++ .../ai/conversation/ConversationSummary.mdx | 29 +++ .../ai/conversation/FunctionCall.mdx | 27 +++ .../ai/conversation/MessageContent.mdx | 25 +++ .../ai/conversation/MessageContentType.mdx | 22 ++- .../ai/conversation/MessagePruningEvent.mdx | 29 +++ .../ai/conversation/MessageRole.mdx | 22 ++- .../ai/conversation/TokenBudgetConfig.mdx | 26 +++ .../ai/conversation/TokenBudgetStrategy.mdx | 22 ++- .../ai/conversation/TokenUsageStats.mdx | 28 +++ .../references/ai/conversation/ToolCall.mdx | 27 +++ .../docs/references/ai/cost/BillingPeriod.mdx | 22 ++- .../docs/references/ai/cost/BudgetLimit.mdx | 28 +++ .../docs/references/ai/cost/BudgetStatus.mdx | 29 +++ .../docs/references/ai/cost/BudgetType.mdx | 22 ++- content/docs/references/ai/cost/CostAlert.mdx | 29 +++ .../docs/references/ai/cost/CostAlertType.mdx | 22 ++- .../docs/references/ai/cost/CostAnalytics.mdx | 29 +++ .../ai/cost/CostBreakdownDimension.mdx | 22 ++- .../references/ai/cost/CostBreakdownEntry.mdx | 29 +++ content/docs/references/ai/cost/CostEntry.mdx | 29 +++ .../references/ai/cost/CostMetricType.mdx | 22 ++- .../cost/CostOptimizationRecommendation.mdx | 29 +++ .../references/ai/cost/CostQueryFilters.mdx | 25 +++ .../docs/references/ai/cost/CostReport.mdx | 29 +++ content/docs/references/ai/index.mdx | 154 ++++++++++++++++ .../ai/model-registry/ModelCapability.mdx | 25 +++ .../ai/model-registry/ModelConfig.mdx | 29 +++ .../ai/model-registry/ModelLimits.mdx | 27 +++ .../ai/model-registry/ModelPricing.mdx | 25 +++ .../ai/model-registry/ModelProvider.mdx | 22 ++- .../ai/model-registry/ModelRegistry.mdx | 27 +++ .../ai/model-registry/ModelRegistryEntry.mdx | 26 +++ .../model-registry/ModelSelectionCriteria.mdx | 25 +++ .../ai/model-registry/PromptTemplate.mdx | 29 +++ .../ai/model-registry/PromptVariable.mdx | 26 +++ content/docs/references/ai/nlq/Entity.mdx | 28 +++ .../references/ai/nlq/FieldSynonymConfig.mdx | 28 +++ .../docs/references/ai/nlq/NLQAnalytics.mdx | 29 +++ .../references/ai/nlq/NLQFieldMapping.mdx | 29 +++ .../docs/references/ai/nlq/NLQModelConfig.mdx | 26 +++ .../docs/references/ai/nlq/NLQParseResult.mdx | 29 +++ content/docs/references/ai/nlq/NLQRequest.mdx | 26 +++ .../docs/references/ai/nlq/NLQResponse.mdx | 27 +++ .../references/ai/nlq/NLQTrainingExample.mdx | 27 +++ .../docs/references/ai/nlq/QueryContext.mdx | 25 +++ .../docs/references/ai/nlq/QueryIntent.mdx | 22 ++- .../docs/references/ai/nlq/QueryTemplate.mdx | 29 +++ content/docs/references/ai/nlq/Timeframe.mdx | 27 +++ .../ai/orchestration/AIOrchestration.mdx | 29 +++ .../AIOrchestrationExecutionResult.mdx | 29 +++ .../orchestration/AIOrchestrationTrigger.mdx | 22 ++- .../references/ai/orchestration/AITask.mdx | 29 +++ .../ai/orchestration/AITaskType.mdx | 22 ++- .../BatchAIOrchestrationExecution.mdx | 27 +++ .../ai/orchestration/PostProcessingAction.mdx | 28 +++ .../orchestration/WorkflowFieldCondition.mdx | 26 +++ .../ai/orchestration/WorkflowSchedule.mdx | 25 +++ .../ai/predictive/EvaluationMetrics.mdx | 25 +++ .../ai/predictive/Hyperparameters.mdx | 25 +++ .../references/ai/predictive/ModelDrift.mdx | 29 +++ .../references/ai/predictive/ModelFeature.mdx | 28 +++ .../ai/predictive/PredictionRequest.mdx | 26 +++ .../ai/predictive/PredictionResult.mdx | 27 +++ .../ai/predictive/PredictiveModel.mdx | 29 +++ .../ai/predictive/PredictiveModelType.mdx | 22 ++- .../ai/predictive/TrainingConfig.mdx | 25 +++ .../ai/rag-pipeline/ChunkingStrategy.mdx | 10 + .../ai/rag-pipeline/DocumentChunk.mdx | 29 +++ .../ai/rag-pipeline/DocumentLoaderConfig.mdx | 27 +++ .../ai/rag-pipeline/DocumentMetadata.mdx | 26 +++ .../ai/rag-pipeline/EmbeddingModel.mdx | 28 +++ .../ai/rag-pipeline/RAGPipelineConfig.mdx | 29 +++ .../ai/rag-pipeline/RAGPipelineStatus.mdx | 28 +++ .../ai/rag-pipeline/RAGQueryRequest.mdx | 27 +++ .../ai/rag-pipeline/RAGQueryResponse.mdx | 28 +++ .../ai/rag-pipeline/RerankingConfig.mdx | 25 +++ .../ai/rag-pipeline/RetrievalStrategy.mdx | 10 + .../ai/rag-pipeline/VectorStoreConfig.mdx | 28 +++ .../ai/rag-pipeline/VectorStoreProvider.mdx | 22 ++- .../docs/references/api/contract/ApiError.mdx | 27 +++ .../references/api/contract/BaseResponse.mdx | 26 +++ .../references/api/contract/BulkRequest.mdx | 26 +++ .../references/api/contract/BulkResponse.mdx | 27 +++ .../references/api/contract/CreateRequest.mdx | 26 +++ .../api/contract/DeleteResponse.mdx | 27 +++ .../references/api/contract/ExportRequest.mdx | 26 +++ .../api/contract/ListRecordResponse.mdx | 28 +++ .../api/contract/ModificationResult.mdx | 26 +++ .../references/api/contract/RecordData.mdx | 10 + .../api/contract/SingleRecordResponse.mdx | 27 +++ .../references/api/contract/UpdateRequest.mdx | 26 +++ .../api/discovery/ApiCapabilities.mdx | 25 +++ .../references/api/discovery/ApiRoutes.mdx | 28 +++ .../references/api/discovery/Discovery.mdx | 29 +++ .../references/api/endpoint/ApiEndpoint.mdx | 29 +++ .../references/api/endpoint/ApiMapping.mdx | 27 +++ .../references/api/endpoint/RateLimit.mdx | 25 +++ content/docs/references/api/index.mdx | 89 +++++++++ .../docs/references/api/odata/ODataError.mdx | 26 +++ .../api/odata/ODataFilterFunction.mdx | 22 ++- .../api/odata/ODataFilterOperator.mdx | 22 ++- .../references/api/odata/ODataMetadata.mdx | 28 +++ .../docs/references/api/odata/ODataQuery.mdx | 25 +++ .../references/api/odata/ODataResponse.mdx | 26 +++ .../docs/references/api/realtime/Presence.mdx | 28 +++ .../api/realtime/PresenceStatus.mdx | 22 ++- .../api/realtime/RealtimeAction.mdx | 22 ++- .../references/api/realtime/RealtimeEvent.mdx | 28 +++ .../api/realtime/RealtimeEventType.mdx | 22 ++- .../references/api/realtime/Subscription.mdx | 28 +++ .../api/realtime/SubscriptionEvent.mdx | 26 +++ .../api/realtime/TransportProtocol.mdx | 22 ++- .../references/api/router/RouteCategory.mdx | 22 ++- .../references/api/router/RouteDefinition.mdx | 28 +++ .../references/api/router/RouterConfig.mdx | 25 +++ .../docs/references/api/view/HttpMethod.mdx | 22 ++- .../auth/config/AccountLinkingConfig.mdx | 25 +++ .../references/auth/config/AuthConfig.mdx | 29 +++ .../auth/config/AuthPluginConfig.mdx | 26 +++ .../references/auth/config/AuthStrategy.mdx | 22 ++- .../references/auth/config/CSRFConfig.mdx | 25 +++ .../auth/config/DatabaseAdapter.mdx | 26 +++ .../auth/config/DatabaseMapping.mdx | 25 +++ .../auth/config/EmailPasswordConfig.mdx | 25 +++ .../auth/config/EnterpriseAuthConfig.mdx | 25 +++ .../references/auth/config/LDAPConfig.mdx | 29 +++ .../auth/config/MagicLinkConfig.mdx | 25 +++ .../references/auth/config/OAuthProvider.mdx | 28 +++ .../references/auth/config/OIDCConfig.mdx | 28 +++ .../references/auth/config/PasskeyConfig.mdx | 26 +++ .../auth/config/RateLimitConfig.mdx | 25 +++ .../references/auth/config/SAMLConfig.mdx | 28 +++ .../references/auth/config/SessionConfig.mdx | 25 +++ .../auth/config/StandardAuthProvider.mdx | 27 +++ .../auth/config/TwoFactorConfig.mdx | 25 +++ .../auth/config/UserFieldMapping.mdx | 25 +++ .../docs/references/auth/identity/Account.mdx | 29 +++ .../docs/references/auth/identity/Session.mdx | 29 +++ .../docs/references/auth/identity/User.mdx | 29 +++ .../auth/identity/VerificationToken.mdx | 29 +++ content/docs/references/auth/index.mdx | 102 +++++++++++ .../auth/organization/Invitation.mdx | 29 +++ .../auth/organization/InvitationStatus.mdx | 22 ++- .../references/auth/organization/Member.mdx | 29 +++ .../auth/organization/Organization.mdx | 29 +++ .../references/auth/policy/AuditPolicy.mdx | 26 +++ .../references/auth/policy/NetworkPolicy.mdx | 26 +++ .../references/auth/policy/PasswordPolicy.mdx | 25 +++ .../docs/references/auth/policy/Policy.mdx | 26 +++ .../references/auth/policy/SessionPolicy.mdx | 25 +++ content/docs/references/auth/role/Role.mdx | 27 +++ .../docs/references/auth/scim/SCIMAddress.mdx | 25 +++ .../docs/references/auth/scim/SCIMEmail.mdx | 26 +++ .../auth/scim/SCIMEnterpriseUser.mdx | 25 +++ .../docs/references/auth/scim/SCIMError.mdx | 26 +++ .../docs/references/auth/scim/SCIMGroup.mdx | 26 +++ .../auth/scim/SCIMGroupReference.mdx | 26 +++ .../references/auth/scim/SCIMListResponse.mdx | 27 +++ .../auth/scim/SCIMMemberReference.mdx | 26 +++ .../docs/references/auth/scim/SCIMMeta.mdx | 25 +++ .../docs/references/auth/scim/SCIMName.mdx | 25 +++ .../auth/scim/SCIMPatchOperation.mdx | 26 +++ .../references/auth/scim/SCIMPatchRequest.mdx | 26 +++ .../references/auth/scim/SCIMPhoneNumber.mdx | 26 +++ .../docs/references/auth/scim/SCIMUser.mdx | 26 +++ .../automation/approval/ApprovalAction.mdx | 28 +++ .../approval/ApprovalActionType.mdx | 22 ++- .../automation/approval/ApprovalProcess.mdx | 29 +++ .../automation/approval/ApprovalStep.mdx | 28 +++ .../automation/approval/ApproverType.mdx | 22 ++- .../automation/connector/AuthField.mdx | 27 +++ .../automation/connector/Authentication.mdx | 26 +++ .../connector/AuthenticationType.mdx | 22 ++- .../automation/connector/Connector.mdx | 29 +++ .../connector/ConnectorCategory.mdx | 22 ++- .../connector/ConnectorInstance.mdx | 29 +++ .../connector/ConnectorOperation.mdx | 28 +++ .../automation/connector/ConnectorTrigger.mdx | 28 +++ .../automation/connector/OAuth2Config.mdx | 27 +++ .../connector/OperationParameter.mdx | 28 +++ .../automation/connector/OperationType.mdx | 22 ++- .../automation/etl/ETLDestination.mdx | 27 +++ .../automation/etl/ETLEndpointType.mdx | 22 ++- .../references/automation/etl/ETLPipeline.mdx | 28 +++ .../automation/etl/ETLPipelineRun.mdx | 29 +++ .../automation/etl/ETLRunStatus.mdx | 22 ++- .../references/automation/etl/ETLSource.mdx | 27 +++ .../references/automation/etl/ETLSyncMode.mdx | 22 ++- .../automation/etl/ETLTransformation.mdx | 27 +++ .../automation/etl/ETLTransformationType.mdx | 22 ++- .../docs/references/automation/flow/Flow.mdx | 29 +++ .../references/automation/flow/FlowEdge.mdx | 28 +++ .../references/automation/flow/FlowNode.mdx | 28 +++ .../automation/flow/FlowNodeAction.mdx | 22 ++- .../automation/flow/FlowVariable.mdx | 27 +++ content/docs/references/automation/index.mdx | 116 ++++++++++++ .../automation/mapping/FieldMapping.mdx | 27 +++ .../automation/sync/ConflictResolution.mdx | 22 ++- .../automation/sync/DataDestinationConfig.mdx | 26 +++ .../automation/sync/DataSourceConfig.mdx | 25 +++ .../automation/sync/DataSyncConfig.mdx | 28 +++ .../automation/sync/SyncDirection.mdx | 22 ++- .../automation/sync/SyncExecutionResult.mdx | 29 +++ .../automation/sync/SyncExecutionStatus.mdx | 22 ++- .../references/automation/sync/SyncMode.mdx | 22 ++- .../references/automation/webhook/Webhook.mdx | 29 +++ .../automation/webhook/WebhookReceiver.mdx | 28 +++ .../automation/webhook/WebhookTriggerType.mdx | 22 ++- .../workflow/CustomScriptAction.mdx | 28 +++ .../automation/workflow/EmailAlertAction.mdx | 29 +++ .../automation/workflow/FieldUpdateAction.mdx | 28 +++ .../automation/workflow/HttpCallAction.mdx | 29 +++ .../workflow/PushNotificationAction.mdx | 29 +++ .../workflow/SlackMessageAction.mdx | 29 +++ .../workflow/SmsNotificationAction.mdx | 29 +++ .../workflow/TaskCreationAction.mdx | 29 +++ .../workflow/TeamsMessageAction.mdx | 29 +++ .../automation/workflow/TimeTrigger.mdx | 29 +++ .../workflow/WebhookTriggerAction.mdx | 28 +++ .../automation/workflow/WorkflowAction.mdx | 10 + .../automation/workflow/WorkflowRule.mdx | 28 +++ .../workflow/WorkflowTriggerType.mdx | 22 ++- .../docs/references/data/dataset/Dataset.mdx | 27 +++ .../references/data/dataset/DatasetMode.mdx | 22 ++- .../docs/references/data/field/Address.mdx | 25 +++ .../references/data/field/CurrencyConfig.mdx | 25 +++ .../references/data/field/CurrencyValue.mdx | 27 +++ content/docs/references/data/field/Field.mdx | 26 +++ .../docs/references/data/field/FieldType.mdx | 22 ++- .../data/field/LocationCoordinates.mdx | 27 +++ .../references/data/field/SelectOption.mdx | 27 +++ .../references/data/field/VectorConfig.mdx | 26 +++ .../data/filter/ComparisonOperator.mdx | 25 +++ .../data/filter/EqualityOperator.mdx | 25 +++ .../references/data/filter/FieldOperators.mdx | 25 +++ .../references/data/filter/FieldReference.mdx | 26 +++ .../data/filter/FilterCondition.mdx | 10 + .../data/filter/NormalizedFilter.mdx | 25 +++ .../references/data/filter/QueryFilter.mdx | 25 +++ .../references/data/filter/RangeOperator.mdx | 25 +++ .../references/data/filter/SetOperator.mdx | 25 +++ .../data/filter/SpecialOperator.mdx | 25 +++ .../references/data/filter/StringOperator.mdx | 25 +++ content/docs/references/data/hook/Hook.mdx | 28 +++ .../docs/references/data/hook/HookContext.mdx | 28 +++ .../docs/references/data/hook/HookEvent.mdx | 22 ++- content/docs/references/data/index.mdx | 110 +++++++++++ content/docs/references/data/object/Index.mdx | 26 +++ .../docs/references/data/object/Object.mdx | 27 +++ .../data/object/ObjectCapabilities.mdx | 25 +++ .../references/data/object/SearchConfig.mdx | 26 +++ .../data/query/AggregationFunction.mdx | 22 ++- .../references/data/query/AggregationNode.mdx | 27 +++ .../docs/references/data/query/FieldNode.mdx | 10 + .../docs/references/data/query/JoinNode.mdx | 28 +++ .../references/data/query/JoinStrategy.mdx | 22 ++- .../docs/references/data/query/JoinType.mdx | 22 ++- content/docs/references/data/query/Query.mdx | 26 +++ .../docs/references/data/query/SortNode.mdx | 26 +++ .../references/data/query/WindowFunction.mdx | 22 ++- .../data/query/WindowFunctionNode.mdx | 28 +++ .../docs/references/data/query/WindowSpec.mdx | 25 +++ .../data/validation/AsyncValidation.mdx | 29 +++ .../data/validation/ConditionalValidation.mdx | 29 +++ .../data/validation/CrossFieldValidation.mdx | 29 +++ .../data/validation/CustomValidator.mdx | 29 +++ .../data/validation/FormatValidation.mdx | 29 +++ .../data/validation/JSONValidation.mdx | 29 +++ .../data/validation/ScriptValidation.mdx | 29 +++ .../validation/StateMachineValidation.mdx | 29 +++ .../data/validation/UniquenessValidation.mdx | 29 +++ .../data/validation/ValidationRule.mdx | 10 + .../hub/composer/BillOfMaterials.mdx | 27 +++ .../hub/composer/ComposerRequest.mdx | 26 +++ .../hub/composer/ComposerResponse.mdx | 29 +++ .../hub/composer/ConflictReport.mdx | 29 +++ .../hub/composer/DependencyRequirement.mdx | 26 +++ content/docs/references/hub/index.mdx | 71 ++++++++ .../docs/references/hub/license/Feature.mdx | 27 +++ .../docs/references/hub/license/License.mdx | 29 +++ .../references/hub/license/MetricType.mdx | 22 ++- content/docs/references/hub/license/Plan.mdx | 29 +++ .../hub/marketplace/MarketplacePlugin.mdx | 28 +++ .../hub/marketplace/PluginAuthor.mdx | 26 +++ .../hub/marketplace/PluginPricing.mdx | 27 +++ .../references/hub/space/DeploymentTarget.mdx | 26 +++ .../docs/references/hub/space/HubSpace.mdx | 29 +++ .../hub/space/SpaceSubscription.mdx | 27 +++ .../hub/space/SubscriptionStatus.mdx | 22 ++- .../tenant/DatabaseLevelIsolationStrategy.mdx | 26 +++ .../tenant/LevelIsolationStrategySchema.mdx | 26 +++ .../hub/tenant/RowLevelIsolationStrategy.mdx | 26 +++ content/docs/references/hub/tenant/Tenant.mdx | 28 +++ .../hub/tenant/TenantIsolationConfig.mdx | 10 + .../hub/tenant/TenantIsolationLevel.mdx | 22 ++- .../references/hub/tenant/TenantQuota.mdx | 25 +++ .../hub/tenant/TenantSecurityPolicy.mdx | 25 +++ content/docs/references/permission/index.mdx | 58 ++++++ .../permission/permission/FieldPermission.mdx | 25 +++ .../permission/ObjectPermission.mdx | 25 +++ .../permission/permission/PermissionSet.mdx | 27 +++ .../references/permission/rls/RLSConfig.mdx | 25 +++ .../permission/rls/RLSEvaluationResult.mdx | 27 +++ .../permission/rls/RLSOperation.mdx | 22 ++- .../permission/rls/RLSUserContext.mdx | 26 +++ .../permission/rls/RowLevelSecurityPolicy.mdx | 28 +++ .../sharing/CriteriaSharingRule.mdx | 29 +++ .../permission/sharing/OWDModel.mdx | 22 ++- .../permission/sharing/OwnerSharingRule.mdx | 29 +++ .../permission/sharing/ShareRecipientType.mdx | 22 ++- .../permission/sharing/SharingLevel.mdx | 22 ++- .../permission/sharing/SharingRule.mdx | 10 + .../permission/sharing/SharingRuleType.mdx | 22 ++- .../permission/territory/Territory.mdx | 28 +++ .../permission/territory/TerritoryModel.mdx | 26 +++ .../permission/territory/TerritoryType.mdx | 22 ++- .../shared/identifiers/EventName.mdx | 10 + .../identifiers/SnakeCaseIdentifier.mdx | 10 + .../shared/identifiers/SystemIdentifier.mdx | 10 + content/docs/references/shared/index.mdx | 22 +++ .../references/system/audit/AuditConfig.mdx | 28 +++ .../references/system/audit/AuditEvent.mdx | 29 +++ .../system/audit/AuditEventActor.mdx | 27 +++ .../system/audit/AuditEventChange.mdx | 26 +++ .../system/audit/AuditEventFilter.mdx | 25 +++ .../system/audit/AuditEventSeverity.mdx | 22 ++- .../system/audit/AuditEventTarget.mdx | 27 +++ .../system/audit/AuditEventType.mdx | 22 ++- .../system/audit/AuditRetentionPolicy.mdx | 25 +++ .../system/audit/AuditStorageConfig.mdx | 26 +++ .../system/audit/SuspiciousActivityRule.mdx | 29 +++ .../system/context/KernelContext.mdx | 29 +++ .../references/system/context/RuntimeMode.mdx | 22 ++- .../system/datasource/Datasource.mdx | 28 +++ .../datasource/DatasourceCapabilities.mdx | 25 +++ .../system/datasource/DriverDefinition.mdx | 28 +++ .../system/datasource/DriverType.mdx | 10 + .../system/driver/DriverCapabilities.mdx | 29 +++ .../system/driver/DriverInterface.mdx | 28 +++ .../system/driver/DriverOptions.mdx | 25 +++ .../docs/references/system/events/Event.mdx | 27 +++ .../references/system/events/EventHandler.mdx | 26 +++ .../system/events/EventMetadata.mdx | 27 +++ .../system/events/EventPersistence.mdx | 26 +++ .../references/system/events/EventRoute.mdx | 27 +++ .../references/system/feature/FeatureFlag.mdx | 26 +++ .../system/feature/FeatureStrategy.mdx | 22 ++- content/docs/references/system/index.mdx | 153 ++++++++++++++++ .../references/system/job/CronSchedule.mdx | 27 +++ .../system/job/IntervalSchedule.mdx | 27 +++ content/docs/references/system/job/Job.mdx | 28 +++ .../references/system/job/JobExecution.mdx | 28 +++ .../system/job/JobExecutionStatus.mdx | 22 ++- .../references/system/job/OnceSchedule.mdx | 27 +++ .../references/system/job/RetryPolicy.mdx | 25 +++ .../docs/references/system/job/Schedule.mdx | 10 + .../references/system/logger/LogEntry.mdx | 28 +++ .../references/system/logger/LogFormat.mdx | 22 ++- .../references/system/logger/LogLevel.mdx | 22 ++- .../references/system/logger/LoggerConfig.mdx | 25 +++ .../references/system/manifest/Manifest.mdx | 29 +++ .../system/{ => misc}/MongoConfig.mdx | 26 +++ .../system/{ => misc}/PostgresConfig.mdx | 26 +++ .../references/system/plugin/I18nContext.mdx | 25 +++ .../docs/references/system/plugin/Logger.mdx | 25 +++ .../system/plugin/ObjectQLClient.mdx | 25 +++ .../docs/references/system/plugin/Plugin.mdx | 25 +++ .../system/plugin/PluginContext.mdx | 29 +++ .../system/plugin/PluginLifecycle.mdx | 25 +++ .../docs/references/system/plugin/Router.mdx | 25 +++ .../references/system/plugin/Scheduler.mdx | 25 +++ .../system/plugin/ScopedStorage.mdx | 25 +++ .../references/system/plugin/SystemAPI.mdx | 25 +++ .../system/scoped-storage/FileMetadata.mdx | 29 +++ .../scoped-storage/ScopedStorageConfig.mdx | 27 +++ .../scoped-storage/StorageAdapterType.mdx | 22 ++- .../system/scoped-storage/StorageScope.mdx | 22 ++- .../references/system/translation/Locale.mdx | 10 + .../system/translation/TranslationBundle.mdx | 10 + .../system/translation/TranslationData.mdx | 25 +++ content/docs/references/ui/action/Action.mdx | 27 +++ .../docs/references/ui/action/ActionParam.mdx | 28 +++ content/docs/references/ui/app/App.mdx | 27 +++ .../docs/references/ui/app/AppBranding.mdx | 25 +++ .../references/ui/app/DashboardNavItem.mdx | 29 +++ .../docs/references/ui/app/GroupNavItem.mdx | 28 +++ .../docs/references/ui/app/NavigationItem.mdx | 10 + .../docs/references/ui/app/ObjectNavItem.mdx | 29 +++ .../docs/references/ui/app/PageNavItem.mdx | 29 +++ content/docs/references/ui/app/UrlNavItem.mdx | 29 +++ .../references/ui/component/PageCardProps.mdx | 26 +++ .../ui/component/PageHeaderProps.mdx | 26 +++ .../references/ui/component/PageTabsProps.mdx | 26 +++ .../ui/component/RecordDetailsProps.mdx | 25 +++ .../ui/component/RecordHighlightsProps.mdx | 26 +++ .../ui/component/RecordRelatedListProps.mdx | 28 +++ .../references/ui/dashboard/ChartType.mdx | 22 ++- .../references/ui/dashboard/Dashboard.mdx | 28 +++ .../ui/dashboard/DashboardWidget.mdx | 26 +++ content/docs/references/ui/index.mdx | 132 ++++++++++++++ content/docs/references/ui/page/Page.mdx | 28 +++ .../docs/references/ui/page/PageComponent.mdx | 27 +++ .../references/ui/page/PageComponentType.mdx | 22 ++- .../docs/references/ui/page/PageRegion.mdx | 27 +++ content/docs/references/ui/report/Report.mdx | 29 +++ .../docs/references/ui/report/ReportChart.mdx | 28 +++ .../references/ui/report/ReportColumn.mdx | 26 +++ .../references/ui/report/ReportGrouping.mdx | 26 +++ .../docs/references/ui/report/ReportType.mdx | 22 ++- .../docs/references/ui/theme/Animation.mdx | 25 +++ .../docs/references/ui/theme/BorderRadius.mdx | 25 +++ .../docs/references/ui/theme/Breakpoints.mdx | 25 +++ .../docs/references/ui/theme/ColorPalette.mdx | 26 +++ content/docs/references/ui/theme/Shadow.mdx | 25 +++ content/docs/references/ui/theme/Spacing.mdx | 25 +++ content/docs/references/ui/theme/Theme.mdx | 28 +++ .../docs/references/ui/theme/ThemeMode.mdx | 22 ++- .../docs/references/ui/theme/Typography.mdx | 25 +++ content/docs/references/ui/theme/ZIndex.mdx | 25 +++ .../references/ui/view/CalendarConfig.mdx | 27 +++ content/docs/references/ui/view/FormField.mdx | 26 +++ .../docs/references/ui/view/FormSection.mdx | 26 +++ content/docs/references/ui/view/FormView.mdx | 25 +++ .../docs/references/ui/view/GanttConfig.mdx | 28 +++ .../docs/references/ui/view/HttpMethod.mdx | 22 ++- .../docs/references/ui/view/HttpRequest.mdx | 26 +++ .../docs/references/ui/view/KanbanConfig.mdx | 27 +++ .../docs/references/ui/view/ListColumn.mdx | 26 +++ content/docs/references/ui/view/ListView.mdx | 26 +++ .../references/ui/view/PaginationConfig.mdx | 25 +++ .../references/ui/view/SelectionConfig.mdx | 25 +++ content/docs/references/ui/view/View.mdx | 25 +++ content/docs/references/ui/view/ViewData.mdx | 10 + .../references/ui/widget/FieldWidgetProps.mdx | 26 +++ .../docs/references/ui/widget/WidgetEvent.mdx | 26 +++ .../references/ui/widget/WidgetLifecycle.mdx | 25 +++ .../references/ui/widget/WidgetManifest.mdx | 27 +++ .../references/ui/widget/WidgetProperty.mdx | 27 +++ packages/spec/scripts/build-docs.ts | 172 +++++++++++++++++- 447 files changed, 12203 insertions(+), 75 deletions(-) create mode 100644 content/docs/references/ai/index.mdx create mode 100644 content/docs/references/api/index.mdx create mode 100644 content/docs/references/auth/index.mdx create mode 100644 content/docs/references/automation/index.mdx create mode 100644 content/docs/references/data/index.mdx create mode 100644 content/docs/references/hub/index.mdx create mode 100644 content/docs/references/permission/index.mdx create mode 100644 content/docs/references/shared/index.mdx create mode 100644 content/docs/references/system/index.mdx rename content/docs/references/system/{ => misc}/MongoConfig.mdx (63%) rename content/docs/references/system/{ => misc}/PostgresConfig.mdx (61%) create mode 100644 content/docs/references/ui/index.mdx diff --git a/content/docs/references/ai/agent/AIKnowledge.mdx b/content/docs/references/ai/agent/AIKnowledge.mdx index a95abc12b..2e63e5193 100644 --- a/content/docs/references/ai/agent/AIKnowledge.mdx +++ b/content/docs/references/ai/agent/AIKnowledge.mdx @@ -1,11 +1,38 @@ --- title: AIKnowledge description: AIKnowledge Schema Reference +category: ai +zodFile: agent --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/agent.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **topics** | `string[]` | ✅ | Topics/Tags to recruit knowledge from | | **indexes** | `string[]` | ✅ | Vector Store Indexes | + +## TypeScript Usage + +```typescript +import { AIKnowledgeSchema } from '@objectstack/spec/ai'; +import type { AIKnowledge } from '@objectstack/spec/ai'; + +// Validate data +const result = AIKnowledgeSchema.parse(data); + +// Type-safe usage +const myAIKnowledge: AIKnowledge = { + topics: [], + indexes: [] +}; +``` + diff --git a/content/docs/references/ai/agent/AIModelConfig.mdx b/content/docs/references/ai/agent/AIModelConfig.mdx index d3f685795..ddcc59a9e 100644 --- a/content/docs/references/ai/agent/AIModelConfig.mdx +++ b/content/docs/references/ai/agent/AIModelConfig.mdx @@ -1,8 +1,18 @@ --- title: AIModelConfig description: AIModelConfig Schema Reference +category: ai +zodFile: agent --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/agent.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: AIModelConfig Schema Reference | **temperature** | `number` | optional | | | **maxTokens** | `number` | optional | | | **topP** | `number` | optional | | + +## TypeScript Usage + +```typescript +import { AIModelConfigSchema } from '@objectstack/spec/ai'; +import type { AIModelConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = AIModelConfigSchema.parse(data); + +// Type-safe usage +const myAIModelConfig: AIModelConfig = { + model: 'example' +}; +``` + diff --git a/content/docs/references/ai/agent/AITool.mdx b/content/docs/references/ai/agent/AITool.mdx index fc872724d..db933da0d 100644 --- a/content/docs/references/ai/agent/AITool.mdx +++ b/content/docs/references/ai/agent/AITool.mdx @@ -1,8 +1,18 @@ --- title: AITool description: AITool Schema Reference +category: ai +zodFile: agent --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/agent.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: AITool Schema Reference | **type** | `Enum<'action' \| 'flow' \| 'query' \| 'vector_search'>` | ✅ | | | **name** | `string` | ✅ | Reference name (Action Name, Flow Name) | | **description** | `string` | optional | Override description for the LLM | + +## TypeScript Usage + +```typescript +import { AIToolSchema } from '@objectstack/spec/ai'; +import type { AITool } from '@objectstack/spec/ai'; + +// Validate data +const result = AIToolSchema.parse(data); + +// Type-safe usage +const myAITool: AITool = { + type: 'action', + name: 'name' +}; +``` + diff --git a/content/docs/references/ai/agent/Agent.mdx b/content/docs/references/ai/agent/Agent.mdx index 63ecbb9c3..01b936fbd 100644 --- a/content/docs/references/ai/agent/Agent.mdx +++ b/content/docs/references/ai/agent/Agent.mdx @@ -1,8 +1,18 @@ --- title: Agent description: Agent Schema Reference +category: ai +zodFile: agent --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/agent.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,22 @@ description: Agent Schema Reference | **knowledge** | `object` | optional | RAG access | | **active** | `boolean` | optional | | | **access** | `string[]` | optional | Who can chat with this agent | + +## TypeScript Usage + +```typescript +import { AgentSchema } from '@objectstack/spec/ai'; +import type { Agent } from '@objectstack/spec/ai'; + +// Validate data +const result = AgentSchema.parse(data); + +// Type-safe usage +const myAgent: Agent = { + name: 'name', + label: 'example', + role: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/conversation/ConversationAnalytics.mdx b/content/docs/references/ai/conversation/ConversationAnalytics.mdx index 2c715617a..0191e6411 100644 --- a/content/docs/references/ai/conversation/ConversationAnalytics.mdx +++ b/content/docs/references/ai/conversation/ConversationAnalytics.mdx @@ -1,8 +1,18 @@ --- title: ConversationAnalytics description: ConversationAnalytics Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -22,3 +32,22 @@ description: ConversationAnalytics Schema Reference | **duration** | `number` | optional | Session duration in seconds | | **firstMessageAt** | `string` | optional | ISO 8601 timestamp | | **lastMessageAt** | `string` | optional | ISO 8601 timestamp | + +## TypeScript Usage + +```typescript +import { ConversationAnalyticsSchema } from '@objectstack/spec/ai'; +import type { ConversationAnalytics } from '@objectstack/spec/ai'; + +// Validate data +const result = ConversationAnalyticsSchema.parse(data); + +// Type-safe usage +const myConversationAnalytics: ConversationAnalytics = { + sessionId: 'example', + totalMessages: null, + userMessages: null, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/conversation/ConversationContext.mdx b/content/docs/references/ai/conversation/ConversationContext.mdx index 8ffd326fd..dd6ece4df 100644 --- a/content/docs/references/ai/conversation/ConversationContext.mdx +++ b/content/docs/references/ai/conversation/ConversationContext.mdx @@ -1,8 +1,18 @@ --- title: ConversationContext description: ConversationContext Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,19 @@ description: ConversationContext Schema Reference | **scope** | `Record` | optional | Additional context scope | | **systemMessage** | `string` | optional | System prompt/instructions | | **metadata** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { ConversationContextSchema } from '@objectstack/spec/ai'; +import type { ConversationContext } from '@objectstack/spec/ai'; + +// Validate data +const result = ConversationContextSchema.parse(data); + +// Type-safe usage +const myConversationContext: ConversationContext = { + sessionId: 'example' +}; +``` + diff --git a/content/docs/references/ai/conversation/ConversationMessage.mdx b/content/docs/references/ai/conversation/ConversationMessage.mdx index abc8cf19c..68c14e9e2 100644 --- a/content/docs/references/ai/conversation/ConversationMessage.mdx +++ b/content/docs/references/ai/conversation/ConversationMessage.mdx @@ -1,8 +1,18 @@ --- title: ConversationMessage description: ConversationMessage Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,22 @@ description: ConversationMessage Schema Reference | **importance** | `number` | optional | Importance score for pruning | | **embedding** | `number[]` | optional | Vector embedding for semantic search | | **metadata** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { ConversationMessageSchema } from '@objectstack/spec/ai'; +import type { ConversationMessage } from '@objectstack/spec/ai'; + +// Validate data +const result = ConversationMessageSchema.parse(data); + +// Type-safe usage +const myConversationMessage: ConversationMessage = { + id: 'example', + timestamp: 'example', + role: 'system', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/conversation/ConversationSession.mdx b/content/docs/references/ai/conversation/ConversationSession.mdx index 769c0f214..02d66c7c7 100644 --- a/content/docs/references/ai/conversation/ConversationSession.mdx +++ b/content/docs/references/ai/conversation/ConversationSession.mdx @@ -1,8 +1,18 @@ --- title: ConversationSession description: ConversationSession Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,22 @@ description: ConversationSession Schema Reference | **expiresAt** | `string` | optional | ISO 8601 timestamp | | **tags** | `string[]` | optional | | | **metadata** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { ConversationSessionSchema } from '@objectstack/spec/ai'; +import type { ConversationSession } from '@objectstack/spec/ai'; + +// Validate data +const result = ConversationSessionSchema.parse(data); + +// Type-safe usage +const myConversationSession: ConversationSession = { + id: 'example', + context: {}, + tokenBudget: {}, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/conversation/ConversationSummary.mdx b/content/docs/references/ai/conversation/ConversationSummary.mdx index 8f5eff0d4..fa3becd1f 100644 --- a/content/docs/references/ai/conversation/ConversationSummary.mdx +++ b/content/docs/references/ai/conversation/ConversationSummary.mdx @@ -1,8 +1,18 @@ --- title: ConversationSummary description: ConversationSummary Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: ConversationSummary Schema Reference | **messageRange** | `object` | ✅ | Range of messages summarized | | **generatedAt** | `string` | ✅ | ISO 8601 timestamp | | **modelId** | `string` | optional | Model used for summarization | + +## TypeScript Usage + +```typescript +import { ConversationSummarySchema } from '@objectstack/spec/ai'; +import type { ConversationSummary } from '@objectstack/spec/ai'; + +// Validate data +const result = ConversationSummarySchema.parse(data); + +// Type-safe usage +const myConversationSummary: ConversationSummary = { + summary: 'example', + originalTokens: null, + summaryTokens: null, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/conversation/FunctionCall.mdx b/content/docs/references/ai/conversation/FunctionCall.mdx index cf5f10605..4f1a2cf2b 100644 --- a/content/docs/references/ai/conversation/FunctionCall.mdx +++ b/content/docs/references/ai/conversation/FunctionCall.mdx @@ -1,8 +1,18 @@ --- title: FunctionCall description: FunctionCall Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: FunctionCall Schema Reference | **name** | `string` | ✅ | Function name | | **arguments** | `string` | ✅ | JSON string of function arguments | | **result** | `string` | optional | Function execution result | + +## TypeScript Usage + +```typescript +import { FunctionCallSchema } from '@objectstack/spec/ai'; +import type { FunctionCall } from '@objectstack/spec/ai'; + +// Validate data +const result = FunctionCallSchema.parse(data); + +// Type-safe usage +const myFunctionCall: FunctionCall = { + name: 'name', + arguments: 'example' +}; +``` + diff --git a/content/docs/references/ai/conversation/MessageContent.mdx b/content/docs/references/ai/conversation/MessageContent.mdx index e7e9c6212..d3e5b2791 100644 --- a/content/docs/references/ai/conversation/MessageContent.mdx +++ b/content/docs/references/ai/conversation/MessageContent.mdx @@ -1,8 +1,18 @@ --- title: MessageContent description: MessageContent Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: MessageContent Schema Reference | **fileUrl** | `string` | optional | File attachment URL | | **mimeType** | `string` | optional | MIME type for files | | **metadata** | `Record` | optional | Additional metadata | + +## TypeScript Usage + +```typescript +import { MessageContentSchema } from '@objectstack/spec/ai'; +import type { MessageContent } from '@objectstack/spec/ai'; + +// Validate data +const result = MessageContentSchema.parse(data); + +// Type-safe usage +const myMessageContent: MessageContent = { +}; +``` + diff --git a/content/docs/references/ai/conversation/MessageContentType.mdx b/content/docs/references/ai/conversation/MessageContentType.mdx index 234ce5b5b..65edf6751 100644 --- a/content/docs/references/ai/conversation/MessageContentType.mdx +++ b/content/docs/references/ai/conversation/MessageContentType.mdx @@ -1,12 +1,32 @@ --- title: MessageContentType description: MessageContentType Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Allowed Values * `text` * `image` * `file` * `code` -* `structured` \ No newline at end of file +* `structured` + +## TypeScript Usage + +```typescript +import { MessageContentType } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: MessageContentType = 'text'; +``` + diff --git a/content/docs/references/ai/conversation/MessagePruningEvent.mdx b/content/docs/references/ai/conversation/MessagePruningEvent.mdx index eb1528348..ec4a88976 100644 --- a/content/docs/references/ai/conversation/MessagePruningEvent.mdx +++ b/content/docs/references/ai/conversation/MessagePruningEvent.mdx @@ -1,8 +1,18 @@ --- title: MessagePruningEvent description: MessagePruningEvent Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: MessagePruningEvent Schema Reference | **messagesRemoved** | `integer` | ✅ | | | **remainingTokens** | `integer` | ✅ | | | **remainingMessages** | `integer` | ✅ | | + +## TypeScript Usage + +```typescript +import { MessagePruningEventSchema } from '@objectstack/spec/ai'; +import type { MessagePruningEvent } from '@objectstack/spec/ai'; + +// Validate data +const result = MessagePruningEventSchema.parse(data); + +// Type-safe usage +const myMessagePruningEvent: MessagePruningEvent = { + timestamp: 'example', + strategy: 'fifo', + reason: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/conversation/MessageRole.mdx b/content/docs/references/ai/conversation/MessageRole.mdx index a24e4016d..daba810d3 100644 --- a/content/docs/references/ai/conversation/MessageRole.mdx +++ b/content/docs/references/ai/conversation/MessageRole.mdx @@ -1,12 +1,32 @@ --- title: MessageRole description: MessageRole Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Allowed Values * `system` * `user` * `assistant` * `function` -* `tool` \ No newline at end of file +* `tool` + +## TypeScript Usage + +```typescript +import { MessageRole } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: MessageRole = 'system'; +``` + diff --git a/content/docs/references/ai/conversation/TokenBudgetConfig.mdx b/content/docs/references/ai/conversation/TokenBudgetConfig.mdx index f9c01c073..172184276 100644 --- a/content/docs/references/ai/conversation/TokenBudgetConfig.mdx +++ b/content/docs/references/ai/conversation/TokenBudgetConfig.mdx @@ -1,8 +1,18 @@ --- title: TokenBudgetConfig description: TokenBudgetConfig Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,19 @@ description: TokenBudgetConfig Schema Reference | **summarizationThreshold** | `integer` | optional | Trigger summarization at N tokens | | **summaryModel** | `string` | optional | Model ID for summarization | | **warnThreshold** | `number` | optional | Warn at % of budget (0.8 = 80%) | + +## TypeScript Usage + +```typescript +import { TokenBudgetConfigSchema } from '@objectstack/spec/ai'; +import type { TokenBudgetConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = TokenBudgetConfigSchema.parse(data); + +// Type-safe usage +const myTokenBudgetConfig: TokenBudgetConfig = { + maxTokens: null +}; +``` + diff --git a/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx b/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx index 4070b4693..1d189f356 100644 --- a/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx +++ b/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx @@ -1,12 +1,32 @@ --- title: TokenBudgetStrategy description: TokenBudgetStrategy Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Allowed Values * `fifo` * `importance` * `semantic` * `sliding_window` -* `summary` \ No newline at end of file +* `summary` + +## TypeScript Usage + +```typescript +import { TokenBudgetStrategy } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: TokenBudgetStrategy = 'fifo'; +``` + diff --git a/content/docs/references/ai/conversation/TokenUsageStats.mdx b/content/docs/references/ai/conversation/TokenUsageStats.mdx index 9d4a776b9..6698f641d 100644 --- a/content/docs/references/ai/conversation/TokenUsageStats.mdx +++ b/content/docs/references/ai/conversation/TokenUsageStats.mdx @@ -1,8 +1,18 @@ --- title: TokenUsageStats description: TokenUsageStats Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,21 @@ description: TokenUsageStats Schema Reference | **messageCount** | `integer` | optional | | | **prunedMessageCount** | `integer` | optional | | | **summarizedMessageCount** | `integer` | optional | | + +## TypeScript Usage + +```typescript +import { TokenUsageStatsSchema } from '@objectstack/spec/ai'; +import type { TokenUsageStats } from '@objectstack/spec/ai'; + +// Validate data +const result = TokenUsageStatsSchema.parse(data); + +// Type-safe usage +const myTokenUsageStats: TokenUsageStats = { + budgetLimit: null, + budgetRemaining: null, + budgetPercentage: 0 +}; +``` + diff --git a/content/docs/references/ai/conversation/ToolCall.mdx b/content/docs/references/ai/conversation/ToolCall.mdx index 8c31d637a..1d7ae2f73 100644 --- a/content/docs/references/ai/conversation/ToolCall.mdx +++ b/content/docs/references/ai/conversation/ToolCall.mdx @@ -1,8 +1,18 @@ --- title: ToolCall description: ToolCall Schema Reference +category: ai +zodFile: conversation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: ToolCall Schema Reference | **id** | `string` | ✅ | Tool call ID | | **type** | `Enum<'function'>` | optional | | | **function** | `object` | ✅ | | + +## TypeScript Usage + +```typescript +import { ToolCallSchema } from '@objectstack/spec/ai'; +import type { ToolCall } from '@objectstack/spec/ai'; + +// Validate data +const result = ToolCallSchema.parse(data); + +// Type-safe usage +const myToolCall: ToolCall = { + id: 'example', + function: {} +}; +``` + diff --git a/content/docs/references/ai/cost/BillingPeriod.mdx b/content/docs/references/ai/cost/BillingPeriod.mdx index 1baf034f5..45eb14955 100644 --- a/content/docs/references/ai/cost/BillingPeriod.mdx +++ b/content/docs/references/ai/cost/BillingPeriod.mdx @@ -1,8 +1,18 @@ --- title: BillingPeriod description: BillingPeriod Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Allowed Values * `hourly` @@ -11,4 +21,14 @@ description: BillingPeriod Schema Reference * `monthly` * `quarterly` * `yearly` -* `custom` \ No newline at end of file +* `custom` + +## TypeScript Usage + +```typescript +import { BillingPeriod } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: BillingPeriod = 'hourly'; +``` + diff --git a/content/docs/references/ai/cost/BudgetLimit.mdx b/content/docs/references/ai/cost/BudgetLimit.mdx index 4d21aaeec..22eab2039 100644 --- a/content/docs/references/ai/cost/BudgetLimit.mdx +++ b/content/docs/references/ai/cost/BudgetLimit.mdx @@ -1,8 +1,18 @@ --- title: BudgetLimit description: BudgetLimit Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -23,3 +33,21 @@ description: BudgetLimit Schema Reference | **description** | `string` | optional | | | **active** | `boolean` | optional | | | **tags** | `string[]` | optional | | + +## TypeScript Usage + +```typescript +import { BudgetLimitSchema } from '@objectstack/spec/ai'; +import type { BudgetLimit } from '@objectstack/spec/ai'; + +// Validate data +const result = BudgetLimitSchema.parse(data); + +// Type-safe usage +const myBudgetLimit: BudgetLimit = { + type: 'global', + maxCost: 0, + period: 'hourly' +}; +``` + diff --git a/content/docs/references/ai/cost/BudgetStatus.mdx b/content/docs/references/ai/cost/BudgetStatus.mdx index 4e1936779..224d2dfa6 100644 --- a/content/docs/references/ai/cost/BudgetStatus.mdx +++ b/content/docs/references/ai/cost/BudgetStatus.mdx @@ -1,8 +1,18 @@ --- title: BudgetStatus description: BudgetStatus Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -22,3 +32,22 @@ description: BudgetStatus Schema Reference | **projectedCost** | `number` | optional | Projected cost for period | | **projectedOverage** | `number` | optional | Projected overage | | **lastUpdated** | `string` | ✅ | ISO 8601 timestamp | + +## TypeScript Usage + +```typescript +import { BudgetStatusSchema } from '@objectstack/spec/ai'; +import type { BudgetStatus } from '@objectstack/spec/ai'; + +// Validate data +const result = BudgetStatusSchema.parse(data); + +// Type-safe usage +const myBudgetStatus: BudgetStatus = { + budgetId: 'example', + type: 'global', + periodStart: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/cost/BudgetType.mdx b/content/docs/references/ai/cost/BudgetType.mdx index 6a73df905..84eb4ad91 100644 --- a/content/docs/references/ai/cost/BudgetType.mdx +++ b/content/docs/references/ai/cost/BudgetType.mdx @@ -1,8 +1,18 @@ --- title: BudgetType description: BudgetType Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Allowed Values * `global` @@ -10,4 +20,14 @@ description: BudgetType Schema Reference * `agent` * `object` * `project` -* `department` \ No newline at end of file +* `department` + +## TypeScript Usage + +```typescript +import { BudgetType } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: BudgetType = 'global'; +``` + diff --git a/content/docs/references/ai/cost/CostAlert.mdx b/content/docs/references/ai/cost/CostAlert.mdx index 71839ae17..88e49e759 100644 --- a/content/docs/references/ai/cost/CostAlert.mdx +++ b/content/docs/references/ai/cost/CostAlert.mdx @@ -1,8 +1,18 @@ --- title: CostAlert description: CostAlert Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -25,3 +35,22 @@ description: CostAlert Schema Reference | **acknowledgedAt** | `string` | optional | | | **resolved** | `boolean` | optional | | | **metadata** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { CostAlertSchema } from '@objectstack/spec/ai'; +import type { CostAlert } from '@objectstack/spec/ai'; + +// Validate data +const result = CostAlertSchema.parse(data); + +// Type-safe usage +const myCostAlert: CostAlert = { + id: 'example', + timestamp: 'example', + type: 'threshold_warning', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/cost/CostAlertType.mdx b/content/docs/references/ai/cost/CostAlertType.mdx index 1f086c20c..cbc04be87 100644 --- a/content/docs/references/ai/cost/CostAlertType.mdx +++ b/content/docs/references/ai/cost/CostAlertType.mdx @@ -1,12 +1,32 @@ --- title: CostAlertType description: CostAlertType Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Allowed Values * `threshold_warning` * `threshold_critical` * `limit_exceeded` * `anomaly_detected` -* `projection_exceeded` \ No newline at end of file +* `projection_exceeded` + +## TypeScript Usage + +```typescript +import { CostAlertType } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: CostAlertType = 'threshold_warning'; +``` + diff --git a/content/docs/references/ai/cost/CostAnalytics.mdx b/content/docs/references/ai/cost/CostAnalytics.mdx index 15f44483b..82cec8f97 100644 --- a/content/docs/references/ai/cost/CostAnalytics.mdx +++ b/content/docs/references/ai/cost/CostAnalytics.mdx @@ -1,8 +1,18 @@ --- title: CostAnalytics description: CostAnalytics Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -29,3 +39,22 @@ description: CostAnalytics Schema Reference | **topAgents** | `object[]` | optional | | | **tokensPerDollar** | `number` | optional | | | **requestsPerDollar** | `number` | optional | | + +## TypeScript Usage + +```typescript +import { CostAnalyticsSchema } from '@objectstack/spec/ai'; +import type { CostAnalytics } from '@objectstack/spec/ai'; + +// Validate data +const result = CostAnalyticsSchema.parse(data); + +// Type-safe usage +const myCostAnalytics: CostAnalytics = { + periodStart: 'example', + periodEnd: 'example', + totalCost: 0, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/cost/CostBreakdownDimension.mdx b/content/docs/references/ai/cost/CostBreakdownDimension.mdx index f52054965..63638bd06 100644 --- a/content/docs/references/ai/cost/CostBreakdownDimension.mdx +++ b/content/docs/references/ai/cost/CostBreakdownDimension.mdx @@ -1,8 +1,18 @@ --- title: CostBreakdownDimension description: CostBreakdownDimension Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Allowed Values * `model` @@ -13,4 +23,14 @@ description: CostBreakdownDimension Schema Reference * `operation` * `date` * `hour` -* `tag` \ No newline at end of file +* `tag` + +## TypeScript Usage + +```typescript +import { CostBreakdownDimension } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: CostBreakdownDimension = 'model'; +``` + diff --git a/content/docs/references/ai/cost/CostBreakdownEntry.mdx b/content/docs/references/ai/cost/CostBreakdownEntry.mdx index 9fd1c8ff3..97ec60372 100644 --- a/content/docs/references/ai/cost/CostBreakdownEntry.mdx +++ b/content/docs/references/ai/cost/CostBreakdownEntry.mdx @@ -1,8 +1,18 @@ --- title: CostBreakdownEntry description: CostBreakdownEntry Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: CostBreakdownEntry Schema Reference | **percentageOfTotal** | `number` | ✅ | | | **periodStart** | `string` | optional | | | **periodEnd** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { CostBreakdownEntrySchema } from '@objectstack/spec/ai'; +import type { CostBreakdownEntry } from '@objectstack/spec/ai'; + +// Validate data +const result = CostBreakdownEntrySchema.parse(data); + +// Type-safe usage +const myCostBreakdownEntry: CostBreakdownEntry = { + dimension: 'model', + value: 'example', + totalCost: 0, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/cost/CostEntry.mdx b/content/docs/references/ai/cost/CostEntry.mdx index 2be46d286..a7aa08ff9 100644 --- a/content/docs/references/ai/cost/CostEntry.mdx +++ b/content/docs/references/ai/cost/CostEntry.mdx @@ -1,8 +1,18 @@ --- title: CostEntry description: CostEntry Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -27,3 +37,22 @@ description: CostEntry Schema Reference | **recordId** | `string` | optional | Related record ID | | **tags** | `string[]` | optional | | | **metadata** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { CostEntrySchema } from '@objectstack/spec/ai'; +import type { CostEntry } from '@objectstack/spec/ai'; + +// Validate data +const result = CostEntrySchema.parse(data); + +// Type-safe usage +const myCostEntry: CostEntry = { + id: 'example', + timestamp: 'example', + modelId: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/cost/CostMetricType.mdx b/content/docs/references/ai/cost/CostMetricType.mdx index 29e70e3f0..6e93b4e1d 100644 --- a/content/docs/references/ai/cost/CostMetricType.mdx +++ b/content/docs/references/ai/cost/CostMetricType.mdx @@ -1,8 +1,18 @@ --- title: CostMetricType description: CostMetricType Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Allowed Values * `token` @@ -10,4 +20,14 @@ description: CostMetricType Schema Reference * `character` * `second` * `image` -* `embedding` \ No newline at end of file +* `embedding` + +## TypeScript Usage + +```typescript +import { CostMetricType } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: CostMetricType = 'token'; +``` + diff --git a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx index a5a2ed947..b5ffb9413 100644 --- a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx +++ b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx @@ -1,8 +1,18 @@ --- title: CostOptimizationRecommendation description: CostOptimizationRecommendation Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -22,3 +32,22 @@ description: CostOptimizationRecommendation Schema Reference | **affectedUsers** | `string[]` | optional | | | **status** | `Enum<'pending' \| 'accepted' \| 'rejected' \| 'implemented'>` | optional | | | **implementedAt** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { CostOptimizationRecommendationSchema } from '@objectstack/spec/ai'; +import type { CostOptimizationRecommendation } from '@objectstack/spec/ai'; + +// Validate data +const result = CostOptimizationRecommendationSchema.parse(data); + +// Type-safe usage +const myCostOptimizationRecommendation: CostOptimizationRecommendation = { + id: 'example', + type: 'switch_model', + title: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/cost/CostQueryFilters.mdx b/content/docs/references/ai/cost/CostQueryFilters.mdx index 2824bc8a6..2831c9a92 100644 --- a/content/docs/references/ai/cost/CostQueryFilters.mdx +++ b/content/docs/references/ai/cost/CostQueryFilters.mdx @@ -1,8 +1,18 @@ --- title: CostQueryFilters description: CostQueryFilters Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -23,3 +33,18 @@ description: CostQueryFilters Schema Reference | **orderDirection** | `Enum<'asc' \| 'desc'>` | optional | | | **limit** | `integer` | optional | | | **offset** | `integer` | optional | | + +## TypeScript Usage + +```typescript +import { CostQueryFiltersSchema } from '@objectstack/spec/ai'; +import type { CostQueryFilters } from '@objectstack/spec/ai'; + +// Validate data +const result = CostQueryFiltersSchema.parse(data); + +// Type-safe usage +const myCostQueryFilters: CostQueryFilters = { +}; +``` + diff --git a/content/docs/references/ai/cost/CostReport.mdx b/content/docs/references/ai/cost/CostReport.mdx index 556b504ae..ecc90e074 100644 --- a/content/docs/references/ai/cost/CostReport.mdx +++ b/content/docs/references/ai/cost/CostReport.mdx @@ -1,8 +1,18 @@ --- title: CostReport description: CostReport Schema Reference +category: ai +zodFile: cost --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -25,3 +35,22 @@ description: CostReport Schema Reference | **forecastedBudgetStatus** | `Enum<'under' \| 'at' \| 'over'>` | optional | | | **format** | `Enum<'summary' \| 'detailed' \| 'executive'>` | optional | | | **currency** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { CostReportSchema } from '@objectstack/spec/ai'; +import type { CostReport } from '@objectstack/spec/ai'; + +// Validate data +const result = CostReportSchema.parse(data); + +// Type-safe usage +const myCostReport: CostReport = { + id: 'example', + name: 'name', + generatedAt: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/index.mdx b/content/docs/references/ai/index.mdx new file mode 100644 index 000000000..b0513f867 --- /dev/null +++ b/content/docs/references/ai/index.mdx @@ -0,0 +1,154 @@ +--- +title: AI Protocol Overview +description: Complete reference for all ai protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# AI Protocol + +This section contains all protocol schemas for the ai layer of ObjectStack. + +## Agent + +Source: `packages/spec/src/ai/agent.zod.ts` + + + + + + + + +## Conversation + +Source: `packages/spec/src/ai/conversation.zod.ts` + + + + + + + + + + + + + + + + + + +## Cost + +Source: `packages/spec/src/ai/cost.zod.ts` + + + + + + + + + + + + + + + + + + +## Model Registry + +Source: `packages/spec/src/ai/model-registry.zod.ts` + + + + + + + + + + + + + + +## Nlq + +Source: `packages/spec/src/ai/nlq.zod.ts` + + + + + + + + + + + + + + + + + +## Orchestration + +Source: `packages/spec/src/ai/orchestration.zod.ts` + + + + + + + + + + + + + +## Predictive + +Source: `packages/spec/src/ai/predictive.zod.ts` + + + + + + + + + + + + + +## Rag Pipeline + +Source: `packages/spec/src/ai/rag-pipeline.zod.ts` + + + + + + + + + + + + + + + + + diff --git a/content/docs/references/ai/model-registry/ModelCapability.mdx b/content/docs/references/ai/model-registry/ModelCapability.mdx index 6773ec578..69c826e81 100644 --- a/content/docs/references/ai/model-registry/ModelCapability.mdx +++ b/content/docs/references/ai/model-registry/ModelCapability.mdx @@ -1,8 +1,18 @@ --- title: ModelCapability description: ModelCapability Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,18 @@ description: ModelCapability Schema Reference | **functionCalling** | `boolean` | optional | Supports function calling | | **codeGeneration** | `boolean` | optional | Supports code generation | | **reasoning** | `boolean` | optional | Supports advanced reasoning | + +## TypeScript Usage + +```typescript +import { ModelCapabilitySchema } from '@objectstack/spec/ai'; +import type { ModelCapability } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelCapabilitySchema.parse(data); + +// Type-safe usage +const myModelCapability: ModelCapability = { +}; +``` + diff --git a/content/docs/references/ai/model-registry/ModelConfig.mdx b/content/docs/references/ai/model-registry/ModelConfig.mdx index 7785c0d9a..7cd5cc1b4 100644 --- a/content/docs/references/ai/model-registry/ModelConfig.mdx +++ b/content/docs/references/ai/model-registry/ModelConfig.mdx @@ -1,8 +1,18 @@ --- title: ModelConfig description: ModelConfig Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,22 @@ description: ModelConfig Schema Reference | **tags** | `string[]` | optional | Tags for categorization | | **deprecated** | `boolean` | optional | | | **recommendedFor** | `string[]` | optional | Use case recommendations | + +## TypeScript Usage + +```typescript +import { ModelConfigSchema } from '@objectstack/spec/ai'; +import type { ModelConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelConfigSchema.parse(data); + +// Type-safe usage +const myModelConfig: ModelConfig = { + id: 'example', + name: 'name', + version: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/model-registry/ModelLimits.mdx b/content/docs/references/ai/model-registry/ModelLimits.mdx index ca682a199..be041e553 100644 --- a/content/docs/references/ai/model-registry/ModelLimits.mdx +++ b/content/docs/references/ai/model-registry/ModelLimits.mdx @@ -1,8 +1,18 @@ --- title: ModelLimits description: ModelLimits Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: ModelLimits Schema Reference | **contextWindow** | `integer` | ✅ | Context window size | | **maxOutputTokens** | `integer` | optional | Maximum output tokens | | **rateLimit** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { ModelLimitsSchema } from '@objectstack/spec/ai'; +import type { ModelLimits } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelLimitsSchema.parse(data); + +// Type-safe usage +const myModelLimits: ModelLimits = { + maxTokens: null, + contextWindow: null +}; +``` + diff --git a/content/docs/references/ai/model-registry/ModelPricing.mdx b/content/docs/references/ai/model-registry/ModelPricing.mdx index d94a8288e..4c2d52635 100644 --- a/content/docs/references/ai/model-registry/ModelPricing.mdx +++ b/content/docs/references/ai/model-registry/ModelPricing.mdx @@ -1,8 +1,18 @@ --- title: ModelPricing description: ModelPricing Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: ModelPricing Schema Reference | **inputCostPer1kTokens** | `number` | optional | Cost per 1K input tokens | | **outputCostPer1kTokens** | `number` | optional | Cost per 1K output tokens | | **embeddingCostPer1kTokens** | `number` | optional | Cost per 1K embedding tokens | + +## TypeScript Usage + +```typescript +import { ModelPricingSchema } from '@objectstack/spec/ai'; +import type { ModelPricing } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelPricingSchema.parse(data); + +// Type-safe usage +const myModelPricing: ModelPricing = { +}; +``` + diff --git a/content/docs/references/ai/model-registry/ModelProvider.mdx b/content/docs/references/ai/model-registry/ModelProvider.mdx index 3f98f0fd4..b02a9d0c0 100644 --- a/content/docs/references/ai/model-registry/ModelProvider.mdx +++ b/content/docs/references/ai/model-registry/ModelProvider.mdx @@ -1,8 +1,18 @@ --- title: ModelProvider description: ModelProvider Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Allowed Values * `openai` @@ -12,4 +22,14 @@ description: ModelProvider Schema Reference * `cohere` * `huggingface` * `local` -* `custom` \ No newline at end of file +* `custom` + +## TypeScript Usage + +```typescript +import { ModelProvider } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: ModelProvider = 'openai'; +``` + diff --git a/content/docs/references/ai/model-registry/ModelRegistry.mdx b/content/docs/references/ai/model-registry/ModelRegistry.mdx index a389e1cc3..32ed05894 100644 --- a/content/docs/references/ai/model-registry/ModelRegistry.mdx +++ b/content/docs/references/ai/model-registry/ModelRegistry.mdx @@ -1,8 +1,18 @@ --- title: ModelRegistry description: ModelRegistry Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: ModelRegistry Schema Reference | **promptTemplates** | `Record` | optional | Prompt templates by name | | **defaultModel** | `string` | optional | Default model ID | | **enableAutoFallback** | `boolean` | optional | Auto-fallback on errors | + +## TypeScript Usage + +```typescript +import { ModelRegistrySchema } from '@objectstack/spec/ai'; +import type { ModelRegistry } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelRegistrySchema.parse(data); + +// Type-safe usage +const myModelRegistry: ModelRegistry = { + name: 'name', + models: {} +}; +``` + diff --git a/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx b/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx index 6fe82e36b..c744cfa4e 100644 --- a/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx +++ b/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx @@ -1,8 +1,18 @@ --- title: ModelRegistryEntry description: ModelRegistryEntry Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: ModelRegistryEntry Schema Reference | **priority** | `integer` | optional | Priority for model selection | | **fallbackModels** | `string[]` | optional | Fallback model IDs | | **healthCheck** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { ModelRegistryEntrySchema } from '@objectstack/spec/ai'; +import type { ModelRegistryEntry } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelRegistryEntrySchema.parse(data); + +// Type-safe usage +const myModelRegistryEntry: ModelRegistryEntry = { + model: {} +}; +``` + diff --git a/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx b/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx index c3ee7946c..7a3e7de26 100644 --- a/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx +++ b/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx @@ -1,8 +1,18 @@ --- title: ModelSelectionCriteria description: ModelSelectionCriteria Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: ModelSelectionCriteria Schema Reference | **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'google' \| 'cohere' \| 'huggingface' \| 'local' \| 'custom'>` | optional | | | **tags** | `string[]` | optional | | | **excludeDeprecated** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { ModelSelectionCriteriaSchema } from '@objectstack/spec/ai'; +import type { ModelSelectionCriteria } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelSelectionCriteriaSchema.parse(data); + +// Type-safe usage +const myModelSelectionCriteria: ModelSelectionCriteria = { +}; +``` + diff --git a/content/docs/references/ai/model-registry/PromptTemplate.mdx b/content/docs/references/ai/model-registry/PromptTemplate.mdx index 437bda43d..a8eca44f3 100644 --- a/content/docs/references/ai/model-registry/PromptTemplate.mdx +++ b/content/docs/references/ai/model-registry/PromptTemplate.mdx @@ -1,8 +1,18 @@ --- title: PromptTemplate description: PromptTemplate Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -26,3 +36,22 @@ description: PromptTemplate Schema Reference | **category** | `string` | optional | Template category (e.g., "code_generation", "support") | | **tags** | `string[]` | optional | | | **examples** | `object[]` | optional | | + +## TypeScript Usage + +```typescript +import { PromptTemplateSchema } from '@objectstack/spec/ai'; +import type { PromptTemplate } from '@objectstack/spec/ai'; + +// Validate data +const result = PromptTemplateSchema.parse(data); + +// Type-safe usage +const myPromptTemplate: PromptTemplate = { + id: 'example', + name: 'name', + label: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/model-registry/PromptVariable.mdx b/content/docs/references/ai/model-registry/PromptVariable.mdx index 10b694014..4ea187d8b 100644 --- a/content/docs/references/ai/model-registry/PromptVariable.mdx +++ b/content/docs/references/ai/model-registry/PromptVariable.mdx @@ -1,8 +1,18 @@ --- title: PromptVariable description: PromptVariable Schema Reference +category: ai +zodFile: model-registry --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,19 @@ description: PromptVariable Schema Reference | **defaultValue** | `any` | optional | | | **description** | `string` | optional | | | **validation** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { PromptVariableSchema } from '@objectstack/spec/ai'; +import type { PromptVariable } from '@objectstack/spec/ai'; + +// Validate data +const result = PromptVariableSchema.parse(data); + +// Type-safe usage +const myPromptVariable: PromptVariable = { + name: 'name' +}; +``` + diff --git a/content/docs/references/ai/nlq/Entity.mdx b/content/docs/references/ai/nlq/Entity.mdx index 94de35e60..eb3336da9 100644 --- a/content/docs/references/ai/nlq/Entity.mdx +++ b/content/docs/references/ai/nlq/Entity.mdx @@ -1,8 +1,18 @@ --- title: Entity description: Entity Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: Entity Schema Reference | **value** | `any` | optional | Normalized value | | **confidence** | `number` | ✅ | Confidence score | | **span** | `any[]` | optional | Character span in query | + +## TypeScript Usage + +```typescript +import { EntitySchema } from '@objectstack/spec/ai'; +import type { Entity } from '@objectstack/spec/ai'; + +// Validate data +const result = EntitySchema.parse(data); + +// Type-safe usage +const myEntity: Entity = { + type: 'object', + text: 'example', + confidence: 0 +}; +``` + diff --git a/content/docs/references/ai/nlq/FieldSynonymConfig.mdx b/content/docs/references/ai/nlq/FieldSynonymConfig.mdx index a7f454f2d..b4f0ac8cf 100644 --- a/content/docs/references/ai/nlq/FieldSynonymConfig.mdx +++ b/content/docs/references/ai/nlq/FieldSynonymConfig.mdx @@ -1,8 +1,18 @@ --- title: FieldSynonymConfig description: FieldSynonymConfig Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: FieldSynonymConfig Schema Reference | **field** | `string` | ✅ | Field name | | **synonyms** | `string[]` | ✅ | Natural language synonyms | | **examples** | `string[]` | optional | Example queries using synonyms | + +## TypeScript Usage + +```typescript +import { FieldSynonymConfigSchema } from '@objectstack/spec/ai'; +import type { FieldSynonymConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = FieldSynonymConfigSchema.parse(data); + +// Type-safe usage +const myFieldSynonymConfig: FieldSynonymConfig = { + object: 'example', + field: 'example', + synonyms: [] +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQAnalytics.mdx b/content/docs/references/ai/nlq/NLQAnalytics.mdx index f680f718e..2eafdd3f3 100644 --- a/content/docs/references/ai/nlq/NLQAnalytics.mdx +++ b/content/docs/references/ai/nlq/NLQAnalytics.mdx @@ -1,8 +1,18 @@ --- title: NLQAnalytics description: NLQAnalytics Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: NLQAnalytics Schema Reference | **lowConfidenceQueries** | `object[]` | ✅ | | | **startDate** | `string` | ✅ | ISO timestamp | | **endDate** | `string` | ✅ | ISO timestamp | + +## TypeScript Usage + +```typescript +import { NLQAnalyticsSchema } from '@objectstack/spec/ai'; +import type { NLQAnalytics } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQAnalyticsSchema.parse(data); + +// Type-safe usage +const myNLQAnalytics: NLQAnalytics = { + totalQueries: null, + successfulQueries: null, + failedQueries: null, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQFieldMapping.mdx b/content/docs/references/ai/nlq/NLQFieldMapping.mdx index 872571d6e..50bfd52fc 100644 --- a/content/docs/references/ai/nlq/NLQFieldMapping.mdx +++ b/content/docs/references/ai/nlq/NLQFieldMapping.mdx @@ -1,8 +1,18 @@ --- title: NLQFieldMapping description: NLQFieldMapping Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,22 @@ description: NLQFieldMapping Schema Reference | **object** | `string` | ✅ | Object name | | **field** | `string` | ✅ | Field name | | **confidence** | `number` | ✅ | | + +## TypeScript Usage + +```typescript +import { NLQFieldMappingSchema } from '@objectstack/spec/ai'; +import type { NLQFieldMapping } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQFieldMappingSchema.parse(data); + +// Type-safe usage +const myNLQFieldMapping: NLQFieldMapping = { + naturalLanguage: 'example', + objectField: 'example', + object: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQModelConfig.mdx b/content/docs/references/ai/nlq/NLQModelConfig.mdx index 00f845aa7..ce0422141 100644 --- a/content/docs/references/ai/nlq/NLQModelConfig.mdx +++ b/content/docs/references/ai/nlq/NLQModelConfig.mdx @@ -1,8 +1,18 @@ --- title: NLQModelConfig description: NLQModelConfig Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,19 @@ description: NLQModelConfig Schema Reference | **defaultTimeframe** | `string` | optional | Default timeframe if not specified | | **enableCaching** | `boolean` | optional | | | **cacheTTL** | `integer` | optional | Cache TTL in seconds | + +## TypeScript Usage + +```typescript +import { NLQModelConfigSchema } from '@objectstack/spec/ai'; +import type { NLQModelConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQModelConfigSchema.parse(data); + +// Type-safe usage +const myNLQModelConfig: NLQModelConfig = { + modelId: 'example' +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQParseResult.mdx b/content/docs/references/ai/nlq/NLQParseResult.mdx index 9394bb6ce..5046f07cd 100644 --- a/content/docs/references/ai/nlq/NLQParseResult.mdx +++ b/content/docs/references/ai/nlq/NLQParseResult.mdx @@ -1,8 +1,18 @@ --- title: NLQParseResult description: NLQParseResult Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: NLQParseResult Schema Reference | **confidence** | `number` | ✅ | Overall confidence | | **ambiguities** | `object[]` | optional | Detected ambiguities requiring clarification | | **alternatives** | `object[]` | optional | | + +## TypeScript Usage + +```typescript +import { NLQParseResultSchema } from '@objectstack/spec/ai'; +import type { NLQParseResult } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQParseResultSchema.parse(data); + +// Type-safe usage +const myNLQParseResult: NLQParseResult = { + originalQuery: 'example', + intent: 'select', + intentConfidence: 0, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQRequest.mdx b/content/docs/references/ai/nlq/NLQRequest.mdx index b19c9e38c..115fcf458 100644 --- a/content/docs/references/ai/nlq/NLQRequest.mdx +++ b/content/docs/references/ai/nlq/NLQRequest.mdx @@ -1,8 +1,18 @@ --- title: NLQRequest description: NLQRequest Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,19 @@ description: NLQRequest Schema Reference | **minConfidence** | `number` | optional | Minimum confidence threshold | | **executeQuery** | `boolean` | optional | Execute query and return results | | **maxResults** | `integer` | optional | Maximum results to return | + +## TypeScript Usage + +```typescript +import { NLQRequestSchema } from '@objectstack/spec/ai'; +import type { NLQRequest } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQRequestSchema.parse(data); + +// Type-safe usage +const myNLQRequest: NLQRequest = { + query: 'example' +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQResponse.mdx b/content/docs/references/ai/nlq/NLQResponse.mdx index 1f95393a4..2629d03a1 100644 --- a/content/docs/references/ai/nlq/NLQResponse.mdx +++ b/content/docs/references/ai/nlq/NLQResponse.mdx @@ -1,8 +1,18 @@ --- title: NLQResponse description: NLQResponse Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,20 @@ description: NLQResponse Schema Reference | **executionTime** | `number` | optional | Execution time in milliseconds | | **needsClarification** | `boolean` | ✅ | Whether query needs clarification | | **suggestions** | `string[]` | optional | Query refinement suggestions | + +## TypeScript Usage + +```typescript +import { NLQResponseSchema } from '@objectstack/spec/ai'; +import type { NLQResponse } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQResponseSchema.parse(data); + +// Type-safe usage +const myNLQResponse: NLQResponse = { + parseResult: {}, + needsClarification: false +}; +``` + diff --git a/content/docs/references/ai/nlq/NLQTrainingExample.mdx b/content/docs/references/ai/nlq/NLQTrainingExample.mdx index b1ed09435..c7f62046f 100644 --- a/content/docs/references/ai/nlq/NLQTrainingExample.mdx +++ b/content/docs/references/ai/nlq/NLQTrainingExample.mdx @@ -1,8 +1,18 @@ --- title: NLQTrainingExample description: NLQTrainingExample Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,20 @@ description: NLQTrainingExample Schema Reference | **category** | `string` | optional | Example category | | **tags** | `string[]` | optional | | | **notes** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { NLQTrainingExampleSchema } from '@objectstack/spec/ai'; +import type { NLQTrainingExample } from '@objectstack/spec/ai'; + +// Validate data +const result = NLQTrainingExampleSchema.parse(data); + +// Type-safe usage +const myNLQTrainingExample: NLQTrainingExample = { + query: 'example', + expectedIntent: 'select' +}; +``` + diff --git a/content/docs/references/ai/nlq/QueryContext.mdx b/content/docs/references/ai/nlq/QueryContext.mdx index 1651dda25..9c286db6b 100644 --- a/content/docs/references/ai/nlq/QueryContext.mdx +++ b/content/docs/references/ai/nlq/QueryContext.mdx @@ -1,8 +1,18 @@ --- title: QueryContext description: QueryContext Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: QueryContext Schema Reference | **defaultLimit** | `integer` | optional | | | **timezone** | `string` | optional | | | **locale** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { QueryContextSchema } from '@objectstack/spec/ai'; +import type { QueryContext } from '@objectstack/spec/ai'; + +// Validate data +const result = QueryContextSchema.parse(data); + +// Type-safe usage +const myQueryContext: QueryContext = { +}; +``` + diff --git a/content/docs/references/ai/nlq/QueryIntent.mdx b/content/docs/references/ai/nlq/QueryIntent.mdx index 378c0a7c5..0309d0423 100644 --- a/content/docs/references/ai/nlq/QueryIntent.mdx +++ b/content/docs/references/ai/nlq/QueryIntent.mdx @@ -1,8 +1,18 @@ --- title: QueryIntent description: QueryIntent Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Allowed Values * `select` @@ -14,4 +24,14 @@ description: QueryIntent Schema Reference * `insight` * `create` * `update` -* `delete` \ No newline at end of file +* `delete` + +## TypeScript Usage + +```typescript +import { QueryIntent } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: QueryIntent = 'select'; +``` + diff --git a/content/docs/references/ai/nlq/QueryTemplate.mdx b/content/docs/references/ai/nlq/QueryTemplate.mdx index aac5d70c9..c5d4ca3dc 100644 --- a/content/docs/references/ai/nlq/QueryTemplate.mdx +++ b/content/docs/references/ai/nlq/QueryTemplate.mdx @@ -1,8 +1,18 @@ --- title: QueryTemplate description: QueryTemplate Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: QueryTemplate Schema Reference | **category** | `string` | optional | | | **examples** | `string[]` | optional | | | **tags** | `string[]` | optional | | + +## TypeScript Usage + +```typescript +import { QueryTemplateSchema } from '@objectstack/spec/ai'; +import type { QueryTemplate } from '@objectstack/spec/ai'; + +// Validate data +const result = QueryTemplateSchema.parse(data); + +// Type-safe usage +const myQueryTemplate: QueryTemplate = { + id: 'example', + name: 'name', + label: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/nlq/Timeframe.mdx b/content/docs/references/ai/nlq/Timeframe.mdx index 5f6a0d8a4..111fba0f9 100644 --- a/content/docs/references/ai/nlq/Timeframe.mdx +++ b/content/docs/references/ai/nlq/Timeframe.mdx @@ -1,8 +1,18 @@ --- title: Timeframe description: Timeframe Schema Reference +category: ai +zodFile: nlq --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: Timeframe Schema Reference | **end** | `string` | optional | End date (ISO format) | | **relative** | `object` | optional | | | **text** | `string` | ✅ | Original timeframe text | + +## TypeScript Usage + +```typescript +import { TimeframeSchema } from '@objectstack/spec/ai'; +import type { Timeframe } from '@objectstack/spec/ai'; + +// Validate data +const result = TimeframeSchema.parse(data); + +// Type-safe usage +const myTimeframe: Timeframe = { + type: 'absolute', + text: 'example' +}; +``` + diff --git a/content/docs/references/ai/orchestration/AIOrchestration.mdx b/content/docs/references/ai/orchestration/AIOrchestration.mdx index 75233ab94..4b3f26225 100644 --- a/content/docs/references/ai/orchestration/AIOrchestration.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestration.mdx @@ -1,8 +1,18 @@ --- title: AIOrchestration description: AIOrchestration Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -32,3 +42,22 @@ description: AIOrchestration Schema Reference | **owner** | `string` | optional | User ID of workflow owner | | **createdAt** | `string` | optional | ISO timestamp | | **updatedAt** | `string` | optional | ISO timestamp | + +## TypeScript Usage + +```typescript +import { AIOrchestrationSchema } from '@objectstack/spec/ai'; +import type { AIOrchestration } from '@objectstack/spec/ai'; + +// Validate data +const result = AIOrchestrationSchema.parse(data); + +// Type-safe usage +const myAIOrchestration: AIOrchestration = { + name: 'name', + label: 'example', + objectName: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx index 865b13f36..d8818e1b8 100644 --- a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx @@ -1,8 +1,18 @@ --- title: AIOrchestrationExecutionResult description: AIOrchestrationExecutionResult Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: AIOrchestrationExecutionResult Schema Reference | **error** | `string` | optional | | | **startedAt** | `string` | ✅ | ISO timestamp | | **completedAt** | `string` | optional | ISO timestamp | + +## TypeScript Usage + +```typescript +import { AIOrchestrationExecutionResultSchema } from '@objectstack/spec/ai'; +import type { AIOrchestrationExecutionResult } from '@objectstack/spec/ai'; + +// Validate data +const result = AIOrchestrationExecutionResultSchema.parse(data); + +// Type-safe usage +const myAIOrchestrationExecutionResult: AIOrchestrationExecutionResult = { + workflowName: 'example', + recordId: 'example', + status: 'success', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx b/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx index 3ff9d846e..bbfebd981 100644 --- a/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx @@ -1,8 +1,18 @@ --- title: AIOrchestrationTrigger description: AIOrchestrationTrigger Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Allowed Values * `record_created` @@ -11,4 +21,14 @@ description: AIOrchestrationTrigger Schema Reference * `scheduled` * `manual` * `webhook` -* `batch` \ No newline at end of file +* `batch` + +## TypeScript Usage + +```typescript +import { AIOrchestrationTrigger } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: AIOrchestrationTrigger = 'record_created'; +``` + diff --git a/content/docs/references/ai/orchestration/AITask.mdx b/content/docs/references/ai/orchestration/AITask.mdx index 0911f29b2..5fdb3c04d 100644 --- a/content/docs/references/ai/orchestration/AITask.mdx +++ b/content/docs/references/ai/orchestration/AITask.mdx @@ -1,8 +1,18 @@ --- title: AITask description: AITask Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -26,3 +36,22 @@ description: AITask Schema Reference | **condition** | `string` | optional | Formula condition - task only runs if TRUE | | **description** | `string` | optional | | | **active** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { AITaskSchema } from '@objectstack/spec/ai'; +import type { AITask } from '@objectstack/spec/ai'; + +// Validate data +const result = AITaskSchema.parse(data); + +// Type-safe usage +const myAITask: AITask = { + name: 'name', + type: 'classify', + inputFields: [], + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/orchestration/AITaskType.mdx b/content/docs/references/ai/orchestration/AITaskType.mdx index 5bc85239d..8511464c5 100644 --- a/content/docs/references/ai/orchestration/AITaskType.mdx +++ b/content/docs/references/ai/orchestration/AITaskType.mdx @@ -1,8 +1,18 @@ --- title: AITaskType description: AITaskType Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Allowed Values * `classify` @@ -14,4 +24,14 @@ description: AITaskType Schema Reference * `sentiment` * `entity_recognition` * `anomaly_detection` -* `recommendation` \ No newline at end of file +* `recommendation` + +## TypeScript Usage + +```typescript +import { AITaskType } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: AITaskType = 'classify'; +``` + diff --git a/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx b/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx index bae06a30f..459712f2e 100644 --- a/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx +++ b/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx @@ -1,8 +1,18 @@ --- title: BatchAIOrchestrationExecution description: BatchAIOrchestrationExecution Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: BatchAIOrchestrationExecution Schema Reference | **batchSize** | `integer` | optional | | | **parallelism** | `integer` | optional | | | **priority** | `Enum<'low' \| 'normal' \| 'high'>` | optional | | + +## TypeScript Usage + +```typescript +import { BatchAIOrchestrationExecutionSchema } from '@objectstack/spec/ai'; +import type { BatchAIOrchestrationExecution } from '@objectstack/spec/ai'; + +// Validate data +const result = BatchAIOrchestrationExecutionSchema.parse(data); + +// Type-safe usage +const myBatchAIOrchestrationExecution: BatchAIOrchestrationExecution = { + workflowName: 'example', + recordIds: [] +}; +``` + diff --git a/content/docs/references/ai/orchestration/PostProcessingAction.mdx b/content/docs/references/ai/orchestration/PostProcessingAction.mdx index a8c93ca76..87e1e6661 100644 --- a/content/docs/references/ai/orchestration/PostProcessingAction.mdx +++ b/content/docs/references/ai/orchestration/PostProcessingAction.mdx @@ -1,8 +1,18 @@ --- title: PostProcessingAction description: PostProcessingAction Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: PostProcessingAction Schema Reference | **name** | `string` | ✅ | Action name | | **config** | `Record` | ✅ | Action-specific configuration | | **condition** | `string` | optional | Execute only if condition is TRUE | + +## TypeScript Usage + +```typescript +import { PostProcessingActionSchema } from '@objectstack/spec/ai'; +import type { PostProcessingAction } from '@objectstack/spec/ai'; + +// Validate data +const result = PostProcessingActionSchema.parse(data); + +// Type-safe usage +const myPostProcessingAction: PostProcessingAction = { + type: 'field_update', + name: 'name', + config: {} +}; +``` + diff --git a/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx b/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx index c5044e30e..079cf963e 100644 --- a/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx +++ b/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx @@ -1,8 +1,18 @@ --- title: WorkflowFieldCondition description: WorkflowFieldCondition Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: WorkflowFieldCondition Schema Reference | **field** | `string` | ✅ | Field name to monitor | | **operator** | `Enum<'changed' \| 'changed_to' \| 'changed_from' \| 'is' \| 'is_not'>` | optional | | | **value** | `any` | optional | Value to compare against (for changed_to/changed_from/is/is_not) | + +## TypeScript Usage + +```typescript +import { WorkflowFieldConditionSchema } from '@objectstack/spec/ai'; +import type { WorkflowFieldCondition } from '@objectstack/spec/ai'; + +// Validate data +const result = WorkflowFieldConditionSchema.parse(data); + +// Type-safe usage +const myWorkflowFieldCondition: WorkflowFieldCondition = { + field: 'example' +}; +``` + diff --git a/content/docs/references/ai/orchestration/WorkflowSchedule.mdx b/content/docs/references/ai/orchestration/WorkflowSchedule.mdx index add93497f..57a2be24e 100644 --- a/content/docs/references/ai/orchestration/WorkflowSchedule.mdx +++ b/content/docs/references/ai/orchestration/WorkflowSchedule.mdx @@ -1,8 +1,18 @@ --- title: WorkflowSchedule description: WorkflowSchedule Schema Reference +category: ai +zodFile: orchestration --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,18 @@ description: WorkflowSchedule Schema Reference | **dayOfWeek** | `integer` | optional | Day of week for weekly (0=Sunday) | | **dayOfMonth** | `integer` | optional | Day of month for monthly | | **timezone** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { WorkflowScheduleSchema } from '@objectstack/spec/ai'; +import type { WorkflowSchedule } from '@objectstack/spec/ai'; + +// Validate data +const result = WorkflowScheduleSchema.parse(data); + +// Type-safe usage +const myWorkflowSchedule: WorkflowSchedule = { +}; +``` + diff --git a/content/docs/references/ai/predictive/EvaluationMetrics.mdx b/content/docs/references/ai/predictive/EvaluationMetrics.mdx index a41fda405..4d56190a1 100644 --- a/content/docs/references/ai/predictive/EvaluationMetrics.mdx +++ b/content/docs/references/ai/predictive/EvaluationMetrics.mdx @@ -1,8 +1,18 @@ --- title: EvaluationMetrics description: EvaluationMetrics Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,18 @@ description: EvaluationMetrics Schema Reference | **mape** | `number` | optional | Mean Absolute Percentage Error | | **smape** | `number` | optional | Symmetric MAPE | | **custom** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { EvaluationMetricsSchema } from '@objectstack/spec/ai'; +import type { EvaluationMetrics } from '@objectstack/spec/ai'; + +// Validate data +const result = EvaluationMetricsSchema.parse(data); + +// Type-safe usage +const myEvaluationMetrics: EvaluationMetrics = { +}; +``` + diff --git a/content/docs/references/ai/predictive/Hyperparameters.mdx b/content/docs/references/ai/predictive/Hyperparameters.mdx index 41f8e9d76..70f06f94e 100644 --- a/content/docs/references/ai/predictive/Hyperparameters.mdx +++ b/content/docs/references/ai/predictive/Hyperparameters.mdx @@ -1,8 +1,18 @@ --- title: Hyperparameters description: Hyperparameters Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -23,3 +33,18 @@ description: Hyperparameters Schema Reference | **seasonalPeriod** | `integer` | optional | Seasonal period for time series | | **forecastHorizon** | `integer` | optional | Number of periods to forecast | | **custom** | `Record` | optional | Algorithm-specific parameters | + +## TypeScript Usage + +```typescript +import { HyperparametersSchema } from '@objectstack/spec/ai'; +import type { Hyperparameters } from '@objectstack/spec/ai'; + +// Validate data +const result = HyperparametersSchema.parse(data); + +// Type-safe usage +const myHyperparameters: Hyperparameters = { +}; +``` + diff --git a/content/docs/references/ai/predictive/ModelDrift.mdx b/content/docs/references/ai/predictive/ModelDrift.mdx index 703e71bff..0bde39d32 100644 --- a/content/docs/references/ai/predictive/ModelDrift.mdx +++ b/content/docs/references/ai/predictive/ModelDrift.mdx @@ -1,8 +1,18 @@ --- title: ModelDrift description: ModelDrift Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: ModelDrift Schema Reference | **metrics** | `object` | ✅ | | | **recommendation** | `string` | optional | | | **autoRetrainTriggered** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { ModelDriftSchema } from '@objectstack/spec/ai'; +import type { ModelDrift } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelDriftSchema.parse(data); + +// Type-safe usage +const myModelDrift: ModelDrift = { + modelName: 'example', + driftType: 'feature_drift', + severity: 'low', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/predictive/ModelFeature.mdx b/content/docs/references/ai/predictive/ModelFeature.mdx index 992f21dae..a3bc12a65 100644 --- a/content/docs/references/ai/predictive/ModelFeature.mdx +++ b/content/docs/references/ai/predictive/ModelFeature.mdx @@ -1,8 +1,18 @@ --- title: ModelFeature description: ModelFeature Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,21 @@ description: ModelFeature Schema Reference | **defaultValue** | `any` | optional | | | **description** | `string` | optional | | | **importance** | `number` | optional | Feature importance score (0-1) | + +## TypeScript Usage + +```typescript +import { ModelFeatureSchema } from '@objectstack/spec/ai'; +import type { ModelFeature } from '@objectstack/spec/ai'; + +// Validate data +const result = ModelFeatureSchema.parse(data); + +// Type-safe usage +const myModelFeature: ModelFeature = { + name: 'name', + field: 'example', + dataType: 'numeric' +}; +``` + diff --git a/content/docs/references/ai/predictive/PredictionRequest.mdx b/content/docs/references/ai/predictive/PredictionRequest.mdx index 99279567d..ed9dac76e 100644 --- a/content/docs/references/ai/predictive/PredictionRequest.mdx +++ b/content/docs/references/ai/predictive/PredictionRequest.mdx @@ -1,8 +1,18 @@ --- title: PredictionRequest description: PredictionRequest Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: PredictionRequest Schema Reference | **inputData** | `Record` | optional | Direct input data (alternative to recordIds) | | **returnConfidence** | `boolean` | optional | | | **returnExplanation** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { PredictionRequestSchema } from '@objectstack/spec/ai'; +import type { PredictionRequest } from '@objectstack/spec/ai'; + +// Validate data +const result = PredictionRequestSchema.parse(data); + +// Type-safe usage +const myPredictionRequest: PredictionRequest = { + modelName: 'example' +}; +``` + diff --git a/content/docs/references/ai/predictive/PredictionResult.mdx b/content/docs/references/ai/predictive/PredictionResult.mdx index 6c9a6c525..67dc621db 100644 --- a/content/docs/references/ai/predictive/PredictionResult.mdx +++ b/content/docs/references/ai/predictive/PredictionResult.mdx @@ -1,8 +1,18 @@ --- title: PredictionResult description: PredictionResult Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,20 @@ description: PredictionResult Schema Reference | **probabilities** | `Record` | optional | Class probabilities (for classification) | | **explanation** | `object` | optional | | | **metadata** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { PredictionResultSchema } from '@objectstack/spec/ai'; +import type { PredictionResult } from '@objectstack/spec/ai'; + +// Validate data +const result = PredictionResultSchema.parse(data); + +// Type-safe usage +const myPredictionResult: PredictionResult = { + modelName: 'example', + modelVersion: 'example' +}; +``` + diff --git a/content/docs/references/ai/predictive/PredictiveModel.mdx b/content/docs/references/ai/predictive/PredictiveModel.mdx index f408f1297..084e56046 100644 --- a/content/docs/references/ai/predictive/PredictiveModel.mdx +++ b/content/docs/references/ai/predictive/PredictiveModel.mdx @@ -1,8 +1,18 @@ --- title: PredictiveModel description: PredictiveModel Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -38,3 +48,22 @@ description: PredictiveModel Schema Reference | **lastTrainedAt** | `string` | optional | ISO timestamp | | **createdAt** | `string` | optional | ISO timestamp | | **updatedAt** | `string` | optional | ISO timestamp | + +## TypeScript Usage + +```typescript +import { PredictiveModelSchema } from '@objectstack/spec/ai'; +import type { PredictiveModel } from '@objectstack/spec/ai'; + +// Validate data +const result = PredictiveModelSchema.parse(data); + +// Type-safe usage +const myPredictiveModel: PredictiveModel = { + name: 'name', + label: 'example', + type: 'classification', + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/predictive/PredictiveModelType.mdx b/content/docs/references/ai/predictive/PredictiveModelType.mdx index b32506628..4903d97a0 100644 --- a/content/docs/references/ai/predictive/PredictiveModelType.mdx +++ b/content/docs/references/ai/predictive/PredictiveModelType.mdx @@ -1,8 +1,18 @@ --- title: PredictiveModelType description: PredictiveModelType Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Allowed Values * `classification` @@ -11,4 +21,14 @@ description: PredictiveModelType Schema Reference * `forecasting` * `anomaly_detection` * `recommendation` -* `ranking` \ No newline at end of file +* `ranking` + +## TypeScript Usage + +```typescript +import { PredictiveModelType } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: PredictiveModelType = 'classification'; +``` + diff --git a/content/docs/references/ai/predictive/TrainingConfig.mdx b/content/docs/references/ai/predictive/TrainingConfig.mdx index f42a11d1b..c83782713 100644 --- a/content/docs/references/ai/predictive/TrainingConfig.mdx +++ b/content/docs/references/ai/predictive/TrainingConfig.mdx @@ -1,8 +1,18 @@ --- title: TrainingConfig description: TrainingConfig Schema Reference +category: ai +zodFile: predictive --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,18 @@ description: TrainingConfig Schema Reference | **maxTrainingTime** | `number` | optional | Maximum training time in seconds | | **gpuEnabled** | `boolean` | optional | | | **randomSeed** | `integer` | optional | Random seed for reproducibility | + +## TypeScript Usage + +```typescript +import { TrainingConfigSchema } from '@objectstack/spec/ai'; +import type { TrainingConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = TrainingConfigSchema.parse(data); + +// Type-safe usage +const myTrainingConfig: TrainingConfig = { +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx b/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx index ccb091681..391850c42 100644 --- a/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx +++ b/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx @@ -1,5 +1,15 @@ --- title: ChunkingStrategy description: ChunkingStrategy Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + diff --git a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx index d6d97907c..73a311dd8 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx @@ -1,8 +1,18 @@ --- title: DocumentChunk description: DocumentChunk Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: DocumentChunk Schema Reference | **metadata** | `object` | ✅ | | | **chunkIndex** | `integer` | ✅ | Chunk position in document | | **tokens** | `integer` | optional | Token count | + +## TypeScript Usage + +```typescript +import { DocumentChunkSchema } from '@objectstack/spec/ai'; +import type { DocumentChunk } from '@objectstack/spec/ai'; + +// Validate data +const result = DocumentChunkSchema.parse(data); + +// Type-safe usage +const myDocumentChunk: DocumentChunk = { + id: 'example', + content: 'example', + metadata: {}, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx b/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx index 887ac300b..34321bea0 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx @@ -1,8 +1,18 @@ --- title: DocumentLoaderConfig description: DocumentLoaderConfig Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,20 @@ description: DocumentLoaderConfig Schema Reference | **extractImages** | `boolean` | optional | Extract text from images (OCR) | | **extractTables** | `boolean` | optional | Extract and format tables | | **loaderConfig** | `Record` | optional | Custom loader-specific config | + +## TypeScript Usage + +```typescript +import { DocumentLoaderConfigSchema } from '@objectstack/spec/ai'; +import type { DocumentLoaderConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = DocumentLoaderConfigSchema.parse(data); + +// Type-safe usage +const myDocumentLoaderConfig: DocumentLoaderConfig = { + type: 'file', + source: 'example' +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx b/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx index ae125abea..2b139db62 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx @@ -1,8 +1,18 @@ --- title: DocumentMetadata description: DocumentMetadata Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,19 @@ description: DocumentMetadata Schema Reference | **category** | `string` | optional | | | **language** | `string` | optional | Document language (ISO 639-1 code) | | **custom** | `Record` | optional | Custom metadata fields | + +## TypeScript Usage + +```typescript +import { DocumentMetadataSchema } from '@objectstack/spec/ai'; +import type { DocumentMetadata } from '@objectstack/spec/ai'; + +// Validate data +const result = DocumentMetadataSchema.parse(data); + +// Type-safe usage +const myDocumentMetadata: DocumentMetadata = { + source: 'example' +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx b/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx index 7d581b2a7..a89d0cc90 100644 --- a/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx +++ b/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx @@ -1,8 +1,18 @@ --- title: EmbeddingModel description: EmbeddingModel Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,21 @@ description: EmbeddingModel Schema Reference | **batchSize** | `integer` | optional | Batch size for embedding | | **endpoint** | `string` | optional | Custom endpoint URL | | **apiKey** | `string` | optional | API key or reference to secret | + +## TypeScript Usage + +```typescript +import { EmbeddingModelSchema } from '@objectstack/spec/ai'; +import type { EmbeddingModel } from '@objectstack/spec/ai'; + +// Validate data +const result = EmbeddingModelSchema.parse(data); + +// Type-safe usage +const myEmbeddingModel: EmbeddingModel = { + provider: 'openai', + model: 'example', + dimensions: null +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx index 74f5433d8..05f5ed3a6 100644 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx @@ -1,8 +1,18 @@ --- title: RAGPipelineConfig description: RAGPipelineConfig Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -22,3 +32,22 @@ description: RAGPipelineConfig Schema Reference | **enableCache** | `boolean` | optional | | | **cacheTTL** | `integer` | optional | Cache TTL in seconds | | **cacheInvalidationStrategy** | `Enum<'time_based' \| 'manual' \| 'on_update'>` | optional | | + +## TypeScript Usage + +```typescript +import { RAGPipelineConfigSchema } from '@objectstack/spec/ai'; +import type { RAGPipelineConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = RAGPipelineConfigSchema.parse(data); + +// Type-safe usage +const myRAGPipelineConfig: RAGPipelineConfig = { + name: 'name', + label: 'example', + embedding: {}, + // ... other fields +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx index daffa4d88..c39d5ef55 100644 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx @@ -1,8 +1,18 @@ --- title: RAGPipelineStatus description: RAGPipelineStatus Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: RAGPipelineStatus Schema Reference | **lastIndexed** | `string` | optional | ISO timestamp | | **errorMessage** | `string` | optional | | | **health** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { RAGPipelineStatusSchema } from '@objectstack/spec/ai'; +import type { RAGPipelineStatus } from '@objectstack/spec/ai'; + +// Validate data +const result = RAGPipelineStatusSchema.parse(data); + +// Type-safe usage +const myRAGPipelineStatus: RAGPipelineStatus = { + name: 'name', + status: 'active', + documentsIndexed: null +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx b/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx index 734d8aad0..6cbb91931 100644 --- a/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx @@ -1,8 +1,18 @@ --- title: RAGQueryRequest description: RAGQueryRequest Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,20 @@ description: RAGQueryRequest Schema Reference | **conversationHistory** | `object[]` | optional | | | **includeMetadata** | `boolean` | optional | | | **includeSources** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { RAGQueryRequestSchema } from '@objectstack/spec/ai'; +import type { RAGQueryRequest } from '@objectstack/spec/ai'; + +// Validate data +const result = RAGQueryRequestSchema.parse(data); + +// Type-safe usage +const myRAGQueryRequest: RAGQueryRequest = { + query: 'example', + pipelineName: 'example' +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx b/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx index d33cdad27..30cb6ba5a 100644 --- a/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx @@ -1,8 +1,18 @@ --- title: RAGQueryResponse description: RAGQueryResponse Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: RAGQueryResponse Schema Reference | **context** | `string` | ✅ | Assembled context for LLM | | **tokensUsed** | `integer` | optional | | | **retrievalTime** | `number` | optional | Retrieval time in milliseconds | + +## TypeScript Usage + +```typescript +import { RAGQueryResponseSchema } from '@objectstack/spec/ai'; +import type { RAGQueryResponse } from '@objectstack/spec/ai'; + +// Validate data +const result = RAGQueryResponseSchema.parse(data); + +// Type-safe usage +const myRAGQueryResponse: RAGQueryResponse = { + query: 'example', + results: [], + context: 'example' +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx b/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx index 7cfb7e3d9..8289a0005 100644 --- a/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx @@ -1,8 +1,18 @@ --- title: RerankingConfig description: RerankingConfig Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: RerankingConfig Schema Reference | **model** | `string` | optional | Reranking model name | | **provider** | `Enum<'cohere' \| 'huggingface' \| 'custom'>` | optional | | | **topK** | `integer` | optional | Final number of results after reranking | + +## TypeScript Usage + +```typescript +import { RerankingConfigSchema } from '@objectstack/spec/ai'; +import type { RerankingConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = RerankingConfigSchema.parse(data); + +// Type-safe usage +const myRerankingConfig: RerankingConfig = { +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx b/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx index 25d9e6dde..3614a66fe 100644 --- a/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx +++ b/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx @@ -1,5 +1,15 @@ --- title: RetrievalStrategy description: RetrievalStrategy Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + diff --git a/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx b/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx index db3bd3fbd..c4172f740 100644 --- a/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx @@ -1,8 +1,18 @@ --- title: VectorStoreConfig description: VectorStoreConfig Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,21 @@ description: VectorStoreConfig Schema Reference | **batchSize** | `integer` | optional | | | **connectionPoolSize** | `integer` | optional | | | **timeout** | `integer` | optional | Timeout in milliseconds | + +## TypeScript Usage + +```typescript +import { VectorStoreConfigSchema } from '@objectstack/spec/ai'; +import type { VectorStoreConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = VectorStoreConfigSchema.parse(data); + +// Type-safe usage +const myVectorStoreConfig: VectorStoreConfig = { + provider: 'pinecone', + indexName: 'example', + dimensions: null +}; +``` + diff --git a/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx b/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx index 37c6435e6..73fcdcfea 100644 --- a/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx +++ b/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx @@ -1,8 +1,18 @@ --- title: VectorStoreProvider description: VectorStoreProvider Schema Reference +category: ai +zodFile: rag-pipeline --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + ## Allowed Values * `pinecone` @@ -14,4 +24,14 @@ description: VectorStoreProvider Schema Reference * `redis` * `opensearch` * `elasticsearch` -* `custom` \ No newline at end of file +* `custom` + +## TypeScript Usage + +```typescript +import { VectorStoreProvider } from '@objectstack/spec/ai'; + +// Type-safe enum value +const value: VectorStoreProvider = 'pinecone'; +``` + diff --git a/content/docs/references/api/contract/ApiError.mdx b/content/docs/references/api/contract/ApiError.mdx index 2f3f78ff1..2b8f997bf 100644 --- a/content/docs/references/api/contract/ApiError.mdx +++ b/content/docs/references/api/contract/ApiError.mdx @@ -1,8 +1,18 @@ --- title: ApiError description: ApiError Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: ApiError Schema Reference | **code** | `string` | ✅ | Error code (e.g. validation_error) | | **message** | `string` | ✅ | Readable error message | | **details** | `any` | optional | Additional error context (e.g. field validation errors) | + +## TypeScript Usage + +```typescript +import { ApiErrorSchema } from '@objectstack/spec/api'; +import type { ApiError } from '@objectstack/spec/api'; + +// Validate data +const result = ApiErrorSchema.parse(data); + +// Type-safe usage +const myApiError: ApiError = { + code: 'example', + message: 'example' +}; +``` + diff --git a/content/docs/references/api/contract/BaseResponse.mdx b/content/docs/references/api/contract/BaseResponse.mdx index c180bace9..004796d76 100644 --- a/content/docs/references/api/contract/BaseResponse.mdx +++ b/content/docs/references/api/contract/BaseResponse.mdx @@ -1,8 +1,18 @@ --- title: BaseResponse description: BaseResponse Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: BaseResponse Schema Reference | **success** | `boolean` | ✅ | Operation success status | | **error** | `object` | optional | Error details if success is false | | **meta** | `object` | optional | Response metadata | + +## TypeScript Usage + +```typescript +import { BaseResponseSchema } from '@objectstack/spec/api'; +import type { BaseResponse } from '@objectstack/spec/api'; + +// Validate data +const result = BaseResponseSchema.parse(data); + +// Type-safe usage +const myBaseResponse: BaseResponse = { + success: false +}; +``` + diff --git a/content/docs/references/api/contract/BulkRequest.mdx b/content/docs/references/api/contract/BulkRequest.mdx index 893f2b17a..ba47b0832 100644 --- a/content/docs/references/api/contract/BulkRequest.mdx +++ b/content/docs/references/api/contract/BulkRequest.mdx @@ -1,11 +1,37 @@ --- title: BulkRequest description: BulkRequest Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **records** | `Record[]` | ✅ | Array of records to process | | **allOrNone** | `boolean` | optional | If true, rollback entire transaction on any failure | + +## TypeScript Usage + +```typescript +import { BulkRequestSchema } from '@objectstack/spec/api'; +import type { BulkRequest } from '@objectstack/spec/api'; + +// Validate data +const result = BulkRequestSchema.parse(data); + +// Type-safe usage +const myBulkRequest: BulkRequest = { + records: [] +}; +``` + diff --git a/content/docs/references/api/contract/BulkResponse.mdx b/content/docs/references/api/contract/BulkResponse.mdx index cc21f18e4..6c5a29619 100644 --- a/content/docs/references/api/contract/BulkResponse.mdx +++ b/content/docs/references/api/contract/BulkResponse.mdx @@ -1,8 +1,18 @@ --- title: BulkResponse description: BulkResponse Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: BulkResponse Schema Reference | **error** | `object` | optional | Error details if success is false | | **meta** | `object` | optional | Response metadata | | **data** | `object[]` | ✅ | Results for each item in the batch | + +## TypeScript Usage + +```typescript +import { BulkResponseSchema } from '@objectstack/spec/api'; +import type { BulkResponse } from '@objectstack/spec/api'; + +// Validate data +const result = BulkResponseSchema.parse(data); + +// Type-safe usage +const myBulkResponse: BulkResponse = { + success: false, + data: [] +}; +``` + diff --git a/content/docs/references/api/contract/CreateRequest.mdx b/content/docs/references/api/contract/CreateRequest.mdx index d6dcc398d..222c07ce3 100644 --- a/content/docs/references/api/contract/CreateRequest.mdx +++ b/content/docs/references/api/contract/CreateRequest.mdx @@ -1,10 +1,36 @@ --- title: CreateRequest description: CreateRequest Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **data** | `Record` | ✅ | Record data to insert | + +## TypeScript Usage + +```typescript +import { CreateRequestSchema } from '@objectstack/spec/api'; +import type { CreateRequest } from '@objectstack/spec/api'; + +// Validate data +const result = CreateRequestSchema.parse(data); + +// Type-safe usage +const myCreateRequest: CreateRequest = { + data: {} +}; +``` + diff --git a/content/docs/references/api/contract/DeleteResponse.mdx b/content/docs/references/api/contract/DeleteResponse.mdx index e0123aab8..9a74b3b5f 100644 --- a/content/docs/references/api/contract/DeleteResponse.mdx +++ b/content/docs/references/api/contract/DeleteResponse.mdx @@ -1,8 +1,18 @@ --- title: DeleteResponse description: DeleteResponse Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: DeleteResponse Schema Reference | **error** | `object` | optional | Error details if success is false | | **meta** | `object` | optional | Response metadata | | **id** | `string` | ✅ | ID of the deleted record | + +## TypeScript Usage + +```typescript +import { DeleteResponseSchema } from '@objectstack/spec/api'; +import type { DeleteResponse } from '@objectstack/spec/api'; + +// Validate data +const result = DeleteResponseSchema.parse(data); + +// Type-safe usage +const myDeleteResponse: DeleteResponse = { + success: false, + id: 'example' +}; +``` + diff --git a/content/docs/references/api/contract/ExportRequest.mdx b/content/docs/references/api/contract/ExportRequest.mdx index f559d1d4a..b6f153c77 100644 --- a/content/docs/references/api/contract/ExportRequest.mdx +++ b/content/docs/references/api/contract/ExportRequest.mdx @@ -1,8 +1,18 @@ --- title: ExportRequest description: ExportRequest Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,19 @@ description: ExportRequest Schema Reference | **windowFunctions** | `object[]` | optional | Window functions with OVER clause | | **distinct** | `boolean` | optional | SELECT DISTINCT flag | | **format** | `Enum<'csv' \| 'json' \| 'xlsx'>` | optional | | + +## TypeScript Usage + +```typescript +import { ExportRequestSchema } from '@objectstack/spec/api'; +import type { ExportRequest } from '@objectstack/spec/api'; + +// Validate data +const result = ExportRequestSchema.parse(data); + +// Type-safe usage +const myExportRequest: ExportRequest = { + object: 'example' +}; +``` + diff --git a/content/docs/references/api/contract/ListRecordResponse.mdx b/content/docs/references/api/contract/ListRecordResponse.mdx index 8a69a402c..22f01f1d5 100644 --- a/content/docs/references/api/contract/ListRecordResponse.mdx +++ b/content/docs/references/api/contract/ListRecordResponse.mdx @@ -1,8 +1,18 @@ --- title: ListRecordResponse description: ListRecordResponse Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: ListRecordResponse Schema Reference | **meta** | `object` | optional | Response metadata | | **data** | `Record[]` | ✅ | Array of matching records | | **pagination** | `object` | ✅ | Pagination info | + +## TypeScript Usage + +```typescript +import { ListRecordResponseSchema } from '@objectstack/spec/api'; +import type { ListRecordResponse } from '@objectstack/spec/api'; + +// Validate data +const result = ListRecordResponseSchema.parse(data); + +// Type-safe usage +const myListRecordResponse: ListRecordResponse = { + success: false, + data: [], + pagination: {} +}; +``` + diff --git a/content/docs/references/api/contract/ModificationResult.mdx b/content/docs/references/api/contract/ModificationResult.mdx index 0498f7c62..f48f9bc5c 100644 --- a/content/docs/references/api/contract/ModificationResult.mdx +++ b/content/docs/references/api/contract/ModificationResult.mdx @@ -1,8 +1,18 @@ --- title: ModificationResult description: ModificationResult Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: ModificationResult Schema Reference | **id** | `string` | optional | Record ID if processed | | **success** | `boolean` | ✅ | | | **errors** | `object[]` | optional | | + +## TypeScript Usage + +```typescript +import { ModificationResultSchema } from '@objectstack/spec/api'; +import type { ModificationResult } from '@objectstack/spec/api'; + +// Validate data +const result = ModificationResultSchema.parse(data); + +// Type-safe usage +const myModificationResult: ModificationResult = { + success: false +}; +``` + diff --git a/content/docs/references/api/contract/RecordData.mdx b/content/docs/references/api/contract/RecordData.mdx index a3a8d02c1..06470f3c0 100644 --- a/content/docs/references/api/contract/RecordData.mdx +++ b/content/docs/references/api/contract/RecordData.mdx @@ -1,7 +1,17 @@ --- title: RecordData description: Key-value map of record data +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Key-value map of record data + +**Source:** `packages/spec/src/api/contract.zod.ts` + + diff --git a/content/docs/references/api/contract/SingleRecordResponse.mdx b/content/docs/references/api/contract/SingleRecordResponse.mdx index 30b52d855..e9b4bf2c0 100644 --- a/content/docs/references/api/contract/SingleRecordResponse.mdx +++ b/content/docs/references/api/contract/SingleRecordResponse.mdx @@ -1,8 +1,18 @@ --- title: SingleRecordResponse description: SingleRecordResponse Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: SingleRecordResponse Schema Reference | **error** | `object` | optional | Error details if success is false | | **meta** | `object` | optional | Response metadata | | **data** | `Record` | ✅ | The requested or modified record | + +## TypeScript Usage + +```typescript +import { SingleRecordResponseSchema } from '@objectstack/spec/api'; +import type { SingleRecordResponse } from '@objectstack/spec/api'; + +// Validate data +const result = SingleRecordResponseSchema.parse(data); + +// Type-safe usage +const mySingleRecordResponse: SingleRecordResponse = { + success: false, + data: {} +}; +``` + diff --git a/content/docs/references/api/contract/UpdateRequest.mdx b/content/docs/references/api/contract/UpdateRequest.mdx index f358d946c..93eebd555 100644 --- a/content/docs/references/api/contract/UpdateRequest.mdx +++ b/content/docs/references/api/contract/UpdateRequest.mdx @@ -1,10 +1,36 @@ --- title: UpdateRequest description: UpdateRequest Schema Reference +category: api +zodFile: contract --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **data** | `Record` | ✅ | Partial record data to update | + +## TypeScript Usage + +```typescript +import { UpdateRequestSchema } from '@objectstack/spec/api'; +import type { UpdateRequest } from '@objectstack/spec/api'; + +// Validate data +const result = UpdateRequestSchema.parse(data); + +// Type-safe usage +const myUpdateRequest: UpdateRequest = { + data: {} +}; +``` + diff --git a/content/docs/references/api/discovery/ApiCapabilities.mdx b/content/docs/references/api/discovery/ApiCapabilities.mdx index ba39b55e8..87354d3a7 100644 --- a/content/docs/references/api/discovery/ApiCapabilities.mdx +++ b/content/docs/references/api/discovery/ApiCapabilities.mdx @@ -1,8 +1,18 @@ --- title: ApiCapabilities description: ApiCapabilities Schema Reference +category: api +zodFile: discovery --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/discovery.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: ApiCapabilities Schema Reference | **search** | `boolean` | optional | | | **websockets** | `boolean` | optional | | | **files** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { ApiCapabilitiesSchema } from '@objectstack/spec/api'; +import type { ApiCapabilities } from '@objectstack/spec/api'; + +// Validate data +const result = ApiCapabilitiesSchema.parse(data); + +// Type-safe usage +const myApiCapabilities: ApiCapabilities = { +}; +``` + diff --git a/content/docs/references/api/discovery/ApiRoutes.mdx b/content/docs/references/api/discovery/ApiRoutes.mdx index 1acb16320..238b10ecf 100644 --- a/content/docs/references/api/discovery/ApiRoutes.mdx +++ b/content/docs/references/api/discovery/ApiRoutes.mdx @@ -1,8 +1,18 @@ --- title: ApiRoutes description: ApiRoutes Schema Reference +category: api +zodFile: discovery --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/discovery.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: ApiRoutes Schema Reference | **automation** | `string` | optional | e.g. /api/automation | | **storage** | `string` | optional | e.g. /api/storage | | **graphql** | `string` | optional | e.g. /graphql | + +## TypeScript Usage + +```typescript +import { ApiRoutesSchema } from '@objectstack/spec/api'; +import type { ApiRoutes } from '@objectstack/spec/api'; + +// Validate data +const result = ApiRoutesSchema.parse(data); + +// Type-safe usage +const myApiRoutes: ApiRoutes = { + data: 'example', + metadata: 'example', + auth: 'example' +}; +``` + diff --git a/content/docs/references/api/discovery/Discovery.mdx b/content/docs/references/api/discovery/Discovery.mdx index 3dbf27d14..3033180e6 100644 --- a/content/docs/references/api/discovery/Discovery.mdx +++ b/content/docs/references/api/discovery/Discovery.mdx @@ -1,8 +1,18 @@ --- title: Discovery description: Discovery Schema Reference +category: api +zodFile: discovery --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/discovery.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: Discovery Schema Reference | **routes** | `object` | ✅ | | | **features** | `object` | ✅ | | | **locale** | `object` | ✅ | | + +## TypeScript Usage + +```typescript +import { DiscoverySchema } from '@objectstack/spec/api'; +import type { Discovery } from '@objectstack/spec/api'; + +// Validate data +const result = DiscoverySchema.parse(data); + +// Type-safe usage +const myDiscovery: Discovery = { + name: 'name', + version: 'example', + environment: 'production', + // ... other fields +}; +``` + diff --git a/content/docs/references/api/endpoint/ApiEndpoint.mdx b/content/docs/references/api/endpoint/ApiEndpoint.mdx index 48aa4ccba..1179d786d 100644 --- a/content/docs/references/api/endpoint/ApiEndpoint.mdx +++ b/content/docs/references/api/endpoint/ApiEndpoint.mdx @@ -1,8 +1,18 @@ --- title: ApiEndpoint description: ApiEndpoint Schema Reference +category: api +zodFile: endpoint --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/endpoint.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,22 @@ description: ApiEndpoint Schema Reference | **authRequired** | `boolean` | optional | Require authentication | | **rateLimit** | `object` | optional | Rate limiting policy | | **cacheTtl** | `number` | optional | Response cache TTL in seconds | + +## TypeScript Usage + +```typescript +import { ApiEndpointSchema } from '@objectstack/spec/api'; +import type { ApiEndpoint } from '@objectstack/spec/api'; + +// Validate data +const result = ApiEndpointSchema.parse(data); + +// Type-safe usage +const myApiEndpoint: ApiEndpoint = { + name: 'name', + path: 'example', + method: 'GET', + // ... other fields +}; +``` + diff --git a/content/docs/references/api/endpoint/ApiMapping.mdx b/content/docs/references/api/endpoint/ApiMapping.mdx index d3ebafe16..37c8f5480 100644 --- a/content/docs/references/api/endpoint/ApiMapping.mdx +++ b/content/docs/references/api/endpoint/ApiMapping.mdx @@ -1,8 +1,18 @@ --- title: ApiMapping description: ApiMapping Schema Reference +category: api +zodFile: endpoint --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/endpoint.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: ApiMapping Schema Reference | **source** | `string` | ✅ | Source field/path | | **target** | `string` | ✅ | Target field/path | | **transform** | `string` | optional | Transformation function name | + +## TypeScript Usage + +```typescript +import { ApiMappingSchema } from '@objectstack/spec/api'; +import type { ApiMapping } from '@objectstack/spec/api'; + +// Validate data +const result = ApiMappingSchema.parse(data); + +// Type-safe usage +const myApiMapping: ApiMapping = { + source: 'example', + target: 'example' +}; +``` + diff --git a/content/docs/references/api/endpoint/RateLimit.mdx b/content/docs/references/api/endpoint/RateLimit.mdx index 84ebaf8fd..2af59d4a1 100644 --- a/content/docs/references/api/endpoint/RateLimit.mdx +++ b/content/docs/references/api/endpoint/RateLimit.mdx @@ -1,8 +1,18 @@ --- title: RateLimit description: RateLimit Schema Reference +category: api +zodFile: endpoint --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/endpoint.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: RateLimit Schema Reference | **enabled** | `boolean` | optional | | | **windowMs** | `number` | optional | Time window in milliseconds | | **maxRequests** | `number` | optional | Max requests per window | + +## TypeScript Usage + +```typescript +import { RateLimitSchema } from '@objectstack/spec/api'; +import type { RateLimit } from '@objectstack/spec/api'; + +// Validate data +const result = RateLimitSchema.parse(data); + +// Type-safe usage +const myRateLimit: RateLimit = { +}; +``` + diff --git a/content/docs/references/api/index.mdx b/content/docs/references/api/index.mdx new file mode 100644 index 000000000..a440d8726 --- /dev/null +++ b/content/docs/references/api/index.mdx @@ -0,0 +1,89 @@ +--- +title: API Protocol Overview +description: Complete reference for all api protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# API Protocol + +This section contains all protocol schemas for the api layer of ObjectStack. + +## Contract + +Source: `packages/spec/src/api/contract.zod.ts` + + + + + + + + + + + + + + + + +## Discovery + +Source: `packages/spec/src/api/discovery.zod.ts` + + + + + + + +## Endpoint + +Source: `packages/spec/src/api/endpoint.zod.ts` + + + + + + + +## Odata + +Source: `packages/spec/src/api/odata.zod.ts` + + + + + + + + + + +## Realtime + +Source: `packages/spec/src/api/realtime.zod.ts` + + + + + + + + + + + + +## Router + +Source: `packages/spec/src/api/router.zod.ts` + + + + + + + diff --git a/content/docs/references/api/odata/ODataError.mdx b/content/docs/references/api/odata/ODataError.mdx index 54a3c00ad..f4dfbfd0e 100644 --- a/content/docs/references/api/odata/ODataError.mdx +++ b/content/docs/references/api/odata/ODataError.mdx @@ -1,10 +1,36 @@ --- title: ODataError description: ODataError Schema Reference +category: api +zodFile: odata --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **error** | `object` | ✅ | | + +## TypeScript Usage + +```typescript +import { ODataErrorSchema } from '@objectstack/spec/api'; +import type { ODataError } from '@objectstack/spec/api'; + +// Validate data +const result = ODataErrorSchema.parse(data); + +// Type-safe usage +const myODataError: ODataError = { + error: {} +}; +``` + diff --git a/content/docs/references/api/odata/ODataFilterFunction.mdx b/content/docs/references/api/odata/ODataFilterFunction.mdx index 32f6d0c4d..cc41ae1cd 100644 --- a/content/docs/references/api/odata/ODataFilterFunction.mdx +++ b/content/docs/references/api/odata/ODataFilterFunction.mdx @@ -1,8 +1,18 @@ --- title: ODataFilterFunction description: ODataFilterFunction Schema Reference +category: api +zodFile: odata --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + ## Allowed Values * `contains` @@ -32,4 +42,14 @@ description: ODataFilterFunction Schema Reference * `cast` * `isof` * `any` -* `all` \ No newline at end of file +* `all` + +## TypeScript Usage + +```typescript +import { ODataFilterFunction } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: ODataFilterFunction = 'contains'; +``` + diff --git a/content/docs/references/api/odata/ODataFilterOperator.mdx b/content/docs/references/api/odata/ODataFilterOperator.mdx index 0b10a8105..fedc3d61a 100644 --- a/content/docs/references/api/odata/ODataFilterOperator.mdx +++ b/content/docs/references/api/odata/ODataFilterOperator.mdx @@ -1,8 +1,18 @@ --- title: ODataFilterOperator description: ODataFilterOperator Schema Reference +category: api +zodFile: odata --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + ## Allowed Values * `eq` @@ -17,4 +27,14 @@ description: ODataFilterOperator Schema Reference * `(` * `)` * `in` -* `has` \ No newline at end of file +* `has` + +## TypeScript Usage + +```typescript +import { ODataFilterOperator } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: ODataFilterOperator = 'eq'; +``` + diff --git a/content/docs/references/api/odata/ODataMetadata.mdx b/content/docs/references/api/odata/ODataMetadata.mdx index 10d1432ab..b589f9f0f 100644 --- a/content/docs/references/api/odata/ODataMetadata.mdx +++ b/content/docs/references/api/odata/ODataMetadata.mdx @@ -1,8 +1,18 @@ --- title: ODataMetadata description: ODataMetadata Schema Reference +category: api +zodFile: odata --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,21 @@ description: ODataMetadata Schema Reference | **namespace** | `string` | ✅ | Service namespace | | **entityTypes** | `object[]` | ✅ | Entity types | | **entitySets** | `object[]` | ✅ | Entity sets | + +## TypeScript Usage + +```typescript +import { ODataMetadataSchema } from '@objectstack/spec/api'; +import type { ODataMetadata } from '@objectstack/spec/api'; + +// Validate data +const result = ODataMetadataSchema.parse(data); + +// Type-safe usage +const myODataMetadata: ODataMetadata = { + namespace: 'namespace', + entityTypes: [], + entitySets: [] +}; +``` + diff --git a/content/docs/references/api/odata/ODataQuery.mdx b/content/docs/references/api/odata/ODataQuery.mdx index 2fba78ae9..d881c84af 100644 --- a/content/docs/references/api/odata/ODataQuery.mdx +++ b/content/docs/references/api/odata/ODataQuery.mdx @@ -1,8 +1,18 @@ --- title: ODataQuery description: ODataQuery Schema Reference +category: api +zodFile: odata --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,18 @@ description: ODataQuery Schema Reference | **$search** | `string` | optional | Search expression | | **$format** | `Enum<'json' \| 'xml' \| 'atom'>` | optional | Response format | | **$apply** | `string` | optional | Aggregation expression | + +## TypeScript Usage + +```typescript +import { ODataQuerySchema } from '@objectstack/spec/api'; +import type { ODataQuery } from '@objectstack/spec/api'; + +// Validate data +const result = ODataQuerySchema.parse(data); + +// Type-safe usage +const myODataQuery: ODataQuery = { +}; +``` + diff --git a/content/docs/references/api/odata/ODataResponse.mdx b/content/docs/references/api/odata/ODataResponse.mdx index c282d6b0f..63b357e1a 100644 --- a/content/docs/references/api/odata/ODataResponse.mdx +++ b/content/docs/references/api/odata/ODataResponse.mdx @@ -1,8 +1,18 @@ --- title: ODataResponse description: ODataResponse Schema Reference +category: api +zodFile: odata --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: ODataResponse Schema Reference | **@odata.count** | `integer` | optional | Total results count | | **@odata.nextLink** | `string` | optional | Next page URL | | **value** | `Record[]` | ✅ | Results array | + +## TypeScript Usage + +```typescript +import { ODataResponseSchema } from '@objectstack/spec/api'; +import type { ODataResponse } from '@objectstack/spec/api'; + +// Validate data +const result = ODataResponseSchema.parse(data); + +// Type-safe usage +const myODataResponse: ODataResponse = { + value: [] +}; +``` + diff --git a/content/docs/references/api/realtime/Presence.mdx b/content/docs/references/api/realtime/Presence.mdx index 014e96053..a3475d126 100644 --- a/content/docs/references/api/realtime/Presence.mdx +++ b/content/docs/references/api/realtime/Presence.mdx @@ -1,8 +1,18 @@ --- title: Presence description: Presence Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: Presence Schema Reference | **status** | `Enum<'online' \| 'away' \| 'offline'>` | ✅ | Current presence status | | **lastSeen** | `string` | ✅ | ISO 8601 datetime of last activity | | **metadata** | `Record` | optional | Custom presence data (e.g., current page, custom status) | + +## TypeScript Usage + +```typescript +import { PresenceSchema } from '@objectstack/spec/api'; +import type { Presence } from '@objectstack/spec/api'; + +// Validate data +const result = PresenceSchema.parse(data); + +// Type-safe usage +const myPresence: Presence = { + userId: 'example', + status: 'online', + lastSeen: 'example' +}; +``` + diff --git a/content/docs/references/api/realtime/PresenceStatus.mdx b/content/docs/references/api/realtime/PresenceStatus.mdx index f884a53c3..e668a8cf8 100644 --- a/content/docs/references/api/realtime/PresenceStatus.mdx +++ b/content/docs/references/api/realtime/PresenceStatus.mdx @@ -1,10 +1,30 @@ --- title: PresenceStatus description: PresenceStatus Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Allowed Values * `online` * `away` -* `offline` \ No newline at end of file +* `offline` + +## TypeScript Usage + +```typescript +import { PresenceStatus } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: PresenceStatus = 'online'; +``` + diff --git a/content/docs/references/api/realtime/RealtimeAction.mdx b/content/docs/references/api/realtime/RealtimeAction.mdx index 2f1af2e3c..7993df9c3 100644 --- a/content/docs/references/api/realtime/RealtimeAction.mdx +++ b/content/docs/references/api/realtime/RealtimeAction.mdx @@ -1,10 +1,30 @@ --- title: RealtimeAction description: RealtimeAction Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Allowed Values * `created` * `updated` -* `deleted` \ No newline at end of file +* `deleted` + +## TypeScript Usage + +```typescript +import { RealtimeAction } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: RealtimeAction = 'created'; +``` + diff --git a/content/docs/references/api/realtime/RealtimeEvent.mdx b/content/docs/references/api/realtime/RealtimeEvent.mdx index 46a1b1b22..e682edd0d 100644 --- a/content/docs/references/api/realtime/RealtimeEvent.mdx +++ b/content/docs/references/api/realtime/RealtimeEvent.mdx @@ -1,8 +1,18 @@ --- title: RealtimeEvent description: RealtimeEvent Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,21 @@ description: RealtimeEvent Schema Reference | **payload** | `any` | optional | Event payload data | | **timestamp** | `string` | ✅ | ISO 8601 datetime when event occurred | | **userId** | `string` | optional | User who triggered the event | + +## TypeScript Usage + +```typescript +import { RealtimeEventSchema } from '@objectstack/spec/api'; +import type { RealtimeEvent } from '@objectstack/spec/api'; + +// Validate data +const result = RealtimeEventSchema.parse(data); + +// Type-safe usage +const myRealtimeEvent: RealtimeEvent = { + id: 'example', + type: 'example', + timestamp: 'example' +}; +``` + diff --git a/content/docs/references/api/realtime/RealtimeEventType.mdx b/content/docs/references/api/realtime/RealtimeEventType.mdx index 56c877e5c..be43423f8 100644 --- a/content/docs/references/api/realtime/RealtimeEventType.mdx +++ b/content/docs/references/api/realtime/RealtimeEventType.mdx @@ -1,11 +1,31 @@ --- title: RealtimeEventType description: RealtimeEventType Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Allowed Values * `record.created` * `record.updated` * `record.deleted` -* `field.changed` \ No newline at end of file +* `field.changed` + +## TypeScript Usage + +```typescript +import { RealtimeEventType } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: RealtimeEventType = 'record.created'; +``` + diff --git a/content/docs/references/api/realtime/Subscription.mdx b/content/docs/references/api/realtime/Subscription.mdx index 31ad739bb..258f9170c 100644 --- a/content/docs/references/api/realtime/Subscription.mdx +++ b/content/docs/references/api/realtime/Subscription.mdx @@ -1,8 +1,18 @@ --- title: Subscription description: Subscription Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: Subscription Schema Reference | **events** | `object[]` | ✅ | Array of events to subscribe to | | **transport** | `Enum<'websocket' \| 'sse' \| 'polling'>` | ✅ | Transport protocol to use | | **channel** | `string` | optional | Optional channel name for grouping subscriptions | + +## TypeScript Usage + +```typescript +import { SubscriptionSchema } from '@objectstack/spec/api'; +import type { Subscription } from '@objectstack/spec/api'; + +// Validate data +const result = SubscriptionSchema.parse(data); + +// Type-safe usage +const mySubscription: Subscription = { + id: 'example', + events: [], + transport: 'websocket' +}; +``` + diff --git a/content/docs/references/api/realtime/SubscriptionEvent.mdx b/content/docs/references/api/realtime/SubscriptionEvent.mdx index ff9133f31..a6af28371 100644 --- a/content/docs/references/api/realtime/SubscriptionEvent.mdx +++ b/content/docs/references/api/realtime/SubscriptionEvent.mdx @@ -1,8 +1,18 @@ --- title: SubscriptionEvent description: SubscriptionEvent Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: SubscriptionEvent Schema Reference | **type** | `Enum<'record.created' \| 'record.updated' \| 'record.deleted' \| 'field.changed'>` | ✅ | Type of event to subscribe to | | **object** | `string` | optional | Object name to subscribe to | | **filters** | `any` | optional | Filter conditions | + +## TypeScript Usage + +```typescript +import { SubscriptionEventSchema } from '@objectstack/spec/api'; +import type { SubscriptionEvent } from '@objectstack/spec/api'; + +// Validate data +const result = SubscriptionEventSchema.parse(data); + +// Type-safe usage +const mySubscriptionEvent: SubscriptionEvent = { + type: 'record.created' +}; +``` + diff --git a/content/docs/references/api/realtime/TransportProtocol.mdx b/content/docs/references/api/realtime/TransportProtocol.mdx index a24a12829..58a4ffca6 100644 --- a/content/docs/references/api/realtime/TransportProtocol.mdx +++ b/content/docs/references/api/realtime/TransportProtocol.mdx @@ -1,10 +1,30 @@ --- title: TransportProtocol description: TransportProtocol Schema Reference +category: api +zodFile: realtime --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + ## Allowed Values * `websocket` * `sse` -* `polling` \ No newline at end of file +* `polling` + +## TypeScript Usage + +```typescript +import { TransportProtocol } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: TransportProtocol = 'websocket'; +``` + diff --git a/content/docs/references/api/router/RouteCategory.mdx b/content/docs/references/api/router/RouteCategory.mdx index 33b9cb4de..bb6201b73 100644 --- a/content/docs/references/api/router/RouteCategory.mdx +++ b/content/docs/references/api/router/RouteCategory.mdx @@ -1,8 +1,18 @@ --- title: RouteCategory description: RouteCategory Schema Reference +category: api +zodFile: router --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/router.zod.ts` + + ## Allowed Values * `system` @@ -10,4 +20,14 @@ description: RouteCategory Schema Reference * `auth` * `static` * `webhook` -* `plugin` \ No newline at end of file +* `plugin` + +## TypeScript Usage + +```typescript +import { RouteCategory } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: RouteCategory = 'system'; +``` + diff --git a/content/docs/references/api/router/RouteDefinition.mdx b/content/docs/references/api/router/RouteDefinition.mdx index cacb592d8..06a5932bd 100644 --- a/content/docs/references/api/router/RouteDefinition.mdx +++ b/content/docs/references/api/router/RouteDefinition.mdx @@ -1,8 +1,18 @@ --- title: RouteDefinition description: RouteDefinition Schema Reference +category: api +zodFile: router --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/router.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,21 @@ description: RouteDefinition Schema Reference | **permissions** | `string[]` | optional | Required permissions | | **timeout** | `integer` | optional | Execution timeout in ms | | **rateLimit** | `string` | optional | Rate limit policy name | + +## TypeScript Usage + +```typescript +import { RouteDefinitionSchema } from '@objectstack/spec/api'; +import type { RouteDefinition } from '@objectstack/spec/api'; + +// Validate data +const result = RouteDefinitionSchema.parse(data); + +// Type-safe usage +const myRouteDefinition: RouteDefinition = { + method: 'GET', + path: 'example', + handler: 'example' +}; +``` + diff --git a/content/docs/references/api/router/RouterConfig.mdx b/content/docs/references/api/router/RouterConfig.mdx index e4c8d8cf8..81cc5f7ca 100644 --- a/content/docs/references/api/router/RouterConfig.mdx +++ b/content/docs/references/api/router/RouterConfig.mdx @@ -1,8 +1,18 @@ --- title: RouterConfig description: RouterConfig Schema Reference +category: api +zodFile: router --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/router.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: RouterConfig Schema Reference | **mounts** | `object` | optional | | | **cors** | `object` | optional | | | **staticMounts** | `object[]` | optional | | + +## TypeScript Usage + +```typescript +import { RouterConfigSchema } from '@objectstack/spec/api'; +import type { RouterConfig } from '@objectstack/spec/api'; + +// Validate data +const result = RouterConfigSchema.parse(data); + +// Type-safe usage +const myRouterConfig: RouterConfig = { +}; +``` + diff --git a/content/docs/references/api/view/HttpMethod.mdx b/content/docs/references/api/view/HttpMethod.mdx index 742c0c547..b55ef14d4 100644 --- a/content/docs/references/api/view/HttpMethod.mdx +++ b/content/docs/references/api/view/HttpMethod.mdx @@ -1,8 +1,18 @@ --- title: HttpMethod description: HttpMethod Schema Reference +category: api +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/api/view.zod.ts` + + ## Allowed Values * `GET` @@ -11,4 +21,14 @@ description: HttpMethod Schema Reference * `DELETE` * `PATCH` * `HEAD` -* `OPTIONS` \ No newline at end of file +* `OPTIONS` + +## TypeScript Usage + +```typescript +import { HttpMethod } from '@objectstack/spec/api'; + +// Type-safe enum value +const value: HttpMethod = 'GET'; +``` + diff --git a/content/docs/references/auth/config/AccountLinkingConfig.mdx b/content/docs/references/auth/config/AccountLinkingConfig.mdx index df6148efd..2f6b88299 100644 --- a/content/docs/references/auth/config/AccountLinkingConfig.mdx +++ b/content/docs/references/auth/config/AccountLinkingConfig.mdx @@ -1,8 +1,18 @@ --- title: AccountLinkingConfig description: AccountLinkingConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: AccountLinkingConfig Schema Reference | **enabled** | `boolean` | optional | Allow account linking | | **autoLink** | `boolean` | optional | Automatically link accounts with same email | | **requireVerification** | `boolean` | optional | Require email verification before linking | + +## TypeScript Usage + +```typescript +import { AccountLinkingConfigSchema } from '@objectstack/spec/auth'; +import type { AccountLinkingConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = AccountLinkingConfigSchema.parse(data); + +// Type-safe usage +const myAccountLinkingConfig: AccountLinkingConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/AuthConfig.mdx b/content/docs/references/auth/config/AuthConfig.mdx index 3844175d1..660f9afbb 100644 --- a/content/docs/references/auth/config/AuthConfig.mdx +++ b/content/docs/references/auth/config/AuthConfig.mdx @@ -1,8 +1,18 @@ --- title: AuthConfig description: AuthConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -34,3 +44,22 @@ description: AuthConfig Schema Reference | **ui** | `object` | optional | UI customization | | **active** | `boolean` | optional | Whether this provider is active | | **allowRegistration** | `boolean` | optional | Allow new user registration | + +## TypeScript Usage + +```typescript +import { AuthConfigSchema } from '@objectstack/spec/auth'; +import type { AuthConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = AuthConfigSchema.parse(data); + +// Type-safe usage +const myAuthConfig: AuthConfig = { + name: 'name', + label: 'example', + strategies: [], + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/config/AuthPluginConfig.mdx b/content/docs/references/auth/config/AuthPluginConfig.mdx index 701df2e7b..80ec23ea8 100644 --- a/content/docs/references/auth/config/AuthPluginConfig.mdx +++ b/content/docs/references/auth/config/AuthPluginConfig.mdx @@ -1,8 +1,18 @@ --- title: AuthPluginConfig description: AuthPluginConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: AuthPluginConfig Schema Reference | **name** | `string` | ✅ | Plugin name | | **enabled** | `boolean` | optional | | | **options** | `Record` | optional | Plugin-specific options | + +## TypeScript Usage + +```typescript +import { AuthPluginConfigSchema } from '@objectstack/spec/auth'; +import type { AuthPluginConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = AuthPluginConfigSchema.parse(data); + +// Type-safe usage +const myAuthPluginConfig: AuthPluginConfig = { + name: 'name' +}; +``` + diff --git a/content/docs/references/auth/config/AuthStrategy.mdx b/content/docs/references/auth/config/AuthStrategy.mdx index 9baafb1ad..50fedf739 100644 --- a/content/docs/references/auth/config/AuthStrategy.mdx +++ b/content/docs/references/auth/config/AuthStrategy.mdx @@ -1,8 +1,18 @@ --- title: AuthStrategy description: AuthStrategy Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Allowed Values * `email_password` @@ -10,4 +20,14 @@ description: AuthStrategy Schema Reference * `oauth` * `passkey` * `otp` -* `anonymous` \ No newline at end of file +* `anonymous` + +## TypeScript Usage + +```typescript +import { AuthStrategy } from '@objectstack/spec/auth'; + +// Type-safe enum value +const value: AuthStrategy = 'email_password'; +``` + diff --git a/content/docs/references/auth/config/CSRFConfig.mdx b/content/docs/references/auth/config/CSRFConfig.mdx index eba2dddf6..53d04c167 100644 --- a/content/docs/references/auth/config/CSRFConfig.mdx +++ b/content/docs/references/auth/config/CSRFConfig.mdx @@ -1,8 +1,18 @@ --- title: CSRFConfig description: CSRFConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: CSRFConfig Schema Reference | **tokenLength** | `number` | optional | CSRF token length | | **cookieName** | `string` | optional | CSRF cookie name | | **headerName** | `string` | optional | CSRF header name | + +## TypeScript Usage + +```typescript +import { CSRFConfigSchema } from '@objectstack/spec/auth'; +import type { CSRFConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = CSRFConfigSchema.parse(data); + +// Type-safe usage +const myCSRFConfig: CSRFConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/DatabaseAdapter.mdx b/content/docs/references/auth/config/DatabaseAdapter.mdx index 804f75b03..1cd259f84 100644 --- a/content/docs/references/auth/config/DatabaseAdapter.mdx +++ b/content/docs/references/auth/config/DatabaseAdapter.mdx @@ -1,8 +1,18 @@ --- title: DatabaseAdapter description: DatabaseAdapter Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: DatabaseAdapter Schema Reference | **connectionString** | `string` | optional | Database connection string | | **tablePrefix** | `string` | optional | Prefix for auth tables | | **schema** | `string` | optional | Database schema name | + +## TypeScript Usage + +```typescript +import { DatabaseAdapterSchema } from '@objectstack/spec/auth'; +import type { DatabaseAdapter } from '@objectstack/spec/auth'; + +// Validate data +const result = DatabaseAdapterSchema.parse(data); + +// Type-safe usage +const myDatabaseAdapter: DatabaseAdapter = { + type: 'prisma' +}; +``` + diff --git a/content/docs/references/auth/config/DatabaseMapping.mdx b/content/docs/references/auth/config/DatabaseMapping.mdx index b618a0b34..bb5e07d74 100644 --- a/content/docs/references/auth/config/DatabaseMapping.mdx +++ b/content/docs/references/auth/config/DatabaseMapping.mdx @@ -1,8 +1,18 @@ --- title: DatabaseMapping description: DatabaseMapping Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: DatabaseMapping Schema Reference | **session** | `Record` | optional | Session field mapping | | **account** | `Record` | optional | Account field mapping | | **verificationToken** | `Record` | optional | VerificationToken field mapping | + +## TypeScript Usage + +```typescript +import { DatabaseMappingSchema } from '@objectstack/spec/auth'; +import type { DatabaseMapping } from '@objectstack/spec/auth'; + +// Validate data +const result = DatabaseMappingSchema.parse(data); + +// Type-safe usage +const myDatabaseMapping: DatabaseMapping = { +}; +``` + diff --git a/content/docs/references/auth/config/EmailPasswordConfig.mdx b/content/docs/references/auth/config/EmailPasswordConfig.mdx index ed35be72f..56637f8a2 100644 --- a/content/docs/references/auth/config/EmailPasswordConfig.mdx +++ b/content/docs/references/auth/config/EmailPasswordConfig.mdx @@ -1,8 +1,18 @@ --- title: EmailPasswordConfig description: EmailPasswordConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: EmailPasswordConfig Schema Reference | **requirePasswordComplexity** | `boolean` | optional | Require uppercase, lowercase, numbers, symbols | | **allowPasswordReset** | `boolean` | optional | Enable password reset functionality | | **passwordResetExpiry** | `number` | optional | Password reset token expiry in seconds | + +## TypeScript Usage + +```typescript +import { EmailPasswordConfigSchema } from '@objectstack/spec/auth'; +import type { EmailPasswordConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = EmailPasswordConfigSchema.parse(data); + +// Type-safe usage +const myEmailPasswordConfig: EmailPasswordConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/EnterpriseAuthConfig.mdx b/content/docs/references/auth/config/EnterpriseAuthConfig.mdx index 10df64191..e6a48622b 100644 --- a/content/docs/references/auth/config/EnterpriseAuthConfig.mdx +++ b/content/docs/references/auth/config/EnterpriseAuthConfig.mdx @@ -1,8 +1,18 @@ --- title: EnterpriseAuthConfig description: EnterpriseAuthConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: EnterpriseAuthConfig Schema Reference | **oidc** | `object` | optional | OpenID Connect configuration | | **saml** | `object` | optional | SAML 2.0 configuration | | **ldap** | `object` | optional | LDAP/Active Directory configuration | + +## TypeScript Usage + +```typescript +import { EnterpriseAuthConfigSchema } from '@objectstack/spec/auth'; +import type { EnterpriseAuthConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = EnterpriseAuthConfigSchema.parse(data); + +// Type-safe usage +const myEnterpriseAuthConfig: EnterpriseAuthConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/LDAPConfig.mdx b/content/docs/references/auth/config/LDAPConfig.mdx index 1eb470eed..ba6ca03c2 100644 --- a/content/docs/references/auth/config/LDAPConfig.mdx +++ b/content/docs/references/auth/config/LDAPConfig.mdx @@ -1,8 +1,18 @@ --- title: LDAPConfig description: LDAPConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: LDAPConfig Schema Reference | **groupSearchBase** | `string` | optional | Group search base DN | | **displayName** | `string` | optional | Display name for the provider button | | **icon** | `string` | optional | Icon URL or identifier | + +## TypeScript Usage + +```typescript +import { LDAPConfigSchema } from '@objectstack/spec/auth'; +import type { LDAPConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = LDAPConfigSchema.parse(data); + +// Type-safe usage +const myLDAPConfig: LDAPConfig = { + url: 'https://example.com', + bindDn: 'example', + bindCredentials: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/config/MagicLinkConfig.mdx b/content/docs/references/auth/config/MagicLinkConfig.mdx index 2971b2862..20fd6f735 100644 --- a/content/docs/references/auth/config/MagicLinkConfig.mdx +++ b/content/docs/references/auth/config/MagicLinkConfig.mdx @@ -1,11 +1,36 @@ --- title: MagicLinkConfig description: MagicLinkConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **enabled** | `boolean` | optional | | | **expiryTime** | `number` | optional | Magic link expiry time in seconds (default 15 min) | + +## TypeScript Usage + +```typescript +import { MagicLinkConfigSchema } from '@objectstack/spec/auth'; +import type { MagicLinkConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = MagicLinkConfigSchema.parse(data); + +// Type-safe usage +const myMagicLinkConfig: MagicLinkConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/OAuthProvider.mdx b/content/docs/references/auth/config/OAuthProvider.mdx index 32ff86e83..e69e93afa 100644 --- a/content/docs/references/auth/config/OAuthProvider.mdx +++ b/content/docs/references/auth/config/OAuthProvider.mdx @@ -1,8 +1,18 @@ --- title: OAuthProvider description: OAuthProvider Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: OAuthProvider Schema Reference | **enabled** | `boolean` | optional | Whether this provider is enabled | | **displayName** | `string` | optional | Display name for the provider button | | **icon** | `string` | optional | Icon URL or identifier | + +## TypeScript Usage + +```typescript +import { OAuthProviderSchema } from '@objectstack/spec/auth'; +import type { OAuthProvider } from '@objectstack/spec/auth'; + +// Validate data +const result = OAuthProviderSchema.parse(data); + +// Type-safe usage +const myOAuthProvider: OAuthProvider = { + provider: 'google', + clientId: 'example', + clientSecret: 'example' +}; +``` + diff --git a/content/docs/references/auth/config/OIDCConfig.mdx b/content/docs/references/auth/config/OIDCConfig.mdx index 6b78913d1..f7e360a86 100644 --- a/content/docs/references/auth/config/OIDCConfig.mdx +++ b/content/docs/references/auth/config/OIDCConfig.mdx @@ -1,8 +1,18 @@ --- title: OIDCConfig description: OIDCConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: OIDCConfig Schema Reference | **attributeMapping** | `Record` | optional | Map IdP claims to User fields | | **displayName** | `string` | optional | Display name for the provider button | | **icon** | `string` | optional | Icon URL or identifier | + +## TypeScript Usage + +```typescript +import { OIDCConfigSchema } from '@objectstack/spec/auth'; +import type { OIDCConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = OIDCConfigSchema.parse(data); + +// Type-safe usage +const myOIDCConfig: OIDCConfig = { + issuer: 'example', + clientId: 'example', + clientSecret: 'example' +}; +``` + diff --git a/content/docs/references/auth/config/PasskeyConfig.mdx b/content/docs/references/auth/config/PasskeyConfig.mdx index 9e305ed4c..bd5448afb 100644 --- a/content/docs/references/auth/config/PasskeyConfig.mdx +++ b/content/docs/references/auth/config/PasskeyConfig.mdx @@ -1,8 +1,18 @@ --- title: PasskeyConfig description: PasskeyConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,19 @@ description: PasskeyConfig Schema Reference | **allowedOrigins** | `string[]` | optional | Allowed origins for WebAuthn | | **userVerification** | `Enum<'required' \| 'preferred' \| 'discouraged'>` | optional | | | **attestation** | `Enum<'none' \| 'indirect' \| 'direct' \| 'enterprise'>` | optional | | + +## TypeScript Usage + +```typescript +import { PasskeyConfigSchema } from '@objectstack/spec/auth'; +import type { PasskeyConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = PasskeyConfigSchema.parse(data); + +// Type-safe usage +const myPasskeyConfig: PasskeyConfig = { + rpName: 'example' +}; +``` + diff --git a/content/docs/references/auth/config/RateLimitConfig.mdx b/content/docs/references/auth/config/RateLimitConfig.mdx index 6682505c5..033db0195 100644 --- a/content/docs/references/auth/config/RateLimitConfig.mdx +++ b/content/docs/references/auth/config/RateLimitConfig.mdx @@ -1,8 +1,18 @@ --- title: RateLimitConfig description: RateLimitConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,18 @@ description: RateLimitConfig Schema Reference | **windowMs** | `number` | optional | Time window in milliseconds (default 15 min) | | **blockDuration** | `number` | optional | Block duration after max attempts in ms | | **skipSuccessfulRequests** | `boolean` | optional | Only count failed requests | + +## TypeScript Usage + +```typescript +import { RateLimitConfigSchema } from '@objectstack/spec/auth'; +import type { RateLimitConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = RateLimitConfigSchema.parse(data); + +// Type-safe usage +const myRateLimitConfig: RateLimitConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/SAMLConfig.mdx b/content/docs/references/auth/config/SAMLConfig.mdx index 6a25ee832..3cfa1bf53 100644 --- a/content/docs/references/auth/config/SAMLConfig.mdx +++ b/content/docs/references/auth/config/SAMLConfig.mdx @@ -1,8 +1,18 @@ --- title: SAMLConfig description: SAMLConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: SAMLConfig Schema Reference | **attributeMapping** | `Record` | optional | Map SAML attributes to User fields | | **displayName** | `string` | optional | Display name for the provider button | | **icon** | `string` | optional | Icon URL or identifier | + +## TypeScript Usage + +```typescript +import { SAMLConfigSchema } from '@objectstack/spec/auth'; +import type { SAMLConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = SAMLConfigSchema.parse(data); + +// Type-safe usage +const mySAMLConfig: SAMLConfig = { + entryPoint: 'example', + cert: 'example', + issuer: 'example' +}; +``` + diff --git a/content/docs/references/auth/config/SessionConfig.mdx b/content/docs/references/auth/config/SessionConfig.mdx index 5fb4b1c25..7659f28c1 100644 --- a/content/docs/references/auth/config/SessionConfig.mdx +++ b/content/docs/references/auth/config/SessionConfig.mdx @@ -1,8 +1,18 @@ --- title: SessionConfig description: SessionConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: SessionConfig Schema Reference | **cookieDomain** | `string` | optional | Cookie domain | | **cookiePath** | `string` | optional | Cookie path | | **cookieHttpOnly** | `boolean` | optional | HttpOnly cookie attribute | + +## TypeScript Usage + +```typescript +import { SessionConfigSchema } from '@objectstack/spec/auth'; +import type { SessionConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = SessionConfigSchema.parse(data); + +// Type-safe usage +const mySessionConfig: SessionConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/StandardAuthProvider.mdx b/content/docs/references/auth/config/StandardAuthProvider.mdx index fdc46136f..5337f42c2 100644 --- a/content/docs/references/auth/config/StandardAuthProvider.mdx +++ b/content/docs/references/auth/config/StandardAuthProvider.mdx @@ -1,11 +1,38 @@ --- title: StandardAuthProvider description: StandardAuthProvider Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **type** | `string` | ✅ | Provider type identifier | | **config** | `object` | ✅ | Standard authentication configuration | + +## TypeScript Usage + +```typescript +import { StandardAuthProviderSchema } from '@objectstack/spec/auth'; +import type { StandardAuthProvider } from '@objectstack/spec/auth'; + +// Validate data +const result = StandardAuthProviderSchema.parse(data); + +// Type-safe usage +const myStandardAuthProvider: StandardAuthProvider = { + type: 'example', + config: {} +}; +``` + diff --git a/content/docs/references/auth/config/TwoFactorConfig.mdx b/content/docs/references/auth/config/TwoFactorConfig.mdx index 70add73db..6004f0d12 100644 --- a/content/docs/references/auth/config/TwoFactorConfig.mdx +++ b/content/docs/references/auth/config/TwoFactorConfig.mdx @@ -1,8 +1,18 @@ --- title: TwoFactorConfig description: TwoFactorConfig Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: TwoFactorConfig Schema Reference | **issuer** | `string` | optional | TOTP issuer name | | **qrCodeSize** | `number` | optional | QR code size in pixels | | **backupCodes** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { TwoFactorConfigSchema } from '@objectstack/spec/auth'; +import type { TwoFactorConfig } from '@objectstack/spec/auth'; + +// Validate data +const result = TwoFactorConfigSchema.parse(data); + +// Type-safe usage +const myTwoFactorConfig: TwoFactorConfig = { +}; +``` + diff --git a/content/docs/references/auth/config/UserFieldMapping.mdx b/content/docs/references/auth/config/UserFieldMapping.mdx index bfbf94d14..8eb2da656 100644 --- a/content/docs/references/auth/config/UserFieldMapping.mdx +++ b/content/docs/references/auth/config/UserFieldMapping.mdx @@ -1,8 +1,18 @@ --- title: UserFieldMapping description: UserFieldMapping Schema Reference +category: auth +zodFile: config --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,18 @@ description: UserFieldMapping Schema Reference | **emailVerified** | `string` | optional | Email verification status field | | **createdAt** | `string` | optional | Created timestamp field | | **updatedAt** | `string` | optional | Updated timestamp field | + +## TypeScript Usage + +```typescript +import { UserFieldMappingSchema } from '@objectstack/spec/auth'; +import type { UserFieldMapping } from '@objectstack/spec/auth'; + +// Validate data +const result = UserFieldMappingSchema.parse(data); + +// Type-safe usage +const myUserFieldMapping: UserFieldMapping = { +}; +``` + diff --git a/content/docs/references/auth/identity/Account.mdx b/content/docs/references/auth/identity/Account.mdx index 541739381..01d29500e 100644 --- a/content/docs/references/auth/identity/Account.mdx +++ b/content/docs/references/auth/identity/Account.mdx @@ -1,8 +1,18 @@ --- title: Account description: Account Schema Reference +category: auth +zodFile: identity --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/identity.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,22 @@ description: Account Schema Reference | **sessionState** | `string` | optional | Session state | | **createdAt** | `string` | ✅ | Account creation timestamp | | **updatedAt** | `string` | ✅ | Last update timestamp | + +## TypeScript Usage + +```typescript +import { AccountSchema } from '@objectstack/spec/auth'; +import type { Account } from '@objectstack/spec/auth'; + +// Validate data +const result = AccountSchema.parse(data); + +// Type-safe usage +const myAccount: Account = { + id: 'example', + userId: 'example', + type: 'oauth', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/identity/Session.mdx b/content/docs/references/auth/identity/Session.mdx index 8423d852a..68d98eeaf 100644 --- a/content/docs/references/auth/identity/Session.mdx +++ b/content/docs/references/auth/identity/Session.mdx @@ -1,8 +1,18 @@ --- title: Session description: Session Schema Reference +category: auth +zodFile: identity --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/identity.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,22 @@ description: Session Schema Reference | **ipAddress** | `string` | optional | IP address | | **userAgent** | `string` | optional | User agent string | | **fingerprint** | `string` | optional | Device fingerprint | + +## TypeScript Usage + +```typescript +import { SessionSchema } from '@objectstack/spec/auth'; +import type { Session } from '@objectstack/spec/auth'; + +// Validate data +const result = SessionSchema.parse(data); + +// Type-safe usage +const mySession: Session = { + id: 'example', + sessionToken: 'example', + userId: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/identity/User.mdx b/content/docs/references/auth/identity/User.mdx index baae4accc..2c19402d7 100644 --- a/content/docs/references/auth/identity/User.mdx +++ b/content/docs/references/auth/identity/User.mdx @@ -1,8 +1,18 @@ --- title: User description: User Schema Reference +category: auth +zodFile: identity --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/identity.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: User Schema Reference | **image** | `string` | optional | Profile image URL | | **createdAt** | `string` | ✅ | Account creation timestamp | | **updatedAt** | `string` | ✅ | Last update timestamp | + +## TypeScript Usage + +```typescript +import { UserSchema } from '@objectstack/spec/auth'; +import type { User } from '@objectstack/spec/auth'; + +// Validate data +const result = UserSchema.parse(data); + +// Type-safe usage +const myUser: User = { + id: 'example', + email: 'user@example.com', + createdAt: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/identity/VerificationToken.mdx b/content/docs/references/auth/identity/VerificationToken.mdx index ee5f9d034..b67f5a267 100644 --- a/content/docs/references/auth/identity/VerificationToken.mdx +++ b/content/docs/references/auth/identity/VerificationToken.mdx @@ -1,8 +1,18 @@ --- title: VerificationToken description: VerificationToken Schema Reference +category: auth +zodFile: identity --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/identity.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,22 @@ description: VerificationToken Schema Reference | **token** | `string` | ✅ | Verification token | | **expires** | `string` | ✅ | Token expiry timestamp | | **createdAt** | `string` | ✅ | Token creation timestamp | + +## TypeScript Usage + +```typescript +import { VerificationTokenSchema } from '@objectstack/spec/auth'; +import type { VerificationToken } from '@objectstack/spec/auth'; + +// Validate data +const result = VerificationTokenSchema.parse(data); + +// Type-safe usage +const myVerificationToken: VerificationToken = { + identifier: 'example', + token: 'example', + expires: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/index.mdx b/content/docs/references/auth/index.mdx new file mode 100644 index 000000000..117411ac1 --- /dev/null +++ b/content/docs/references/auth/index.mdx @@ -0,0 +1,102 @@ +--- +title: Auth Protocol Overview +description: Complete reference for all auth protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# Auth Protocol + +This section contains all protocol schemas for the auth layer of ObjectStack. + +## Config + +Source: `packages/spec/src/auth/config.zod.ts` + + + + + + + + + + + + + + + + + + + + + + + + +## Identity + +Source: `packages/spec/src/auth/identity.zod.ts` + + + + + + + + +## Organization + +Source: `packages/spec/src/auth/organization.zod.ts` + + + + + + + + +## Policy + +Source: `packages/spec/src/auth/policy.zod.ts` + + + + + + + + + +## Role + +Source: `packages/spec/src/auth/role.zod.ts` + + + + + +## Scim + +Source: `packages/spec/src/auth/scim.zod.ts` + + + + + + + + + + + + + + + + + + diff --git a/content/docs/references/auth/organization/Invitation.mdx b/content/docs/references/auth/organization/Invitation.mdx index 6b1dc9901..9df3c51cd 100644 --- a/content/docs/references/auth/organization/Invitation.mdx +++ b/content/docs/references/auth/organization/Invitation.mdx @@ -1,8 +1,18 @@ --- title: Invitation description: Invitation Schema Reference +category: auth +zodFile: organization --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/organization.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: Invitation Schema Reference | **inviterId** | `string` | ✅ | User ID of the inviter | | **createdAt** | `string` | ✅ | Invitation creation timestamp | | **updatedAt** | `string` | ✅ | Last update timestamp | + +## TypeScript Usage + +```typescript +import { InvitationSchema } from '@objectstack/spec/auth'; +import type { Invitation } from '@objectstack/spec/auth'; + +// Validate data +const result = InvitationSchema.parse(data); + +// Type-safe usage +const myInvitation: Invitation = { + id: 'example', + organizationId: 'example', + email: 'user@example.com', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/organization/InvitationStatus.mdx b/content/docs/references/auth/organization/InvitationStatus.mdx index 8969996d1..7f5eedacb 100644 --- a/content/docs/references/auth/organization/InvitationStatus.mdx +++ b/content/docs/references/auth/organization/InvitationStatus.mdx @@ -1,11 +1,31 @@ --- title: InvitationStatus description: InvitationStatus Schema Reference +category: auth +zodFile: organization --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/organization.zod.ts` + + ## Allowed Values * `pending` * `accepted` * `rejected` -* `expired` \ No newline at end of file +* `expired` + +## TypeScript Usage + +```typescript +import { InvitationStatus } from '@objectstack/spec/auth'; + +// Type-safe enum value +const value: InvitationStatus = 'pending'; +``` + diff --git a/content/docs/references/auth/organization/Member.mdx b/content/docs/references/auth/organization/Member.mdx index f02aac973..6bd6e7a25 100644 --- a/content/docs/references/auth/organization/Member.mdx +++ b/content/docs/references/auth/organization/Member.mdx @@ -1,8 +1,18 @@ --- title: Member description: Member Schema Reference +category: auth +zodFile: organization --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/organization.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: Member Schema Reference | **role** | `string` | ✅ | Member role (e.g., owner, admin, member, guest) | | **createdAt** | `string` | ✅ | Member creation timestamp | | **updatedAt** | `string` | ✅ | Last update timestamp | + +## TypeScript Usage + +```typescript +import { MemberSchema } from '@objectstack/spec/auth'; +import type { Member } from '@objectstack/spec/auth'; + +// Validate data +const result = MemberSchema.parse(data); + +// Type-safe usage +const myMember: Member = { + id: 'example', + organizationId: 'example', + userId: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/organization/Organization.mdx b/content/docs/references/auth/organization/Organization.mdx index 5afbfecce..581ef86b2 100644 --- a/content/docs/references/auth/organization/Organization.mdx +++ b/content/docs/references/auth/organization/Organization.mdx @@ -1,8 +1,18 @@ --- title: Organization description: Organization Schema Reference +category: auth +zodFile: organization --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/organization.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: Organization Schema Reference | **metadata** | `Record` | optional | Custom metadata | | **createdAt** | `string` | ✅ | Organization creation timestamp | | **updatedAt** | `string` | ✅ | Last update timestamp | + +## TypeScript Usage + +```typescript +import { OrganizationSchema } from '@objectstack/spec/auth'; +import type { Organization } from '@objectstack/spec/auth'; + +// Validate data +const result = OrganizationSchema.parse(data); + +// Type-safe usage +const myOrganization: Organization = { + id: 'example', + name: 'name', + slug: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/auth/policy/AuditPolicy.mdx b/content/docs/references/auth/policy/AuditPolicy.mdx index 9dd0106f9..bc70cc5ba 100644 --- a/content/docs/references/auth/policy/AuditPolicy.mdx +++ b/content/docs/references/auth/policy/AuditPolicy.mdx @@ -1,8 +1,18 @@ --- title: AuditPolicy description: AuditPolicy Schema Reference +category: auth +zodFile: policy --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/policy.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: AuditPolicy Schema Reference | **logRetentionDays** | `number` | optional | | | **sensitiveFields** | `string[]` | ✅ | Fields to redact in logs (e.g. password, ssn) | | **captureRead** | `boolean` | optional | Log read access (High volume!) | + +## TypeScript Usage + +```typescript +import { AuditPolicySchema } from '@objectstack/spec/auth'; +import type { AuditPolicy } from '@objectstack/spec/auth'; + +// Validate data +const result = AuditPolicySchema.parse(data); + +// Type-safe usage +const myAuditPolicy: AuditPolicy = { + sensitiveFields: [] +}; +``` + diff --git a/content/docs/references/auth/policy/NetworkPolicy.mdx b/content/docs/references/auth/policy/NetworkPolicy.mdx index ce0112852..65d16368a 100644 --- a/content/docs/references/auth/policy/NetworkPolicy.mdx +++ b/content/docs/references/auth/policy/NetworkPolicy.mdx @@ -1,8 +1,18 @@ --- title: NetworkPolicy description: NetworkPolicy Schema Reference +category: auth +zodFile: policy --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/policy.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: NetworkPolicy Schema Reference | **trustedRanges** | `string[]` | ✅ | CIDR ranges allowed to access (e.g. 10.0.0.0/8) | | **blockUnknown** | `boolean` | optional | Block all IPs not in trusted ranges | | **vpnRequired** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { NetworkPolicySchema } from '@objectstack/spec/auth'; +import type { NetworkPolicy } from '@objectstack/spec/auth'; + +// Validate data +const result = NetworkPolicySchema.parse(data); + +// Type-safe usage +const myNetworkPolicy: NetworkPolicy = { + trustedRanges: [] +}; +``` + diff --git a/content/docs/references/auth/policy/PasswordPolicy.mdx b/content/docs/references/auth/policy/PasswordPolicy.mdx index 7d23bd06c..5e281649f 100644 --- a/content/docs/references/auth/policy/PasswordPolicy.mdx +++ b/content/docs/references/auth/policy/PasswordPolicy.mdx @@ -1,8 +1,18 @@ --- title: PasswordPolicy description: PasswordPolicy Schema Reference +category: auth +zodFile: policy --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/policy.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,18 @@ description: PasswordPolicy Schema Reference | **requireSymbols** | `boolean` | optional | | | **expirationDays** | `number` | optional | Force password change every X days | | **historyCount** | `number` | optional | Prevent reusing last X passwords | + +## TypeScript Usage + +```typescript +import { PasswordPolicySchema } from '@objectstack/spec/auth'; +import type { PasswordPolicy } from '@objectstack/spec/auth'; + +// Validate data +const result = PasswordPolicySchema.parse(data); + +// Type-safe usage +const myPasswordPolicy: PasswordPolicy = { +}; +``` + diff --git a/content/docs/references/auth/policy/Policy.mdx b/content/docs/references/auth/policy/Policy.mdx index c143fef9e..620a85b69 100644 --- a/content/docs/references/auth/policy/Policy.mdx +++ b/content/docs/references/auth/policy/Policy.mdx @@ -1,8 +1,18 @@ --- title: Policy description: Policy Schema Reference +category: auth +zodFile: policy --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/policy.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,19 @@ description: Policy Schema Reference | **audit** | `object` | optional | | | **isDefault** | `boolean` | optional | Apply to all users by default | | **assignedProfiles** | `string[]` | optional | Apply to specific profiles | + +## TypeScript Usage + +```typescript +import { PolicySchema } from '@objectstack/spec/auth'; +import type { Policy } from '@objectstack/spec/auth'; + +// Validate data +const result = PolicySchema.parse(data); + +// Type-safe usage +const myPolicy: Policy = { + name: 'name' +}; +``` + diff --git a/content/docs/references/auth/policy/SessionPolicy.mdx b/content/docs/references/auth/policy/SessionPolicy.mdx index da62e84af..0481fa710 100644 --- a/content/docs/references/auth/policy/SessionPolicy.mdx +++ b/content/docs/references/auth/policy/SessionPolicy.mdx @@ -1,8 +1,18 @@ --- title: SessionPolicy description: SessionPolicy Schema Reference +category: auth +zodFile: policy --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/policy.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: SessionPolicy Schema Reference | **idleTimeout** | `number` | optional | Minutes before idle session logout | | **absoluteTimeout** | `number` | optional | Max session duration (minutes) | | **forceMfa** | `boolean` | optional | Require 2FA for all users | + +## TypeScript Usage + +```typescript +import { SessionPolicySchema } from '@objectstack/spec/auth'; +import type { SessionPolicy } from '@objectstack/spec/auth'; + +// Validate data +const result = SessionPolicySchema.parse(data); + +// Type-safe usage +const mySessionPolicy: SessionPolicy = { +}; +``` + diff --git a/content/docs/references/auth/role/Role.mdx b/content/docs/references/auth/role/Role.mdx index ad088d0f7..489b70e13 100644 --- a/content/docs/references/auth/role/Role.mdx +++ b/content/docs/references/auth/role/Role.mdx @@ -1,8 +1,18 @@ --- title: Role description: Role Schema Reference +category: auth +zodFile: role --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/role.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: Role Schema Reference | **label** | `string` | ✅ | Display label (e.g. VP of Sales) | | **parent** | `string` | optional | Parent Role ID (Reports To) | | **description** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { RoleSchema } from '@objectstack/spec/auth'; +import type { Role } from '@objectstack/spec/auth'; + +// Validate data +const result = RoleSchema.parse(data); + +// Type-safe usage +const myRole: Role = { + name: 'name', + label: 'example' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMAddress.mdx b/content/docs/references/auth/scim/SCIMAddress.mdx index d7af19716..db9f2825f 100644 --- a/content/docs/references/auth/scim/SCIMAddress.mdx +++ b/content/docs/references/auth/scim/SCIMAddress.mdx @@ -1,8 +1,18 @@ --- title: SCIMAddress description: SCIMAddress Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: SCIMAddress Schema Reference | **country** | `string` | optional | Country | | **type** | `Enum<'work' \| 'home' \| 'other'>` | optional | Address type | | **primary** | `boolean` | optional | Primary address indicator | + +## TypeScript Usage + +```typescript +import { SCIMAddressSchema } from '@objectstack/spec/auth'; +import type { SCIMAddress } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMAddressSchema.parse(data); + +// Type-safe usage +const mySCIMAddress: SCIMAddress = { +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMEmail.mdx b/content/docs/references/auth/scim/SCIMEmail.mdx index 8ac77c635..083d3ddde 100644 --- a/content/docs/references/auth/scim/SCIMEmail.mdx +++ b/content/docs/references/auth/scim/SCIMEmail.mdx @@ -1,8 +1,18 @@ --- title: SCIMEmail description: SCIMEmail Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: SCIMEmail Schema Reference | **type** | `Enum<'work' \| 'home' \| 'other'>` | optional | Email type | | **display** | `string` | optional | Display label | | **primary** | `boolean` | optional | Primary email indicator | + +## TypeScript Usage + +```typescript +import { SCIMEmailSchema } from '@objectstack/spec/auth'; +import type { SCIMEmail } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMEmailSchema.parse(data); + +// Type-safe usage +const mySCIMEmail: SCIMEmail = { + value: 'example' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx b/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx index 4d9bf5e38..109977634 100644 --- a/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx +++ b/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx @@ -1,8 +1,18 @@ --- title: SCIMEnterpriseUser description: SCIMEnterpriseUser Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: SCIMEnterpriseUser Schema Reference | **division** | `string` | optional | Division | | **department** | `string` | optional | Department | | **manager** | `object` | optional | Manager reference | + +## TypeScript Usage + +```typescript +import { SCIMEnterpriseUserSchema } from '@objectstack/spec/auth'; +import type { SCIMEnterpriseUser } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMEnterpriseUserSchema.parse(data); + +// Type-safe usage +const mySCIMEnterpriseUser: SCIMEnterpriseUser = { +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMError.mdx b/content/docs/references/auth/scim/SCIMError.mdx index 11c12b1f6..496a0b613 100644 --- a/content/docs/references/auth/scim/SCIMError.mdx +++ b/content/docs/references/auth/scim/SCIMError.mdx @@ -1,8 +1,18 @@ --- title: SCIMError description: SCIMError Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: SCIMError Schema Reference | **status** | `integer` | ✅ | HTTP status code | | **scimType** | `Enum<'invalidFilter' \| 'tooMany' \| 'uniqueness' \| 'mutability' \| 'invalidSyntax' \| 'invalidPath' \| 'noTarget' \| 'invalidValue' \| 'invalidVers' \| 'sensitive'>` | optional | SCIM error type | | **detail** | `string` | optional | Error detail message | + +## TypeScript Usage + +```typescript +import { SCIMErrorSchema } from '@objectstack/spec/auth'; +import type { SCIMError } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMErrorSchema.parse(data); + +// Type-safe usage +const mySCIMError: SCIMError = { + status: null +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMGroup.mdx b/content/docs/references/auth/scim/SCIMGroup.mdx index 73e6d24e7..cfedeb567 100644 --- a/content/docs/references/auth/scim/SCIMGroup.mdx +++ b/content/docs/references/auth/scim/SCIMGroup.mdx @@ -1,8 +1,18 @@ --- title: SCIMGroup description: SCIMGroup Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,19 @@ description: SCIMGroup Schema Reference | **displayName** | `string` | ✅ | Group display name (REQUIRED) | | **members** | `object[]` | optional | Group members | | **meta** | `object` | optional | Resource metadata | + +## TypeScript Usage + +```typescript +import { SCIMGroupSchema } from '@objectstack/spec/auth'; +import type { SCIMGroup } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMGroupSchema.parse(data); + +// Type-safe usage +const mySCIMGroup: SCIMGroup = { + displayName: 'example' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMGroupReference.mdx b/content/docs/references/auth/scim/SCIMGroupReference.mdx index 5a9458643..372361ea2 100644 --- a/content/docs/references/auth/scim/SCIMGroupReference.mdx +++ b/content/docs/references/auth/scim/SCIMGroupReference.mdx @@ -1,8 +1,18 @@ --- title: SCIMGroupReference description: SCIMGroupReference Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: SCIMGroupReference Schema Reference | **$ref** | `string` | optional | URI reference to the group | | **display** | `string` | optional | Group display name | | **type** | `Enum<'direct' \| 'indirect'>` | optional | Membership type | + +## TypeScript Usage + +```typescript +import { SCIMGroupReferenceSchema } from '@objectstack/spec/auth'; +import type { SCIMGroupReference } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMGroupReferenceSchema.parse(data); + +// Type-safe usage +const mySCIMGroupReference: SCIMGroupReference = { + value: 'example' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMListResponse.mdx b/content/docs/references/auth/scim/SCIMListResponse.mdx index 5c0f6d2c8..95df17a02 100644 --- a/content/docs/references/auth/scim/SCIMListResponse.mdx +++ b/content/docs/references/auth/scim/SCIMListResponse.mdx @@ -1,8 +1,18 @@ --- title: SCIMListResponse description: SCIMListResponse Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: SCIMListResponse Schema Reference | **Resources** | `object \| object \| Record[]` | ✅ | Resources array (Users, Groups, or custom resources) | | **startIndex** | `integer` | optional | Start index (1-based) | | **itemsPerPage** | `integer` | optional | Items per page | + +## TypeScript Usage + +```typescript +import { SCIMListResponseSchema } from '@objectstack/spec/auth'; +import type { SCIMListResponse } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMListResponseSchema.parse(data); + +// Type-safe usage +const mySCIMListResponse: SCIMListResponse = { + totalResults: null, + Resources: [] +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMMemberReference.mdx b/content/docs/references/auth/scim/SCIMMemberReference.mdx index e2e05e926..fc78efdff 100644 --- a/content/docs/references/auth/scim/SCIMMemberReference.mdx +++ b/content/docs/references/auth/scim/SCIMMemberReference.mdx @@ -1,8 +1,18 @@ --- title: SCIMMemberReference description: SCIMMemberReference Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: SCIMMemberReference Schema Reference | **$ref** | `string` | optional | URI reference to the member | | **type** | `Enum<'User' \| 'Group'>` | optional | Member type | | **display** | `string` | optional | Member display name | + +## TypeScript Usage + +```typescript +import { SCIMMemberReferenceSchema } from '@objectstack/spec/auth'; +import type { SCIMMemberReference } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMMemberReferenceSchema.parse(data); + +// Type-safe usage +const mySCIMMemberReference: SCIMMemberReference = { + value: 'example' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMMeta.mdx b/content/docs/references/auth/scim/SCIMMeta.mdx index 919cb861b..054424b84 100644 --- a/content/docs/references/auth/scim/SCIMMeta.mdx +++ b/content/docs/references/auth/scim/SCIMMeta.mdx @@ -1,8 +1,18 @@ --- title: SCIMMeta description: SCIMMeta Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,18 @@ description: SCIMMeta Schema Reference | **lastModified** | `string` | optional | Last modification timestamp | | **location** | `string` | optional | Resource location URI | | **version** | `string` | optional | Entity tag (ETag) for concurrency control | + +## TypeScript Usage + +```typescript +import { SCIMMetaSchema } from '@objectstack/spec/auth'; +import type { SCIMMeta } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMMetaSchema.parse(data); + +// Type-safe usage +const mySCIMMeta: SCIMMeta = { +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMName.mdx b/content/docs/references/auth/scim/SCIMName.mdx index 7947a0cdf..ac4ca9066 100644 --- a/content/docs/references/auth/scim/SCIMName.mdx +++ b/content/docs/references/auth/scim/SCIMName.mdx @@ -1,8 +1,18 @@ --- title: SCIMName description: SCIMName Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: SCIMName Schema Reference | **middleName** | `string` | optional | Middle name | | **honorificPrefix** | `string` | optional | Honorific prefix (Mr., Ms., Dr.) | | **honorificSuffix** | `string` | optional | Honorific suffix (Jr., Sr.) | + +## TypeScript Usage + +```typescript +import { SCIMNameSchema } from '@objectstack/spec/auth'; +import type { SCIMName } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMNameSchema.parse(data); + +// Type-safe usage +const mySCIMName: SCIMName = { +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMPatchOperation.mdx b/content/docs/references/auth/scim/SCIMPatchOperation.mdx index 2d92e6839..2f01fb513 100644 --- a/content/docs/references/auth/scim/SCIMPatchOperation.mdx +++ b/content/docs/references/auth/scim/SCIMPatchOperation.mdx @@ -1,8 +1,18 @@ --- title: SCIMPatchOperation description: SCIMPatchOperation Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: SCIMPatchOperation Schema Reference | **op** | `Enum<'add' \| 'remove' \| 'replace'>` | ✅ | Operation type | | **path** | `string` | optional | Attribute path (optional for add) | | **value** | `any` | optional | Value to set | + +## TypeScript Usage + +```typescript +import { SCIMPatchOperationSchema } from '@objectstack/spec/auth'; +import type { SCIMPatchOperation } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMPatchOperationSchema.parse(data); + +// Type-safe usage +const mySCIMPatchOperation: SCIMPatchOperation = { + op: 'add' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMPatchRequest.mdx b/content/docs/references/auth/scim/SCIMPatchRequest.mdx index 17180da9f..bdc7916f4 100644 --- a/content/docs/references/auth/scim/SCIMPatchRequest.mdx +++ b/content/docs/references/auth/scim/SCIMPatchRequest.mdx @@ -1,11 +1,37 @@ --- title: SCIMPatchRequest description: SCIMPatchRequest Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **schemas** | `string[]` | optional | SCIM schema URIs | | **Operations** | `object[]` | ✅ | Patch operations | + +## TypeScript Usage + +```typescript +import { SCIMPatchRequestSchema } from '@objectstack/spec/auth'; +import type { SCIMPatchRequest } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMPatchRequestSchema.parse(data); + +// Type-safe usage +const mySCIMPatchRequest: SCIMPatchRequest = { + Operations: [] +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMPhoneNumber.mdx b/content/docs/references/auth/scim/SCIMPhoneNumber.mdx index 8bee2e021..607ffd374 100644 --- a/content/docs/references/auth/scim/SCIMPhoneNumber.mdx +++ b/content/docs/references/auth/scim/SCIMPhoneNumber.mdx @@ -1,8 +1,18 @@ --- title: SCIMPhoneNumber description: SCIMPhoneNumber Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: SCIMPhoneNumber Schema Reference | **type** | `Enum<'work' \| 'home' \| 'mobile' \| 'fax' \| 'pager' \| 'other'>` | optional | Phone number type | | **display** | `string` | optional | Display label | | **primary** | `boolean` | optional | Primary phone indicator | + +## TypeScript Usage + +```typescript +import { SCIMPhoneNumberSchema } from '@objectstack/spec/auth'; +import type { SCIMPhoneNumber } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMPhoneNumberSchema.parse(data); + +// Type-safe usage +const mySCIMPhoneNumber: SCIMPhoneNumber = { + value: 'example' +}; +``` + diff --git a/content/docs/references/auth/scim/SCIMUser.mdx b/content/docs/references/auth/scim/SCIMUser.mdx index 5c7cf2379..6e6108bc1 100644 --- a/content/docs/references/auth/scim/SCIMUser.mdx +++ b/content/docs/references/auth/scim/SCIMUser.mdx @@ -1,8 +1,18 @@ --- title: SCIMUser description: SCIMUser Schema Reference +category: auth +zodFile: scim --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -33,3 +43,19 @@ description: SCIMUser Schema Reference | **x509Certificates** | `object[]` | optional | X509 certificates | | **meta** | `object` | optional | Resource metadata | | **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** | `object` | optional | Enterprise user attributes | + +## TypeScript Usage + +```typescript +import { SCIMUserSchema } from '@objectstack/spec/auth'; +import type { SCIMUser } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMUserSchema.parse(data); + +// Type-safe usage +const mySCIMUser: SCIMUser = { + userName: 'example' +}; +``` + diff --git a/content/docs/references/automation/approval/ApprovalAction.mdx b/content/docs/references/automation/approval/ApprovalAction.mdx index 479cd8ab0..471b5d889 100644 --- a/content/docs/references/automation/approval/ApprovalAction.mdx +++ b/content/docs/references/automation/approval/ApprovalAction.mdx @@ -1,8 +1,18 @@ --- title: ApprovalAction description: ApprovalAction Schema Reference +category: automation +zodFile: approval --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/approval.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,21 @@ description: ApprovalAction Schema Reference | **type** | `Enum<'field_update' \| 'email_alert' \| 'webhook' \| 'script'>` | ✅ | | | **name** | `string` | ✅ | Action name | | **config** | `Record` | ✅ | Action configuration | + +## TypeScript Usage + +```typescript +import { ApprovalActionSchema } from '@objectstack/spec/automation'; +import type { ApprovalAction } from '@objectstack/spec/automation'; + +// Validate data +const result = ApprovalActionSchema.parse(data); + +// Type-safe usage +const myApprovalAction: ApprovalAction = { + type: 'field_update', + name: 'name', + config: {} +}; +``` + diff --git a/content/docs/references/automation/approval/ApprovalActionType.mdx b/content/docs/references/automation/approval/ApprovalActionType.mdx index d02ae2712..a58f83438 100644 --- a/content/docs/references/automation/approval/ApprovalActionType.mdx +++ b/content/docs/references/automation/approval/ApprovalActionType.mdx @@ -1,11 +1,31 @@ --- title: ApprovalActionType description: ApprovalActionType Schema Reference +category: automation +zodFile: approval --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/approval.zod.ts` + + ## Allowed Values * `field_update` * `email_alert` * `webhook` -* `script` \ No newline at end of file +* `script` + +## TypeScript Usage + +```typescript +import { ApprovalActionType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ApprovalActionType = 'field_update'; +``` + diff --git a/content/docs/references/automation/approval/ApprovalProcess.mdx b/content/docs/references/automation/approval/ApprovalProcess.mdx index 795fbf333..f7566bc34 100644 --- a/content/docs/references/automation/approval/ApprovalProcess.mdx +++ b/content/docs/references/automation/approval/ApprovalProcess.mdx @@ -1,8 +1,18 @@ --- title: ApprovalProcess description: ApprovalProcess Schema Reference +category: automation +zodFile: approval --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/approval.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -19,3 +29,22 @@ description: ApprovalProcess Schema Reference | **onFinalApprove** | `object[]` | optional | Actions on final approval | | **onFinalReject** | `object[]` | optional | Actions on final rejection | | **onRecall** | `object[]` | optional | Actions on recall | + +## TypeScript Usage + +```typescript +import { ApprovalProcessSchema } from '@objectstack/spec/automation'; +import type { ApprovalProcess } from '@objectstack/spec/automation'; + +// Validate data +const result = ApprovalProcessSchema.parse(data); + +// Type-safe usage +const myApprovalProcess: ApprovalProcess = { + name: 'name', + label: 'example', + object: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/approval/ApprovalStep.mdx b/content/docs/references/automation/approval/ApprovalStep.mdx index 595ee69bf..f219ca2cc 100644 --- a/content/docs/references/automation/approval/ApprovalStep.mdx +++ b/content/docs/references/automation/approval/ApprovalStep.mdx @@ -1,8 +1,18 @@ --- title: ApprovalStep description: ApprovalStep Schema Reference +category: automation +zodFile: approval --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/approval.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,21 @@ description: ApprovalStep Schema Reference | **rejectionBehavior** | `Enum<'reject_process' \| 'back_to_previous'>` | optional | What happens if rejected | | **onApprove** | `object[]` | optional | Actions on step approval | | **onReject** | `object[]` | optional | Actions on step rejection | + +## TypeScript Usage + +```typescript +import { ApprovalStepSchema } from '@objectstack/spec/automation'; +import type { ApprovalStep } from '@objectstack/spec/automation'; + +// Validate data +const result = ApprovalStepSchema.parse(data); + +// Type-safe usage +const myApprovalStep: ApprovalStep = { + name: 'name', + label: 'example', + approvers: [] +}; +``` + diff --git a/content/docs/references/automation/approval/ApproverType.mdx b/content/docs/references/automation/approval/ApproverType.mdx index 46374b980..6bde621d2 100644 --- a/content/docs/references/automation/approval/ApproverType.mdx +++ b/content/docs/references/automation/approval/ApproverType.mdx @@ -1,12 +1,32 @@ --- title: ApproverType description: ApproverType Schema Reference +category: automation +zodFile: approval --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/approval.zod.ts` + + ## Allowed Values * `user` * `role` * `manager` * `field` -* `queue` \ No newline at end of file +* `queue` + +## TypeScript Usage + +```typescript +import { ApproverType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ApproverType = 'user'; +``` + diff --git a/content/docs/references/automation/connector/AuthField.mdx b/content/docs/references/automation/connector/AuthField.mdx index 7b361e853..69aa1d293 100644 --- a/content/docs/references/automation/connector/AuthField.mdx +++ b/content/docs/references/automation/connector/AuthField.mdx @@ -1,8 +1,18 @@ --- title: AuthField description: AuthField Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,20 @@ description: AuthField Schema Reference | **default** | `string` | optional | Default value | | **options** | `object[]` | optional | Select field options | | **placeholder** | `string` | optional | Placeholder text | + +## TypeScript Usage + +```typescript +import { AuthFieldSchema } from '@objectstack/spec/automation'; +import type { AuthField } from '@objectstack/spec/automation'; + +// Validate data +const result = AuthFieldSchema.parse(data); + +// Type-safe usage +const myAuthField: AuthField = { + name: 'name', + label: 'example' +}; +``` + diff --git a/content/docs/references/automation/connector/Authentication.mdx b/content/docs/references/automation/connector/Authentication.mdx index 8f246e78f..bca0dbe59 100644 --- a/content/docs/references/automation/connector/Authentication.mdx +++ b/content/docs/references/automation/connector/Authentication.mdx @@ -1,8 +1,18 @@ --- title: Authentication description: Authentication Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: Authentication Schema Reference | **fields** | `object[]` | optional | Authentication fields | | **oauth2** | `object` | optional | OAuth 2.0 configuration | | **test** | `object` | optional | Authentication test configuration | + +## TypeScript Usage + +```typescript +import { AuthenticationSchema } from '@objectstack/spec/automation'; +import type { Authentication } from '@objectstack/spec/automation'; + +// Validate data +const result = AuthenticationSchema.parse(data); + +// Type-safe usage +const myAuthentication: Authentication = { + type: 'none' +}; +``` + diff --git a/content/docs/references/automation/connector/AuthenticationType.mdx b/content/docs/references/automation/connector/AuthenticationType.mdx index 62060107e..d0b391700 100644 --- a/content/docs/references/automation/connector/AuthenticationType.mdx +++ b/content/docs/references/automation/connector/AuthenticationType.mdx @@ -1,8 +1,18 @@ --- title: AuthenticationType description: AuthenticationType Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Allowed Values * `none` @@ -11,4 +21,14 @@ description: AuthenticationType Schema Reference * `bearer` * `oauth1` * `oauth2` -* `custom` \ No newline at end of file +* `custom` + +## TypeScript Usage + +```typescript +import { AuthenticationType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: AuthenticationType = 'none'; +``` + diff --git a/content/docs/references/automation/connector/Connector.mdx b/content/docs/references/automation/connector/Connector.mdx index 9d46fc79c..e8f72f489 100644 --- a/content/docs/references/automation/connector/Connector.mdx +++ b/content/docs/references/automation/connector/Connector.mdx @@ -1,8 +1,18 @@ --- title: Connector description: Connector Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -25,3 +35,22 @@ description: Connector Schema Reference | **tags** | `string[]` | optional | Connector tags | | **verified** | `boolean` | optional | Verified connector | | **metadata** | `Record` | optional | Custom metadata | + +## TypeScript Usage + +```typescript +import { ConnectorSchema } from '@objectstack/spec/automation'; +import type { Connector } from '@objectstack/spec/automation'; + +// Validate data +const result = ConnectorSchema.parse(data); + +// Type-safe usage +const myConnector: Connector = { + id: 'example', + name: 'name', + category: 'crm', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/connector/ConnectorCategory.mdx b/content/docs/references/automation/connector/ConnectorCategory.mdx index 93ad90f0c..6495211bf 100644 --- a/content/docs/references/automation/connector/ConnectorCategory.mdx +++ b/content/docs/references/automation/connector/ConnectorCategory.mdx @@ -1,8 +1,18 @@ --- title: ConnectorCategory description: ConnectorCategory Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Allowed Values * `crm` @@ -19,4 +29,14 @@ description: ConnectorCategory Schema Reference * `support` * `devtools` * `social` -* `other` \ No newline at end of file +* `other` + +## TypeScript Usage + +```typescript +import { ConnectorCategory } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ConnectorCategory = 'crm'; +``` + diff --git a/content/docs/references/automation/connector/ConnectorInstance.mdx b/content/docs/references/automation/connector/ConnectorInstance.mdx index 52799becd..ec61422b9 100644 --- a/content/docs/references/automation/connector/ConnectorInstance.mdx +++ b/content/docs/references/automation/connector/ConnectorInstance.mdx @@ -1,8 +1,18 @@ --- title: ConnectorInstance description: ConnectorInstance Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,22 @@ description: ConnectorInstance Schema Reference | **createdAt** | `string` | optional | Creation time | | **lastTestedAt** | `string` | optional | Last test time | | **testStatus** | `Enum<'unknown' \| 'success' \| 'failed'>` | optional | Connection test status | + +## TypeScript Usage + +```typescript +import { ConnectorInstanceSchema } from '@objectstack/spec/automation'; +import type { ConnectorInstance } from '@objectstack/spec/automation'; + +// Validate data +const result = ConnectorInstanceSchema.parse(data); + +// Type-safe usage +const myConnectorInstance: ConnectorInstance = { + id: 'example', + connectorId: 'example', + name: 'name', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/connector/ConnectorOperation.mdx b/content/docs/references/automation/connector/ConnectorOperation.mdx index d02607623..1e64b219c 100644 --- a/content/docs/references/automation/connector/ConnectorOperation.mdx +++ b/content/docs/references/automation/connector/ConnectorOperation.mdx @@ -1,8 +1,18 @@ --- title: ConnectorOperation description: ConnectorOperation Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,21 @@ description: ConnectorOperation Schema Reference | **sampleOutput** | `any` | optional | Sample output | | **supportsPagination** | `boolean` | optional | Supports pagination | | **supportsFiltering** | `boolean` | optional | Supports filtering | + +## TypeScript Usage + +```typescript +import { ConnectorOperationSchema } from '@objectstack/spec/automation'; +import type { ConnectorOperation } from '@objectstack/spec/automation'; + +// Validate data +const result = ConnectorOperationSchema.parse(data); + +// Type-safe usage +const myConnectorOperation: ConnectorOperation = { + id: 'example', + name: 'name', + type: 'read' +}; +``` + diff --git a/content/docs/references/automation/connector/ConnectorTrigger.mdx b/content/docs/references/automation/connector/ConnectorTrigger.mdx index 0e8f44d49..867b1fcf1 100644 --- a/content/docs/references/automation/connector/ConnectorTrigger.mdx +++ b/content/docs/references/automation/connector/ConnectorTrigger.mdx @@ -1,8 +1,18 @@ --- title: ConnectorTrigger description: ConnectorTrigger Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,21 @@ description: ConnectorTrigger Schema Reference | **config** | `Record` | optional | Trigger configuration | | **outputSchema** | `Record` | optional | Event payload schema | | **pollingIntervalMs** | `integer` | optional | Polling interval in ms | + +## TypeScript Usage + +```typescript +import { ConnectorTriggerSchema } from '@objectstack/spec/automation'; +import type { ConnectorTrigger } from '@objectstack/spec/automation'; + +// Validate data +const result = ConnectorTriggerSchema.parse(data); + +// Type-safe usage +const myConnectorTrigger: ConnectorTrigger = { + id: 'example', + name: 'name', + type: 'webhook' +}; +``` + diff --git a/content/docs/references/automation/connector/OAuth2Config.mdx b/content/docs/references/automation/connector/OAuth2Config.mdx index 56b9b7806..f785d10b1 100644 --- a/content/docs/references/automation/connector/OAuth2Config.mdx +++ b/content/docs/references/automation/connector/OAuth2Config.mdx @@ -1,8 +1,18 @@ --- title: OAuth2Config description: OAuth2Config Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: OAuth2Config Schema Reference | **scopes** | `string[]` | optional | OAuth scopes | | **clientIdField** | `string` | optional | Client ID field name | | **clientSecretField** | `string` | optional | Client secret field name | + +## TypeScript Usage + +```typescript +import { OAuth2ConfigSchema } from '@objectstack/spec/automation'; +import type { OAuth2Config } from '@objectstack/spec/automation'; + +// Validate data +const result = OAuth2ConfigSchema.parse(data); + +// Type-safe usage +const myOAuth2Config: OAuth2Config = { + authorizationUrl: 'example', + tokenUrl: 'example' +}; +``` + diff --git a/content/docs/references/automation/connector/OperationParameter.mdx b/content/docs/references/automation/connector/OperationParameter.mdx index 57a928a2e..5f2b73d14 100644 --- a/content/docs/references/automation/connector/OperationParameter.mdx +++ b/content/docs/references/automation/connector/OperationParameter.mdx @@ -1,8 +1,18 @@ --- title: OperationParameter description: OperationParameter Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: OperationParameter Schema Reference | **default** | `any` | optional | Default value | | **validation** | `Record` | optional | Validation rules | | **dynamicOptions** | `string` | optional | Function to load dynamic options | + +## TypeScript Usage + +```typescript +import { OperationParameterSchema } from '@objectstack/spec/automation'; +import type { OperationParameter } from '@objectstack/spec/automation'; + +// Validate data +const result = OperationParameterSchema.parse(data); + +// Type-safe usage +const myOperationParameter: OperationParameter = { + name: 'name', + label: 'example', + type: 'string' +}; +``` + diff --git a/content/docs/references/automation/connector/OperationType.mdx b/content/docs/references/automation/connector/OperationType.mdx index 4506104ca..0d8d6399e 100644 --- a/content/docs/references/automation/connector/OperationType.mdx +++ b/content/docs/references/automation/connector/OperationType.mdx @@ -1,8 +1,18 @@ --- title: OperationType description: OperationType Schema Reference +category: automation +zodFile: connector --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + ## Allowed Values * `read` @@ -10,4 +20,14 @@ description: OperationType Schema Reference * `delete` * `search` * `trigger` -* `action` \ No newline at end of file +* `action` + +## TypeScript Usage + +```typescript +import { OperationType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: OperationType = 'read'; +``` + diff --git a/content/docs/references/automation/etl/ETLDestination.mdx b/content/docs/references/automation/etl/ETLDestination.mdx index da14d10d1..bba08e19e 100644 --- a/content/docs/references/automation/etl/ETLDestination.mdx +++ b/content/docs/references/automation/etl/ETLDestination.mdx @@ -1,8 +1,18 @@ --- title: ETLDestination description: ETLDestination Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: ETLDestination Schema Reference | **config** | `Record` | ✅ | Destination configuration | | **writeMode** | `Enum<'append' \| 'overwrite' \| 'upsert' \| 'merge'>` | optional | How to write data | | **primaryKey** | `string[]` | optional | Primary key fields | + +## TypeScript Usage + +```typescript +import { ETLDestinationSchema } from '@objectstack/spec/automation'; +import type { ETLDestination } from '@objectstack/spec/automation'; + +// Validate data +const result = ETLDestinationSchema.parse(data); + +// Type-safe usage +const myETLDestination: ETLDestination = { + type: 'database', + config: {} +}; +``` + diff --git a/content/docs/references/automation/etl/ETLEndpointType.mdx b/content/docs/references/automation/etl/ETLEndpointType.mdx index e085179cd..c466df080 100644 --- a/content/docs/references/automation/etl/ETLEndpointType.mdx +++ b/content/docs/references/automation/etl/ETLEndpointType.mdx @@ -1,8 +1,18 @@ --- title: ETLEndpointType description: ETLEndpointType Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Allowed Values * `database` @@ -12,4 +22,14 @@ description: ETLEndpointType Schema Reference * `object` * `warehouse` * `storage` -* `spreadsheet` \ No newline at end of file +* `spreadsheet` + +## TypeScript Usage + +```typescript +import { ETLEndpointType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ETLEndpointType = 'database'; +``` + diff --git a/content/docs/references/automation/etl/ETLPipeline.mdx b/content/docs/references/automation/etl/ETLPipeline.mdx index 3bf4c3c79..a8a89b9af 100644 --- a/content/docs/references/automation/etl/ETLPipeline.mdx +++ b/content/docs/references/automation/etl/ETLPipeline.mdx @@ -1,8 +1,18 @@ --- title: ETLPipeline description: ETLPipeline Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,21 @@ description: ETLPipeline Schema Reference | **notifications** | `object` | optional | Notification settings | | **tags** | `string[]` | optional | Pipeline tags | | **metadata** | `Record` | optional | Custom metadata | + +## TypeScript Usage + +```typescript +import { ETLPipelineSchema } from '@objectstack/spec/automation'; +import type { ETLPipeline } from '@objectstack/spec/automation'; + +// Validate data +const result = ETLPipelineSchema.parse(data); + +// Type-safe usage +const myETLPipeline: ETLPipeline = { + name: 'name', + source: {}, + destination: {} +}; +``` + diff --git a/content/docs/references/automation/etl/ETLPipelineRun.mdx b/content/docs/references/automation/etl/ETLPipelineRun.mdx index 50d06bde7..f7a1bd191 100644 --- a/content/docs/references/automation/etl/ETLPipelineRun.mdx +++ b/content/docs/references/automation/etl/ETLPipelineRun.mdx @@ -1,8 +1,18 @@ --- title: ETLPipelineRun description: ETLPipelineRun Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: ETLPipelineRun Schema Reference | **stats** | `object` | optional | Run statistics | | **error** | `object` | optional | Error information | | **logs** | `string[]` | optional | Execution logs | + +## TypeScript Usage + +```typescript +import { ETLPipelineRunSchema } from '@objectstack/spec/automation'; +import type { ETLPipelineRun } from '@objectstack/spec/automation'; + +// Validate data +const result = ETLPipelineRunSchema.parse(data); + +// Type-safe usage +const myETLPipelineRun: ETLPipelineRun = { + id: 'example', + pipelineName: 'example', + status: 'pending', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/etl/ETLRunStatus.mdx b/content/docs/references/automation/etl/ETLRunStatus.mdx index a5c018d1e..2a48aac20 100644 --- a/content/docs/references/automation/etl/ETLRunStatus.mdx +++ b/content/docs/references/automation/etl/ETLRunStatus.mdx @@ -1,8 +1,18 @@ --- title: ETLRunStatus description: ETLRunStatus Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Allowed Values * `pending` @@ -10,4 +20,14 @@ description: ETLRunStatus Schema Reference * `succeeded` * `failed` * `cancelled` -* `timeout` \ No newline at end of file +* `timeout` + +## TypeScript Usage + +```typescript +import { ETLRunStatus } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ETLRunStatus = 'pending'; +``` + diff --git a/content/docs/references/automation/etl/ETLSource.mdx b/content/docs/references/automation/etl/ETLSource.mdx index dbdd9c44e..28932bdc3 100644 --- a/content/docs/references/automation/etl/ETLSource.mdx +++ b/content/docs/references/automation/etl/ETLSource.mdx @@ -1,8 +1,18 @@ --- title: ETLSource description: ETLSource Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: ETLSource Schema Reference | **connector** | `string` | optional | Connector ID | | **config** | `Record` | ✅ | Source configuration | | **incremental** | `object` | optional | Incremental extraction config | + +## TypeScript Usage + +```typescript +import { ETLSourceSchema } from '@objectstack/spec/automation'; +import type { ETLSource } from '@objectstack/spec/automation'; + +// Validate data +const result = ETLSourceSchema.parse(data); + +// Type-safe usage +const myETLSource: ETLSource = { + type: 'database', + config: {} +}; +``` + diff --git a/content/docs/references/automation/etl/ETLSyncMode.mdx b/content/docs/references/automation/etl/ETLSyncMode.mdx index 7f2c49c69..fa10915ba 100644 --- a/content/docs/references/automation/etl/ETLSyncMode.mdx +++ b/content/docs/references/automation/etl/ETLSyncMode.mdx @@ -1,10 +1,30 @@ --- title: ETLSyncMode description: ETLSyncMode Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Allowed Values * `full` * `incremental` -* `cdc` \ No newline at end of file +* `cdc` + +## TypeScript Usage + +```typescript +import { ETLSyncMode } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ETLSyncMode = 'full'; +``` + diff --git a/content/docs/references/automation/etl/ETLTransformation.mdx b/content/docs/references/automation/etl/ETLTransformation.mdx index 5cdf487f7..57416ec64 100644 --- a/content/docs/references/automation/etl/ETLTransformation.mdx +++ b/content/docs/references/automation/etl/ETLTransformation.mdx @@ -1,8 +1,18 @@ --- title: ETLTransformation description: ETLTransformation Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: ETLTransformation Schema Reference | **type** | `Enum<'map' \| 'filter' \| 'aggregate' \| 'join' \| 'script' \| 'lookup' \| 'split' \| 'merge' \| 'normalize' \| 'deduplicate'>` | ✅ | Transformation type | | **config** | `Record` | ✅ | Transformation config | | **continueOnError** | `boolean` | optional | Continue on error | + +## TypeScript Usage + +```typescript +import { ETLTransformationSchema } from '@objectstack/spec/automation'; +import type { ETLTransformation } from '@objectstack/spec/automation'; + +// Validate data +const result = ETLTransformationSchema.parse(data); + +// Type-safe usage +const myETLTransformation: ETLTransformation = { + type: 'map', + config: {} +}; +``` + diff --git a/content/docs/references/automation/etl/ETLTransformationType.mdx b/content/docs/references/automation/etl/ETLTransformationType.mdx index 47be46d4f..70219a446 100644 --- a/content/docs/references/automation/etl/ETLTransformationType.mdx +++ b/content/docs/references/automation/etl/ETLTransformationType.mdx @@ -1,8 +1,18 @@ --- title: ETLTransformationType description: ETLTransformationType Schema Reference +category: automation +zodFile: etl --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + ## Allowed Values * `map` @@ -14,4 +24,14 @@ description: ETLTransformationType Schema Reference * `split` * `merge` * `normalize` -* `deduplicate` \ No newline at end of file +* `deduplicate` + +## TypeScript Usage + +```typescript +import { ETLTransformationType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ETLTransformationType = 'map'; +``` + diff --git a/content/docs/references/automation/flow/Flow.mdx b/content/docs/references/automation/flow/Flow.mdx index 188f7ebe6..f894b2832 100644 --- a/content/docs/references/automation/flow/Flow.mdx +++ b/content/docs/references/automation/flow/Flow.mdx @@ -1,8 +1,18 @@ --- title: Flow description: Flow Schema Reference +category: automation +zodFile: flow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/flow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -19,3 +29,22 @@ description: Flow Schema Reference | **edges** | `object[]` | ✅ | Flow connections | | **active** | `boolean` | optional | Is active (Deprecated: use status) | | **runAs** | `Enum<'system' \| 'user'>` | optional | Execution context | + +## TypeScript Usage + +```typescript +import { FlowSchema } from '@objectstack/spec/automation'; +import type { Flow } from '@objectstack/spec/automation'; + +// Validate data +const result = FlowSchema.parse(data); + +// Type-safe usage +const myFlow: Flow = { + name: 'name', + label: 'example', + type: 'autolaunched', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/flow/FlowEdge.mdx b/content/docs/references/automation/flow/FlowEdge.mdx index 5a3fe6e0c..7ebef3aa1 100644 --- a/content/docs/references/automation/flow/FlowEdge.mdx +++ b/content/docs/references/automation/flow/FlowEdge.mdx @@ -1,8 +1,18 @@ --- title: FlowEdge description: FlowEdge Schema Reference +category: automation +zodFile: flow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/flow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: FlowEdge Schema Reference | **condition** | `string` | optional | Expression returning boolean used for branching | | **type** | `Enum<'default' \| 'fault'>` | optional | Connection type: Standard (Success) or Fault (Error) path | | **label** | `string` | optional | Label on the connector | + +## TypeScript Usage + +```typescript +import { FlowEdgeSchema } from '@objectstack/spec/automation'; +import type { FlowEdge } from '@objectstack/spec/automation'; + +// Validate data +const result = FlowEdgeSchema.parse(data); + +// Type-safe usage +const myFlowEdge: FlowEdge = { + id: 'example', + source: 'example', + target: 'example' +}; +``` + diff --git a/content/docs/references/automation/flow/FlowNode.mdx b/content/docs/references/automation/flow/FlowNode.mdx index d36e3a88f..04b5b4694 100644 --- a/content/docs/references/automation/flow/FlowNode.mdx +++ b/content/docs/references/automation/flow/FlowNode.mdx @@ -1,8 +1,18 @@ --- title: FlowNode description: FlowNode Schema Reference +category: automation +zodFile: flow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/flow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: FlowNode Schema Reference | **label** | `string` | ✅ | Node label | | **config** | `Record` | optional | Node configuration | | **position** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { FlowNodeSchema } from '@objectstack/spec/automation'; +import type { FlowNode } from '@objectstack/spec/automation'; + +// Validate data +const result = FlowNodeSchema.parse(data); + +// Type-safe usage +const myFlowNode: FlowNode = { + id: 'example', + type: 'start', + label: 'example' +}; +``` + diff --git a/content/docs/references/automation/flow/FlowNodeAction.mdx b/content/docs/references/automation/flow/FlowNodeAction.mdx index 0d0a054ef..33ace7027 100644 --- a/content/docs/references/automation/flow/FlowNodeAction.mdx +++ b/content/docs/references/automation/flow/FlowNodeAction.mdx @@ -1,8 +1,18 @@ --- title: FlowNodeAction description: FlowNodeAction Schema Reference +category: automation +zodFile: flow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/flow.zod.ts` + + ## Allowed Values * `start` @@ -17,4 +27,14 @@ description: FlowNodeAction Schema Reference * `http_request` * `script` * `wait` -* `subflow` \ No newline at end of file +* `subflow` + +## TypeScript Usage + +```typescript +import { FlowNodeAction } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: FlowNodeAction = 'start'; +``` + diff --git a/content/docs/references/automation/flow/FlowVariable.mdx b/content/docs/references/automation/flow/FlowVariable.mdx index 82f28b8b8..c00f7c6c1 100644 --- a/content/docs/references/automation/flow/FlowVariable.mdx +++ b/content/docs/references/automation/flow/FlowVariable.mdx @@ -1,8 +1,18 @@ --- title: FlowVariable description: FlowVariable Schema Reference +category: automation +zodFile: flow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/flow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: FlowVariable Schema Reference | **type** | `string` | ✅ | Data type (text, number, boolean, object, list) | | **isInput** | `boolean` | optional | Is input parameter | | **isOutput** | `boolean` | optional | Is output parameter | + +## TypeScript Usage + +```typescript +import { FlowVariableSchema } from '@objectstack/spec/automation'; +import type { FlowVariable } from '@objectstack/spec/automation'; + +// Validate data +const result = FlowVariableSchema.parse(data); + +// Type-safe usage +const myFlowVariable: FlowVariable = { + name: 'name', + type: 'example' +}; +``` + diff --git a/content/docs/references/automation/index.mdx b/content/docs/references/automation/index.mdx new file mode 100644 index 000000000..d0e8ea9ad --- /dev/null +++ b/content/docs/references/automation/index.mdx @@ -0,0 +1,116 @@ +--- +title: Automation Protocol Overview +description: Complete reference for all automation protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# Automation Protocol + +This section contains all protocol schemas for the automation layer of ObjectStack. + +## Approval + +Source: `packages/spec/src/automation/approval.zod.ts` + + + + + + + + + +## Connector + +Source: `packages/spec/src/automation/connector.zod.ts` + + + + + + + + + + + + + + + +## Etl + +Source: `packages/spec/src/automation/etl.zod.ts` + + + + + + + + + + + + + +## Flow + +Source: `packages/spec/src/automation/flow.zod.ts` + + + + + + + + + +## Sync + +Source: `packages/spec/src/automation/sync.zod.ts` + + + + + + + + + + + + +## Webhook + +Source: `packages/spec/src/automation/webhook.zod.ts` + + + + + + + +## Workflow + +Source: `packages/spec/src/automation/workflow.zod.ts` + + + + + + + + + + + + + + + + + + diff --git a/content/docs/references/automation/mapping/FieldMapping.mdx b/content/docs/references/automation/mapping/FieldMapping.mdx index e53d8f039..6c9438154 100644 --- a/content/docs/references/automation/mapping/FieldMapping.mdx +++ b/content/docs/references/automation/mapping/FieldMapping.mdx @@ -1,8 +1,18 @@ --- title: FieldMapping description: FieldMapping Schema Reference +category: automation +zodFile: mapping --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/mapping.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: FieldMapping Schema Reference | **transform** | `string` | optional | Transformation formula | | **default** | `any` | optional | Default value | | **syncNull** | `boolean` | optional | Sync null values | + +## TypeScript Usage + +```typescript +import { FieldMappingSchema } from '@objectstack/spec/automation'; +import type { FieldMapping } from '@objectstack/spec/automation'; + +// Validate data +const result = FieldMappingSchema.parse(data); + +// Type-safe usage +const myFieldMapping: FieldMapping = { + sourceField: 'example', + destinationField: 'example' +}; +``` + diff --git a/content/docs/references/automation/sync/ConflictResolution.mdx b/content/docs/references/automation/sync/ConflictResolution.mdx index 623a5aeb9..57a8822d9 100644 --- a/content/docs/references/automation/sync/ConflictResolution.mdx +++ b/content/docs/references/automation/sync/ConflictResolution.mdx @@ -1,12 +1,32 @@ --- title: ConflictResolution description: ConflictResolution Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Allowed Values * `source_wins` * `destination_wins` * `latest_wins` * `manual` -* `merge` \ No newline at end of file +* `merge` + +## TypeScript Usage + +```typescript +import { ConflictResolution } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: ConflictResolution = 'source_wins'; +``` + diff --git a/content/docs/references/automation/sync/DataDestinationConfig.mdx b/content/docs/references/automation/sync/DataDestinationConfig.mdx index 59bf93ddf..f1607cc5f 100644 --- a/content/docs/references/automation/sync/DataDestinationConfig.mdx +++ b/content/docs/references/automation/sync/DataDestinationConfig.mdx @@ -1,8 +1,18 @@ --- title: DataDestinationConfig description: DataDestinationConfig Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,19 @@ description: DataDestinationConfig Schema Reference | **mapping** | `Record \| object[]` | optional | Field mappings | | **externalResource** | `string` | optional | External resource ID | | **matchKey** | `string[]` | optional | Match key fields | + +## TypeScript Usage + +```typescript +import { DataDestinationConfigSchema } from '@objectstack/spec/automation'; +import type { DataDestinationConfig } from '@objectstack/spec/automation'; + +// Validate data +const result = DataDestinationConfigSchema.parse(data); + +// Type-safe usage +const myDataDestinationConfig: DataDestinationConfig = { + operation: 'insert' +}; +``` + diff --git a/content/docs/references/automation/sync/DataSourceConfig.mdx b/content/docs/references/automation/sync/DataSourceConfig.mdx index c0d6a79ba..d0bb7168f 100644 --- a/content/docs/references/automation/sync/DataSourceConfig.mdx +++ b/content/docs/references/automation/sync/DataSourceConfig.mdx @@ -1,8 +1,18 @@ --- title: DataSourceConfig description: DataSourceConfig Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,18 @@ description: DataSourceConfig Schema Reference | **fields** | `string[]` | optional | Fields to sync | | **connectorInstanceId** | `string` | optional | Connector instance ID | | **externalResource** | `string` | optional | External resource ID | + +## TypeScript Usage + +```typescript +import { DataSourceConfigSchema } from '@objectstack/spec/automation'; +import type { DataSourceConfig } from '@objectstack/spec/automation'; + +// Validate data +const result = DataSourceConfigSchema.parse(data); + +// Type-safe usage +const myDataSourceConfig: DataSourceConfig = { +}; +``` + diff --git a/content/docs/references/automation/sync/DataSyncConfig.mdx b/content/docs/references/automation/sync/DataSyncConfig.mdx index aaee284da..f301effad 100644 --- a/content/docs/references/automation/sync/DataSyncConfig.mdx +++ b/content/docs/references/automation/sync/DataSyncConfig.mdx @@ -1,8 +1,18 @@ --- title: DataSyncConfig description: DataSyncConfig Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -26,3 +36,21 @@ description: DataSyncConfig Schema Reference | **audit** | `object` | optional | Audit configuration | | **tags** | `string[]` | optional | Sync tags | | **metadata** | `Record` | optional | Custom metadata | + +## TypeScript Usage + +```typescript +import { DataSyncConfigSchema } from '@objectstack/spec/automation'; +import type { DataSyncConfig } from '@objectstack/spec/automation'; + +// Validate data +const result = DataSyncConfigSchema.parse(data); + +// Type-safe usage +const myDataSyncConfig: DataSyncConfig = { + name: 'name', + source: {}, + destination: {} +}; +``` + diff --git a/content/docs/references/automation/sync/SyncDirection.mdx b/content/docs/references/automation/sync/SyncDirection.mdx index 4d65f05ca..a0e04a8cb 100644 --- a/content/docs/references/automation/sync/SyncDirection.mdx +++ b/content/docs/references/automation/sync/SyncDirection.mdx @@ -1,10 +1,30 @@ --- title: SyncDirection description: SyncDirection Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Allowed Values * `push` * `pull` -* `bidirectional` \ No newline at end of file +* `bidirectional` + +## TypeScript Usage + +```typescript +import { SyncDirection } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: SyncDirection = 'push'; +``` + diff --git a/content/docs/references/automation/sync/SyncExecutionResult.mdx b/content/docs/references/automation/sync/SyncExecutionResult.mdx index 388e3794a..2d95b6629 100644 --- a/content/docs/references/automation/sync/SyncExecutionResult.mdx +++ b/content/docs/references/automation/sync/SyncExecutionResult.mdx @@ -1,8 +1,18 @@ --- title: SyncExecutionResult description: SyncExecutionResult Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: SyncExecutionResult Schema Reference | **stats** | `object` | optional | Execution statistics | | **errors** | `object[]` | optional | Errors | | **logs** | `string[]` | optional | Execution logs | + +## TypeScript Usage + +```typescript +import { SyncExecutionResultSchema } from '@objectstack/spec/automation'; +import type { SyncExecutionResult } from '@objectstack/spec/automation'; + +// Validate data +const result = SyncExecutionResultSchema.parse(data); + +// Type-safe usage +const mySyncExecutionResult: SyncExecutionResult = { + id: 'example', + syncName: 'example', + status: 'pending', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/sync/SyncExecutionStatus.mdx b/content/docs/references/automation/sync/SyncExecutionStatus.mdx index be4b86047..bde062c4a 100644 --- a/content/docs/references/automation/sync/SyncExecutionStatus.mdx +++ b/content/docs/references/automation/sync/SyncExecutionStatus.mdx @@ -1,8 +1,18 @@ --- title: SyncExecutionStatus description: SyncExecutionStatus Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Allowed Values * `pending` @@ -10,4 +20,14 @@ description: SyncExecutionStatus Schema Reference * `completed` * `partial` * `failed` -* `cancelled` \ No newline at end of file +* `cancelled` + +## TypeScript Usage + +```typescript +import { SyncExecutionStatus } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: SyncExecutionStatus = 'pending'; +``` + diff --git a/content/docs/references/automation/sync/SyncMode.mdx b/content/docs/references/automation/sync/SyncMode.mdx index 746d60c3e..0ca761bad 100644 --- a/content/docs/references/automation/sync/SyncMode.mdx +++ b/content/docs/references/automation/sync/SyncMode.mdx @@ -1,10 +1,30 @@ --- title: SyncMode description: SyncMode Schema Reference +category: automation +zodFile: sync --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + ## Allowed Values * `full` * `incremental` -* `realtime` \ No newline at end of file +* `realtime` + +## TypeScript Usage + +```typescript +import { SyncMode } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: SyncMode = 'full'; +``` + diff --git a/content/docs/references/automation/webhook/Webhook.mdx b/content/docs/references/automation/webhook/Webhook.mdx index 0c4feb308..e0fa3e3d9 100644 --- a/content/docs/references/automation/webhook/Webhook.mdx +++ b/content/docs/references/automation/webhook/Webhook.mdx @@ -1,8 +1,18 @@ --- title: Webhook description: Webhook Schema Reference +category: automation +zodFile: webhook --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/webhook.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -19,3 +29,22 @@ description: Webhook Schema Reference | **includeSession** | `boolean` | optional | Include user session info | | **retryCount** | `number` | optional | | | **isActive** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { WebhookSchema } from '@objectstack/spec/automation'; +import type { Webhook } from '@objectstack/spec/automation'; + +// Validate data +const result = WebhookSchema.parse(data); + +// Type-safe usage +const myWebhook: Webhook = { + name: 'name', + object: 'example', + triggers: [], + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/webhook/WebhookReceiver.mdx b/content/docs/references/automation/webhook/WebhookReceiver.mdx index 1de662065..0ae96ffe9 100644 --- a/content/docs/references/automation/webhook/WebhookReceiver.mdx +++ b/content/docs/references/automation/webhook/WebhookReceiver.mdx @@ -1,8 +1,18 @@ --- title: WebhookReceiver description: WebhookReceiver Schema Reference +category: automation +zodFile: webhook --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/webhook.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: WebhookReceiver Schema Reference | **verificationParams** | `object` | optional | | | **action** | `Enum<'trigger_flow' \| 'script' \| 'upsert_record'>` | optional | | | **target** | `string` | ✅ | Flow ID or Script name | + +## TypeScript Usage + +```typescript +import { WebhookReceiverSchema } from '@objectstack/spec/automation'; +import type { WebhookReceiver } from '@objectstack/spec/automation'; + +// Validate data +const result = WebhookReceiverSchema.parse(data); + +// Type-safe usage +const myWebhookReceiver: WebhookReceiver = { + name: 'name', + path: 'example', + target: 'example' +}; +``` + diff --git a/content/docs/references/automation/webhook/WebhookTriggerType.mdx b/content/docs/references/automation/webhook/WebhookTriggerType.mdx index 18c38830b..5412ea8b9 100644 --- a/content/docs/references/automation/webhook/WebhookTriggerType.mdx +++ b/content/docs/references/automation/webhook/WebhookTriggerType.mdx @@ -1,12 +1,32 @@ --- title: WebhookTriggerType description: WebhookTriggerType Schema Reference +category: automation +zodFile: webhook --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/webhook.zod.ts` + + ## Allowed Values * `create` * `update` * `delete` * `undelete` -* `api` \ No newline at end of file +* `api` + +## TypeScript Usage + +```typescript +import { WebhookTriggerType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: WebhookTriggerType = 'create'; +``` + diff --git a/content/docs/references/automation/workflow/CustomScriptAction.mdx b/content/docs/references/automation/workflow/CustomScriptAction.mdx index ce65c528f..d45192df5 100644 --- a/content/docs/references/automation/workflow/CustomScriptAction.mdx +++ b/content/docs/references/automation/workflow/CustomScriptAction.mdx @@ -1,8 +1,18 @@ --- title: CustomScriptAction description: CustomScriptAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: CustomScriptAction Schema Reference | **code** | `string` | ✅ | Script code to execute | | **timeout** | `number` | optional | Execution timeout in milliseconds | | **context** | `Record` | optional | Additional context variables | + +## TypeScript Usage + +```typescript +import { CustomScriptActionSchema } from '@objectstack/spec/automation'; +import type { CustomScriptAction } from '@objectstack/spec/automation'; + +// Validate data +const result = CustomScriptActionSchema.parse(data); + +// Type-safe usage +const myCustomScriptAction: CustomScriptAction = { + name: 'name', + type: 'example', + code: 'example' +}; +``` + diff --git a/content/docs/references/automation/workflow/EmailAlertAction.mdx b/content/docs/references/automation/workflow/EmailAlertAction.mdx index e23cd03e0..9d0eb5e36 100644 --- a/content/docs/references/automation/workflow/EmailAlertAction.mdx +++ b/content/docs/references/automation/workflow/EmailAlertAction.mdx @@ -1,8 +1,18 @@ --- title: EmailAlertAction description: EmailAlertAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,22 @@ description: EmailAlertAction Schema Reference | **type** | `string` | ✅ | | | **template** | `string` | ✅ | Email template ID/DevName | | **recipients** | `string[]` | ✅ | List of recipient emails or user IDs | + +## TypeScript Usage + +```typescript +import { EmailAlertActionSchema } from '@objectstack/spec/automation'; +import type { EmailAlertAction } from '@objectstack/spec/automation'; + +// Validate data +const result = EmailAlertActionSchema.parse(data); + +// Type-safe usage +const myEmailAlertAction: EmailAlertAction = { + name: 'name', + type: 'example', + template: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/FieldUpdateAction.mdx b/content/docs/references/automation/workflow/FieldUpdateAction.mdx index 62298b986..169b631ca 100644 --- a/content/docs/references/automation/workflow/FieldUpdateAction.mdx +++ b/content/docs/references/automation/workflow/FieldUpdateAction.mdx @@ -1,8 +1,18 @@ --- title: FieldUpdateAction description: FieldUpdateAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: FieldUpdateAction Schema Reference | **type** | `string` | ✅ | | | **field** | `string` | ✅ | Field to update | | **value** | `any` | optional | Value or Formula to set | + +## TypeScript Usage + +```typescript +import { FieldUpdateActionSchema } from '@objectstack/spec/automation'; +import type { FieldUpdateAction } from '@objectstack/spec/automation'; + +// Validate data +const result = FieldUpdateActionSchema.parse(data); + +// Type-safe usage +const myFieldUpdateAction: FieldUpdateAction = { + name: 'name', + type: 'example', + field: 'example' +}; +``` + diff --git a/content/docs/references/automation/workflow/HttpCallAction.mdx b/content/docs/references/automation/workflow/HttpCallAction.mdx index e5bc884ef..8e45e85c6 100644 --- a/content/docs/references/automation/workflow/HttpCallAction.mdx +++ b/content/docs/references/automation/workflow/HttpCallAction.mdx @@ -1,8 +1,18 @@ --- title: HttpCallAction description: HttpCallAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: HttpCallAction Schema Reference | **body** | `any` | optional | Request body (object/string) | | **authentication** | `object` | optional | Authentication configuration | | **timeout** | `number` | optional | Request timeout in milliseconds | + +## TypeScript Usage + +```typescript +import { HttpCallActionSchema } from '@objectstack/spec/automation'; +import type { HttpCallAction } from '@objectstack/spec/automation'; + +// Validate data +const result = HttpCallActionSchema.parse(data); + +// Type-safe usage +const myHttpCallAction: HttpCallAction = { + name: 'name', + type: 'example', + url: 'https://example.com', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/PushNotificationAction.mdx b/content/docs/references/automation/workflow/PushNotificationAction.mdx index 77add310e..99479c4e0 100644 --- a/content/docs/references/automation/workflow/PushNotificationAction.mdx +++ b/content/docs/references/automation/workflow/PushNotificationAction.mdx @@ -1,8 +1,18 @@ --- title: PushNotificationAction description: PushNotificationAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: PushNotificationAction Schema Reference | **badge** | `number` | optional | Badge count (iOS) | | **sound** | `string` | optional | Notification sound | | **clickAction** | `string` | optional | Action/URL when notification is clicked | + +## TypeScript Usage + +```typescript +import { PushNotificationActionSchema } from '@objectstack/spec/automation'; +import type { PushNotificationAction } from '@objectstack/spec/automation'; + +// Validate data +const result = PushNotificationActionSchema.parse(data); + +// Type-safe usage +const myPushNotificationAction: PushNotificationAction = { + name: 'name', + type: 'example', + title: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/SlackMessageAction.mdx b/content/docs/references/automation/workflow/SlackMessageAction.mdx index 5e634be8a..531a3ff2a 100644 --- a/content/docs/references/automation/workflow/SlackMessageAction.mdx +++ b/content/docs/references/automation/workflow/SlackMessageAction.mdx @@ -1,8 +1,18 @@ --- title: SlackMessageAction description: SlackMessageAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: SlackMessageAction Schema Reference | **message** | `string` | ✅ | Message text with optional markdown | | **mentions** | `string[]` | optional | User IDs or @username to mention | | **threadId** | `string` | optional | Thread ID for replies | + +## TypeScript Usage + +```typescript +import { SlackMessageActionSchema } from '@objectstack/spec/automation'; +import type { SlackMessageAction } from '@objectstack/spec/automation'; + +// Validate data +const result = SlackMessageActionSchema.parse(data); + +// Type-safe usage +const mySlackMessageAction: SlackMessageAction = { + name: 'name', + type: 'example', + channel: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/SmsNotificationAction.mdx b/content/docs/references/automation/workflow/SmsNotificationAction.mdx index 9025b4e4a..934d2b25c 100644 --- a/content/docs/references/automation/workflow/SmsNotificationAction.mdx +++ b/content/docs/references/automation/workflow/SmsNotificationAction.mdx @@ -1,8 +1,18 @@ --- title: SmsNotificationAction description: SmsNotificationAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: SmsNotificationAction Schema Reference | **recipients** | `string[]` | ✅ | List of phone numbers or user field references | | **message** | `string` | ✅ | SMS message text or template | | **fromNumber** | `string` | optional | Sender phone number (provider-specific) | + +## TypeScript Usage + +```typescript +import { SmsNotificationActionSchema } from '@objectstack/spec/automation'; +import type { SmsNotificationAction } from '@objectstack/spec/automation'; + +// Validate data +const result = SmsNotificationActionSchema.parse(data); + +// Type-safe usage +const mySmsNotificationAction: SmsNotificationAction = { + name: 'name', + type: 'example', + provider: 'twilio', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/TaskCreationAction.mdx b/content/docs/references/automation/workflow/TaskCreationAction.mdx index 7b55f6a17..93ef59fd3 100644 --- a/content/docs/references/automation/workflow/TaskCreationAction.mdx +++ b/content/docs/references/automation/workflow/TaskCreationAction.mdx @@ -1,8 +1,18 @@ --- title: TaskCreationAction description: TaskCreationAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,22 @@ description: TaskCreationAction Schema Reference | **priority** | `string` | optional | Task priority | | **relatedTo** | `string` | optional | Related record ID or field reference | | **additionalFields** | `Record` | optional | Additional custom fields | + +## TypeScript Usage + +```typescript +import { TaskCreationActionSchema } from '@objectstack/spec/automation'; +import type { TaskCreationAction } from '@objectstack/spec/automation'; + +// Validate data +const result = TaskCreationActionSchema.parse(data); + +// Type-safe usage +const myTaskCreationAction: TaskCreationAction = { + name: 'name', + type: 'example', + taskObject: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/TeamsMessageAction.mdx b/content/docs/references/automation/workflow/TeamsMessageAction.mdx index 71804dbf5..1ddecfe97 100644 --- a/content/docs/references/automation/workflow/TeamsMessageAction.mdx +++ b/content/docs/references/automation/workflow/TeamsMessageAction.mdx @@ -1,8 +1,18 @@ --- title: TeamsMessageAction description: TeamsMessageAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: TeamsMessageAction Schema Reference | **message** | `string` | ✅ | Message text with optional markdown | | **mentions** | `string[]` | optional | User IDs to mention | | **teamId** | `string` | optional | Team ID (if not in default team) | + +## TypeScript Usage + +```typescript +import { TeamsMessageActionSchema } from '@objectstack/spec/automation'; +import type { TeamsMessageAction } from '@objectstack/spec/automation'; + +// Validate data +const result = TeamsMessageActionSchema.parse(data); + +// Type-safe usage +const myTeamsMessageAction: TeamsMessageAction = { + name: 'name', + type: 'example', + channel: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/TimeTrigger.mdx b/content/docs/references/automation/workflow/TimeTrigger.mdx index c7f4677aa..9f4c3160e 100644 --- a/content/docs/references/automation/workflow/TimeTrigger.mdx +++ b/content/docs/references/automation/workflow/TimeTrigger.mdx @@ -1,8 +1,18 @@ --- title: TimeTrigger description: TimeTrigger Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: TimeTrigger Schema Reference | **offsetFrom** | `Enum<'trigger_date' \| 'date_field'>` | ✅ | Basis for calculation | | **dateField** | `string` | optional | Date field to calculate from (required if offsetFrom is date_field) | | **actions** | `object \| object \| object \| object \| object \| object \| object \| object \| object \| object[]` | ✅ | Actions to execute at the scheduled time | + +## TypeScript Usage + +```typescript +import { TimeTriggerSchema } from '@objectstack/spec/automation'; +import type { TimeTrigger } from '@objectstack/spec/automation'; + +// Validate data +const result = TimeTriggerSchema.parse(data); + +// Type-safe usage +const myTimeTrigger: TimeTrigger = { + timeLength: null, + timeUnit: 'minutes', + offsetDirection: 'before', + // ... other fields +}; +``` + diff --git a/content/docs/references/automation/workflow/WebhookTriggerAction.mdx b/content/docs/references/automation/workflow/WebhookTriggerAction.mdx index 207882a30..9af225016 100644 --- a/content/docs/references/automation/workflow/WebhookTriggerAction.mdx +++ b/content/docs/references/automation/workflow/WebhookTriggerAction.mdx @@ -1,8 +1,18 @@ --- title: WebhookTriggerAction description: WebhookTriggerAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: WebhookTriggerAction Schema Reference | **payload** | `any` | optional | Webhook payload (uses record data if not specified) | | **retryOnFailure** | `boolean` | optional | Retry if webhook fails | | **maxRetries** | `number` | optional | Maximum retry attempts | + +## TypeScript Usage + +```typescript +import { WebhookTriggerActionSchema } from '@objectstack/spec/automation'; +import type { WebhookTriggerAction } from '@objectstack/spec/automation'; + +// Validate data +const result = WebhookTriggerActionSchema.parse(data); + +// Type-safe usage +const myWebhookTriggerAction: WebhookTriggerAction = { + name: 'name', + type: 'example', + url: 'https://example.com' +}; +``` + diff --git a/content/docs/references/automation/workflow/WorkflowAction.mdx b/content/docs/references/automation/workflow/WorkflowAction.mdx index 9d45b696a..ab806c17b 100644 --- a/content/docs/references/automation/workflow/WorkflowAction.mdx +++ b/content/docs/references/automation/workflow/WorkflowAction.mdx @@ -1,5 +1,15 @@ --- title: WorkflowAction description: WorkflowAction Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + diff --git a/content/docs/references/automation/workflow/WorkflowRule.mdx b/content/docs/references/automation/workflow/WorkflowRule.mdx index 88bfca56f..74eac7f69 100644 --- a/content/docs/references/automation/workflow/WorkflowRule.mdx +++ b/content/docs/references/automation/workflow/WorkflowRule.mdx @@ -1,8 +1,18 @@ --- title: WorkflowRule description: WorkflowRule Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: WorkflowRule Schema Reference | **timeTriggers** | `object[]` | optional | Scheduled actions relative to trigger or date field | | **active** | `boolean` | optional | Whether this workflow is active | | **reevaluateOnChange** | `boolean` | optional | Re-evaluate rule if field updates change the record validity | + +## TypeScript Usage + +```typescript +import { WorkflowRuleSchema } from '@objectstack/spec/automation'; +import type { WorkflowRule } from '@objectstack/spec/automation'; + +// Validate data +const result = WorkflowRuleSchema.parse(data); + +// Type-safe usage +const myWorkflowRule: WorkflowRule = { + name: 'name', + objectName: 'example', + triggerType: 'on_create' +}; +``` + diff --git a/content/docs/references/automation/workflow/WorkflowTriggerType.mdx b/content/docs/references/automation/workflow/WorkflowTriggerType.mdx index 6c5f6564c..01c154507 100644 --- a/content/docs/references/automation/workflow/WorkflowTriggerType.mdx +++ b/content/docs/references/automation/workflow/WorkflowTriggerType.mdx @@ -1,12 +1,32 @@ --- title: WorkflowTriggerType description: WorkflowTriggerType Schema Reference +category: automation +zodFile: workflow --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + ## Allowed Values * `on_create` * `on_update` * `on_create_or_update` * `on_delete` -* `schedule` \ No newline at end of file +* `schedule` + +## TypeScript Usage + +```typescript +import { WorkflowTriggerType } from '@objectstack/spec/automation'; + +// Type-safe enum value +const value: WorkflowTriggerType = 'on_create'; +``` + diff --git a/content/docs/references/data/dataset/Dataset.mdx b/content/docs/references/data/dataset/Dataset.mdx index 7e003d6e9..46af6962f 100644 --- a/content/docs/references/data/dataset/Dataset.mdx +++ b/content/docs/references/data/dataset/Dataset.mdx @@ -1,8 +1,18 @@ --- title: Dataset description: Dataset Schema Reference +category: data +zodFile: dataset --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/dataset.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: Dataset Schema Reference | **mode** | `Enum<'insert' \| 'update' \| 'upsert' \| 'replace' \| 'ignore'>` | optional | Conflict resolution strategy | | **env** | `Enum<'prod' \| 'dev' \| 'test'>[]` | optional | Applicable environments | | **records** | `Record[]` | ✅ | Data records | + +## TypeScript Usage + +```typescript +import { DatasetSchema } from '@objectstack/spec/data'; +import type { Dataset } from '@objectstack/spec/data'; + +// Validate data +const result = DatasetSchema.parse(data); + +// Type-safe usage +const myDataset: Dataset = { + object: 'example', + records: [] +}; +``` + diff --git a/content/docs/references/data/dataset/DatasetMode.mdx b/content/docs/references/data/dataset/DatasetMode.mdx index 4366a09d9..9b43b8cff 100644 --- a/content/docs/references/data/dataset/DatasetMode.mdx +++ b/content/docs/references/data/dataset/DatasetMode.mdx @@ -1,12 +1,32 @@ --- title: DatasetMode description: DatasetMode Schema Reference +category: data +zodFile: dataset --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/dataset.zod.ts` + + ## Allowed Values * `insert` * `update` * `upsert` * `replace` -* `ignore` \ No newline at end of file +* `ignore` + +## TypeScript Usage + +```typescript +import { DatasetMode } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: DatasetMode = 'insert'; +``` + diff --git a/content/docs/references/data/field/Address.mdx b/content/docs/references/data/field/Address.mdx index 1889b8213..412fd50ae 100644 --- a/content/docs/references/data/field/Address.mdx +++ b/content/docs/references/data/field/Address.mdx @@ -1,8 +1,18 @@ --- title: Address description: Address Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,18 @@ description: Address Schema Reference | **country** | `string` | optional | Country name or code | | **countryCode** | `string` | optional | ISO country code (e.g., US, GB) | | **formatted** | `string` | optional | Formatted address string | + +## TypeScript Usage + +```typescript +import { AddressSchema } from '@objectstack/spec/data'; +import type { Address } from '@objectstack/spec/data'; + +// Validate data +const result = AddressSchema.parse(data); + +// Type-safe usage +const myAddress: Address = { +}; +``` + diff --git a/content/docs/references/data/field/CurrencyConfig.mdx b/content/docs/references/data/field/CurrencyConfig.mdx index 3bf14db03..128d86128 100644 --- a/content/docs/references/data/field/CurrencyConfig.mdx +++ b/content/docs/references/data/field/CurrencyConfig.mdx @@ -1,8 +1,18 @@ --- title: CurrencyConfig description: CurrencyConfig Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: CurrencyConfig Schema Reference | **precision** | `integer` | optional | Decimal precision (default: 2) | | **currencyMode** | `Enum<'dynamic' \| 'fixed'>` | optional | Currency mode: dynamic (user selectable) or fixed (single currency) | | **defaultCurrency** | `string` | optional | Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR) | + +## TypeScript Usage + +```typescript +import { CurrencyConfigSchema } from '@objectstack/spec/data'; +import type { CurrencyConfig } from '@objectstack/spec/data'; + +// Validate data +const result = CurrencyConfigSchema.parse(data); + +// Type-safe usage +const myCurrencyConfig: CurrencyConfig = { +}; +``` + diff --git a/content/docs/references/data/field/CurrencyValue.mdx b/content/docs/references/data/field/CurrencyValue.mdx index cb7ecbc0e..ab101c674 100644 --- a/content/docs/references/data/field/CurrencyValue.mdx +++ b/content/docs/references/data/field/CurrencyValue.mdx @@ -1,11 +1,38 @@ --- title: CurrencyValue description: CurrencyValue Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **value** | `number` | ✅ | Monetary amount | | **currency** | `string` | ✅ | Currency code (ISO 4217) | + +## TypeScript Usage + +```typescript +import { CurrencyValueSchema } from '@objectstack/spec/data'; +import type { CurrencyValue } from '@objectstack/spec/data'; + +// Validate data +const result = CurrencyValueSchema.parse(data); + +// Type-safe usage +const myCurrencyValue: CurrencyValue = { + value: 0, + currency: 'example' +}; +``` + diff --git a/content/docs/references/data/field/Field.mdx b/content/docs/references/data/field/Field.mdx index 8f9b05947..bcbd9dddd 100644 --- a/content/docs/references/data/field/Field.mdx +++ b/content/docs/references/data/field/Field.mdx @@ -1,8 +1,18 @@ --- title: Field description: Field Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -56,3 +66,19 @@ description: Field Schema Reference | **encryption** | `boolean` | optional | Encrypt at rest | | **index** | `boolean` | optional | Create standard database index | | **externalId** | `boolean` | optional | Is external ID for upsert operations | + +## TypeScript Usage + +```typescript +import { FieldSchema } from '@objectstack/spec/data'; +import type { Field } from '@objectstack/spec/data'; + +// Validate data +const result = FieldSchema.parse(data); + +// Type-safe usage +const myField: Field = { + type: 'text' +}; +``` + diff --git a/content/docs/references/data/field/FieldType.mdx b/content/docs/references/data/field/FieldType.mdx index 7aa8b5c80..38e75e0fd 100644 --- a/content/docs/references/data/field/FieldType.mdx +++ b/content/docs/references/data/field/FieldType.mdx @@ -1,8 +1,18 @@ --- title: FieldType description: FieldType Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Allowed Values * `text` @@ -48,4 +58,14 @@ description: FieldType Schema Reference * `qrcode` * `progress` * `tags` -* `vector` \ No newline at end of file +* `vector` + +## TypeScript Usage + +```typescript +import { FieldType } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: FieldType = 'text'; +``` + diff --git a/content/docs/references/data/field/LocationCoordinates.mdx b/content/docs/references/data/field/LocationCoordinates.mdx index d450f72c7..c8d2ed8b2 100644 --- a/content/docs/references/data/field/LocationCoordinates.mdx +++ b/content/docs/references/data/field/LocationCoordinates.mdx @@ -1,8 +1,18 @@ --- title: LocationCoordinates description: LocationCoordinates Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: LocationCoordinates Schema Reference | **longitude** | `number` | ✅ | Longitude coordinate | | **altitude** | `number` | optional | Altitude in meters | | **accuracy** | `number` | optional | Accuracy in meters | + +## TypeScript Usage + +```typescript +import { LocationCoordinatesSchema } from '@objectstack/spec/data'; +import type { LocationCoordinates } from '@objectstack/spec/data'; + +// Validate data +const result = LocationCoordinatesSchema.parse(data); + +// Type-safe usage +const myLocationCoordinates: LocationCoordinates = { + latitude: 0, + longitude: 0 +}; +``` + diff --git a/content/docs/references/data/field/SelectOption.mdx b/content/docs/references/data/field/SelectOption.mdx index 095d71ac1..2d930a158 100644 --- a/content/docs/references/data/field/SelectOption.mdx +++ b/content/docs/references/data/field/SelectOption.mdx @@ -1,8 +1,18 @@ --- title: SelectOption description: SelectOption Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: SelectOption Schema Reference | **value** | `string` | ✅ | Stored value (lowercase machine identifier) | | **color** | `string` | optional | Color code for badges/charts | | **default** | `boolean` | optional | Is default option | + +## TypeScript Usage + +```typescript +import { SelectOptionSchema } from '@objectstack/spec/data'; +import type { SelectOption } from '@objectstack/spec/data'; + +// Validate data +const result = SelectOptionSchema.parse(data); + +// Type-safe usage +const mySelectOption: SelectOption = { + label: 'example', + value: 'example' +}; +``` + diff --git a/content/docs/references/data/field/VectorConfig.mdx b/content/docs/references/data/field/VectorConfig.mdx index 2a2bb5739..483310826 100644 --- a/content/docs/references/data/field/VectorConfig.mdx +++ b/content/docs/references/data/field/VectorConfig.mdx @@ -1,8 +1,18 @@ --- title: VectorConfig description: VectorConfig Schema Reference +category: data +zodFile: field --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/field.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: VectorConfig Schema Reference | **normalized** | `boolean` | optional | Whether vectors are normalized (unit length) | | **indexed** | `boolean` | optional | Whether to create a vector index for fast similarity search | | **indexType** | `Enum<'hnsw' \| 'ivfflat' \| 'flat'>` | optional | Vector index algorithm (HNSW for high accuracy, IVFFlat for large datasets) | + +## TypeScript Usage + +```typescript +import { VectorConfigSchema } from '@objectstack/spec/data'; +import type { VectorConfig } from '@objectstack/spec/data'; + +// Validate data +const result = VectorConfigSchema.parse(data); + +// Type-safe usage +const myVectorConfig: VectorConfig = { + dimensions: null +}; +``` + diff --git a/content/docs/references/data/filter/ComparisonOperator.mdx b/content/docs/references/data/filter/ComparisonOperator.mdx index 03e44b00a..c8b3692cc 100644 --- a/content/docs/references/data/filter/ComparisonOperator.mdx +++ b/content/docs/references/data/filter/ComparisonOperator.mdx @@ -1,8 +1,18 @@ --- title: ComparisonOperator description: ComparisonOperator Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: ComparisonOperator Schema Reference | **$gte** | `number \| string \| object` | optional | | | **$lt** | `number \| string \| object` | optional | | | **$lte** | `number \| string \| object` | optional | | + +## TypeScript Usage + +```typescript +import { ComparisonOperatorSchema } from '@objectstack/spec/data'; +import type { ComparisonOperator } from '@objectstack/spec/data'; + +// Validate data +const result = ComparisonOperatorSchema.parse(data); + +// Type-safe usage +const myComparisonOperator: ComparisonOperator = { +}; +``` + diff --git a/content/docs/references/data/filter/EqualityOperator.mdx b/content/docs/references/data/filter/EqualityOperator.mdx index b7c3a4064..9af9e0052 100644 --- a/content/docs/references/data/filter/EqualityOperator.mdx +++ b/content/docs/references/data/filter/EqualityOperator.mdx @@ -1,11 +1,36 @@ --- title: EqualityOperator description: EqualityOperator Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **$eq** | `any` | optional | | | **$ne** | `any` | optional | | + +## TypeScript Usage + +```typescript +import { EqualityOperatorSchema } from '@objectstack/spec/data'; +import type { EqualityOperator } from '@objectstack/spec/data'; + +// Validate data +const result = EqualityOperatorSchema.parse(data); + +// Type-safe usage +const myEqualityOperator: EqualityOperator = { +}; +``` + diff --git a/content/docs/references/data/filter/FieldOperators.mdx b/content/docs/references/data/filter/FieldOperators.mdx index 27d4ff041..be28fe0f5 100644 --- a/content/docs/references/data/filter/FieldOperators.mdx +++ b/content/docs/references/data/filter/FieldOperators.mdx @@ -1,8 +1,18 @@ --- title: FieldOperators description: FieldOperators Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,18 @@ description: FieldOperators Schema Reference | **$endsWith** | `string` | optional | | | **$null** | `boolean` | optional | | | **$exist** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { FieldOperatorsSchema } from '@objectstack/spec/data'; +import type { FieldOperators } from '@objectstack/spec/data'; + +// Validate data +const result = FieldOperatorsSchema.parse(data); + +// Type-safe usage +const myFieldOperators: FieldOperators = { +}; +``` + diff --git a/content/docs/references/data/filter/FieldReference.mdx b/content/docs/references/data/filter/FieldReference.mdx index 585ba206b..2249f92a1 100644 --- a/content/docs/references/data/filter/FieldReference.mdx +++ b/content/docs/references/data/filter/FieldReference.mdx @@ -1,10 +1,36 @@ --- title: FieldReference description: FieldReference Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **$field** | `string` | ✅ | Field Reference/Column Name | + +## TypeScript Usage + +```typescript +import { FieldReferenceSchema } from '@objectstack/spec/data'; +import type { FieldReference } from '@objectstack/spec/data'; + +// Validate data +const result = FieldReferenceSchema.parse(data); + +// Type-safe usage +const myFieldReference: FieldReference = { + $field: 'example' +}; +``` + diff --git a/content/docs/references/data/filter/FilterCondition.mdx b/content/docs/references/data/filter/FilterCondition.mdx index 622d19051..4cff03a9e 100644 --- a/content/docs/references/data/filter/FilterCondition.mdx +++ b/content/docs/references/data/filter/FilterCondition.mdx @@ -1,5 +1,15 @@ --- title: FilterCondition description: FilterCondition Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + diff --git a/content/docs/references/data/filter/NormalizedFilter.mdx b/content/docs/references/data/filter/NormalizedFilter.mdx index babf352d3..2e559d6d5 100644 --- a/content/docs/references/data/filter/NormalizedFilter.mdx +++ b/content/docs/references/data/filter/NormalizedFilter.mdx @@ -1,8 +1,18 @@ --- title: NormalizedFilter description: NormalizedFilter Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: NormalizedFilter Schema Reference | **$and** | `Record \| any[]` | optional | | | **$or** | `Record \| any[]` | optional | | | **$not** | `Record \| any` | optional | | + +## TypeScript Usage + +```typescript +import { NormalizedFilterSchema } from '@objectstack/spec/data'; +import type { NormalizedFilter } from '@objectstack/spec/data'; + +// Validate data +const result = NormalizedFilterSchema.parse(data); + +// Type-safe usage +const myNormalizedFilter: NormalizedFilter = { +}; +``` + diff --git a/content/docs/references/data/filter/QueryFilter.mdx b/content/docs/references/data/filter/QueryFilter.mdx index ca1b37363..55d13b3e0 100644 --- a/content/docs/references/data/filter/QueryFilter.mdx +++ b/content/docs/references/data/filter/QueryFilter.mdx @@ -1,10 +1,35 @@ --- title: QueryFilter description: QueryFilter Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **where** | `any` | optional | | + +## TypeScript Usage + +```typescript +import { QueryFilterSchema } from '@objectstack/spec/data'; +import type { QueryFilter } from '@objectstack/spec/data'; + +// Validate data +const result = QueryFilterSchema.parse(data); + +// Type-safe usage +const myQueryFilter: QueryFilter = { +}; +``` + diff --git a/content/docs/references/data/filter/RangeOperator.mdx b/content/docs/references/data/filter/RangeOperator.mdx index 618f6c323..5b0311b12 100644 --- a/content/docs/references/data/filter/RangeOperator.mdx +++ b/content/docs/references/data/filter/RangeOperator.mdx @@ -1,10 +1,35 @@ --- title: RangeOperator description: RangeOperator Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **$between** | `any[]` | optional | | + +## TypeScript Usage + +```typescript +import { RangeOperatorSchema } from '@objectstack/spec/data'; +import type { RangeOperator } from '@objectstack/spec/data'; + +// Validate data +const result = RangeOperatorSchema.parse(data); + +// Type-safe usage +const myRangeOperator: RangeOperator = { +}; +``` + diff --git a/content/docs/references/data/filter/SetOperator.mdx b/content/docs/references/data/filter/SetOperator.mdx index c3b5290c7..284164424 100644 --- a/content/docs/references/data/filter/SetOperator.mdx +++ b/content/docs/references/data/filter/SetOperator.mdx @@ -1,11 +1,36 @@ --- title: SetOperator description: SetOperator Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **$in** | `any[]` | optional | | | **$nin** | `any[]` | optional | | + +## TypeScript Usage + +```typescript +import { SetOperatorSchema } from '@objectstack/spec/data'; +import type { SetOperator } from '@objectstack/spec/data'; + +// Validate data +const result = SetOperatorSchema.parse(data); + +// Type-safe usage +const mySetOperator: SetOperator = { +}; +``` + diff --git a/content/docs/references/data/filter/SpecialOperator.mdx b/content/docs/references/data/filter/SpecialOperator.mdx index 65aa64c98..34a847316 100644 --- a/content/docs/references/data/filter/SpecialOperator.mdx +++ b/content/docs/references/data/filter/SpecialOperator.mdx @@ -1,11 +1,36 @@ --- title: SpecialOperator description: SpecialOperator Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **$null** | `boolean` | optional | | | **$exist** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { SpecialOperatorSchema } from '@objectstack/spec/data'; +import type { SpecialOperator } from '@objectstack/spec/data'; + +// Validate data +const result = SpecialOperatorSchema.parse(data); + +// Type-safe usage +const mySpecialOperator: SpecialOperator = { +}; +``` + diff --git a/content/docs/references/data/filter/StringOperator.mdx b/content/docs/references/data/filter/StringOperator.mdx index a2b0b6f94..554031e9a 100644 --- a/content/docs/references/data/filter/StringOperator.mdx +++ b/content/docs/references/data/filter/StringOperator.mdx @@ -1,8 +1,18 @@ --- title: StringOperator description: StringOperator Schema Reference +category: data +zodFile: filter --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: StringOperator Schema Reference | **$contains** | `string` | optional | | | **$startsWith** | `string` | optional | | | **$endsWith** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { StringOperatorSchema } from '@objectstack/spec/data'; +import type { StringOperator } from '@objectstack/spec/data'; + +// Validate data +const result = StringOperatorSchema.parse(data); + +// Type-safe usage +const myStringOperator: StringOperator = { +}; +``` + diff --git a/content/docs/references/data/hook/Hook.mdx b/content/docs/references/data/hook/Hook.mdx index 11e76ccdd..bb90c5cdf 100644 --- a/content/docs/references/data/hook/Hook.mdx +++ b/content/docs/references/data/hook/Hook.mdx @@ -1,8 +1,18 @@ --- title: Hook description: Hook Schema Reference +category: data +zodFile: hook --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/hook.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,21 @@ description: Hook Schema Reference | **priority** | `number` | optional | Execution priority | | **async** | `boolean` | optional | Run specifically as fire-and-forget | | **onError** | `Enum<'abort' \| 'log'>` | optional | Error handling strategy | + +## TypeScript Usage + +```typescript +import { HookSchema } from '@objectstack/spec/data'; +import type { Hook } from '@objectstack/spec/data'; + +// Validate data +const result = HookSchema.parse(data); + +// Type-safe usage +const myHook: Hook = { + name: 'name', + object: null, + events: [] +}; +``` + diff --git a/content/docs/references/data/hook/HookContext.mdx b/content/docs/references/data/hook/HookContext.mdx index a01727c76..712579251 100644 --- a/content/docs/references/data/hook/HookContext.mdx +++ b/content/docs/references/data/hook/HookContext.mdx @@ -1,8 +1,18 @@ --- title: HookContext description: HookContext Schema Reference +category: data +zodFile: hook --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/hook.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,21 @@ description: HookContext Schema Reference | **session** | `object` | optional | Current session context | | **transaction** | `any` | optional | Database transaction handle | | **ql** | `any` | optional | ObjectQL Engine Reference | + +## TypeScript Usage + +```typescript +import { HookContextSchema } from '@objectstack/spec/data'; +import type { HookContext } from '@objectstack/spec/data'; + +// Validate data +const result = HookContextSchema.parse(data); + +// Type-safe usage +const myHookContext: HookContext = { + object: 'example', + event: 'beforeFind', + input: {} +}; +``` + diff --git a/content/docs/references/data/hook/HookEvent.mdx b/content/docs/references/data/hook/HookEvent.mdx index 3b25c657e..6136248a3 100644 --- a/content/docs/references/data/hook/HookEvent.mdx +++ b/content/docs/references/data/hook/HookEvent.mdx @@ -1,8 +1,18 @@ --- title: HookEvent description: HookEvent Schema Reference +category: data +zodFile: hook --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/hook.zod.ts` + + ## Allowed Values * `beforeFind` @@ -22,4 +32,14 @@ description: HookEvent Schema Reference * `beforeUpdateMany` * `afterUpdateMany` * `beforeDeleteMany` -* `afterDeleteMany` \ No newline at end of file +* `afterDeleteMany` + +## TypeScript Usage + +```typescript +import { HookEvent } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: HookEvent = 'beforeFind'; +``` + diff --git a/content/docs/references/data/index.mdx b/content/docs/references/data/index.mdx new file mode 100644 index 000000000..4964a9faa --- /dev/null +++ b/content/docs/references/data/index.mdx @@ -0,0 +1,110 @@ +--- +title: Data Protocol Overview +description: Complete reference for all data protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# Data Protocol + +This section contains all protocol schemas for the data layer of ObjectStack. + +## Dataset + +Source: `packages/spec/src/data/dataset.zod.ts` + + + + + + +## Field + +Source: `packages/spec/src/data/field.zod.ts` + + + + + + + + + + + + +## Filter + +Source: `packages/spec/src/data/filter.zod.ts` + + + + + + + + + + + + + + + +## Hook + +Source: `packages/spec/src/data/hook.zod.ts` + + + + + + + +## Object + +Source: `packages/spec/src/data/object.zod.ts` + + + + + + + + +## Query + +Source: `packages/spec/src/data/query.zod.ts` + + + + + + + + + + + + + + + +## Validation + +Source: `packages/spec/src/data/validation.zod.ts` + + + + + + + + + + + + + + diff --git a/content/docs/references/data/object/Index.mdx b/content/docs/references/data/object/Index.mdx index e8059bb62..f7ac488c2 100644 --- a/content/docs/references/data/object/Index.mdx +++ b/content/docs/references/data/object/Index.mdx @@ -1,8 +1,18 @@ --- title: Index description: Index Schema Reference +category: data +zodFile: object --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/object.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: Index Schema Reference | **fields** | `string[]` | ✅ | Fields included in the index | | **unique** | `boolean` | optional | Whether the index is unique | | **type** | `Enum<'btree' \| 'hash' \| 'gin' \| 'gist'>` | optional | Index type (default: btree) | + +## TypeScript Usage + +```typescript +import { IndexSchema } from '@objectstack/spec/data'; +import type { Index } from '@objectstack/spec/data'; + +// Validate data +const result = IndexSchema.parse(data); + +// Type-safe usage +const myIndex: Index = { + fields: [] +}; +``` + diff --git a/content/docs/references/data/object/Object.mdx b/content/docs/references/data/object/Object.mdx index d9aca8c56..21f7abfe0 100644 --- a/content/docs/references/data/object/Object.mdx +++ b/content/docs/references/data/object/Object.mdx @@ -1,8 +1,18 @@ --- title: Object description: Object Schema Reference +category: data +zodFile: object --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/object.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -25,3 +35,20 @@ description: Object Schema Reference | **compactLayout** | `string[]` | optional | Primary fields for hover/cards/lookups | | **search** | `object` | optional | Search engine configuration | | **enable** | `object` | optional | Enabled system features modules | + +## TypeScript Usage + +```typescript +import { ObjectSchema } from '@objectstack/spec/data'; +import type { Object } from '@objectstack/spec/data'; + +// Validate data +const result = ObjectSchema.parse(data); + +// Type-safe usage +const myObject: Object = { + name: 'name', + fields: {} +}; +``` + diff --git a/content/docs/references/data/object/ObjectCapabilities.mdx b/content/docs/references/data/object/ObjectCapabilities.mdx index 14d269fdc..bc160c26a 100644 --- a/content/docs/references/data/object/ObjectCapabilities.mdx +++ b/content/docs/references/data/object/ObjectCapabilities.mdx @@ -1,8 +1,18 @@ --- title: ObjectCapabilities description: ObjectCapabilities Schema Reference +category: data +zodFile: object --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/object.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,18 @@ description: ObjectCapabilities Schema Reference | **trash** | `boolean` | optional | Enable soft-delete with restore capability | | **mru** | `boolean` | optional | Track Most Recently Used (MRU) list for users | | **clone** | `boolean` | optional | Allow record deep cloning | + +## TypeScript Usage + +```typescript +import { ObjectCapabilitiesSchema } from '@objectstack/spec/data'; +import type { ObjectCapabilities } from '@objectstack/spec/data'; + +// Validate data +const result = ObjectCapabilitiesSchema.parse(data); + +// Type-safe usage +const myObjectCapabilities: ObjectCapabilities = { +}; +``` + diff --git a/content/docs/references/data/object/SearchConfig.mdx b/content/docs/references/data/object/SearchConfig.mdx index fa44545ea..e2b0a77c9 100644 --- a/content/docs/references/data/object/SearchConfig.mdx +++ b/content/docs/references/data/object/SearchConfig.mdx @@ -1,8 +1,18 @@ --- title: SearchConfig description: SearchConfig Schema Reference +category: data +zodFile: object --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/object.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: SearchConfig Schema Reference | **fields** | `string[]` | ✅ | Fields to index for full-text search weighting | | **displayFields** | `string[]` | optional | Fields to display in search result cards | | **filters** | `string[]` | optional | Default filters for search results | + +## TypeScript Usage + +```typescript +import { SearchConfigSchema } from '@objectstack/spec/data'; +import type { SearchConfig } from '@objectstack/spec/data'; + +// Validate data +const result = SearchConfigSchema.parse(data); + +// Type-safe usage +const mySearchConfig: SearchConfig = { + fields: [] +}; +``` + diff --git a/content/docs/references/data/query/AggregationFunction.mdx b/content/docs/references/data/query/AggregationFunction.mdx index 9477b17f8..950694610 100644 --- a/content/docs/references/data/query/AggregationFunction.mdx +++ b/content/docs/references/data/query/AggregationFunction.mdx @@ -1,8 +1,18 @@ --- title: AggregationFunction description: AggregationFunction Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Allowed Values * `count` @@ -12,4 +22,14 @@ description: AggregationFunction Schema Reference * `max` * `count_distinct` * `array_agg` -* `string_agg` \ No newline at end of file +* `string_agg` + +## TypeScript Usage + +```typescript +import { AggregationFunction } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: AggregationFunction = 'count'; +``` + diff --git a/content/docs/references/data/query/AggregationNode.mdx b/content/docs/references/data/query/AggregationNode.mdx index aa9a4d7c4..9ab3d187a 100644 --- a/content/docs/references/data/query/AggregationNode.mdx +++ b/content/docs/references/data/query/AggregationNode.mdx @@ -1,8 +1,18 @@ --- title: AggregationNode description: AggregationNode Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: AggregationNode Schema Reference | **alias** | `string` | ✅ | Result column alias | | **distinct** | `boolean` | optional | Apply DISTINCT before aggregation | | **filter** | `any` | optional | Filter/Condition to apply to the aggregation (FILTER WHERE clause) | + +## TypeScript Usage + +```typescript +import { AggregationNodeSchema } from '@objectstack/spec/data'; +import type { AggregationNode } from '@objectstack/spec/data'; + +// Validate data +const result = AggregationNodeSchema.parse(data); + +// Type-safe usage +const myAggregationNode: AggregationNode = { + function: 'count', + alias: 'example' +}; +``` + diff --git a/content/docs/references/data/query/FieldNode.mdx b/content/docs/references/data/query/FieldNode.mdx index 7f363499b..ce12e5661 100644 --- a/content/docs/references/data/query/FieldNode.mdx +++ b/content/docs/references/data/query/FieldNode.mdx @@ -1,5 +1,15 @@ --- title: FieldNode description: FieldNode Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + diff --git a/content/docs/references/data/query/JoinNode.mdx b/content/docs/references/data/query/JoinNode.mdx index 120379e0f..10c487348 100644 --- a/content/docs/references/data/query/JoinNode.mdx +++ b/content/docs/references/data/query/JoinNode.mdx @@ -1,8 +1,18 @@ --- title: JoinNode description: JoinNode Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: JoinNode Schema Reference | **alias** | `string` | optional | Table alias | | **on** | `any` | ✅ | Join condition | | **subquery** | `object` | optional | Subquery instead of object | + +## TypeScript Usage + +```typescript +import { JoinNodeSchema } from '@objectstack/spec/data'; +import type { JoinNode } from '@objectstack/spec/data'; + +// Validate data +const result = JoinNodeSchema.parse(data); + +// Type-safe usage +const myJoinNode: JoinNode = { + type: 'inner', + object: 'example', + on: null +}; +``` + diff --git a/content/docs/references/data/query/JoinStrategy.mdx b/content/docs/references/data/query/JoinStrategy.mdx index cab1eaca1..264ca4c52 100644 --- a/content/docs/references/data/query/JoinStrategy.mdx +++ b/content/docs/references/data/query/JoinStrategy.mdx @@ -1,11 +1,31 @@ --- title: JoinStrategy description: JoinStrategy Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Allowed Values * `auto` * `database` * `hash` -* `loop` \ No newline at end of file +* `loop` + +## TypeScript Usage + +```typescript +import { JoinStrategy } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: JoinStrategy = 'auto'; +``` + diff --git a/content/docs/references/data/query/JoinType.mdx b/content/docs/references/data/query/JoinType.mdx index b83d28253..265975df6 100644 --- a/content/docs/references/data/query/JoinType.mdx +++ b/content/docs/references/data/query/JoinType.mdx @@ -1,11 +1,31 @@ --- title: JoinType description: JoinType Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Allowed Values * `inner` * `left` * `right` -* `full` \ No newline at end of file +* `full` + +## TypeScript Usage + +```typescript +import { JoinType } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: JoinType = 'inner'; +``` + diff --git a/content/docs/references/data/query/Query.mdx b/content/docs/references/data/query/Query.mdx index 1d809d213..6d6e657d0 100644 --- a/content/docs/references/data/query/Query.mdx +++ b/content/docs/references/data/query/Query.mdx @@ -1,8 +1,18 @@ --- title: Query description: Query Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,19 @@ description: Query Schema Reference | **having** | `any` | optional | HAVING clause for aggregation filtering | | **windowFunctions** | `object[]` | optional | Window functions with OVER clause | | **distinct** | `boolean` | optional | SELECT DISTINCT flag | + +## TypeScript Usage + +```typescript +import { QuerySchema } from '@objectstack/spec/data'; +import type { Query } from '@objectstack/spec/data'; + +// Validate data +const result = QuerySchema.parse(data); + +// Type-safe usage +const myQuery: Query = { + object: 'example' +}; +``` + diff --git a/content/docs/references/data/query/SortNode.mdx b/content/docs/references/data/query/SortNode.mdx index 1574f19bc..ec06497ad 100644 --- a/content/docs/references/data/query/SortNode.mdx +++ b/content/docs/references/data/query/SortNode.mdx @@ -1,11 +1,37 @@ --- title: SortNode description: SortNode Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **field** | `string` | ✅ | | | **order** | `Enum<'asc' \| 'desc'>` | optional | | + +## TypeScript Usage + +```typescript +import { SortNodeSchema } from '@objectstack/spec/data'; +import type { SortNode } from '@objectstack/spec/data'; + +// Validate data +const result = SortNodeSchema.parse(data); + +// Type-safe usage +const mySortNode: SortNode = { + field: 'example' +}; +``` + diff --git a/content/docs/references/data/query/WindowFunction.mdx b/content/docs/references/data/query/WindowFunction.mdx index 598d21b6b..ba826256a 100644 --- a/content/docs/references/data/query/WindowFunction.mdx +++ b/content/docs/references/data/query/WindowFunction.mdx @@ -1,8 +1,18 @@ --- title: WindowFunction description: WindowFunction Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Allowed Values * `row_number` @@ -17,4 +27,14 @@ description: WindowFunction Schema Reference * `avg` * `count` * `min` -* `max` \ No newline at end of file +* `max` + +## TypeScript Usage + +```typescript +import { WindowFunction } from '@objectstack/spec/data'; + +// Type-safe enum value +const value: WindowFunction = 'row_number'; +``` + diff --git a/content/docs/references/data/query/WindowFunctionNode.mdx b/content/docs/references/data/query/WindowFunctionNode.mdx index c0a9f0e9b..17ca683ec 100644 --- a/content/docs/references/data/query/WindowFunctionNode.mdx +++ b/content/docs/references/data/query/WindowFunctionNode.mdx @@ -1,8 +1,18 @@ --- title: WindowFunctionNode description: WindowFunctionNode Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: WindowFunctionNode Schema Reference | **field** | `string` | optional | Field to operate on (for aggregate window functions) | | **alias** | `string` | ✅ | Result column alias | | **over** | `object` | ✅ | Window specification (OVER clause) | + +## TypeScript Usage + +```typescript +import { WindowFunctionNodeSchema } from '@objectstack/spec/data'; +import type { WindowFunctionNode } from '@objectstack/spec/data'; + +// Validate data +const result = WindowFunctionNodeSchema.parse(data); + +// Type-safe usage +const myWindowFunctionNode: WindowFunctionNode = { + function: 'row_number', + alias: 'example', + over: {} +}; +``` + diff --git a/content/docs/references/data/query/WindowSpec.mdx b/content/docs/references/data/query/WindowSpec.mdx index 0093f8533..deeed0e89 100644 --- a/content/docs/references/data/query/WindowSpec.mdx +++ b/content/docs/references/data/query/WindowSpec.mdx @@ -1,8 +1,18 @@ --- title: WindowSpec description: WindowSpec Schema Reference +category: data +zodFile: query --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/query.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: WindowSpec Schema Reference | **partitionBy** | `string[]` | optional | PARTITION BY fields | | **orderBy** | `object[]` | optional | ORDER BY specification | | **frame** | `object` | optional | Window frame specification | + +## TypeScript Usage + +```typescript +import { WindowSpecSchema } from '@objectstack/spec/data'; +import type { WindowSpec } from '@objectstack/spec/data'; + +// Validate data +const result = WindowSpecSchema.parse(data); + +// Type-safe usage +const myWindowSpec: WindowSpec = { +}; +``` + diff --git a/content/docs/references/data/validation/AsyncValidation.mdx b/content/docs/references/data/validation/AsyncValidation.mdx index 07a921950..7e9c2bc97 100644 --- a/content/docs/references/data/validation/AsyncValidation.mdx +++ b/content/docs/references/data/validation/AsyncValidation.mdx @@ -1,8 +1,18 @@ --- title: AsyncValidation description: AsyncValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -24,3 +34,22 @@ description: AsyncValidation Schema Reference | **timeout** | `number` | optional | Timeout in milliseconds | | **debounce** | `number` | optional | Debounce delay in milliseconds | | **params** | `Record` | optional | Additional parameters to pass to validator | + +## TypeScript Usage + +```typescript +import { AsyncValidationSchema } from '@objectstack/spec/data'; +import type { AsyncValidation } from '@objectstack/spec/data'; + +// Validate data +const result = AsyncValidationSchema.parse(data); + +// Type-safe usage +const myAsyncValidation: AsyncValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/ConditionalValidation.mdx b/content/docs/references/data/validation/ConditionalValidation.mdx index 663670772..ecfae6662 100644 --- a/content/docs/references/data/validation/ConditionalValidation.mdx +++ b/content/docs/references/data/validation/ConditionalValidation.mdx @@ -1,8 +1,18 @@ --- title: ConditionalValidation description: ConditionalValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -19,3 +29,22 @@ description: ConditionalValidation Schema Reference | **when** | `string` | ✅ | Condition formula (e.g. "type = 'enterprise'") | | **then** | `object \| object \| object \| object \| object \| object \| object \| object \| any` | ✅ | Validation rule to apply when condition is true | | **otherwise** | `object \| object \| object \| object \| object \| object \| object \| object \| any` | optional | Validation rule to apply when condition is false | + +## TypeScript Usage + +```typescript +import { ConditionalValidationSchema } from '@objectstack/spec/data'; +import type { ConditionalValidation } from '@objectstack/spec/data'; + +// Validate data +const result = ConditionalValidationSchema.parse(data); + +// Type-safe usage +const myConditionalValidation: ConditionalValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/CrossFieldValidation.mdx b/content/docs/references/data/validation/CrossFieldValidation.mdx index 9e55e2149..96aa0d715 100644 --- a/content/docs/references/data/validation/CrossFieldValidation.mdx +++ b/content/docs/references/data/validation/CrossFieldValidation.mdx @@ -1,8 +1,18 @@ --- title: CrossFieldValidation description: CrossFieldValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: CrossFieldValidation Schema Reference | **type** | `string` | ✅ | | | **condition** | `string` | ✅ | Formula expression comparing fields (e.g. "end_date > start_date") | | **fields** | `string[]` | ✅ | Fields involved in the validation | + +## TypeScript Usage + +```typescript +import { CrossFieldValidationSchema } from '@objectstack/spec/data'; +import type { CrossFieldValidation } from '@objectstack/spec/data'; + +// Validate data +const result = CrossFieldValidationSchema.parse(data); + +// Type-safe usage +const myCrossFieldValidation: CrossFieldValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/CustomValidator.mdx b/content/docs/references/data/validation/CustomValidator.mdx index b373f0a9e..3dc821d12 100644 --- a/content/docs/references/data/validation/CustomValidator.mdx +++ b/content/docs/references/data/validation/CustomValidator.mdx @@ -1,8 +1,18 @@ --- title: CustomValidator description: CustomValidator Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: CustomValidator Schema Reference | **type** | `string` | ✅ | | | **handler** | `string` | ✅ | Name of the custom validation function registered in the system | | **params** | `Record` | optional | Parameters passed to the custom handler | + +## TypeScript Usage + +```typescript +import { CustomValidatorSchema } from '@objectstack/spec/data'; +import type { CustomValidator } from '@objectstack/spec/data'; + +// Validate data +const result = CustomValidatorSchema.parse(data); + +// Type-safe usage +const myCustomValidator: CustomValidator = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/FormatValidation.mdx b/content/docs/references/data/validation/FormatValidation.mdx index 2cb09badc..59634283c 100644 --- a/content/docs/references/data/validation/FormatValidation.mdx +++ b/content/docs/references/data/validation/FormatValidation.mdx @@ -1,8 +1,18 @@ --- title: FormatValidation description: FormatValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -19,3 +29,22 @@ description: FormatValidation Schema Reference | **field** | `string` | ✅ | | | **regex** | `string` | optional | | | **format** | `Enum<'email' \| 'url' \| 'phone' \| 'json'>` | optional | | + +## TypeScript Usage + +```typescript +import { FormatValidationSchema } from '@objectstack/spec/data'; +import type { FormatValidation } from '@objectstack/spec/data'; + +// Validate data +const result = FormatValidationSchema.parse(data); + +// Type-safe usage +const myFormatValidation: FormatValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/JSONValidation.mdx b/content/docs/references/data/validation/JSONValidation.mdx index e8d3ce100..b09b93df6 100644 --- a/content/docs/references/data/validation/JSONValidation.mdx +++ b/content/docs/references/data/validation/JSONValidation.mdx @@ -1,8 +1,18 @@ --- title: JSONValidation description: JSONValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: JSONValidation Schema Reference | **type** | `string` | ✅ | | | **field** | `string` | ✅ | JSON field to validate | | **schema** | `Record` | ✅ | JSON Schema object definition | + +## TypeScript Usage + +```typescript +import { JSONValidationSchema } from '@objectstack/spec/data'; +import type { JSONValidation } from '@objectstack/spec/data'; + +// Validate data +const result = JSONValidationSchema.parse(data); + +// Type-safe usage +const myJSONValidation: JSONValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/ScriptValidation.mdx b/content/docs/references/data/validation/ScriptValidation.mdx index 8331642bb..f3d3541ae 100644 --- a/content/docs/references/data/validation/ScriptValidation.mdx +++ b/content/docs/references/data/validation/ScriptValidation.mdx @@ -1,8 +1,18 @@ --- title: ScriptValidation description: ScriptValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,22 @@ description: ScriptValidation Schema Reference | **message** | `string` | ✅ | Error message to display to the user | | **type** | `string` | ✅ | | | **condition** | `string` | ✅ | Formula expression. If TRUE, validation fails. (e.g. amount < 0) | + +## TypeScript Usage + +```typescript +import { ScriptValidationSchema } from '@objectstack/spec/data'; +import type { ScriptValidation } from '@objectstack/spec/data'; + +// Validate data +const result = ScriptValidationSchema.parse(data); + +// Type-safe usage +const myScriptValidation: ScriptValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/StateMachineValidation.mdx b/content/docs/references/data/validation/StateMachineValidation.mdx index c5e6c835f..c95f941b9 100644 --- a/content/docs/references/data/validation/StateMachineValidation.mdx +++ b/content/docs/references/data/validation/StateMachineValidation.mdx @@ -1,8 +1,18 @@ --- title: StateMachineValidation description: StateMachineValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: StateMachineValidation Schema Reference | **type** | `string` | ✅ | | | **field** | `string` | ✅ | State field (e.g. status) | | **transitions** | `Record` | ✅ | Map of `{ OldState: [AllowedNewStates] }` | + +## TypeScript Usage + +```typescript +import { StateMachineValidationSchema } from '@objectstack/spec/data'; +import type { StateMachineValidation } from '@objectstack/spec/data'; + +// Validate data +const result = StateMachineValidationSchema.parse(data); + +// Type-safe usage +const myStateMachineValidation: StateMachineValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/UniquenessValidation.mdx b/content/docs/references/data/validation/UniquenessValidation.mdx index 4c5f80c7c..da9f3d34d 100644 --- a/content/docs/references/data/validation/UniquenessValidation.mdx +++ b/content/docs/references/data/validation/UniquenessValidation.mdx @@ -1,8 +1,18 @@ --- title: UniquenessValidation description: UniquenessValidation Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -19,3 +29,22 @@ description: UniquenessValidation Schema Reference | **fields** | `string[]` | ✅ | Fields that must be combined unique | | **scope** | `string` | optional | Formula condition for scope (e.g. active = true) | | **caseSensitive** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { UniquenessValidationSchema } from '@objectstack/spec/data'; +import type { UniquenessValidation } from '@objectstack/spec/data'; + +// Validate data +const result = UniquenessValidationSchema.parse(data); + +// Type-safe usage +const myUniquenessValidation: UniquenessValidation = { + name: 'name', + message: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/data/validation/ValidationRule.mdx b/content/docs/references/data/validation/ValidationRule.mdx index 8acc0ff10..d200d58e3 100644 --- a/content/docs/references/data/validation/ValidationRule.mdx +++ b/content/docs/references/data/validation/ValidationRule.mdx @@ -1,5 +1,15 @@ --- title: ValidationRule description: ValidationRule Schema Reference +category: data +zodFile: validation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + diff --git a/content/docs/references/hub/composer/BillOfMaterials.mdx b/content/docs/references/hub/composer/BillOfMaterials.mdx index dc046e80b..f647f02b6 100644 --- a/content/docs/references/hub/composer/BillOfMaterials.mdx +++ b/content/docs/references/hub/composer/BillOfMaterials.mdx @@ -1,8 +1,18 @@ --- title: BillOfMaterials description: BillOfMaterials Schema Reference +category: hub +zodFile: composer --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/composer.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: BillOfMaterials Schema Reference | **dependencies** | `object[]` | ✅ | Installed packages | | **environment** | `Record` | optional | | | **resolutionStrategy** | `Enum<'strict' \| 'override' \| 'merge'>` | optional | Conflict resolution strategy (strict=fail, override=last-wins, merge=deep-merge) | + +## TypeScript Usage + +```typescript +import { BillOfMaterialsSchema } from '@objectstack/spec/hub'; +import type { BillOfMaterials } from '@objectstack/spec/hub'; + +// Validate data +const result = BillOfMaterialsSchema.parse(data); + +// Type-safe usage +const myBillOfMaterials: BillOfMaterials = { + tenantId: 'example', + dependencies: [] +}; +``` + diff --git a/content/docs/references/hub/composer/ComposerRequest.mdx b/content/docs/references/hub/composer/ComposerRequest.mdx index f69a711bf..94f4a4890 100644 --- a/content/docs/references/hub/composer/ComposerRequest.mdx +++ b/content/docs/references/hub/composer/ComposerRequest.mdx @@ -1,8 +1,18 @@ --- title: ComposerRequest description: ComposerRequest Schema Reference +category: hub +zodFile: composer --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/composer.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: ComposerRequest Schema Reference | **bom** | `object` | ✅ | | | **runtimeVersion** | `string` | optional | | | **dryRun** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { ComposerRequestSchema } from '@objectstack/spec/hub'; +import type { ComposerRequest } from '@objectstack/spec/hub'; + +// Validate data +const result = ComposerRequestSchema.parse(data); + +// Type-safe usage +const myComposerRequest: ComposerRequest = { + bom: {} +}; +``` + diff --git a/content/docs/references/hub/composer/ComposerResponse.mdx b/content/docs/references/hub/composer/ComposerResponse.mdx index 97d4b5ed9..c61bba161 100644 --- a/content/docs/references/hub/composer/ComposerResponse.mdx +++ b/content/docs/references/hub/composer/ComposerResponse.mdx @@ -1,8 +1,18 @@ --- title: ComposerResponse description: ComposerResponse Schema Reference +category: hub +zodFile: composer --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/composer.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: ComposerResponse Schema Reference | **duration** | `number` | ✅ | Compilation time in ms | | **conflicts** | `object[]` | optional | | | **errors** | `string[]` | optional | | + +## TypeScript Usage + +```typescript +import { ComposerResponseSchema } from '@objectstack/spec/hub'; +import type { ComposerResponse } from '@objectstack/spec/hub'; + +// Validate data +const result = ComposerResponseSchema.parse(data); + +// Type-safe usage +const myComposerResponse: ComposerResponse = { + success: false, + buildId: 'example', + timestamp: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/hub/composer/ConflictReport.mdx b/content/docs/references/hub/composer/ConflictReport.mdx index 8f9f89c24..96a96afb6 100644 --- a/content/docs/references/hub/composer/ConflictReport.mdx +++ b/content/docs/references/hub/composer/ConflictReport.mdx @@ -1,8 +1,18 @@ --- title: ConflictReport description: ConflictReport Schema Reference +category: hub +zodFile: composer --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/composer.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,22 @@ description: ConflictReport Schema Reference | **sources** | `string[]` | ✅ | List of plugin IDs defining this resource | | **resolution** | `string` | ✅ | How it was resolved (e.g. "com.example.erp won") | | **severity** | `Enum<'info' \| 'warning' \| 'error'>` | ✅ | Severity of the conflict | + +## TypeScript Usage + +```typescript +import { ConflictReportSchema } from '@objectstack/spec/hub'; +import type { ConflictReport } from '@objectstack/spec/hub'; + +// Validate data +const result = ConflictReportSchema.parse(data); + +// Type-safe usage +const myConflictReport: ConflictReport = { + resourceType: 'object', + resourceId: 'example', + sources: [], + // ... other fields +}; +``` + diff --git a/content/docs/references/hub/composer/DependencyRequirement.mdx b/content/docs/references/hub/composer/DependencyRequirement.mdx index e47f0a732..2d6bac497 100644 --- a/content/docs/references/hub/composer/DependencyRequirement.mdx +++ b/content/docs/references/hub/composer/DependencyRequirement.mdx @@ -1,8 +1,18 @@ --- title: DependencyRequirement description: DependencyRequirement Schema Reference +category: hub +zodFile: composer --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/composer.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: DependencyRequirement Schema Reference | **version** | `string` | optional | SemVer range or "latest" | | **configuration** | `Record` | optional | Configuration overrides | | **features** | `Record` | optional | Feature toggles | + +## TypeScript Usage + +```typescript +import { DependencyRequirementSchema } from '@objectstack/spec/hub'; +import type { DependencyRequirement } from '@objectstack/spec/hub'; + +// Validate data +const result = DependencyRequirementSchema.parse(data); + +// Type-safe usage +const myDependencyRequirement: DependencyRequirement = { + id: 'example' +}; +``` + diff --git a/content/docs/references/hub/index.mdx b/content/docs/references/hub/index.mdx new file mode 100644 index 000000000..94b116d79 --- /dev/null +++ b/content/docs/references/hub/index.mdx @@ -0,0 +1,71 @@ +--- +title: Hub Protocol Overview +description: Complete reference for all hub protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# Hub Protocol + +This section contains all protocol schemas for the hub layer of ObjectStack. + +## Composer + +Source: `packages/spec/src/hub/composer.zod.ts` + + + + + + + + + +## License + +Source: `packages/spec/src/hub/license.zod.ts` + + + + + + + + +## Marketplace + +Source: `packages/spec/src/hub/marketplace.zod.ts` + + + + + + + +## Space + +Source: `packages/spec/src/hub/space.zod.ts` + + + + + + + + +## Tenant + +Source: `packages/spec/src/hub/tenant.zod.ts` + + + + + + + + + + + + diff --git a/content/docs/references/hub/license/Feature.mdx b/content/docs/references/hub/license/Feature.mdx index 3a480aa1f..0602fa690 100644 --- a/content/docs/references/hub/license/Feature.mdx +++ b/content/docs/references/hub/license/Feature.mdx @@ -1,8 +1,18 @@ --- title: Feature description: Feature Schema Reference +category: hub +zodFile: license --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/license.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,20 @@ description: Feature Schema Reference | **type** | `Enum<'boolean' \| 'counter' \| 'gauge'>` | optional | | | **unit** | `Enum<'count' \| 'bytes' \| 'seconds' \| 'percent'>` | optional | | | **requires** | `string[]` | optional | | + +## TypeScript Usage + +```typescript +import { FeatureSchema } from '@objectstack/spec/hub'; +import type { Feature } from '@objectstack/spec/hub'; + +// Validate data +const result = FeatureSchema.parse(data); + +// Type-safe usage +const myFeature: Feature = { + code: 'example', + label: 'example' +}; +``` + diff --git a/content/docs/references/hub/license/License.mdx b/content/docs/references/hub/license/License.mdx index 4b987bbaf..2cc53f4db 100644 --- a/content/docs/references/hub/license/License.mdx +++ b/content/docs/references/hub/license/License.mdx @@ -1,8 +1,18 @@ --- title: License description: License Schema Reference +category: hub +zodFile: license --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/license.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: License Schema Reference | **customLimits** | `Record` | optional | | | **plugins** | `string[]` | optional | List of enabled plugin package IDs | | **signature** | `string` | optional | Cryptographic signature of the license | + +## TypeScript Usage + +```typescript +import { LicenseSchema } from '@objectstack/spec/hub'; +import type { License } from '@objectstack/spec/hub'; + +// Validate data +const result = LicenseSchema.parse(data); + +// Type-safe usage +const myLicense: License = { + spaceId: 'example', + planCode: 'example', + issuedAt: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/hub/license/MetricType.mdx b/content/docs/references/hub/license/MetricType.mdx index eae9b632e..b05e0a939 100644 --- a/content/docs/references/hub/license/MetricType.mdx +++ b/content/docs/references/hub/license/MetricType.mdx @@ -1,10 +1,30 @@ --- title: MetricType description: MetricType Schema Reference +category: hub +zodFile: license --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/license.zod.ts` + + ## Allowed Values * `boolean` * `counter` -* `gauge` \ No newline at end of file +* `gauge` + +## TypeScript Usage + +```typescript +import { MetricType } from '@objectstack/spec/hub'; + +// Type-safe enum value +const value: MetricType = 'boolean'; +``` + diff --git a/content/docs/references/hub/license/Plan.mdx b/content/docs/references/hub/license/Plan.mdx index 516b7b8a2..99aab27d2 100644 --- a/content/docs/references/hub/license/Plan.mdx +++ b/content/docs/references/hub/license/Plan.mdx @@ -1,8 +1,18 @@ --- title: Plan description: Plan Schema Reference +category: hub +zodFile: license --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/license.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: Plan Schema Reference | **currency** | `string` | optional | | | **priceMonthly** | `number` | optional | | | **priceYearly** | `number` | optional | | + +## TypeScript Usage + +```typescript +import { PlanSchema } from '@objectstack/spec/hub'; +import type { Plan } from '@objectstack/spec/hub'; + +// Validate data +const result = PlanSchema.parse(data); + +// Type-safe usage +const myPlan: Plan = { + code: 'example', + label: 'example', + features: [], + // ... other fields +}; +``` + diff --git a/content/docs/references/hub/marketplace/MarketplacePlugin.mdx b/content/docs/references/hub/marketplace/MarketplacePlugin.mdx index a12868ca7..75ad24145 100644 --- a/content/docs/references/hub/marketplace/MarketplacePlugin.mdx +++ b/content/docs/references/hub/marketplace/MarketplacePlugin.mdx @@ -1,8 +1,18 @@ --- title: MarketplacePlugin description: MarketplacePlugin Schema Reference +category: hub +zodFile: marketplace --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/marketplace.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -24,3 +34,21 @@ description: MarketplacePlugin Schema Reference | **rating** | `number` | optional | | | **pricing** | `object` | optional | | | **verified** | `boolean` | optional | Is verified maintaned by ObjectStack | + +## TypeScript Usage + +```typescript +import { MarketplacePluginSchema } from '@objectstack/spec/hub'; +import type { MarketplacePlugin } from '@objectstack/spec/hub'; + +// Validate data +const result = MarketplacePluginSchema.parse(data); + +// Type-safe usage +const myMarketplacePlugin: MarketplacePlugin = { + id: 'example', + label: 'example', + version: 'example' +}; +``` + diff --git a/content/docs/references/hub/marketplace/PluginAuthor.mdx b/content/docs/references/hub/marketplace/PluginAuthor.mdx index 220bac02d..36ce0c3b6 100644 --- a/content/docs/references/hub/marketplace/PluginAuthor.mdx +++ b/content/docs/references/hub/marketplace/PluginAuthor.mdx @@ -1,8 +1,18 @@ --- title: PluginAuthor description: PluginAuthor Schema Reference +category: hub +zodFile: marketplace --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/marketplace.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: PluginAuthor Schema Reference | **name** | `string` | ✅ | | | **email** | `string` | optional | | | **url** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { PluginAuthorSchema } from '@objectstack/spec/hub'; +import type { PluginAuthor } from '@objectstack/spec/hub'; + +// Validate data +const result = PluginAuthorSchema.parse(data); + +// Type-safe usage +const myPluginAuthor: PluginAuthor = { + name: 'name' +}; +``` + diff --git a/content/docs/references/hub/marketplace/PluginPricing.mdx b/content/docs/references/hub/marketplace/PluginPricing.mdx index 91ef36b3e..79b7480bd 100644 --- a/content/docs/references/hub/marketplace/PluginPricing.mdx +++ b/content/docs/references/hub/marketplace/PluginPricing.mdx @@ -1,8 +1,18 @@ --- title: PluginPricing description: PluginPricing Schema Reference +category: hub +zodFile: marketplace --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/marketplace.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: PluginPricing Schema Reference | **amount** | `number` | ✅ | | | **interval** | `Enum<'month' \| 'year'>` | optional | Required if type is recurring | | **trialDays** | `integer` | optional | | + +## TypeScript Usage + +```typescript +import { PluginPricingSchema } from '@objectstack/spec/hub'; +import type { PluginPricing } from '@objectstack/spec/hub'; + +// Validate data +const result = PluginPricingSchema.parse(data); + +// Type-safe usage +const myPluginPricing: PluginPricing = { + type: 'free', + amount: 0 +}; +``` + diff --git a/content/docs/references/hub/space/DeploymentTarget.mdx b/content/docs/references/hub/space/DeploymentTarget.mdx index 34e73ef9f..e1edf1aef 100644 --- a/content/docs/references/hub/space/DeploymentTarget.mdx +++ b/content/docs/references/hub/space/DeploymentTarget.mdx @@ -1,8 +1,18 @@ --- title: DeploymentTarget description: DeploymentTarget Schema Reference +category: hub +zodFile: space --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/space.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: DeploymentTarget Schema Reference | **region** | `string` | optional | | | **url** | `string` | optional | Public Access URL | | **env** | `Record` | optional | Runtime Environment Variables | + +## TypeScript Usage + +```typescript +import { DeploymentTargetSchema } from '@objectstack/spec/hub'; +import type { DeploymentTarget } from '@objectstack/spec/hub'; + +// Validate data +const result = DeploymentTargetSchema.parse(data); + +// Type-safe usage +const myDeploymentTarget: DeploymentTarget = { + provider: 'vercel' +}; +``` + diff --git a/content/docs/references/hub/space/HubSpace.mdx b/content/docs/references/hub/space/HubSpace.mdx index 0e789b129..70ef10471 100644 --- a/content/docs/references/hub/space/HubSpace.mdx +++ b/content/docs/references/hub/space/HubSpace.mdx @@ -1,8 +1,18 @@ --- title: HubSpace description: HubSpace Schema Reference +category: hub +zodFile: space --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/space.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,22 @@ description: HubSpace Schema Reference | **deployment** | `object` | optional | | | **createdAt** | `string` | ✅ | | | **updatedAt** | `string` | ✅ | | + +## TypeScript Usage + +```typescript +import { HubSpaceSchema } from '@objectstack/spec/hub'; +import type { HubSpace } from '@objectstack/spec/hub'; + +// Validate data +const result = HubSpaceSchema.parse(data); + +// Type-safe usage +const myHubSpace: HubSpace = { + id: 'example', + name: 'name', + slug: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/hub/space/SpaceSubscription.mdx b/content/docs/references/hub/space/SpaceSubscription.mdx index 0e68c11b3..3651441d5 100644 --- a/content/docs/references/hub/space/SpaceSubscription.mdx +++ b/content/docs/references/hub/space/SpaceSubscription.mdx @@ -1,8 +1,18 @@ --- title: SpaceSubscription description: SpaceSubscription Schema Reference +category: hub +zodFile: space --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/space.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,20 @@ description: SpaceSubscription Schema Reference | **stripeSubscriptionId** | `string` | optional | | | **addons** | `object[]` | optional | | | **usage** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { SpaceSubscriptionSchema } from '@objectstack/spec/hub'; +import type { SpaceSubscription } from '@objectstack/spec/hub'; + +// Validate data +const result = SpaceSubscriptionSchema.parse(data); + +// Type-safe usage +const mySpaceSubscription: SpaceSubscription = { + planId: 'example', + status: 'active' +}; +``` + diff --git a/content/docs/references/hub/space/SubscriptionStatus.mdx b/content/docs/references/hub/space/SubscriptionStatus.mdx index 8b8d01191..544fccead 100644 --- a/content/docs/references/hub/space/SubscriptionStatus.mdx +++ b/content/docs/references/hub/space/SubscriptionStatus.mdx @@ -1,12 +1,32 @@ --- title: SubscriptionStatus description: SubscriptionStatus Schema Reference +category: hub +zodFile: space --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/space.zod.ts` + + ## Allowed Values * `active` * `past_due` * `canceled` * `trialing` -* `incomplete` \ No newline at end of file +* `incomplete` + +## TypeScript Usage + +```typescript +import { SubscriptionStatus } from '@objectstack/spec/hub'; + +// Type-safe enum value +const value: SubscriptionStatus = 'active'; +``` + diff --git a/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx b/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx index 3e0d6ba8a..0bdcd6f20 100644 --- a/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx +++ b/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx @@ -1,8 +1,18 @@ --- title: DatabaseLevelIsolationStrategy description: DatabaseLevelIsolationStrategy Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: DatabaseLevelIsolationStrategy Schema Reference | **connectionPool** | `object` | optional | Connection pool configuration | | **backup** | `object` | optional | Backup configuration | | **encryption** | `object` | optional | Encryption configuration | + +## TypeScript Usage + +```typescript +import { DatabaseLevelIsolationStrategySchema } from '@objectstack/spec/hub'; +import type { DatabaseLevelIsolationStrategy } from '@objectstack/spec/hub'; + +// Validate data +const result = DatabaseLevelIsolationStrategySchema.parse(data); + +// Type-safe usage +const myDatabaseLevelIsolationStrategy: DatabaseLevelIsolationStrategy = { + strategy: 'example' +}; +``` + diff --git a/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx b/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx index b7ebe9be3..52df9d720 100644 --- a/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx +++ b/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx @@ -1,8 +1,18 @@ --- title: LevelIsolationStrategySchema description: LevelIsolationStrategySchema Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: LevelIsolationStrategySchema Schema Reference | **schema** | `object` | optional | Schema configuration | | **migrations** | `object` | optional | Migration configuration | | **performance** | `object` | optional | Performance settings | + +## TypeScript Usage + +```typescript +import { LevelIsolationStrategySchemaSchema } from '@objectstack/spec/hub'; +import type { LevelIsolationStrategySchema } from '@objectstack/spec/hub'; + +// Validate data +const result = LevelIsolationStrategySchemaSchema.parse(data); + +// Type-safe usage +const myLevelIsolationStrategySchema: LevelIsolationStrategySchema = { + strategy: 'example' +}; +``` + diff --git a/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx b/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx index e15a26aff..80c1f39a3 100644 --- a/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx +++ b/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx @@ -1,8 +1,18 @@ --- title: RowLevelIsolationStrategy description: RowLevelIsolationStrategy Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: RowLevelIsolationStrategy Schema Reference | **strategy** | `string` | ✅ | Row-level isolation strategy | | **database** | `object` | optional | Database configuration | | **performance** | `object` | optional | Performance settings | + +## TypeScript Usage + +```typescript +import { RowLevelIsolationStrategySchema } from '@objectstack/spec/hub'; +import type { RowLevelIsolationStrategy } from '@objectstack/spec/hub'; + +// Validate data +const result = RowLevelIsolationStrategySchema.parse(data); + +// Type-safe usage +const myRowLevelIsolationStrategy: RowLevelIsolationStrategy = { + strategy: 'example' +}; +``` + diff --git a/content/docs/references/hub/tenant/Tenant.mdx b/content/docs/references/hub/tenant/Tenant.mdx index 63b2241a6..b8bfdeffb 100644 --- a/content/docs/references/hub/tenant/Tenant.mdx +++ b/content/docs/references/hub/tenant/Tenant.mdx @@ -1,8 +1,18 @@ --- title: Tenant description: Tenant Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: Tenant Schema Reference | **isolationLevel** | `Enum<'shared_schema' \| 'isolated_schema' \| 'isolated_db'>` | ✅ | | | **customizations** | `Record` | optional | Custom configuration values | | **quotas** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { TenantSchema } from '@objectstack/spec/hub'; +import type { Tenant } from '@objectstack/spec/hub'; + +// Validate data +const result = TenantSchema.parse(data); + +// Type-safe usage +const myTenant: Tenant = { + id: 'example', + name: 'name', + isolationLevel: 'shared_schema' +}; +``` + diff --git a/content/docs/references/hub/tenant/TenantIsolationConfig.mdx b/content/docs/references/hub/tenant/TenantIsolationConfig.mdx index 80a0beec7..90eefe6cc 100644 --- a/content/docs/references/hub/tenant/TenantIsolationConfig.mdx +++ b/content/docs/references/hub/tenant/TenantIsolationConfig.mdx @@ -1,5 +1,15 @@ --- title: TenantIsolationConfig description: TenantIsolationConfig Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + diff --git a/content/docs/references/hub/tenant/TenantIsolationLevel.mdx b/content/docs/references/hub/tenant/TenantIsolationLevel.mdx index 74af0d0da..f1cd1f80e 100644 --- a/content/docs/references/hub/tenant/TenantIsolationLevel.mdx +++ b/content/docs/references/hub/tenant/TenantIsolationLevel.mdx @@ -1,10 +1,30 @@ --- title: TenantIsolationLevel description: TenantIsolationLevel Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Allowed Values * `shared_schema` * `isolated_schema` -* `isolated_db` \ No newline at end of file +* `isolated_db` + +## TypeScript Usage + +```typescript +import { TenantIsolationLevel } from '@objectstack/spec/hub'; + +// Type-safe enum value +const value: TenantIsolationLevel = 'shared_schema'; +``` + diff --git a/content/docs/references/hub/tenant/TenantQuota.mdx b/content/docs/references/hub/tenant/TenantQuota.mdx index f1eb79ae0..a4c19ed5c 100644 --- a/content/docs/references/hub/tenant/TenantQuota.mdx +++ b/content/docs/references/hub/tenant/TenantQuota.mdx @@ -1,8 +1,18 @@ --- title: TenantQuota description: TenantQuota Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: TenantQuota Schema Reference | **maxUsers** | `integer` | optional | Maximum number of users | | **maxStorage** | `integer` | optional | Maximum storage in bytes | | **apiRateLimit** | `integer` | optional | API requests per minute | + +## TypeScript Usage + +```typescript +import { TenantQuotaSchema } from '@objectstack/spec/hub'; +import type { TenantQuota } from '@objectstack/spec/hub'; + +// Validate data +const result = TenantQuotaSchema.parse(data); + +// Type-safe usage +const myTenantQuota: TenantQuota = { +}; +``` + diff --git a/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx b/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx index 42a8fb480..992b45d4f 100644 --- a/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx +++ b/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx @@ -1,8 +1,18 @@ --- title: TenantSecurityPolicy description: TenantSecurityPolicy Schema Reference +category: hub +zodFile: tenant --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: TenantSecurityPolicy Schema Reference | **encryption** | `object` | optional | Encryption requirements | | **accessControl** | `object` | optional | Access control requirements | | **compliance** | `object` | optional | Compliance requirements | + +## TypeScript Usage + +```typescript +import { TenantSecurityPolicySchema } from '@objectstack/spec/hub'; +import type { TenantSecurityPolicy } from '@objectstack/spec/hub'; + +// Validate data +const result = TenantSecurityPolicySchema.parse(data); + +// Type-safe usage +const myTenantSecurityPolicy: TenantSecurityPolicy = { +}; +``` + diff --git a/content/docs/references/permission/index.mdx b/content/docs/references/permission/index.mdx new file mode 100644 index 000000000..7891734d8 --- /dev/null +++ b/content/docs/references/permission/index.mdx @@ -0,0 +1,58 @@ +--- +title: Permission Protocol Overview +description: Complete reference for all permission protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# Permission Protocol + +This section contains all protocol schemas for the permission layer of ObjectStack. + +## Permission + +Source: `packages/spec/src/permission/permission.zod.ts` + + + + + + + +## Rls + +Source: `packages/spec/src/permission/rls.zod.ts` + + + + + + + + + +## Sharing + +Source: `packages/spec/src/permission/sharing.zod.ts` + + + + + + + + + + + +## Territory + +Source: `packages/spec/src/permission/territory.zod.ts` + + + + + + + diff --git a/content/docs/references/permission/permission/FieldPermission.mdx b/content/docs/references/permission/permission/FieldPermission.mdx index 61319166a..5201cd3fa 100644 --- a/content/docs/references/permission/permission/FieldPermission.mdx +++ b/content/docs/references/permission/permission/FieldPermission.mdx @@ -1,11 +1,36 @@ --- title: FieldPermission description: FieldPermission Schema Reference +category: permission +zodFile: permission --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/permission.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **readable** | `boolean` | optional | Field read access | | **editable** | `boolean` | optional | Field edit access | + +## TypeScript Usage + +```typescript +import { FieldPermissionSchema } from '@objectstack/spec/permission'; +import type { FieldPermission } from '@objectstack/spec/permission'; + +// Validate data +const result = FieldPermissionSchema.parse(data); + +// Type-safe usage +const myFieldPermission: FieldPermission = { +}; +``` + diff --git a/content/docs/references/permission/permission/ObjectPermission.mdx b/content/docs/references/permission/permission/ObjectPermission.mdx index 67c734862..5aa5e6993 100644 --- a/content/docs/references/permission/permission/ObjectPermission.mdx +++ b/content/docs/references/permission/permission/ObjectPermission.mdx @@ -1,8 +1,18 @@ --- title: ObjectPermission description: ObjectPermission Schema Reference +category: permission +zodFile: permission --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/permission.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,18 @@ description: ObjectPermission Schema Reference | **allowPurge** | `boolean` | optional | Permanently delete (Hard Delete/GDPR) | | **viewAllRecords** | `boolean` | optional | View All Data (Bypass Sharing) | | **modifyAllRecords** | `boolean` | optional | Modify All Data (Bypass Sharing) | + +## TypeScript Usage + +```typescript +import { ObjectPermissionSchema } from '@objectstack/spec/permission'; +import type { ObjectPermission } from '@objectstack/spec/permission'; + +// Validate data +const result = ObjectPermissionSchema.parse(data); + +// Type-safe usage +const myObjectPermission: ObjectPermission = { +}; +``` + diff --git a/content/docs/references/permission/permission/PermissionSet.mdx b/content/docs/references/permission/permission/PermissionSet.mdx index 017783e11..0809c2777 100644 --- a/content/docs/references/permission/permission/PermissionSet.mdx +++ b/content/docs/references/permission/permission/PermissionSet.mdx @@ -1,8 +1,18 @@ --- title: PermissionSet description: PermissionSet Schema Reference +category: permission +zodFile: permission --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/permission.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,20 @@ description: PermissionSet Schema Reference | **objects** | `Record` | ✅ | Entity permissions | | **fields** | `Record` | optional | Field level security | | **systemPermissions** | `string[]` | optional | System level capabilities | + +## TypeScript Usage + +```typescript +import { PermissionSetSchema } from '@objectstack/spec/permission'; +import type { PermissionSet } from '@objectstack/spec/permission'; + +// Validate data +const result = PermissionSetSchema.parse(data); + +// Type-safe usage +const myPermissionSet: PermissionSet = { + name: 'name', + objects: {} +}; +``` + diff --git a/content/docs/references/permission/rls/RLSConfig.mdx b/content/docs/references/permission/rls/RLSConfig.mdx index 2c55e7906..de17b6eee 100644 --- a/content/docs/references/permission/rls/RLSConfig.mdx +++ b/content/docs/references/permission/rls/RLSConfig.mdx @@ -1,8 +1,18 @@ --- title: RLSConfig description: RLSConfig Schema Reference +category: permission +zodFile: rls --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/rls.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: RLSConfig Schema Reference | **cacheResults** | `boolean` | optional | Cache RLS evaluation results | | **cacheTtlSeconds** | `integer` | optional | Cache TTL in seconds | | **prefetchUserContext** | `boolean` | optional | Pre-fetch user context for performance | + +## TypeScript Usage + +```typescript +import { RLSConfigSchema } from '@objectstack/spec/permission'; +import type { RLSConfig } from '@objectstack/spec/permission'; + +// Validate data +const result = RLSConfigSchema.parse(data); + +// Type-safe usage +const myRLSConfig: RLSConfig = { +}; +``` + diff --git a/content/docs/references/permission/rls/RLSEvaluationResult.mdx b/content/docs/references/permission/rls/RLSEvaluationResult.mdx index 092fbaed1..9ec7ad694 100644 --- a/content/docs/references/permission/rls/RLSEvaluationResult.mdx +++ b/content/docs/references/permission/rls/RLSEvaluationResult.mdx @@ -1,8 +1,18 @@ --- title: RLSEvaluationResult description: RLSEvaluationResult Schema Reference +category: permission +zodFile: rls --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/rls.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,20 @@ description: RLSEvaluationResult Schema Reference | **error** | `string` | optional | Error message if evaluation failed | | **usingResult** | `boolean` | optional | USING clause evaluation result | | **checkResult** | `boolean` | optional | CHECK clause evaluation result | + +## TypeScript Usage + +```typescript +import { RLSEvaluationResultSchema } from '@objectstack/spec/permission'; +import type { RLSEvaluationResult } from '@objectstack/spec/permission'; + +// Validate data +const result = RLSEvaluationResultSchema.parse(data); + +// Type-safe usage +const myRLSEvaluationResult: RLSEvaluationResult = { + policyName: 'example', + granted: false +}; +``` + diff --git a/content/docs/references/permission/rls/RLSOperation.mdx b/content/docs/references/permission/rls/RLSOperation.mdx index 327a10285..6a27f52a4 100644 --- a/content/docs/references/permission/rls/RLSOperation.mdx +++ b/content/docs/references/permission/rls/RLSOperation.mdx @@ -1,12 +1,32 @@ --- title: RLSOperation description: RLSOperation Schema Reference +category: permission +zodFile: rls --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/rls.zod.ts` + + ## Allowed Values * `select` * `insert` * `update` * `delete` -* `all` \ No newline at end of file +* `all` + +## TypeScript Usage + +```typescript +import { RLSOperation } from '@objectstack/spec/permission'; + +// Type-safe enum value +const value: RLSOperation = 'select'; +``` + diff --git a/content/docs/references/permission/rls/RLSUserContext.mdx b/content/docs/references/permission/rls/RLSUserContext.mdx index 20649e6a3..318081760 100644 --- a/content/docs/references/permission/rls/RLSUserContext.mdx +++ b/content/docs/references/permission/rls/RLSUserContext.mdx @@ -1,8 +1,18 @@ --- title: RLSUserContext description: RLSUserContext Schema Reference +category: permission +zodFile: rls --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/rls.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,19 @@ description: RLSUserContext Schema Reference | **role** | `string \| string[]` | optional | User role(s) | | **department** | `string` | optional | User department | | **attributes** | `Record` | optional | Additional custom user attributes | + +## TypeScript Usage + +```typescript +import { RLSUserContextSchema } from '@objectstack/spec/permission'; +import type { RLSUserContext } from '@objectstack/spec/permission'; + +// Validate data +const result = RLSUserContextSchema.parse(data); + +// Type-safe usage +const myRLSUserContext: RLSUserContext = { + id: 'example' +}; +``` + diff --git a/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx b/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx index b73d798d2..cbc20f1c0 100644 --- a/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx +++ b/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx @@ -1,8 +1,18 @@ --- title: RowLevelSecurityPolicy description: RowLevelSecurityPolicy Schema Reference +category: permission +zodFile: rls --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/rls.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,21 @@ description: RowLevelSecurityPolicy Schema Reference | **enabled** | `boolean` | optional | Whether this policy is active | | **priority** | `integer` | optional | Policy evaluation priority (higher = evaluated first) | | **tags** | `string[]` | optional | Policy categorization tags | + +## TypeScript Usage + +```typescript +import { RowLevelSecurityPolicySchema } from '@objectstack/spec/permission'; +import type { RowLevelSecurityPolicy } from '@objectstack/spec/permission'; + +// Validate data +const result = RowLevelSecurityPolicySchema.parse(data); + +// Type-safe usage +const myRowLevelSecurityPolicy: RowLevelSecurityPolicy = { + name: 'name', + object: 'example', + operation: 'select' +}; +``` + diff --git a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx index a4374d8e9..42b48c80a 100644 --- a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx +++ b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx @@ -1,8 +1,18 @@ --- title: CriteriaSharingRule description: CriteriaSharingRule Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: CriteriaSharingRule Schema Reference | **sharedWith** | `object` | ✅ | The recipient of the shared access | | **type** | `string` | ✅ | | | **condition** | `string` | ✅ | Formula condition (e.g. "department = 'Sales'") | + +## TypeScript Usage + +```typescript +import { CriteriaSharingRuleSchema } from '@objectstack/spec/permission'; +import type { CriteriaSharingRule } from '@objectstack/spec/permission'; + +// Validate data +const result = CriteriaSharingRuleSchema.parse(data); + +// Type-safe usage +const myCriteriaSharingRule: CriteriaSharingRule = { + name: 'name', + object: 'example', + sharedWith: {}, + // ... other fields +}; +``` + diff --git a/content/docs/references/permission/sharing/OWDModel.mdx b/content/docs/references/permission/sharing/OWDModel.mdx index a6b676c1c..7e2869fdd 100644 --- a/content/docs/references/permission/sharing/OWDModel.mdx +++ b/content/docs/references/permission/sharing/OWDModel.mdx @@ -1,11 +1,31 @@ --- title: OWDModel description: OWDModel Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + ## Allowed Values * `private` * `public_read` * `public_read_write` -* `controlled_by_parent` \ No newline at end of file +* `controlled_by_parent` + +## TypeScript Usage + +```typescript +import { OWDModel } from '@objectstack/spec/permission'; + +// Type-safe enum value +const value: OWDModel = 'private'; +``` + diff --git a/content/docs/references/permission/sharing/OwnerSharingRule.mdx b/content/docs/references/permission/sharing/OwnerSharingRule.mdx index dd3b69b98..842c3659a 100644 --- a/content/docs/references/permission/sharing/OwnerSharingRule.mdx +++ b/content/docs/references/permission/sharing/OwnerSharingRule.mdx @@ -1,8 +1,18 @@ --- title: OwnerSharingRule description: OwnerSharingRule Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: OwnerSharingRule Schema Reference | **sharedWith** | `object` | ✅ | The recipient of the shared access | | **type** | `string` | ✅ | | | **ownedBy** | `object` | ✅ | Source group/role whose records are being shared | + +## TypeScript Usage + +```typescript +import { OwnerSharingRuleSchema } from '@objectstack/spec/permission'; +import type { OwnerSharingRule } from '@objectstack/spec/permission'; + +// Validate data +const result = OwnerSharingRuleSchema.parse(data); + +// Type-safe usage +const myOwnerSharingRule: OwnerSharingRule = { + name: 'name', + object: 'example', + sharedWith: {}, + // ... other fields +}; +``` + diff --git a/content/docs/references/permission/sharing/ShareRecipientType.mdx b/content/docs/references/permission/sharing/ShareRecipientType.mdx index 3790701ce..59ee40853 100644 --- a/content/docs/references/permission/sharing/ShareRecipientType.mdx +++ b/content/docs/references/permission/sharing/ShareRecipientType.mdx @@ -1,12 +1,32 @@ --- title: ShareRecipientType description: ShareRecipientType Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + ## Allowed Values * `user` * `group` * `role` * `role_and_subordinates` -* `guest` \ No newline at end of file +* `guest` + +## TypeScript Usage + +```typescript +import { ShareRecipientType } from '@objectstack/spec/permission'; + +// Type-safe enum value +const value: ShareRecipientType = 'user'; +``` + diff --git a/content/docs/references/permission/sharing/SharingLevel.mdx b/content/docs/references/permission/sharing/SharingLevel.mdx index 1b013707b..fbfb0b32c 100644 --- a/content/docs/references/permission/sharing/SharingLevel.mdx +++ b/content/docs/references/permission/sharing/SharingLevel.mdx @@ -1,10 +1,30 @@ --- title: SharingLevel description: SharingLevel Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + ## Allowed Values * `read` * `edit` -* `full` \ No newline at end of file +* `full` + +## TypeScript Usage + +```typescript +import { SharingLevel } from '@objectstack/spec/permission'; + +// Type-safe enum value +const value: SharingLevel = 'read'; +``` + diff --git a/content/docs/references/permission/sharing/SharingRule.mdx b/content/docs/references/permission/sharing/SharingRule.mdx index f0223b515..48d9aaae0 100644 --- a/content/docs/references/permission/sharing/SharingRule.mdx +++ b/content/docs/references/permission/sharing/SharingRule.mdx @@ -1,5 +1,15 @@ --- title: SharingRule description: SharingRule Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + diff --git a/content/docs/references/permission/sharing/SharingRuleType.mdx b/content/docs/references/permission/sharing/SharingRuleType.mdx index df297b610..5865f5f30 100644 --- a/content/docs/references/permission/sharing/SharingRuleType.mdx +++ b/content/docs/references/permission/sharing/SharingRuleType.mdx @@ -1,9 +1,29 @@ --- title: SharingRuleType description: SharingRuleType Schema Reference +category: permission +zodFile: sharing --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + ## Allowed Values * `owner` -* `criteria` \ No newline at end of file +* `criteria` + +## TypeScript Usage + +```typescript +import { SharingRuleType } from '@objectstack/spec/permission'; + +// Type-safe enum value +const value: SharingRuleType = 'owner'; +``` + diff --git a/content/docs/references/permission/territory/Territory.mdx b/content/docs/references/permission/territory/Territory.mdx index 337ea7987..7731997d2 100644 --- a/content/docs/references/permission/territory/Territory.mdx +++ b/content/docs/references/permission/territory/Territory.mdx @@ -1,8 +1,18 @@ --- title: Territory description: Territory Schema Reference +category: permission +zodFile: territory --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/territory.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,21 @@ description: Territory Schema Reference | **accountAccess** | `Enum<'read' \| 'edit'>` | optional | | | **opportunityAccess** | `Enum<'read' \| 'edit'>` | optional | | | **caseAccess** | `Enum<'read' \| 'edit'>` | optional | | + +## TypeScript Usage + +```typescript +import { TerritorySchema } from '@objectstack/spec/permission'; +import type { Territory } from '@objectstack/spec/permission'; + +// Validate data +const result = TerritorySchema.parse(data); + +// Type-safe usage +const myTerritory: Territory = { + name: 'name', + label: 'example', + modelId: 'example' +}; +``` + diff --git a/content/docs/references/permission/territory/TerritoryModel.mdx b/content/docs/references/permission/territory/TerritoryModel.mdx index e043d74cb..5ed23dec2 100644 --- a/content/docs/references/permission/territory/TerritoryModel.mdx +++ b/content/docs/references/permission/territory/TerritoryModel.mdx @@ -1,8 +1,18 @@ --- title: TerritoryModel description: TerritoryModel Schema Reference +category: permission +zodFile: territory --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/territory.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: TerritoryModel Schema Reference | **state** | `Enum<'planning' \| 'active' \| 'archived'>` | optional | | | **startDate** | `string` | optional | | | **endDate** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { TerritoryModelSchema } from '@objectstack/spec/permission'; +import type { TerritoryModel } from '@objectstack/spec/permission'; + +// Validate data +const result = TerritoryModelSchema.parse(data); + +// Type-safe usage +const myTerritoryModel: TerritoryModel = { + name: 'name' +}; +``` + diff --git a/content/docs/references/permission/territory/TerritoryType.mdx b/content/docs/references/permission/territory/TerritoryType.mdx index d43de23a5..cb5e3a4aa 100644 --- a/content/docs/references/permission/territory/TerritoryType.mdx +++ b/content/docs/references/permission/territory/TerritoryType.mdx @@ -1,11 +1,31 @@ --- title: TerritoryType description: TerritoryType Schema Reference +category: permission +zodFile: territory --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/permission/territory.zod.ts` + + ## Allowed Values * `geography` * `industry` * `named_account` -* `product_line` \ No newline at end of file +* `product_line` + +## TypeScript Usage + +```typescript +import { TerritoryType } from '@objectstack/spec/permission'; + +// Type-safe enum value +const value: TerritoryType = 'geography'; +``` + diff --git a/content/docs/references/shared/identifiers/EventName.mdx b/content/docs/references/shared/identifiers/EventName.mdx index 0f20dc682..c7cd5ad14 100644 --- a/content/docs/references/shared/identifiers/EventName.mdx +++ b/content/docs/references/shared/identifiers/EventName.mdx @@ -1,7 +1,17 @@ --- title: EventName description: Event name (lowercase with dot notation for namespacing) +category: shared +zodFile: identifiers --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Event name (lowercase with dot notation for namespacing) + +**Source:** `packages/spec/src/shared/identifiers.zod.ts` + + diff --git a/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx b/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx index 1b964ecf9..af36a8320 100644 --- a/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx +++ b/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx @@ -1,7 +1,17 @@ --- title: SnakeCaseIdentifier description: Snake case identifier (lowercase with underscores only) +category: shared +zodFile: identifiers --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Snake case identifier (lowercase with underscores only) + +**Source:** `packages/spec/src/shared/identifiers.zod.ts` + + diff --git a/content/docs/references/shared/identifiers/SystemIdentifier.mdx b/content/docs/references/shared/identifiers/SystemIdentifier.mdx index dc0ea350a..c32744e11 100644 --- a/content/docs/references/shared/identifiers/SystemIdentifier.mdx +++ b/content/docs/references/shared/identifiers/SystemIdentifier.mdx @@ -1,7 +1,17 @@ --- title: SystemIdentifier description: System identifier (lowercase with underscores or dots) +category: shared +zodFile: identifiers --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + System identifier (lowercase with underscores or dots) + +**Source:** `packages/spec/src/shared/identifiers.zod.ts` + + diff --git a/content/docs/references/shared/index.mdx b/content/docs/references/shared/index.mdx new file mode 100644 index 000000000..89b76d580 --- /dev/null +++ b/content/docs/references/shared/index.mdx @@ -0,0 +1,22 @@ +--- +title: Shared Protocol Overview +description: Complete reference for all shared protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# Shared Protocol + +This section contains all protocol schemas for the shared layer of ObjectStack. + +## Identifiers + +Source: `packages/spec/src/shared/identifiers.zod.ts` + + + + + + + diff --git a/content/docs/references/system/audit/AuditConfig.mdx b/content/docs/references/system/audit/AuditConfig.mdx index feebef7d9..74d17bd71 100644 --- a/content/docs/references/system/audit/AuditConfig.mdx +++ b/content/docs/references/system/audit/AuditConfig.mdx @@ -1,8 +1,18 @@ --- title: AuditConfig description: AuditConfig Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -23,3 +33,21 @@ description: AuditConfig Schema Reference | **logSystemEvents** | `boolean` | optional | Log system events | | **customHandlers** | `object[]` | optional | Custom event handler references | | **compliance** | `object` | optional | Compliance configuration | + +## TypeScript Usage + +```typescript +import { AuditConfigSchema } from '@objectstack/spec/system'; +import type { AuditConfig } from '@objectstack/spec/system'; + +// Validate data +const result = AuditConfigSchema.parse(data); + +// Type-safe usage +const myAuditConfig: AuditConfig = { + name: 'name', + label: 'example', + storage: {} +}; +``` + diff --git a/content/docs/references/system/audit/AuditEvent.mdx b/content/docs/references/system/audit/AuditEvent.mdx index a1bc3ed39..c29db026d 100644 --- a/content/docs/references/system/audit/AuditEvent.mdx +++ b/content/docs/references/system/audit/AuditEvent.mdx @@ -1,8 +1,18 @@ --- title: AuditEvent description: AuditEvent Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,22 @@ description: AuditEvent Schema Reference | **requestId** | `string` | optional | Request ID for tracing | | **metadata** | `Record` | optional | Additional metadata | | **location** | `object` | optional | Geographic location | + +## TypeScript Usage + +```typescript +import { AuditEventSchema } from '@objectstack/spec/system'; +import type { AuditEvent } from '@objectstack/spec/system'; + +// Validate data +const result = AuditEventSchema.parse(data); + +// Type-safe usage +const myAuditEvent: AuditEvent = { + id: 'example', + eventType: 'data.create', + timestamp: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/system/audit/AuditEventActor.mdx b/content/docs/references/system/audit/AuditEventActor.mdx index f59a630a4..40f3fa760 100644 --- a/content/docs/references/system/audit/AuditEventActor.mdx +++ b/content/docs/references/system/audit/AuditEventActor.mdx @@ -1,8 +1,18 @@ --- title: AuditEventActor description: AuditEventActor Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,20 @@ description: AuditEventActor Schema Reference | **email** | `string` | optional | Actor email address | | **ipAddress** | `string` | optional | Actor IP address | | **userAgent** | `string` | optional | User agent string | + +## TypeScript Usage + +```typescript +import { AuditEventActorSchema } from '@objectstack/spec/system'; +import type { AuditEventActor } from '@objectstack/spec/system'; + +// Validate data +const result = AuditEventActorSchema.parse(data); + +// Type-safe usage +const myAuditEventActor: AuditEventActor = { + type: 'user', + id: 'example' +}; +``` + diff --git a/content/docs/references/system/audit/AuditEventChange.mdx b/content/docs/references/system/audit/AuditEventChange.mdx index 9ab45b293..ec7e587c4 100644 --- a/content/docs/references/system/audit/AuditEventChange.mdx +++ b/content/docs/references/system/audit/AuditEventChange.mdx @@ -1,8 +1,18 @@ --- title: AuditEventChange description: AuditEventChange Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: AuditEventChange Schema Reference | **field** | `string` | ✅ | Changed field name | | **oldValue** | `any` | optional | Previous value | | **newValue** | `any` | optional | New value | + +## TypeScript Usage + +```typescript +import { AuditEventChangeSchema } from '@objectstack/spec/system'; +import type { AuditEventChange } from '@objectstack/spec/system'; + +// Validate data +const result = AuditEventChangeSchema.parse(data); + +// Type-safe usage +const myAuditEventChange: AuditEventChange = { + field: 'example' +}; +``` + diff --git a/content/docs/references/system/audit/AuditEventFilter.mdx b/content/docs/references/system/audit/AuditEventFilter.mdx index 013cf44e0..c5e6fac98 100644 --- a/content/docs/references/system/audit/AuditEventFilter.mdx +++ b/content/docs/references/system/audit/AuditEventFilter.mdx @@ -1,8 +1,18 @@ --- title: AuditEventFilter description: AuditEventFilter Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: AuditEventFilter Schema Reference | **result** | `Enum<'success' \| 'failure' \| 'partial'>` | optional | Result status | | **searchQuery** | `string` | optional | Search query | | **customFilters** | `Record` | optional | Custom filters | + +## TypeScript Usage + +```typescript +import { AuditEventFilterSchema } from '@objectstack/spec/system'; +import type { AuditEventFilter } from '@objectstack/spec/system'; + +// Validate data +const result = AuditEventFilterSchema.parse(data); + +// Type-safe usage +const myAuditEventFilter: AuditEventFilter = { +}; +``` + diff --git a/content/docs/references/system/audit/AuditEventSeverity.mdx b/content/docs/references/system/audit/AuditEventSeverity.mdx index 41d142d29..44cdcd301 100644 --- a/content/docs/references/system/audit/AuditEventSeverity.mdx +++ b/content/docs/references/system/audit/AuditEventSeverity.mdx @@ -1,8 +1,18 @@ --- title: AuditEventSeverity description: AuditEventSeverity Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Allowed Values * `debug` @@ -12,4 +22,14 @@ description: AuditEventSeverity Schema Reference * `error` * `critical` * `alert` -* `emergency` \ No newline at end of file +* `emergency` + +## TypeScript Usage + +```typescript +import { AuditEventSeverity } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: AuditEventSeverity = 'debug'; +``` + diff --git a/content/docs/references/system/audit/AuditEventTarget.mdx b/content/docs/references/system/audit/AuditEventTarget.mdx index 040747df5..8091dd09e 100644 --- a/content/docs/references/system/audit/AuditEventTarget.mdx +++ b/content/docs/references/system/audit/AuditEventTarget.mdx @@ -1,8 +1,18 @@ --- title: AuditEventTarget description: AuditEventTarget Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: AuditEventTarget Schema Reference | **id** | `string` | ✅ | Target identifier | | **name** | `string` | optional | Target display name | | **metadata** | `Record` | optional | Target metadata | + +## TypeScript Usage + +```typescript +import { AuditEventTargetSchema } from '@objectstack/spec/system'; +import type { AuditEventTarget } from '@objectstack/spec/system'; + +// Validate data +const result = AuditEventTargetSchema.parse(data); + +// Type-safe usage +const myAuditEventTarget: AuditEventTarget = { + type: 'example', + id: 'example' +}; +``` + diff --git a/content/docs/references/system/audit/AuditEventType.mdx b/content/docs/references/system/audit/AuditEventType.mdx index 4f6a42351..0e9fa85f6 100644 --- a/content/docs/references/system/audit/AuditEventType.mdx +++ b/content/docs/references/system/audit/AuditEventType.mdx @@ -1,8 +1,18 @@ --- title: AuditEventType description: AuditEventType Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Allowed Values * `data.create` @@ -46,4 +56,14 @@ description: AuditEventType Schema Reference * `security.suspicious_activity` * `security.data_breach` * `security.api_key_created` -* `security.api_key_revoked` \ No newline at end of file +* `security.api_key_revoked` + +## TypeScript Usage + +```typescript +import { AuditEventType } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: AuditEventType = 'data.create'; +``` + diff --git a/content/docs/references/system/audit/AuditRetentionPolicy.mdx b/content/docs/references/system/audit/AuditRetentionPolicy.mdx index fdb5c24d7..87fe3b6b2 100644 --- a/content/docs/references/system/audit/AuditRetentionPolicy.mdx +++ b/content/docs/references/system/audit/AuditRetentionPolicy.mdx @@ -1,8 +1,18 @@ --- title: AuditRetentionPolicy description: AuditRetentionPolicy Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,18 @@ description: AuditRetentionPolicy Schema Reference | **archiveStorage** | `object` | optional | Archive storage configuration | | **customRetention** | `Record` | optional | Custom retention by event type | | **minimumRetentionDays** | `integer` | optional | Minimum retention for compliance | + +## TypeScript Usage + +```typescript +import { AuditRetentionPolicySchema } from '@objectstack/spec/system'; +import type { AuditRetentionPolicy } from '@objectstack/spec/system'; + +// Validate data +const result = AuditRetentionPolicySchema.parse(data); + +// Type-safe usage +const myAuditRetentionPolicy: AuditRetentionPolicy = { +}; +``` + diff --git a/content/docs/references/system/audit/AuditStorageConfig.mdx b/content/docs/references/system/audit/AuditStorageConfig.mdx index 2938b8fb3..afa716a83 100644 --- a/content/docs/references/system/audit/AuditStorageConfig.mdx +++ b/content/docs/references/system/audit/AuditStorageConfig.mdx @@ -1,8 +1,18 @@ --- title: AuditStorageConfig description: AuditStorageConfig Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,19 @@ description: AuditStorageConfig Schema Reference | **bufferSize** | `integer` | optional | Buffer size | | **flushIntervalSeconds** | `integer` | optional | Flush interval in seconds | | **compression** | `boolean` | optional | Enable compression | + +## TypeScript Usage + +```typescript +import { AuditStorageConfigSchema } from '@objectstack/spec/system'; +import type { AuditStorageConfig } from '@objectstack/spec/system'; + +// Validate data +const result = AuditStorageConfigSchema.parse(data); + +// Type-safe usage +const myAuditStorageConfig: AuditStorageConfig = { + type: 'database' +}; +``` + diff --git a/content/docs/references/system/audit/SuspiciousActivityRule.mdx b/content/docs/references/system/audit/SuspiciousActivityRule.mdx index 7bd718083..38706640d 100644 --- a/content/docs/references/system/audit/SuspiciousActivityRule.mdx +++ b/content/docs/references/system/audit/SuspiciousActivityRule.mdx @@ -1,8 +1,18 @@ --- title: SuspiciousActivityRule description: SuspiciousActivityRule Schema Reference +category: system +zodFile: audit --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: SuspiciousActivityRule Schema Reference | **actions** | `Enum<'alert' \| 'lock_account' \| 'block_ip' \| 'require_mfa' \| 'log_critical' \| 'webhook'>[]` | ✅ | Actions to take | | **alertSeverity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Alert severity | | **notifications** | `object` | optional | Notification configuration | + +## TypeScript Usage + +```typescript +import { SuspiciousActivityRuleSchema } from '@objectstack/spec/system'; +import type { SuspiciousActivityRule } from '@objectstack/spec/system'; + +// Validate data +const result = SuspiciousActivityRuleSchema.parse(data); + +// Type-safe usage +const mySuspiciousActivityRule: SuspiciousActivityRule = { + id: 'example', + name: 'name', + eventTypes: [], + // ... other fields +}; +``` + diff --git a/content/docs/references/system/context/KernelContext.mdx b/content/docs/references/system/context/KernelContext.mdx index 4634402d9..58365c1fe 100644 --- a/content/docs/references/system/context/KernelContext.mdx +++ b/content/docs/references/system/context/KernelContext.mdx @@ -1,8 +1,18 @@ --- title: KernelContext description: KernelContext Schema Reference +category: system +zodFile: context --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/context.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,22 @@ description: KernelContext Schema Reference | **workspaceRoot** | `string` | optional | Workspace root if different from cwd | | **startTime** | `integer` | ✅ | Boot timestamp (ms) | | **features** | `Record` | optional | Global feature toggles | + +## TypeScript Usage + +```typescript +import { KernelContextSchema } from '@objectstack/spec/system'; +import type { KernelContext } from '@objectstack/spec/system'; + +// Validate data +const result = KernelContextSchema.parse(data); + +// Type-safe usage +const myKernelContext: KernelContext = { + instanceId: 'example', + version: 'example', + cwd: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/system/context/RuntimeMode.mdx b/content/docs/references/system/context/RuntimeMode.mdx index 3bb6e9869..b9ffa16a5 100644 --- a/content/docs/references/system/context/RuntimeMode.mdx +++ b/content/docs/references/system/context/RuntimeMode.mdx @@ -1,13 +1,33 @@ --- title: RuntimeMode description: Kernel operating mode +category: system +zodFile: context --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Kernel operating mode + +**Source:** `packages/spec/src/system/context.zod.ts` + + ## Allowed Values * `development` * `production` * `test` -* `provisioning` \ No newline at end of file +* `provisioning` + +## TypeScript Usage + +```typescript +import { RuntimeMode } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: RuntimeMode = 'development'; +``` + diff --git a/content/docs/references/system/datasource/Datasource.mdx b/content/docs/references/system/datasource/Datasource.mdx index 2d406896b..59860631f 100644 --- a/content/docs/references/system/datasource/Datasource.mdx +++ b/content/docs/references/system/datasource/Datasource.mdx @@ -1,8 +1,18 @@ --- title: Datasource description: Datasource Schema Reference +category: system +zodFile: datasource --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/datasource.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,21 @@ description: Datasource Schema Reference | **capabilities** | `object` | optional | Capability overrides | | **description** | `string` | optional | Internal description | | **active** | `boolean` | optional | Is datasource enabled | + +## TypeScript Usage + +```typescript +import { DatasourceSchema } from '@objectstack/spec/system'; +import type { Datasource } from '@objectstack/spec/system'; + +// Validate data +const result = DatasourceSchema.parse(data); + +// Type-safe usage +const myDatasource: Datasource = { + name: 'name', + driver: 'example', + config: {} +}; +``` + diff --git a/content/docs/references/system/datasource/DatasourceCapabilities.mdx b/content/docs/references/system/datasource/DatasourceCapabilities.mdx index c1e512544..a4ab55314 100644 --- a/content/docs/references/system/datasource/DatasourceCapabilities.mdx +++ b/content/docs/references/system/datasource/DatasourceCapabilities.mdx @@ -1,8 +1,18 @@ --- title: DatasourceCapabilities description: DatasourceCapabilities Schema Reference +category: system +zodFile: datasource --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/datasource.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,18 @@ description: DatasourceCapabilities Schema Reference | **fullTextSearch** | `boolean` | optional | | | **readOnly** | `boolean` | optional | | | **dynamicSchema** | `boolean` | optional | | + +## TypeScript Usage + +```typescript +import { DatasourceCapabilitiesSchema } from '@objectstack/spec/system'; +import type { DatasourceCapabilities } from '@objectstack/spec/system'; + +// Validate data +const result = DatasourceCapabilitiesSchema.parse(data); + +// Type-safe usage +const myDatasourceCapabilities: DatasourceCapabilities = { +}; +``` + diff --git a/content/docs/references/system/datasource/DriverDefinition.mdx b/content/docs/references/system/datasource/DriverDefinition.mdx index b680f3085..d0b95dfcf 100644 --- a/content/docs/references/system/datasource/DriverDefinition.mdx +++ b/content/docs/references/system/datasource/DriverDefinition.mdx @@ -1,8 +1,18 @@ --- title: DriverDefinition description: DriverDefinition Schema Reference +category: system +zodFile: datasource --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/datasource.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: DriverDefinition Schema Reference | **icon** | `string` | optional | | | **configSchema** | `Record` | ✅ | JSON Schema for connection configuration | | **capabilities** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { DriverDefinitionSchema } from '@objectstack/spec/system'; +import type { DriverDefinition } from '@objectstack/spec/system'; + +// Validate data +const result = DriverDefinitionSchema.parse(data); + +// Type-safe usage +const myDriverDefinition: DriverDefinition = { + id: 'example', + label: 'example', + configSchema: {} +}; +``` + diff --git a/content/docs/references/system/datasource/DriverType.mdx b/content/docs/references/system/datasource/DriverType.mdx index e896a3850..f2cff3c56 100644 --- a/content/docs/references/system/datasource/DriverType.mdx +++ b/content/docs/references/system/datasource/DriverType.mdx @@ -1,7 +1,17 @@ --- title: DriverType description: Underlying driver identifier +category: system +zodFile: datasource --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Underlying driver identifier + +**Source:** `packages/spec/src/system/datasource.zod.ts` + + diff --git a/content/docs/references/system/driver/DriverCapabilities.mdx b/content/docs/references/system/driver/DriverCapabilities.mdx index f1a95721d..91e8e5f87 100644 --- a/content/docs/references/system/driver/DriverCapabilities.mdx +++ b/content/docs/references/system/driver/DriverCapabilities.mdx @@ -1,8 +1,18 @@ --- title: DriverCapabilities description: DriverCapabilities Schema Reference +category: system +zodFile: driver --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/driver.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,22 @@ description: DriverCapabilities Schema Reference | **arrayFields** | `boolean` | ✅ | Supports array field types | | **vectorSearch** | `boolean` | optional | Supports vector embeddings and similarity search | | **geoSpatial** | `boolean` | optional | Supports geospatial queries | + +## TypeScript Usage + +```typescript +import { DriverCapabilitiesSchema } from '@objectstack/spec/system'; +import type { DriverCapabilities } from '@objectstack/spec/system'; + +// Validate data +const result = DriverCapabilitiesSchema.parse(data); + +// Type-safe usage +const myDriverCapabilities: DriverCapabilities = { + transactions: false, + queryFilters: false, + queryAggregations: false, + // ... other fields +}; +``` + diff --git a/content/docs/references/system/driver/DriverInterface.mdx b/content/docs/references/system/driver/DriverInterface.mdx index b31b9a93c..dc8951e4c 100644 --- a/content/docs/references/system/driver/DriverInterface.mdx +++ b/content/docs/references/system/driver/DriverInterface.mdx @@ -1,8 +1,18 @@ --- title: DriverInterface description: DriverInterface Schema Reference +category: system +zodFile: driver --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/driver.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,21 @@ description: DriverInterface Schema Reference | **name** | `string` | ✅ | Driver unique name | | **version** | `string` | ✅ | Driver version | | **supports** | `object` | ✅ | | + +## TypeScript Usage + +```typescript +import { DriverInterfaceSchema } from '@objectstack/spec/system'; +import type { DriverInterface } from '@objectstack/spec/system'; + +// Validate data +const result = DriverInterfaceSchema.parse(data); + +// Type-safe usage +const myDriverInterface: DriverInterface = { + name: 'name', + version: 'example', + supports: {} +}; +``` + diff --git a/content/docs/references/system/driver/DriverOptions.mdx b/content/docs/references/system/driver/DriverOptions.mdx index 0f5926019..fbc423a17 100644 --- a/content/docs/references/system/driver/DriverOptions.mdx +++ b/content/docs/references/system/driver/DriverOptions.mdx @@ -1,8 +1,18 @@ --- title: DriverOptions description: DriverOptions Schema Reference +category: system +zodFile: driver --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/driver.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,18 @@ description: DriverOptions Schema Reference | **skipCache** | `boolean` | optional | Bypass cache | | **traceContext** | `Record` | optional | OpenTelemetry context or request ID | | **tenantId** | `string` | optional | Tenant Isolation identifier | + +## TypeScript Usage + +```typescript +import { DriverOptionsSchema } from '@objectstack/spec/system'; +import type { DriverOptions } from '@objectstack/spec/system'; + +// Validate data +const result = DriverOptionsSchema.parse(data); + +// Type-safe usage +const myDriverOptions: DriverOptions = { +}; +``` + diff --git a/content/docs/references/system/events/Event.mdx b/content/docs/references/system/events/Event.mdx index 711083ea0..35a8eee62 100644 --- a/content/docs/references/system/events/Event.mdx +++ b/content/docs/references/system/events/Event.mdx @@ -1,8 +1,18 @@ --- title: Event description: Event Schema Reference +category: system +zodFile: events --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/events.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: Event Schema Reference | **name** | `string` | ✅ | Event name (lowercase with dots, e.g., user.created, order.paid) | | **payload** | `any` | optional | Event payload schema | | **metadata** | `object` | ✅ | Event metadata | + +## TypeScript Usage + +```typescript +import { EventSchema } from '@objectstack/spec/system'; +import type { Event } from '@objectstack/spec/system'; + +// Validate data +const result = EventSchema.parse(data); + +// Type-safe usage +const myEvent: Event = { + name: 'name', + metadata: {} +}; +``` + diff --git a/content/docs/references/system/events/EventHandler.mdx b/content/docs/references/system/events/EventHandler.mdx index 994cd5407..4fd2bec2e 100644 --- a/content/docs/references/system/events/EventHandler.mdx +++ b/content/docs/references/system/events/EventHandler.mdx @@ -1,8 +1,18 @@ --- title: EventHandler description: EventHandler Schema Reference +category: system +zodFile: events --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/events.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: EventHandler Schema Reference | **eventName** | `string` | ✅ | Name of event to handle (supports wildcards like user.*) | | **priority** | `integer` | optional | Execution priority (lower numbers execute first) | | **async** | `boolean` | optional | Execute in background (true) or block (false) | + +## TypeScript Usage + +```typescript +import { EventHandlerSchema } from '@objectstack/spec/system'; +import type { EventHandler } from '@objectstack/spec/system'; + +// Validate data +const result = EventHandlerSchema.parse(data); + +// Type-safe usage +const myEventHandler: EventHandler = { + eventName: 'example' +}; +``` + diff --git a/content/docs/references/system/events/EventMetadata.mdx b/content/docs/references/system/events/EventMetadata.mdx index 86e4254d0..a778a0305 100644 --- a/content/docs/references/system/events/EventMetadata.mdx +++ b/content/docs/references/system/events/EventMetadata.mdx @@ -1,8 +1,18 @@ --- title: EventMetadata description: EventMetadata Schema Reference +category: system +zodFile: events --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/events.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: EventMetadata Schema Reference | **timestamp** | `string` | ✅ | ISO 8601 datetime when event was created | | **userId** | `string` | optional | User who triggered the event | | **tenantId** | `string` | optional | Tenant identifier for multi-tenant systems | + +## TypeScript Usage + +```typescript +import { EventMetadataSchema } from '@objectstack/spec/system'; +import type { EventMetadata } from '@objectstack/spec/system'; + +// Validate data +const result = EventMetadataSchema.parse(data); + +// Type-safe usage +const myEventMetadata: EventMetadata = { + source: 'example', + timestamp: 'example' +}; +``` + diff --git a/content/docs/references/system/events/EventPersistence.mdx b/content/docs/references/system/events/EventPersistence.mdx index eac9960cc..f006222cd 100644 --- a/content/docs/references/system/events/EventPersistence.mdx +++ b/content/docs/references/system/events/EventPersistence.mdx @@ -1,11 +1,37 @@ --- title: EventPersistence description: EventPersistence Schema Reference +category: system +zodFile: events --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/events.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **enabled** | `boolean` | optional | Enable event persistence | | **retention** | `integer` | ✅ | Days to retain persisted events | + +## TypeScript Usage + +```typescript +import { EventPersistenceSchema } from '@objectstack/spec/system'; +import type { EventPersistence } from '@objectstack/spec/system'; + +// Validate data +const result = EventPersistenceSchema.parse(data); + +// Type-safe usage +const myEventPersistence: EventPersistence = { + retention: null +}; +``` + diff --git a/content/docs/references/system/events/EventRoute.mdx b/content/docs/references/system/events/EventRoute.mdx index 39c417154..0b17beaef 100644 --- a/content/docs/references/system/events/EventRoute.mdx +++ b/content/docs/references/system/events/EventRoute.mdx @@ -1,11 +1,38 @@ --- title: EventRoute description: EventRoute Schema Reference +category: system +zodFile: events --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/events.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **from** | `string` | ✅ | Source event pattern (supports wildcards, e.g., user.* or *.created) | | **to** | `string[]` | ✅ | Target event names to route to | + +## TypeScript Usage + +```typescript +import { EventRouteSchema } from '@objectstack/spec/system'; +import type { EventRoute } from '@objectstack/spec/system'; + +// Validate data +const result = EventRouteSchema.parse(data); + +// Type-safe usage +const myEventRoute: EventRoute = { + from: 'example', + to: [] +}; +``` + diff --git a/content/docs/references/system/feature/FeatureFlag.mdx b/content/docs/references/system/feature/FeatureFlag.mdx index e19bdd598..133aeb5fa 100644 --- a/content/docs/references/system/feature/FeatureFlag.mdx +++ b/content/docs/references/system/feature/FeatureFlag.mdx @@ -1,8 +1,18 @@ --- title: FeatureFlag description: FeatureFlag Schema Reference +category: system +zodFile: feature --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/feature.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,19 @@ description: FeatureFlag Schema Reference | **conditions** | `object` | optional | | | **environment** | `Enum<'dev' \| 'staging' \| 'prod' \| 'all'>` | optional | Environment validity | | **expiresAt** | `string` | optional | Feature flag expiration date | + +## TypeScript Usage + +```typescript +import { FeatureFlagSchema } from '@objectstack/spec/system'; +import type { FeatureFlag } from '@objectstack/spec/system'; + +// Validate data +const result = FeatureFlagSchema.parse(data); + +// Type-safe usage +const myFeatureFlag: FeatureFlag = { + name: 'name' +}; +``` + diff --git a/content/docs/references/system/feature/FeatureStrategy.mdx b/content/docs/references/system/feature/FeatureStrategy.mdx index d69930635..d366448b0 100644 --- a/content/docs/references/system/feature/FeatureStrategy.mdx +++ b/content/docs/references/system/feature/FeatureStrategy.mdx @@ -1,12 +1,32 @@ --- title: FeatureStrategy description: FeatureStrategy Schema Reference +category: system +zodFile: feature --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/feature.zod.ts` + + ## Allowed Values * `boolean` * `percentage` * `user_list` * `group` -* `custom` \ No newline at end of file +* `custom` + +## TypeScript Usage + +```typescript +import { FeatureStrategy } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: FeatureStrategy = 'boolean'; +``` + diff --git a/content/docs/references/system/index.mdx b/content/docs/references/system/index.mdx new file mode 100644 index 000000000..82edbf53e --- /dev/null +++ b/content/docs/references/system/index.mdx @@ -0,0 +1,153 @@ +--- +title: System Protocol Overview +description: Complete reference for all system protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# System Protocol + +This section contains all protocol schemas for the system layer of ObjectStack. + +## Audit + +Source: `packages/spec/src/system/audit.zod.ts` + + + + + + + + + + + + + + + +## Context + +Source: `packages/spec/src/system/context.zod.ts` + + + + + + +## Datasource + +Source: `packages/spec/src/system/datasource.zod.ts` + + + + + + + + +## Driver + +Source: `packages/spec/src/system/driver.zod.ts` + + + + + + + +## Events + +Source: `packages/spec/src/system/events.zod.ts` + + + + + + + + + +## Feature + +Source: `packages/spec/src/system/feature.zod.ts` + + + + + + +## Job + +Source: `packages/spec/src/system/job.zod.ts` + + + + + + + + + + + + +## Logger + +Source: `packages/spec/src/system/logger.zod.ts` + + + + + + + + +## Manifest + +Source: `packages/spec/src/system/manifest.zod.ts` + + + + + +## Plugin + +Source: `packages/spec/src/system/plugin.zod.ts` + + + + + + + + + + + + + + +## Scoped Storage + +Source: `packages/spec/src/system/scoped-storage.zod.ts` + + + + + + + + +## Translation + +Source: `packages/spec/src/system/translation.zod.ts` + + + + + + + diff --git a/content/docs/references/system/job/CronSchedule.mdx b/content/docs/references/system/job/CronSchedule.mdx index 805be3270..b778f9c4b 100644 --- a/content/docs/references/system/job/CronSchedule.mdx +++ b/content/docs/references/system/job/CronSchedule.mdx @@ -1,8 +1,18 @@ --- title: CronSchedule description: CronSchedule Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: CronSchedule Schema Reference | **type** | `string` | ✅ | | | **expression** | `string` | ✅ | Cron expression (e.g., "0 0 * * *" for daily at midnight) | | **timezone** | `string` | optional | Timezone for cron execution (e.g., "America/New_York") | + +## TypeScript Usage + +```typescript +import { CronScheduleSchema } from '@objectstack/spec/system'; +import type { CronSchedule } from '@objectstack/spec/system'; + +// Validate data +const result = CronScheduleSchema.parse(data); + +// Type-safe usage +const myCronSchedule: CronSchedule = { + type: 'example', + expression: 'example' +}; +``` + diff --git a/content/docs/references/system/job/IntervalSchedule.mdx b/content/docs/references/system/job/IntervalSchedule.mdx index e73d6f8ec..c7d769e44 100644 --- a/content/docs/references/system/job/IntervalSchedule.mdx +++ b/content/docs/references/system/job/IntervalSchedule.mdx @@ -1,11 +1,38 @@ --- title: IntervalSchedule description: IntervalSchedule Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **type** | `string` | ✅ | | | **intervalMs** | `integer` | ✅ | Interval in milliseconds | + +## TypeScript Usage + +```typescript +import { IntervalScheduleSchema } from '@objectstack/spec/system'; +import type { IntervalSchedule } from '@objectstack/spec/system'; + +// Validate data +const result = IntervalScheduleSchema.parse(data); + +// Type-safe usage +const myIntervalSchedule: IntervalSchedule = { + type: 'example', + intervalMs: null +}; +``` + diff --git a/content/docs/references/system/job/Job.mdx b/content/docs/references/system/job/Job.mdx index 43c9affe1..ef587722e 100644 --- a/content/docs/references/system/job/Job.mdx +++ b/content/docs/references/system/job/Job.mdx @@ -1,8 +1,18 @@ --- title: Job description: Job Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: Job Schema Reference | **retryPolicy** | `object` | optional | Retry policy configuration | | **timeout** | `integer` | optional | Timeout in milliseconds | | **enabled** | `boolean` | optional | Whether the job is enabled | + +## TypeScript Usage + +```typescript +import { JobSchema } from '@objectstack/spec/system'; +import type { Job } from '@objectstack/spec/system'; + +// Validate data +const result = JobSchema.parse(data); + +// Type-safe usage +const myJob: Job = { + id: 'example', + name: 'name', + schedule: null +}; +``` + diff --git a/content/docs/references/system/job/JobExecution.mdx b/content/docs/references/system/job/JobExecution.mdx index e1921929c..e9c7f194d 100644 --- a/content/docs/references/system/job/JobExecution.mdx +++ b/content/docs/references/system/job/JobExecution.mdx @@ -1,8 +1,18 @@ --- title: JobExecution description: JobExecution Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: JobExecution Schema Reference | **status** | `Enum<'running' \| 'success' \| 'failed' \| 'timeout'>` | ✅ | Execution status | | **error** | `string` | optional | Error message if failed | | **duration** | `integer` | optional | Execution duration in milliseconds | + +## TypeScript Usage + +```typescript +import { JobExecutionSchema } from '@objectstack/spec/system'; +import type { JobExecution } from '@objectstack/spec/system'; + +// Validate data +const result = JobExecutionSchema.parse(data); + +// Type-safe usage +const myJobExecution: JobExecution = { + jobId: 'example', + startedAt: 'example', + status: 'running' +}; +``` + diff --git a/content/docs/references/system/job/JobExecutionStatus.mdx b/content/docs/references/system/job/JobExecutionStatus.mdx index 32b3eefad..a31357782 100644 --- a/content/docs/references/system/job/JobExecutionStatus.mdx +++ b/content/docs/references/system/job/JobExecutionStatus.mdx @@ -1,11 +1,31 @@ --- title: JobExecutionStatus description: JobExecutionStatus Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Allowed Values * `running` * `success` * `failed` -* `timeout` \ No newline at end of file +* `timeout` + +## TypeScript Usage + +```typescript +import { JobExecutionStatus } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: JobExecutionStatus = 'running'; +``` + diff --git a/content/docs/references/system/job/OnceSchedule.mdx b/content/docs/references/system/job/OnceSchedule.mdx index f3b49aa22..a9401e70c 100644 --- a/content/docs/references/system/job/OnceSchedule.mdx +++ b/content/docs/references/system/job/OnceSchedule.mdx @@ -1,11 +1,38 @@ --- title: OnceSchedule description: OnceSchedule Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **type** | `string` | ✅ | | | **at** | `string` | ✅ | ISO 8601 datetime when to execute | + +## TypeScript Usage + +```typescript +import { OnceScheduleSchema } from '@objectstack/spec/system'; +import type { OnceSchedule } from '@objectstack/spec/system'; + +// Validate data +const result = OnceScheduleSchema.parse(data); + +// Type-safe usage +const myOnceSchedule: OnceSchedule = { + type: 'example', + at: 'example' +}; +``` + diff --git a/content/docs/references/system/job/RetryPolicy.mdx b/content/docs/references/system/job/RetryPolicy.mdx index 5277b4dfe..5882d1f14 100644 --- a/content/docs/references/system/job/RetryPolicy.mdx +++ b/content/docs/references/system/job/RetryPolicy.mdx @@ -1,8 +1,18 @@ --- title: RetryPolicy description: RetryPolicy Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: RetryPolicy Schema Reference | **maxRetries** | `integer` | optional | Maximum number of retry attempts | | **backoffMs** | `integer` | optional | Initial backoff delay in milliseconds | | **backoffMultiplier** | `number` | optional | Multiplier for exponential backoff | + +## TypeScript Usage + +```typescript +import { RetryPolicySchema } from '@objectstack/spec/system'; +import type { RetryPolicy } from '@objectstack/spec/system'; + +// Validate data +const result = RetryPolicySchema.parse(data); + +// Type-safe usage +const myRetryPolicy: RetryPolicy = { +}; +``` + diff --git a/content/docs/references/system/job/Schedule.mdx b/content/docs/references/system/job/Schedule.mdx index 87b18bed7..23729708b 100644 --- a/content/docs/references/system/job/Schedule.mdx +++ b/content/docs/references/system/job/Schedule.mdx @@ -1,5 +1,15 @@ --- title: Schedule description: Schedule Schema Reference +category: system +zodFile: job --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/job.zod.ts` + + diff --git a/content/docs/references/system/logger/LogEntry.mdx b/content/docs/references/system/logger/LogEntry.mdx index 14fb533f9..8614951ee 100644 --- a/content/docs/references/system/logger/LogEntry.mdx +++ b/content/docs/references/system/logger/LogEntry.mdx @@ -1,8 +1,18 @@ --- title: LogEntry description: LogEntry Schema Reference +category: system +zodFile: logger --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/logger.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,21 @@ description: LogEntry Schema Reference | **spanId** | `string` | optional | Span ID | | **service** | `string` | optional | Service name | | **component** | `string` | optional | Component name (e.g. plugin id) | + +## TypeScript Usage + +```typescript +import { LogEntrySchema } from '@objectstack/spec/system'; +import type { LogEntry } from '@objectstack/spec/system'; + +// Validate data +const result = LogEntrySchema.parse(data); + +// Type-safe usage +const myLogEntry: LogEntry = { + timestamp: 'example', + level: 'debug', + message: 'example' +}; +``` + diff --git a/content/docs/references/system/logger/LogFormat.mdx b/content/docs/references/system/logger/LogFormat.mdx index 78b174802..be9ca9855 100644 --- a/content/docs/references/system/logger/LogFormat.mdx +++ b/content/docs/references/system/logger/LogFormat.mdx @@ -1,12 +1,32 @@ --- title: LogFormat description: Log output format +category: system +zodFile: logger --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Log output format + +**Source:** `packages/spec/src/system/logger.zod.ts` + + ## Allowed Values * `json` * `text` -* `pretty` \ No newline at end of file +* `pretty` + +## TypeScript Usage + +```typescript +import { LogFormat } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: LogFormat = 'json'; +``` + diff --git a/content/docs/references/system/logger/LogLevel.mdx b/content/docs/references/system/logger/LogLevel.mdx index c8790054b..ca8798d9c 100644 --- a/content/docs/references/system/logger/LogLevel.mdx +++ b/content/docs/references/system/logger/LogLevel.mdx @@ -1,14 +1,34 @@ --- title: LogLevel description: Log severity level +category: system +zodFile: logger --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Log severity level + +**Source:** `packages/spec/src/system/logger.zod.ts` + + ## Allowed Values * `debug` * `info` * `warn` * `error` -* `fatal` \ No newline at end of file +* `fatal` + +## TypeScript Usage + +```typescript +import { LogLevel } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: LogLevel = 'debug'; +``` + diff --git a/content/docs/references/system/logger/LoggerConfig.mdx b/content/docs/references/system/logger/LoggerConfig.mdx index 2a35ba499..9ee1c8c9d 100644 --- a/content/docs/references/system/logger/LoggerConfig.mdx +++ b/content/docs/references/system/logger/LoggerConfig.mdx @@ -1,8 +1,18 @@ --- title: LoggerConfig description: LoggerConfig Schema Reference +category: system +zodFile: logger --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/logger.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: LoggerConfig Schema Reference | **sourceLocation** | `boolean` | optional | Include file and line number | | **file** | `string` | optional | Path to log file | | **rotation** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { LoggerConfigSchema } from '@objectstack/spec/system'; +import type { LoggerConfig } from '@objectstack/spec/system'; + +// Validate data +const result = LoggerConfigSchema.parse(data); + +// Type-safe usage +const myLoggerConfig: LoggerConfig = { +}; +``` + diff --git a/content/docs/references/system/manifest/Manifest.mdx b/content/docs/references/system/manifest/Manifest.mdx index 2d411d92f..bb2c395f0 100644 --- a/content/docs/references/system/manifest/Manifest.mdx +++ b/content/docs/references/system/manifest/Manifest.mdx @@ -1,8 +1,18 @@ --- title: Manifest description: Manifest Schema Reference +category: system +zodFile: manifest --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/manifest.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,22 @@ description: Manifest Schema Reference | **contributes** | `object` | optional | Platform contributions | | **data** | `object[]` | optional | Initial seed data | | **extensions** | `Record` | optional | Extension points and contributions | + +## TypeScript Usage + +```typescript +import { ManifestSchema } from '@objectstack/spec/system'; +import type { Manifest } from '@objectstack/spec/system'; + +// Validate data +const result = ManifestSchema.parse(data); + +// Type-safe usage +const myManifest: Manifest = { + id: 'example', + version: 'example', + type: 'app', + // ... other fields +}; +``` + diff --git a/content/docs/references/system/MongoConfig.mdx b/content/docs/references/system/misc/MongoConfig.mdx similarity index 63% rename from content/docs/references/system/MongoConfig.mdx rename to content/docs/references/system/misc/MongoConfig.mdx index 5698e7c21..fbc72ac80 100644 --- a/content/docs/references/system/MongoConfig.mdx +++ b/content/docs/references/system/misc/MongoConfig.mdx @@ -1,8 +1,18 @@ --- title: MongoConfig description: MongoConfig Schema Reference +category: system +zodFile: misc --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/misc.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,19 @@ description: MongoConfig Schema Reference | **minPoolSize** | `number` | optional | Min Connection Pool Size | | **connectTimeoutMS** | `number` | optional | Connection Timeout (ms) | | **socketTimeoutMS** | `number` | optional | Socket Timeout (ms) | + +## TypeScript Usage + +```typescript +import { MongoConfigSchema } from '@objectstack/spec/system'; +import type { MongoConfig } from '@objectstack/spec/system'; + +// Validate data +const result = MongoConfigSchema.parse(data); + +// Type-safe usage +const myMongoConfig: MongoConfig = { + database: 'example' +}; +``` + diff --git a/content/docs/references/system/PostgresConfig.mdx b/content/docs/references/system/misc/PostgresConfig.mdx similarity index 61% rename from content/docs/references/system/PostgresConfig.mdx rename to content/docs/references/system/misc/PostgresConfig.mdx index 907050c71..9291490da 100644 --- a/content/docs/references/system/PostgresConfig.mdx +++ b/content/docs/references/system/misc/PostgresConfig.mdx @@ -1,8 +1,18 @@ --- title: PostgresConfig description: PostgresConfig Schema Reference +category: system +zodFile: misc --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/misc.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,19 @@ description: PostgresConfig Schema Reference | **idleTimeoutMillis** | `number` | optional | Idle Timeout (ms) | | **connectionTimeoutMillis** | `number` | optional | Connection Timeout (ms) | | **statementTimeout** | `number` | optional | Statement Timeout (ms) | + +## TypeScript Usage + +```typescript +import { PostgresConfigSchema } from '@objectstack/spec/system'; +import type { PostgresConfig } from '@objectstack/spec/system'; + +// Validate data +const result = PostgresConfigSchema.parse(data); + +// Type-safe usage +const myPostgresConfig: PostgresConfig = { + database: 'example' +}; +``` + diff --git a/content/docs/references/system/plugin/I18nContext.mdx b/content/docs/references/system/plugin/I18nContext.mdx index 7f03c9198..64eeeb65b 100644 --- a/content/docs/references/system/plugin/I18nContext.mdx +++ b/content/docs/references/system/plugin/I18nContext.mdx @@ -1,11 +1,36 @@ --- title: I18nContext description: Internationalization Helper +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Internationalization Helper + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { I18nContextSchema } from '@objectstack/spec/system'; +import type { I18nContext } from '@objectstack/spec/system'; + +// Validate data +const result = I18nContextSchema.parse(data); + +// Type-safe usage +const myI18nContext: I18nContext = { +}; +``` + diff --git a/content/docs/references/system/plugin/Logger.mdx b/content/docs/references/system/plugin/Logger.mdx index 90febc850..bcf18f8b3 100644 --- a/content/docs/references/system/plugin/Logger.mdx +++ b/content/docs/references/system/plugin/Logger.mdx @@ -1,10 +1,20 @@ --- title: Logger description: Structured Logger +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Structured Logger + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ Structured Logger | **info** | `any` | optional | (message: string, ...meta: any[]) => void | | **warn** | `any` | optional | (message: string, ...meta: any[]) => void | | **error** | `any` | optional | (message: string, ...meta: any[]) => void | + +## TypeScript Usage + +```typescript +import { LoggerSchema } from '@objectstack/spec/system'; +import type { Logger } from '@objectstack/spec/system'; + +// Validate data +const result = LoggerSchema.parse(data); + +// Type-safe usage +const myLogger: Logger = { +}; +``` + diff --git a/content/docs/references/system/plugin/ObjectQLClient.mdx b/content/docs/references/system/plugin/ObjectQLClient.mdx index dddd5e862..6eb4143f8 100644 --- a/content/docs/references/system/plugin/ObjectQLClient.mdx +++ b/content/docs/references/system/plugin/ObjectQLClient.mdx @@ -1,11 +1,36 @@ --- title: ObjectQLClient description: ObjectQL Data Access Client +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + ObjectQL Data Access Client + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { ObjectQLClientSchema } from '@objectstack/spec/system'; +import type { ObjectQLClient } from '@objectstack/spec/system'; + +// Validate data +const result = ObjectQLClientSchema.parse(data); + +// Type-safe usage +const myObjectQLClient: ObjectQLClient = { +}; +``` + diff --git a/content/docs/references/system/plugin/Plugin.mdx b/content/docs/references/system/plugin/Plugin.mdx index 00d48a3fe..d3aa58f04 100644 --- a/content/docs/references/system/plugin/Plugin.mdx +++ b/content/docs/references/system/plugin/Plugin.mdx @@ -1,11 +1,36 @@ --- title: Plugin description: Plugin Schema Reference +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **id** | `string` | optional | Plugin identifier | | **version** | `string` | optional | Plugin version | + +## TypeScript Usage + +```typescript +import { PluginSchema } from '@objectstack/spec/system'; +import type { Plugin } from '@objectstack/spec/system'; + +// Validate data +const result = PluginSchema.parse(data); + +// Type-safe usage +const myPlugin: Plugin = { +}; +``` + diff --git a/content/docs/references/system/plugin/PluginContext.mdx b/content/docs/references/system/plugin/PluginContext.mdx index 63eaee7c1..a3d05319f 100644 --- a/content/docs/references/system/plugin/PluginContext.mdx +++ b/content/docs/references/system/plugin/PluginContext.mdx @@ -1,8 +1,18 @@ --- title: PluginContext description: PluginContext Schema Reference +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,22 @@ description: PluginContext Schema Reference | **events** | `any` | optional | Event bus | | **app** | `object` | ✅ | App Runtime Capabilities | | **drivers** | `object` | ✅ | Driver Management | + +## TypeScript Usage + +```typescript +import { PluginContextSchema } from '@objectstack/spec/system'; +import type { PluginContext } from '@objectstack/spec/system'; + +// Validate data +const result = PluginContextSchema.parse(data); + +// Type-safe usage +const myPluginContext: PluginContext = { + ql: {}, + os: {}, + logger: {}, + // ... other fields +}; +``` + diff --git a/content/docs/references/system/plugin/PluginLifecycle.mdx b/content/docs/references/system/plugin/PluginLifecycle.mdx index 3e4cbb022..9ca46bbcd 100644 --- a/content/docs/references/system/plugin/PluginLifecycle.mdx +++ b/content/docs/references/system/plugin/PluginLifecycle.mdx @@ -1,9 +1,34 @@ --- title: PluginLifecycle description: PluginLifecycle Schema Reference +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { PluginLifecycleSchema } from '@objectstack/spec/system'; +import type { PluginLifecycle } from '@objectstack/spec/system'; + +// Validate data +const result = PluginLifecycleSchema.parse(data); + +// Type-safe usage +const myPluginLifecycle: PluginLifecycle = { +}; +``` + diff --git a/content/docs/references/system/plugin/Router.mdx b/content/docs/references/system/plugin/Router.mdx index 5960be2f8..700c2eb8f 100644 --- a/content/docs/references/system/plugin/Router.mdx +++ b/content/docs/references/system/plugin/Router.mdx @@ -1,11 +1,36 @@ --- title: Router description: HTTP Router Interface +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + HTTP Router Interface + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { RouterSchema } from '@objectstack/spec/system'; +import type { Router } from '@objectstack/spec/system'; + +// Validate data +const result = RouterSchema.parse(data); + +// Type-safe usage +const myRouter: Router = { +}; +``` + diff --git a/content/docs/references/system/plugin/Scheduler.mdx b/content/docs/references/system/plugin/Scheduler.mdx index 60390dc1d..9ac08b156 100644 --- a/content/docs/references/system/plugin/Scheduler.mdx +++ b/content/docs/references/system/plugin/Scheduler.mdx @@ -1,11 +1,36 @@ --- title: Scheduler description: Job Scheduler Interface +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Job Scheduler Interface + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { SchedulerSchema } from '@objectstack/spec/system'; +import type { Scheduler } from '@objectstack/spec/system'; + +// Validate data +const result = SchedulerSchema.parse(data); + +// Type-safe usage +const myScheduler: Scheduler = { +}; +``` + diff --git a/content/docs/references/system/plugin/ScopedStorage.mdx b/content/docs/references/system/plugin/ScopedStorage.mdx index 9ec40e6c1..8c4b454ca 100644 --- a/content/docs/references/system/plugin/ScopedStorage.mdx +++ b/content/docs/references/system/plugin/ScopedStorage.mdx @@ -1,11 +1,36 @@ --- title: ScopedStorage description: Plugin Scoped Data Storage (KV) +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Plugin Scoped Data Storage (KV) + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { ScopedStorageSchema } from '@objectstack/spec/system'; +import type { ScopedStorage } from '@objectstack/spec/system'; + +// Validate data +const result = ScopedStorageSchema.parse(data); + +// Type-safe usage +const myScopedStorage: ScopedStorage = { +}; +``` + diff --git a/content/docs/references/system/plugin/SystemAPI.mdx b/content/docs/references/system/plugin/SystemAPI.mdx index 2ad8c9166..f4a68b1ba 100644 --- a/content/docs/references/system/plugin/SystemAPI.mdx +++ b/content/docs/references/system/plugin/SystemAPI.mdx @@ -1,11 +1,36 @@ --- title: SystemAPI description: Access to System Core +category: system +zodFile: plugin --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Access to System Core + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | + +## TypeScript Usage + +```typescript +import { SystemAPISchema } from '@objectstack/spec/system'; +import type { SystemAPI } from '@objectstack/spec/system'; + +// Validate data +const result = SystemAPISchema.parse(data); + +// Type-safe usage +const mySystemAPI: SystemAPI = { +}; +``` + diff --git a/content/docs/references/system/scoped-storage/FileMetadata.mdx b/content/docs/references/system/scoped-storage/FileMetadata.mdx index 9a06a697b..da0074287 100644 --- a/content/docs/references/system/scoped-storage/FileMetadata.mdx +++ b/content/docs/references/system/scoped-storage/FileMetadata.mdx @@ -1,8 +1,18 @@ --- title: FileMetadata description: FileMetadata Schema Reference +category: system +zodFile: scoped-storage --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/scoped-storage.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: FileMetadata Schema Reference | **lastModified** | `string` | ✅ | | | **created** | `string` | ✅ | | | **etag** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { FileMetadataSchema } from '@objectstack/spec/system'; +import type { FileMetadata } from '@objectstack/spec/system'; + +// Validate data +const result = FileMetadataSchema.parse(data); + +// Type-safe usage +const myFileMetadata: FileMetadata = { + path: 'example', + name: 'name', + size: null, + // ... other fields +}; +``` + diff --git a/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx b/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx index d06945154..b96b07b8b 100644 --- a/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx +++ b/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx @@ -1,8 +1,18 @@ --- title: ScopedStorageConfig description: ScopedStorageConfig Schema Reference +category: system +zodFile: scoped-storage --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/scoped-storage.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: ScopedStorageConfig Schema Reference | **location** | `string` | ✅ | Root path (local) or Bucket name (remote) | | **options** | `Record` | optional | Driver specific options (region, endpoint, etc) | | **quota** | `integer` | optional | Max size in bytes | + +## TypeScript Usage + +```typescript +import { ScopedStorageConfigSchema } from '@objectstack/spec/system'; +import type { ScopedStorageConfig } from '@objectstack/spec/system'; + +// Validate data +const result = ScopedStorageConfigSchema.parse(data); + +// Type-safe usage +const myScopedStorageConfig: ScopedStorageConfig = { + scope: 'temp', + location: 'example' +}; +``` + diff --git a/content/docs/references/system/scoped-storage/StorageAdapterType.mdx b/content/docs/references/system/scoped-storage/StorageAdapterType.mdx index a614be9ee..49fa452ca 100644 --- a/content/docs/references/system/scoped-storage/StorageAdapterType.mdx +++ b/content/docs/references/system/scoped-storage/StorageAdapterType.mdx @@ -1,8 +1,18 @@ --- title: StorageAdapterType description: StorageAdapterType Schema Reference +category: system +zodFile: scoped-storage --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/scoped-storage.zod.ts` + + ## Allowed Values * `local` @@ -10,4 +20,14 @@ description: StorageAdapterType Schema Reference * `s3` * `gcs` * `azure` -* `gridfs` \ No newline at end of file +* `gridfs` + +## TypeScript Usage + +```typescript +import { StorageAdapterType } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: StorageAdapterType = 'local'; +``` + diff --git a/content/docs/references/system/scoped-storage/StorageScope.mdx b/content/docs/references/system/scoped-storage/StorageScope.mdx index f155f1e81..b56577eaf 100644 --- a/content/docs/references/system/scoped-storage/StorageScope.mdx +++ b/content/docs/references/system/scoped-storage/StorageScope.mdx @@ -1,10 +1,20 @@ --- title: StorageScope description: Generic storage scope classification +category: system +zodFile: scoped-storage --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + Generic storage scope classification + +**Source:** `packages/spec/src/system/scoped-storage.zod.ts` + + ## Allowed Values * `temp` @@ -12,4 +22,14 @@ Generic storage scope classification * `data` * `logs` * `config` -* `public` \ No newline at end of file +* `public` + +## TypeScript Usage + +```typescript +import { StorageScope } from '@objectstack/spec/system'; + +// Type-safe enum value +const value: StorageScope = 'temp'; +``` + diff --git a/content/docs/references/system/translation/Locale.mdx b/content/docs/references/system/translation/Locale.mdx index a930a875d..0665d76da 100644 --- a/content/docs/references/system/translation/Locale.mdx +++ b/content/docs/references/system/translation/Locale.mdx @@ -1,7 +1,17 @@ --- title: Locale description: BCP-47 Language Tag (e.g. en-US, zh-CN) +category: system +zodFile: translation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + BCP-47 Language Tag (e.g. en-US, zh-CN) + +**Source:** `packages/spec/src/system/translation.zod.ts` + + diff --git a/content/docs/references/system/translation/TranslationBundle.mdx b/content/docs/references/system/translation/TranslationBundle.mdx index 937c54f56..ebe834faf 100644 --- a/content/docs/references/system/translation/TranslationBundle.mdx +++ b/content/docs/references/system/translation/TranslationBundle.mdx @@ -1,5 +1,15 @@ --- title: TranslationBundle description: TranslationBundle Schema Reference +category: system +zodFile: translation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/translation.zod.ts` + + diff --git a/content/docs/references/system/translation/TranslationData.mdx b/content/docs/references/system/translation/TranslationData.mdx index 95a354a6e..38c07ab0c 100644 --- a/content/docs/references/system/translation/TranslationData.mdx +++ b/content/docs/references/system/translation/TranslationData.mdx @@ -1,8 +1,18 @@ --- title: TranslationData description: TranslationData Schema Reference +category: system +zodFile: translation --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/system/translation.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: TranslationData Schema Reference | **objects** | `Record` | optional | | | **apps** | `Record` | optional | | | **messages** | `Record` | optional | | + +## TypeScript Usage + +```typescript +import { TranslationDataSchema } from '@objectstack/spec/system'; +import type { TranslationData } from '@objectstack/spec/system'; + +// Validate data +const result = TranslationDataSchema.parse(data); + +// Type-safe usage +const myTranslationData: TranslationData = { +}; +``` + diff --git a/content/docs/references/ui/action/Action.mdx b/content/docs/references/ui/action/Action.mdx index 6ff80d0c6..5e62ee619 100644 --- a/content/docs/references/ui/action/Action.mdx +++ b/content/docs/references/ui/action/Action.mdx @@ -1,8 +1,18 @@ --- title: Action description: Action Schema Reference +category: ui +zodFile: action --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/action.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -21,3 +31,20 @@ description: Action Schema Reference | **successMessage** | `string` | optional | Success message to show after execution | | **refreshAfter** | `boolean` | optional | Refresh view after execution | | **visible** | `string` | optional | Formula returning boolean | + +## TypeScript Usage + +```typescript +import { ActionSchema } from '@objectstack/spec/ui'; +import type { Action } from '@objectstack/spec/ui'; + +// Validate data +const result = ActionSchema.parse(data); + +// Type-safe usage +const myAction: Action = { + name: 'name', + label: 'example' +}; +``` + diff --git a/content/docs/references/ui/action/ActionParam.mdx b/content/docs/references/ui/action/ActionParam.mdx index bc61561f3..e614ae991 100644 --- a/content/docs/references/ui/action/ActionParam.mdx +++ b/content/docs/references/ui/action/ActionParam.mdx @@ -1,8 +1,18 @@ --- title: ActionParam description: ActionParam Schema Reference +category: ui +zodFile: action --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/action.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: ActionParam Schema Reference | **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'toggle' \| 'select' \| 'multiselect' \| 'radio' \| 'checkboxes' \| 'lookup' \| 'master_detail' \| 'tree' \| 'image' \| 'file' \| 'avatar' \| 'video' \| 'audio' \| 'formula' \| 'summary' \| 'autonumber' \| 'location' \| 'address' \| 'code' \| 'json' \| 'color' \| 'rating' \| 'slider' \| 'signature' \| 'qrcode' \| 'progress' \| 'tags' \| 'vector'>` | ✅ | | | **required** | `boolean` | optional | | | **options** | `object[]` | optional | | + +## TypeScript Usage + +```typescript +import { ActionParamSchema } from '@objectstack/spec/ui'; +import type { ActionParam } from '@objectstack/spec/ui'; + +// Validate data +const result = ActionParamSchema.parse(data); + +// Type-safe usage +const myActionParam: ActionParam = { + name: 'name', + label: 'example', + type: 'text' +}; +``` + diff --git a/content/docs/references/ui/app/App.mdx b/content/docs/references/ui/app/App.mdx index 124d5d2a6..ab07ebdcb 100644 --- a/content/docs/references/ui/app/App.mdx +++ b/content/docs/references/ui/app/App.mdx @@ -1,8 +1,18 @@ --- title: App description: App Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,20 @@ description: App Schema Reference | **requiredPermissions** | `string[]` | optional | Permissions required to access this app | | **objects** | `any[]` | optional | Objects belonging to this app | | **apis** | `any[]` | optional | Custom APIs belonging to this app | + +## TypeScript Usage + +```typescript +import { AppSchema } from '@objectstack/spec/ui'; +import type { App } from '@objectstack/spec/ui'; + +// Validate data +const result = AppSchema.parse(data); + +// Type-safe usage +const myApp: App = { + name: 'name', + label: 'example' +}; +``` + diff --git a/content/docs/references/ui/app/AppBranding.mdx b/content/docs/references/ui/app/AppBranding.mdx index ff066bb0e..386f35b18 100644 --- a/content/docs/references/ui/app/AppBranding.mdx +++ b/content/docs/references/ui/app/AppBranding.mdx @@ -1,8 +1,18 @@ --- title: AppBranding description: AppBranding Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: AppBranding Schema Reference | **primaryColor** | `string` | optional | Primary theme color hex code | | **logo** | `string` | optional | Custom logo URL for this app | | **favicon** | `string` | optional | Custom favicon URL for this app | + +## TypeScript Usage + +```typescript +import { AppBrandingSchema } from '@objectstack/spec/ui'; +import type { AppBranding } from '@objectstack/spec/ui'; + +// Validate data +const result = AppBrandingSchema.parse(data); + +// Type-safe usage +const myAppBranding: AppBranding = { +}; +``` + diff --git a/content/docs/references/ui/app/DashboardNavItem.mdx b/content/docs/references/ui/app/DashboardNavItem.mdx index 06d8c61d4..6989613b9 100644 --- a/content/docs/references/ui/app/DashboardNavItem.mdx +++ b/content/docs/references/ui/app/DashboardNavItem.mdx @@ -1,8 +1,18 @@ --- title: DashboardNavItem description: DashboardNavItem Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,22 @@ description: DashboardNavItem Schema Reference | **visible** | `string` | optional | Visibility formula condition | | **type** | `string` | ✅ | | | **dashboardName** | `string` | ✅ | Target dashboard name | + +## TypeScript Usage + +```typescript +import { DashboardNavItemSchema } from '@objectstack/spec/ui'; +import type { DashboardNavItem } from '@objectstack/spec/ui'; + +// Validate data +const result = DashboardNavItemSchema.parse(data); + +// Type-safe usage +const myDashboardNavItem: DashboardNavItem = { + id: 'example', + label: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ui/app/GroupNavItem.mdx b/content/docs/references/ui/app/GroupNavItem.mdx index a336fee27..d60d1949a 100644 --- a/content/docs/references/ui/app/GroupNavItem.mdx +++ b/content/docs/references/ui/app/GroupNavItem.mdx @@ -1,8 +1,18 @@ --- title: GroupNavItem description: GroupNavItem Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,21 @@ description: GroupNavItem Schema Reference | **visible** | `string` | optional | Visibility formula condition | | **type** | `string` | ✅ | | | **expanded** | `boolean` | optional | Default expansion state in sidebar | + +## TypeScript Usage + +```typescript +import { GroupNavItemSchema } from '@objectstack/spec/ui'; +import type { GroupNavItem } from '@objectstack/spec/ui'; + +// Validate data +const result = GroupNavItemSchema.parse(data); + +// Type-safe usage +const myGroupNavItem: GroupNavItem = { + id: 'example', + label: 'example', + type: 'example' +}; +``` + diff --git a/content/docs/references/ui/app/NavigationItem.mdx b/content/docs/references/ui/app/NavigationItem.mdx index 159d66648..50110bce1 100644 --- a/content/docs/references/ui/app/NavigationItem.mdx +++ b/content/docs/references/ui/app/NavigationItem.mdx @@ -1,5 +1,15 @@ --- title: NavigationItem description: NavigationItem Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + diff --git a/content/docs/references/ui/app/ObjectNavItem.mdx b/content/docs/references/ui/app/ObjectNavItem.mdx index 080bed559..9a9c9441a 100644 --- a/content/docs/references/ui/app/ObjectNavItem.mdx +++ b/content/docs/references/ui/app/ObjectNavItem.mdx @@ -1,8 +1,18 @@ --- title: ObjectNavItem description: ObjectNavItem Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: ObjectNavItem Schema Reference | **type** | `string` | ✅ | | | **objectName** | `string` | ✅ | Target object name | | **viewName** | `string` | optional | Default list view to open. Defaults to "all" | + +## TypeScript Usage + +```typescript +import { ObjectNavItemSchema } from '@objectstack/spec/ui'; +import type { ObjectNavItem } from '@objectstack/spec/ui'; + +// Validate data +const result = ObjectNavItemSchema.parse(data); + +// Type-safe usage +const myObjectNavItem: ObjectNavItem = { + id: 'example', + label: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ui/app/PageNavItem.mdx b/content/docs/references/ui/app/PageNavItem.mdx index f30bf6b75..6bb454cd0 100644 --- a/content/docs/references/ui/app/PageNavItem.mdx +++ b/content/docs/references/ui/app/PageNavItem.mdx @@ -1,8 +1,18 @@ --- title: PageNavItem description: PageNavItem Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: PageNavItem Schema Reference | **type** | `string` | ✅ | | | **pageName** | `string` | ✅ | Target custom page component name | | **params** | `Record` | optional | Parameters passed to the page context | + +## TypeScript Usage + +```typescript +import { PageNavItemSchema } from '@objectstack/spec/ui'; +import type { PageNavItem } from '@objectstack/spec/ui'; + +// Validate data +const result = PageNavItemSchema.parse(data); + +// Type-safe usage +const myPageNavItem: PageNavItem = { + id: 'example', + label: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ui/app/UrlNavItem.mdx b/content/docs/references/ui/app/UrlNavItem.mdx index f25bdd153..bcc3b2b67 100644 --- a/content/docs/references/ui/app/UrlNavItem.mdx +++ b/content/docs/references/ui/app/UrlNavItem.mdx @@ -1,8 +1,18 @@ --- title: UrlNavItem description: UrlNavItem Schema Reference +category: ui +zodFile: app --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,22 @@ description: UrlNavItem Schema Reference | **type** | `string` | ✅ | | | **url** | `string` | ✅ | Target external URL | | **target** | `Enum<'_self' \| '_blank'>` | optional | Link target window | + +## TypeScript Usage + +```typescript +import { UrlNavItemSchema } from '@objectstack/spec/ui'; +import type { UrlNavItem } from '@objectstack/spec/ui'; + +// Validate data +const result = UrlNavItemSchema.parse(data); + +// Type-safe usage +const myUrlNavItem: UrlNavItem = { + id: 'example', + label: 'example', + type: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ui/component/PageCardProps.mdx b/content/docs/references/ui/component/PageCardProps.mdx index c5f453484..ac94f884d 100644 --- a/content/docs/references/ui/component/PageCardProps.mdx +++ b/content/docs/references/ui/component/PageCardProps.mdx @@ -1,8 +1,18 @@ --- title: PageCardProps description: PageCardProps Schema Reference +category: ui +zodFile: component --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,19 @@ description: PageCardProps Schema Reference | **bordered** | `boolean` | optional | | | **actions** | `string[]` | optional | | | **children** | `any[]` | ✅ | Card content | + +## TypeScript Usage + +```typescript +import { PageCardPropsSchema } from '@objectstack/spec/ui'; +import type { PageCardProps } from '@objectstack/spec/ui'; + +// Validate data +const result = PageCardPropsSchema.parse(data); + +// Type-safe usage +const myPageCardProps: PageCardProps = { + children: [] +}; +``` + diff --git a/content/docs/references/ui/component/PageHeaderProps.mdx b/content/docs/references/ui/component/PageHeaderProps.mdx index 9154f6895..37d33a1ac 100644 --- a/content/docs/references/ui/component/PageHeaderProps.mdx +++ b/content/docs/references/ui/component/PageHeaderProps.mdx @@ -1,8 +1,18 @@ --- title: PageHeaderProps description: PageHeaderProps Schema Reference +category: ui +zodFile: component --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: PageHeaderProps Schema Reference | **icon** | `string` | optional | Icon name | | **breadcrumb** | `boolean` | optional | Show breadcrumb | | **actions** | `string[]` | optional | Action IDs to show in header | + +## TypeScript Usage + +```typescript +import { PageHeaderPropsSchema } from '@objectstack/spec/ui'; +import type { PageHeaderProps } from '@objectstack/spec/ui'; + +// Validate data +const result = PageHeaderPropsSchema.parse(data); + +// Type-safe usage +const myPageHeaderProps: PageHeaderProps = { + title: 'example' +}; +``` + diff --git a/content/docs/references/ui/component/PageTabsProps.mdx b/content/docs/references/ui/component/PageTabsProps.mdx index 71f9e9207..908ff91fc 100644 --- a/content/docs/references/ui/component/PageTabsProps.mdx +++ b/content/docs/references/ui/component/PageTabsProps.mdx @@ -1,8 +1,18 @@ --- title: PageTabsProps description: PageTabsProps Schema Reference +category: ui +zodFile: component --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: PageTabsProps Schema Reference | **type** | `Enum<'line' \| 'card' \| 'pill'>` | optional | | | **position** | `Enum<'top' \| 'left'>` | optional | | | **items** | `object[]` | ✅ | | + +## TypeScript Usage + +```typescript +import { PageTabsPropsSchema } from '@objectstack/spec/ui'; +import type { PageTabsProps } from '@objectstack/spec/ui'; + +// Validate data +const result = PageTabsPropsSchema.parse(data); + +// Type-safe usage +const myPageTabsProps: PageTabsProps = { + items: [] +}; +``` + diff --git a/content/docs/references/ui/component/RecordDetailsProps.mdx b/content/docs/references/ui/component/RecordDetailsProps.mdx index e9e1f9326..c56290920 100644 --- a/content/docs/references/ui/component/RecordDetailsProps.mdx +++ b/content/docs/references/ui/component/RecordDetailsProps.mdx @@ -1,8 +1,18 @@ --- title: RecordDetailsProps description: RecordDetailsProps Schema Reference +category: ui +zodFile: component --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,18 @@ description: RecordDetailsProps Schema Reference | **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | | | **layout** | `Enum<'auto' \| 'custom'>` | optional | | | **sections** | `string[]` | optional | Section IDs to show | + +## TypeScript Usage + +```typescript +import { RecordDetailsPropsSchema } from '@objectstack/spec/ui'; +import type { RecordDetailsProps } from '@objectstack/spec/ui'; + +// Validate data +const result = RecordDetailsPropsSchema.parse(data); + +// Type-safe usage +const myRecordDetailsProps: RecordDetailsProps = { +}; +``` + diff --git a/content/docs/references/ui/component/RecordHighlightsProps.mdx b/content/docs/references/ui/component/RecordHighlightsProps.mdx index 690dbe6f0..3330cbf27 100644 --- a/content/docs/references/ui/component/RecordHighlightsProps.mdx +++ b/content/docs/references/ui/component/RecordHighlightsProps.mdx @@ -1,10 +1,36 @@ --- title: RecordHighlightsProps description: RecordHighlightsProps Schema Reference +category: ui +zodFile: component --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **fields** | `string[]` | ✅ | Key fields to highlights (max 7) | + +## TypeScript Usage + +```typescript +import { RecordHighlightsPropsSchema } from '@objectstack/spec/ui'; +import type { RecordHighlightsProps } from '@objectstack/spec/ui'; + +// Validate data +const result = RecordHighlightsPropsSchema.parse(data); + +// Type-safe usage +const myRecordHighlightsProps: RecordHighlightsProps = { + fields: [] +}; +``` + diff --git a/content/docs/references/ui/component/RecordRelatedListProps.mdx b/content/docs/references/ui/component/RecordRelatedListProps.mdx index af02873eb..a383b7a98 100644 --- a/content/docs/references/ui/component/RecordRelatedListProps.mdx +++ b/content/docs/references/ui/component/RecordRelatedListProps.mdx @@ -1,8 +1,18 @@ --- title: RecordRelatedListProps description: RecordRelatedListProps Schema Reference +category: ui +zodFile: component --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: RecordRelatedListProps Schema Reference | **columns** | `string[]` | ✅ | Fields to display | | **sort** | `string` | optional | | | **limit** | `number` | optional | | + +## TypeScript Usage + +```typescript +import { RecordRelatedListPropsSchema } from '@objectstack/spec/ui'; +import type { RecordRelatedListProps } from '@objectstack/spec/ui'; + +// Validate data +const result = RecordRelatedListPropsSchema.parse(data); + +// Type-safe usage +const myRecordRelatedListProps: RecordRelatedListProps = { + objectName: 'example', + relationshipField: 'example', + columns: [] +}; +``` + diff --git a/content/docs/references/ui/dashboard/ChartType.mdx b/content/docs/references/ui/dashboard/ChartType.mdx index 363b133c7..0e313f926 100644 --- a/content/docs/references/ui/dashboard/ChartType.mdx +++ b/content/docs/references/ui/dashboard/ChartType.mdx @@ -1,8 +1,18 @@ --- title: ChartType description: ChartType Schema Reference +category: ui +zodFile: dashboard --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/dashboard.zod.ts` + + ## Allowed Values * `metric` @@ -20,4 +30,14 @@ description: ChartType Schema Reference * `list` * `text` * `image` -* `frame` \ No newline at end of file +* `frame` + +## TypeScript Usage + +```typescript +import { ChartType } from '@objectstack/spec/ui'; + +// Type-safe enum value +const value: ChartType = 'metric'; +``` + diff --git a/content/docs/references/ui/dashboard/Dashboard.mdx b/content/docs/references/ui/dashboard/Dashboard.mdx index 5e042dc3b..03cf5a21f 100644 --- a/content/docs/references/ui/dashboard/Dashboard.mdx +++ b/content/docs/references/ui/dashboard/Dashboard.mdx @@ -1,8 +1,18 @@ --- title: Dashboard description: Dashboard Schema Reference +category: ui +zodFile: dashboard --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/dashboard.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,21 @@ description: Dashboard Schema Reference | **label** | `string` | ✅ | Dashboard label | | **description** | `string` | optional | Dashboard description | | **widgets** | `object[]` | ✅ | Widgets to display | + +## TypeScript Usage + +```typescript +import { DashboardSchema } from '@objectstack/spec/ui'; +import type { Dashboard } from '@objectstack/spec/ui'; + +// Validate data +const result = DashboardSchema.parse(data); + +// Type-safe usage +const myDashboard: Dashboard = { + name: 'name', + label: 'example', + widgets: [] +}; +``` + diff --git a/content/docs/references/ui/dashboard/DashboardWidget.mdx b/content/docs/references/ui/dashboard/DashboardWidget.mdx index 0084d1ae4..0c14f45b6 100644 --- a/content/docs/references/ui/dashboard/DashboardWidget.mdx +++ b/content/docs/references/ui/dashboard/DashboardWidget.mdx @@ -1,8 +1,18 @@ --- title: DashboardWidget description: DashboardWidget Schema Reference +category: ui +zodFile: dashboard --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/dashboard.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,19 @@ description: DashboardWidget Schema Reference | **aggregate** | `Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max'>` | optional | Aggregate function | | **layout** | `object` | ✅ | Grid layout position | | **options** | `any` | optional | Widget specific configuration | + +## TypeScript Usage + +```typescript +import { DashboardWidgetSchema } from '@objectstack/spec/ui'; +import type { DashboardWidget } from '@objectstack/spec/ui'; + +// Validate data +const result = DashboardWidgetSchema.parse(data); + +// Type-safe usage +const myDashboardWidget: DashboardWidget = { + layout: {} +}; +``` + diff --git a/content/docs/references/ui/index.mdx b/content/docs/references/ui/index.mdx new file mode 100644 index 000000000..2c3afd7bd --- /dev/null +++ b/content/docs/references/ui/index.mdx @@ -0,0 +1,132 @@ +--- +title: UI Protocol Overview +description: Complete reference for all ui protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Cpu, Zap } from 'lucide-react'; + +# UI Protocol + +This section contains all protocol schemas for the ui layer of ObjectStack. + +## Action + +Source: `packages/spec/src/ui/action.zod.ts` + + + + + + +## App + +Source: `packages/spec/src/ui/app.zod.ts` + + + + + + + + + + + + +## Component + +Source: `packages/spec/src/ui/component.zod.ts` + + + + + + + + + + +## Dashboard + +Source: `packages/spec/src/ui/dashboard.zod.ts` + + + + + + + +## Page + +Source: `packages/spec/src/ui/page.zod.ts` + + + + + + + + +## Report + +Source: `packages/spec/src/ui/report.zod.ts` + + + + + + + + + +## Theme + +Source: `packages/spec/src/ui/theme.zod.ts` + + + + + + + + + + + + + + +## View + +Source: `packages/spec/src/ui/view.zod.ts` + + + + + + + + + + + + + + + + + + +## Widget + +Source: `packages/spec/src/ui/widget.zod.ts` + + + + + + + + + diff --git a/content/docs/references/ui/page/Page.mdx b/content/docs/references/ui/page/Page.mdx index 31b53a195..edd98d36e 100644 --- a/content/docs/references/ui/page/Page.mdx +++ b/content/docs/references/ui/page/Page.mdx @@ -1,8 +1,18 @@ --- title: Page description: Page Schema Reference +category: ui +zodFile: page --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/page.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,21 @@ description: Page Schema Reference | **regions** | `object[]` | ✅ | Defined regions with components | | **isDefault** | `boolean` | optional | | | **assignedProfiles** | `string[]` | optional | | + +## TypeScript Usage + +```typescript +import { PageSchema } from '@objectstack/spec/ui'; +import type { Page } from '@objectstack/spec/ui'; + +// Validate data +const result = PageSchema.parse(data); + +// Type-safe usage +const myPage: Page = { + name: 'name', + label: 'example', + regions: [] +}; +``` + diff --git a/content/docs/references/ui/page/PageComponent.mdx b/content/docs/references/ui/page/PageComponent.mdx index e6d232530..ac5ef737e 100644 --- a/content/docs/references/ui/page/PageComponent.mdx +++ b/content/docs/references/ui/page/PageComponent.mdx @@ -1,8 +1,18 @@ --- title: PageComponent description: PageComponent Schema Reference +category: ui +zodFile: page --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/page.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,20 @@ description: PageComponent Schema Reference | **label** | `string` | optional | | | **properties** | `Record` | ✅ | Component props passed to the widget. See block.zod.ts for schemas. | | **visibility** | `string` | optional | Visibility filter/formula | + +## TypeScript Usage + +```typescript +import { PageComponentSchema } from '@objectstack/spec/ui'; +import type { PageComponent } from '@objectstack/spec/ui'; + +// Validate data +const result = PageComponentSchema.parse(data); + +// Type-safe usage +const myPageComponent: PageComponent = { + type: null, + properties: {} +}; +``` + diff --git a/content/docs/references/ui/page/PageComponentType.mdx b/content/docs/references/ui/page/PageComponentType.mdx index b454a22d5..bf7f8693f 100644 --- a/content/docs/references/ui/page/PageComponentType.mdx +++ b/content/docs/references/ui/page/PageComponentType.mdx @@ -1,8 +1,18 @@ --- title: PageComponentType description: PageComponentType Schema Reference +category: ui +zodFile: page --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/page.zod.ts` + + ## Allowed Values * `page:header` @@ -25,4 +35,14 @@ description: PageComponentType Schema Reference * `global:notifications` * `user:profile` * `ai:chat_window` -* `ai:suggestion` \ No newline at end of file +* `ai:suggestion` + +## TypeScript Usage + +```typescript +import { PageComponentType } from '@objectstack/spec/ui'; + +// Type-safe enum value +const value: PageComponentType = 'page:header'; +``` + diff --git a/content/docs/references/ui/page/PageRegion.mdx b/content/docs/references/ui/page/PageRegion.mdx index 1340f51ad..dac43aef9 100644 --- a/content/docs/references/ui/page/PageRegion.mdx +++ b/content/docs/references/ui/page/PageRegion.mdx @@ -1,8 +1,18 @@ --- title: PageRegion description: PageRegion Schema Reference +category: ui +zodFile: page --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/page.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: PageRegion Schema Reference | **name** | `string` | ✅ | Region name (e.g. "sidebar", "main", "header") | | **width** | `Enum<'small' \| 'medium' \| 'large' \| 'full'>` | optional | | | **components** | `object[]` | ✅ | Components in this region | + +## TypeScript Usage + +```typescript +import { PageRegionSchema } from '@objectstack/spec/ui'; +import type { PageRegion } from '@objectstack/spec/ui'; + +// Validate data +const result = PageRegionSchema.parse(data); + +// Type-safe usage +const myPageRegion: PageRegion = { + name: 'name', + components: [] +}; +``` + diff --git a/content/docs/references/ui/report/Report.mdx b/content/docs/references/ui/report/Report.mdx index 68954c597..82cf3b397 100644 --- a/content/docs/references/ui/report/Report.mdx +++ b/content/docs/references/ui/report/Report.mdx @@ -1,8 +1,18 @@ --- title: Report description: Report Schema Reference +category: ui +zodFile: report --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/report.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -17,3 +27,22 @@ description: Report Schema Reference | **groupingsAcross** | `object[]` | optional | Column groupings (Matrix only) | | **filter** | `any` | optional | Filter criteria | | **chart** | `object` | optional | Embedded chart configuration | + +## TypeScript Usage + +```typescript +import { ReportSchema } from '@objectstack/spec/ui'; +import type { Report } from '@objectstack/spec/ui'; + +// Validate data +const result = ReportSchema.parse(data); + +// Type-safe usage +const myReport: Report = { + name: 'name', + label: 'example', + objectName: 'example', + // ... other fields +}; +``` + diff --git a/content/docs/references/ui/report/ReportChart.mdx b/content/docs/references/ui/report/ReportChart.mdx index b6c342462..37a2e2840 100644 --- a/content/docs/references/ui/report/ReportChart.mdx +++ b/content/docs/references/ui/report/ReportChart.mdx @@ -1,8 +1,18 @@ --- title: ReportChart description: ReportChart Schema Reference +category: ui +zodFile: report --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/report.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: ReportChart Schema Reference | **showLegend** | `boolean` | optional | | | **xAxis** | `string` | ✅ | Grouping field for X-Axis | | **yAxis** | `string` | ✅ | Summary field for Y-Axis | + +## TypeScript Usage + +```typescript +import { ReportChartSchema } from '@objectstack/spec/ui'; +import type { ReportChart } from '@objectstack/spec/ui'; + +// Validate data +const result = ReportChartSchema.parse(data); + +// Type-safe usage +const myReportChart: ReportChart = { + type: 'bar', + xAxis: 'example', + yAxis: 'example' +}; +``` + diff --git a/content/docs/references/ui/report/ReportColumn.mdx b/content/docs/references/ui/report/ReportColumn.mdx index 607e8ace1..9d67239c3 100644 --- a/content/docs/references/ui/report/ReportColumn.mdx +++ b/content/docs/references/ui/report/ReportColumn.mdx @@ -1,8 +1,18 @@ --- title: ReportColumn description: ReportColumn Schema Reference +category: ui +zodFile: report --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/report.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: ReportColumn Schema Reference | **field** | `string` | ✅ | Field name | | **label** | `string` | optional | Override label | | **aggregate** | `Enum<'sum' \| 'avg' \| 'max' \| 'min' \| 'count' \| 'unique'>` | optional | Aggregation function | + +## TypeScript Usage + +```typescript +import { ReportColumnSchema } from '@objectstack/spec/ui'; +import type { ReportColumn } from '@objectstack/spec/ui'; + +// Validate data +const result = ReportColumnSchema.parse(data); + +// Type-safe usage +const myReportColumn: ReportColumn = { + field: 'example' +}; +``` + diff --git a/content/docs/references/ui/report/ReportGrouping.mdx b/content/docs/references/ui/report/ReportGrouping.mdx index e82ab5ada..5dc10dfa6 100644 --- a/content/docs/references/ui/report/ReportGrouping.mdx +++ b/content/docs/references/ui/report/ReportGrouping.mdx @@ -1,8 +1,18 @@ --- title: ReportGrouping description: ReportGrouping Schema Reference +category: ui +zodFile: report --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/report.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,19 @@ description: ReportGrouping Schema Reference | **field** | `string` | ✅ | Field to group by | | **sortOrder** | `Enum<'asc' \| 'desc'>` | optional | | | **dateGranularity** | `Enum<'day' \| 'week' \| 'month' \| 'quarter' \| 'year'>` | optional | For date fields | + +## TypeScript Usage + +```typescript +import { ReportGroupingSchema } from '@objectstack/spec/ui'; +import type { ReportGrouping } from '@objectstack/spec/ui'; + +// Validate data +const result = ReportGroupingSchema.parse(data); + +// Type-safe usage +const myReportGrouping: ReportGrouping = { + field: 'example' +}; +``` + diff --git a/content/docs/references/ui/report/ReportType.mdx b/content/docs/references/ui/report/ReportType.mdx index db2609f65..3763e6468 100644 --- a/content/docs/references/ui/report/ReportType.mdx +++ b/content/docs/references/ui/report/ReportType.mdx @@ -1,11 +1,31 @@ --- title: ReportType description: ReportType Schema Reference +category: ui +zodFile: report --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/report.zod.ts` + + ## Allowed Values * `tabular` * `summary` * `matrix` -* `joined` \ No newline at end of file +* `joined` + +## TypeScript Usage + +```typescript +import { ReportType } from '@objectstack/spec/ui'; + +// Type-safe enum value +const value: ReportType = 'tabular'; +``` + diff --git a/content/docs/references/ui/theme/Animation.mdx b/content/docs/references/ui/theme/Animation.mdx index ff48ac9ba..c9e414fcd 100644 --- a/content/docs/references/ui/theme/Animation.mdx +++ b/content/docs/references/ui/theme/Animation.mdx @@ -1,11 +1,36 @@ --- title: Animation description: Animation Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **duration** | `object` | optional | | | **timing** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { AnimationSchema } from '@objectstack/spec/ui'; +import type { Animation } from '@objectstack/spec/ui'; + +// Validate data +const result = AnimationSchema.parse(data); + +// Type-safe usage +const myAnimation: Animation = { +}; +``` + diff --git a/content/docs/references/ui/theme/BorderRadius.mdx b/content/docs/references/ui/theme/BorderRadius.mdx index e4a7dc165..2ee787234 100644 --- a/content/docs/references/ui/theme/BorderRadius.mdx +++ b/content/docs/references/ui/theme/BorderRadius.mdx @@ -1,8 +1,18 @@ --- title: BorderRadius description: BorderRadius Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: BorderRadius Schema Reference | **xl** | `string` | optional | Extra large border radius (e.g., 0.75rem) | | **2xl** | `string` | optional | 2X large border radius (e.g., 1rem) | | **full** | `string` | optional | Full border radius (50%) | + +## TypeScript Usage + +```typescript +import { BorderRadiusSchema } from '@objectstack/spec/ui'; +import type { BorderRadius } from '@objectstack/spec/ui'; + +// Validate data +const result = BorderRadiusSchema.parse(data); + +// Type-safe usage +const myBorderRadius: BorderRadius = { +}; +``` + diff --git a/content/docs/references/ui/theme/Breakpoints.mdx b/content/docs/references/ui/theme/Breakpoints.mdx index bdbaeed87..b70e3fbbf 100644 --- a/content/docs/references/ui/theme/Breakpoints.mdx +++ b/content/docs/references/ui/theme/Breakpoints.mdx @@ -1,8 +1,18 @@ --- title: Breakpoints description: Breakpoints Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,18 @@ description: Breakpoints Schema Reference | **lg** | `string` | optional | Large breakpoint (e.g., 1024px) | | **xl** | `string` | optional | Extra large breakpoint (e.g., 1280px) | | **2xl** | `string` | optional | 2X large breakpoint (e.g., 1536px) | + +## TypeScript Usage + +```typescript +import { BreakpointsSchema } from '@objectstack/spec/ui'; +import type { Breakpoints } from '@objectstack/spec/ui'; + +// Validate data +const result = BreakpointsSchema.parse(data); + +// Type-safe usage +const myBreakpoints: Breakpoints = { +}; +``` + diff --git a/content/docs/references/ui/theme/ColorPalette.mdx b/content/docs/references/ui/theme/ColorPalette.mdx index 346dd8fe4..e210464a2 100644 --- a/content/docs/references/ui/theme/ColorPalette.mdx +++ b/content/docs/references/ui/theme/ColorPalette.mdx @@ -1,8 +1,18 @@ --- title: ColorPalette description: ColorPalette Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -24,3 +34,19 @@ description: ColorPalette Schema Reference | **primaryDark** | `string` | optional | Darker shade of primary | | **secondaryLight** | `string` | optional | Lighter shade of secondary | | **secondaryDark** | `string` | optional | Darker shade of secondary | + +## TypeScript Usage + +```typescript +import { ColorPaletteSchema } from '@objectstack/spec/ui'; +import type { ColorPalette } from '@objectstack/spec/ui'; + +// Validate data +const result = ColorPaletteSchema.parse(data); + +// Type-safe usage +const myColorPalette: ColorPalette = { + primary: 'example' +}; +``` + diff --git a/content/docs/references/ui/theme/Shadow.mdx b/content/docs/references/ui/theme/Shadow.mdx index 4fe3c269f..d8cc42c91 100644 --- a/content/docs/references/ui/theme/Shadow.mdx +++ b/content/docs/references/ui/theme/Shadow.mdx @@ -1,8 +1,18 @@ --- title: Shadow description: Shadow Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: Shadow Schema Reference | **xl** | `string` | optional | Extra large shadow | | **2xl** | `string` | optional | 2X large shadow | | **inner** | `string` | optional | Inner shadow (inset) | + +## TypeScript Usage + +```typescript +import { ShadowSchema } from '@objectstack/spec/ui'; +import type { Shadow } from '@objectstack/spec/ui'; + +// Validate data +const result = ShadowSchema.parse(data); + +// Type-safe usage +const myShadow: Shadow = { +}; +``` + diff --git a/content/docs/references/ui/theme/Spacing.mdx b/content/docs/references/ui/theme/Spacing.mdx index 127bb81f1..4d6915d9f 100644 --- a/content/docs/references/ui/theme/Spacing.mdx +++ b/content/docs/references/ui/theme/Spacing.mdx @@ -1,8 +1,18 @@ --- title: Spacing description: Spacing Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -20,3 +30,18 @@ description: Spacing Schema Reference | **16** | `string` | optional | Spacing unit 16 (e.g., 4rem) | | **20** | `string` | optional | Spacing unit 20 (e.g., 5rem) | | **24** | `string` | optional | Spacing unit 24 (e.g., 6rem) | + +## TypeScript Usage + +```typescript +import { SpacingSchema } from '@objectstack/spec/ui'; +import type { Spacing } from '@objectstack/spec/ui'; + +// Validate data +const result = SpacingSchema.parse(data); + +// Type-safe usage +const mySpacing: Spacing = { +}; +``` + diff --git a/content/docs/references/ui/theme/Theme.mdx b/content/docs/references/ui/theme/Theme.mdx index e1131ecb1..121ca79d7 100644 --- a/content/docs/references/ui/theme/Theme.mdx +++ b/content/docs/references/ui/theme/Theme.mdx @@ -1,8 +1,18 @@ --- title: Theme description: Theme Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -22,3 +32,21 @@ description: Theme Schema Reference | **customVars** | `Record` | optional | Custom CSS variables (key-value pairs) | | **logo** | `object` | optional | Logo assets | | **extends** | `string` | optional | Base theme to extend from | + +## TypeScript Usage + +```typescript +import { ThemeSchema } from '@objectstack/spec/ui'; +import type { Theme } from '@objectstack/spec/ui'; + +// Validate data +const result = ThemeSchema.parse(data); + +// Type-safe usage +const myTheme: Theme = { + name: 'name', + label: 'example', + colors: {} +}; +``` + diff --git a/content/docs/references/ui/theme/ThemeMode.mdx b/content/docs/references/ui/theme/ThemeMode.mdx index 553ecaeb7..4a2136364 100644 --- a/content/docs/references/ui/theme/ThemeMode.mdx +++ b/content/docs/references/ui/theme/ThemeMode.mdx @@ -1,10 +1,30 @@ --- title: ThemeMode description: ThemeMode Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Allowed Values * `light` * `dark` -* `auto` \ No newline at end of file +* `auto` + +## TypeScript Usage + +```typescript +import { ThemeMode } from '@objectstack/spec/ui'; + +// Type-safe enum value +const value: ThemeMode = 'light'; +``` + diff --git a/content/docs/references/ui/theme/Typography.mdx b/content/docs/references/ui/theme/Typography.mdx index e04d15c48..5f5254b2b 100644 --- a/content/docs/references/ui/theme/Typography.mdx +++ b/content/docs/references/ui/theme/Typography.mdx @@ -1,8 +1,18 @@ --- title: Typography description: Typography Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,18 @@ description: Typography Schema Reference | **fontWeight** | `object` | optional | | | **lineHeight** | `object` | optional | | | **letterSpacing** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { TypographySchema } from '@objectstack/spec/ui'; +import type { Typography } from '@objectstack/spec/ui'; + +// Validate data +const result = TypographySchema.parse(data); + +// Type-safe usage +const myTypography: Typography = { +}; +``` + diff --git a/content/docs/references/ui/theme/ZIndex.mdx b/content/docs/references/ui/theme/ZIndex.mdx index 1e570762c..79b02ec74 100644 --- a/content/docs/references/ui/theme/ZIndex.mdx +++ b/content/docs/references/ui/theme/ZIndex.mdx @@ -1,8 +1,18 @@ --- title: ZIndex description: ZIndex Schema Reference +category: ui +zodFile: theme --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,18 @@ description: ZIndex Schema Reference | **modal** | `number` | optional | Modal z-index (e.g., 1050) | | **popover** | `number` | optional | Popover z-index (e.g., 1060) | | **tooltip** | `number` | optional | Tooltip z-index (e.g., 1070) | + +## TypeScript Usage + +```typescript +import { ZIndexSchema } from '@objectstack/spec/ui'; +import type { ZIndex } from '@objectstack/spec/ui'; + +// Validate data +const result = ZIndexSchema.parse(data); + +// Type-safe usage +const myZIndex: ZIndex = { +}; +``` + diff --git a/content/docs/references/ui/view/CalendarConfig.mdx b/content/docs/references/ui/view/CalendarConfig.mdx index b47adbfa2..5238030c9 100644 --- a/content/docs/references/ui/view/CalendarConfig.mdx +++ b/content/docs/references/ui/view/CalendarConfig.mdx @@ -1,8 +1,18 @@ --- title: CalendarConfig description: CalendarConfig Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,20 @@ description: CalendarConfig Schema Reference | **endDateField** | `string` | optional | | | **titleField** | `string` | ✅ | | | **colorField** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { CalendarConfigSchema } from '@objectstack/spec/ui'; +import type { CalendarConfig } from '@objectstack/spec/ui'; + +// Validate data +const result = CalendarConfigSchema.parse(data); + +// Type-safe usage +const myCalendarConfig: CalendarConfig = { + startDateField: 'example', + titleField: 'example' +}; +``` + diff --git a/content/docs/references/ui/view/FormField.mdx b/content/docs/references/ui/view/FormField.mdx index e0e56aa1c..d14fca978 100644 --- a/content/docs/references/ui/view/FormField.mdx +++ b/content/docs/references/ui/view/FormField.mdx @@ -1,8 +1,18 @@ --- title: FormField description: FormField Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -18,3 +28,19 @@ description: FormField Schema Reference | **widget** | `string` | optional | Custom widget/component name | | **dependsOn** | `string` | optional | Parent field name for cascading | | **visibleOn** | `string` | optional | Visibility condition expression | + +## TypeScript Usage + +```typescript +import { FormFieldSchema } from '@objectstack/spec/ui'; +import type { FormField } from '@objectstack/spec/ui'; + +// Validate data +const result = FormFieldSchema.parse(data); + +// Type-safe usage +const myFormField: FormField = { + field: 'example' +}; +``` + diff --git a/content/docs/references/ui/view/FormSection.mdx b/content/docs/references/ui/view/FormSection.mdx index a5c8e68e4..db34312c2 100644 --- a/content/docs/references/ui/view/FormSection.mdx +++ b/content/docs/references/ui/view/FormSection.mdx @@ -1,8 +1,18 @@ --- title: FormSection description: FormSection Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: FormSection Schema Reference | **collapsed** | `boolean` | optional | | | **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | | | **fields** | `string \| object[]` | ✅ | | + +## TypeScript Usage + +```typescript +import { FormSectionSchema } from '@objectstack/spec/ui'; +import type { FormSection } from '@objectstack/spec/ui'; + +// Validate data +const result = FormSectionSchema.parse(data); + +// Type-safe usage +const myFormSection: FormSection = { + fields: [] +}; +``` + diff --git a/content/docs/references/ui/view/FormView.mdx b/content/docs/references/ui/view/FormView.mdx index 256fe0782..18b6b17bb 100644 --- a/content/docs/references/ui/view/FormView.mdx +++ b/content/docs/references/ui/view/FormView.mdx @@ -1,8 +1,18 @@ --- title: FormView description: FormView Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: FormView Schema Reference | **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) | | **sections** | `object[]` | optional | | | **groups** | `object[]` | optional | | + +## TypeScript Usage + +```typescript +import { FormViewSchema } from '@objectstack/spec/ui'; +import type { FormView } from '@objectstack/spec/ui'; + +// Validate data +const result = FormViewSchema.parse(data); + +// Type-safe usage +const myFormView: FormView = { +}; +``` + diff --git a/content/docs/references/ui/view/GanttConfig.mdx b/content/docs/references/ui/view/GanttConfig.mdx index 363692d57..dc7b82e28 100644 --- a/content/docs/references/ui/view/GanttConfig.mdx +++ b/content/docs/references/ui/view/GanttConfig.mdx @@ -1,8 +1,18 @@ --- title: GanttConfig description: GanttConfig Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,21 @@ description: GanttConfig Schema Reference | **titleField** | `string` | ✅ | | | **progressField** | `string` | optional | | | **dependenciesField** | `string` | optional | | + +## TypeScript Usage + +```typescript +import { GanttConfigSchema } from '@objectstack/spec/ui'; +import type { GanttConfig } from '@objectstack/spec/ui'; + +// Validate data +const result = GanttConfigSchema.parse(data); + +// Type-safe usage +const myGanttConfig: GanttConfig = { + startDateField: 'example', + endDateField: 'example', + titleField: 'example' +}; +``` + diff --git a/content/docs/references/ui/view/HttpMethod.mdx b/content/docs/references/ui/view/HttpMethod.mdx index 6373632f5..3cc6290cb 100644 --- a/content/docs/references/ui/view/HttpMethod.mdx +++ b/content/docs/references/ui/view/HttpMethod.mdx @@ -1,12 +1,32 @@ --- title: HttpMethod description: HttpMethod Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Allowed Values * `GET` * `POST` * `PUT` * `PATCH` -* `DELETE` \ No newline at end of file +* `DELETE` + +## TypeScript Usage + +```typescript +import { HttpMethod } from '@objectstack/spec/ui'; + +// Type-safe enum value +const value: HttpMethod = 'GET'; +``` + diff --git a/content/docs/references/ui/view/HttpRequest.mdx b/content/docs/references/ui/view/HttpRequest.mdx index 9e7e931dc..7e08a5d76 100644 --- a/content/docs/references/ui/view/HttpRequest.mdx +++ b/content/docs/references/ui/view/HttpRequest.mdx @@ -1,8 +1,18 @@ --- title: HttpRequest description: HttpRequest Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -12,3 +22,19 @@ description: HttpRequest Schema Reference | **headers** | `Record` | optional | Custom HTTP headers | | **params** | `Record` | optional | Query parameters | | **body** | `any` | optional | Request body for POST/PUT/PATCH | + +## TypeScript Usage + +```typescript +import { HttpRequestSchema } from '@objectstack/spec/ui'; +import type { HttpRequest } from '@objectstack/spec/ui'; + +// Validate data +const result = HttpRequestSchema.parse(data); + +// Type-safe usage +const myHttpRequest: HttpRequest = { + url: 'https://example.com' +}; +``` + diff --git a/content/docs/references/ui/view/KanbanConfig.mdx b/content/docs/references/ui/view/KanbanConfig.mdx index b1c12639b..00ad6ea24 100644 --- a/content/docs/references/ui/view/KanbanConfig.mdx +++ b/content/docs/references/ui/view/KanbanConfig.mdx @@ -1,8 +1,18 @@ --- title: KanbanConfig description: KanbanConfig Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -10,3 +20,20 @@ description: KanbanConfig Schema Reference | **groupByField** | `string` | ✅ | Field to group columns by (usually status/select) | | **summarizeField** | `string` | optional | Field to sum at top of column (e.g. amount) | | **columns** | `string[]` | ✅ | Fields to show on cards | + +## TypeScript Usage + +```typescript +import { KanbanConfigSchema } from '@objectstack/spec/ui'; +import type { KanbanConfig } from '@objectstack/spec/ui'; + +// Validate data +const result = KanbanConfigSchema.parse(data); + +// Type-safe usage +const myKanbanConfig: KanbanConfig = { + groupByField: 'example', + columns: [] +}; +``` + diff --git a/content/docs/references/ui/view/ListColumn.mdx b/content/docs/references/ui/view/ListColumn.mdx index a9578a61b..6ec1c6db1 100644 --- a/content/docs/references/ui/view/ListColumn.mdx +++ b/content/docs/references/ui/view/ListColumn.mdx @@ -1,8 +1,18 @@ --- title: ListColumn description: ListColumn Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -16,3 +26,19 @@ description: ListColumn Schema Reference | **resizable** | `boolean` | optional | Allow resizing this column | | **wrap** | `boolean` | optional | Allow text wrapping | | **type** | `string` | optional | Renderer type override (e.g., "currency", "date") | + +## TypeScript Usage + +```typescript +import { ListColumnSchema } from '@objectstack/spec/ui'; +import type { ListColumn } from '@objectstack/spec/ui'; + +// Validate data +const result = ListColumnSchema.parse(data); + +// Type-safe usage +const myListColumn: ListColumn = { + field: 'example' +}; +``` + diff --git a/content/docs/references/ui/view/ListView.mdx b/content/docs/references/ui/view/ListView.mdx index fd910c175..dd1904cb0 100644 --- a/content/docs/references/ui/view/ListView.mdx +++ b/content/docs/references/ui/view/ListView.mdx @@ -1,8 +1,18 @@ --- title: ListView description: ListView Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -23,3 +33,19 @@ description: ListView Schema Reference | **kanban** | `object` | optional | | | **calendar** | `object` | optional | | | **gantt** | `object` | optional | | + +## TypeScript Usage + +```typescript +import { ListViewSchema } from '@objectstack/spec/ui'; +import type { ListView } from '@objectstack/spec/ui'; + +// Validate data +const result = ListViewSchema.parse(data); + +// Type-safe usage +const myListView: ListView = { + columns: null +}; +``` + diff --git a/content/docs/references/ui/view/PaginationConfig.mdx b/content/docs/references/ui/view/PaginationConfig.mdx index 887a7f44b..72f5e7893 100644 --- a/content/docs/references/ui/view/PaginationConfig.mdx +++ b/content/docs/references/ui/view/PaginationConfig.mdx @@ -1,11 +1,36 @@ --- title: PaginationConfig description: PaginationConfig Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **pageSize** | `integer` | optional | Number of records per page | | **pageSizeOptions** | `integer[]` | optional | Available page size options | + +## TypeScript Usage + +```typescript +import { PaginationConfigSchema } from '@objectstack/spec/ui'; +import type { PaginationConfig } from '@objectstack/spec/ui'; + +// Validate data +const result = PaginationConfigSchema.parse(data); + +// Type-safe usage +const myPaginationConfig: PaginationConfig = { +}; +``` + diff --git a/content/docs/references/ui/view/SelectionConfig.mdx b/content/docs/references/ui/view/SelectionConfig.mdx index cd7aa6348..35750fcab 100644 --- a/content/docs/references/ui/view/SelectionConfig.mdx +++ b/content/docs/references/ui/view/SelectionConfig.mdx @@ -1,10 +1,35 @@ --- title: SelectionConfig description: SelectionConfig Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | | **type** | `Enum<'none' \| 'single' \| 'multiple'>` | optional | Selection mode | + +## TypeScript Usage + +```typescript +import { SelectionConfigSchema } from '@objectstack/spec/ui'; +import type { SelectionConfig } from '@objectstack/spec/ui'; + +// Validate data +const result = SelectionConfigSchema.parse(data); + +// Type-safe usage +const mySelectionConfig: SelectionConfig = { +}; +``` + diff --git a/content/docs/references/ui/view/View.mdx b/content/docs/references/ui/view/View.mdx index 61dd3b7ad..fc82e3864 100644 --- a/content/docs/references/ui/view/View.mdx +++ b/content/docs/references/ui/view/View.mdx @@ -1,8 +1,18 @@ --- title: View description: View Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -11,3 +21,18 @@ description: View Schema Reference | **form** | `object` | optional | | | **listViews** | `Record` | optional | Additional named list views | | **formViews** | `Record` | optional | Additional named form views | + +## TypeScript Usage + +```typescript +import { ViewSchema } from '@objectstack/spec/ui'; +import type { View } from '@objectstack/spec/ui'; + +// Validate data +const result = ViewSchema.parse(data); + +// Type-safe usage +const myView: View = { +}; +``` + diff --git a/content/docs/references/ui/view/ViewData.mdx b/content/docs/references/ui/view/ViewData.mdx index 297acad9a..1a7969634 100644 --- a/content/docs/references/ui/view/ViewData.mdx +++ b/content/docs/references/ui/view/ViewData.mdx @@ -1,5 +1,15 @@ --- title: ViewData description: ViewData Schema Reference +category: ui +zodFile: view --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + diff --git a/content/docs/references/ui/widget/FieldWidgetProps.mdx b/content/docs/references/ui/widget/FieldWidgetProps.mdx index 3ff8a96d6..59d0bf2b3 100644 --- a/content/docs/references/ui/widget/FieldWidgetProps.mdx +++ b/content/docs/references/ui/widget/FieldWidgetProps.mdx @@ -1,8 +1,18 @@ --- title: FieldWidgetProps description: FieldWidgetProps Schema Reference +category: ui +zodFile: widget --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/widget.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,19 @@ description: FieldWidgetProps Schema Reference | **field** | `object` | ✅ | Field schema definition | | **record** | `Record` | optional | Complete record data | | **options** | `Record` | optional | Custom widget options | + +## TypeScript Usage + +```typescript +import { FieldWidgetPropsSchema } from '@objectstack/spec/ui'; +import type { FieldWidgetProps } from '@objectstack/spec/ui'; + +// Validate data +const result = FieldWidgetPropsSchema.parse(data); + +// Type-safe usage +const myFieldWidgetProps: FieldWidgetProps = { + field: {} +}; +``` + diff --git a/content/docs/references/ui/widget/WidgetEvent.mdx b/content/docs/references/ui/widget/WidgetEvent.mdx index 223aee6ba..3fc9ad832 100644 --- a/content/docs/references/ui/widget/WidgetEvent.mdx +++ b/content/docs/references/ui/widget/WidgetEvent.mdx @@ -1,8 +1,18 @@ --- title: WidgetEvent description: WidgetEvent Schema Reference +category: ui +zodFile: widget --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/widget.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -13,3 +23,19 @@ description: WidgetEvent Schema Reference | **bubbles** | `boolean` | optional | Whether event bubbles | | **cancelable** | `boolean` | optional | Whether event is cancelable | | **payload** | `Record` | optional | Event payload schema | + +## TypeScript Usage + +```typescript +import { WidgetEventSchema } from '@objectstack/spec/ui'; +import type { WidgetEvent } from '@objectstack/spec/ui'; + +// Validate data +const result = WidgetEventSchema.parse(data); + +// Type-safe usage +const myWidgetEvent: WidgetEvent = { + name: 'name' +}; +``` + diff --git a/content/docs/references/ui/widget/WidgetLifecycle.mdx b/content/docs/references/ui/widget/WidgetLifecycle.mdx index f403efa40..c12578423 100644 --- a/content/docs/references/ui/widget/WidgetLifecycle.mdx +++ b/content/docs/references/ui/widget/WidgetLifecycle.mdx @@ -1,8 +1,18 @@ --- title: WidgetLifecycle description: WidgetLifecycle Schema Reference +category: ui +zodFile: widget --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/widget.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -14,3 +24,18 @@ description: WidgetLifecycle Schema Reference | **onFocus** | `string` | optional | Code to run on focus | | **onBlur** | `string` | optional | Code to run on blur | | **onError** | `string` | optional | Error handling code | + +## TypeScript Usage + +```typescript +import { WidgetLifecycleSchema } from '@objectstack/spec/ui'; +import type { WidgetLifecycle } from '@objectstack/spec/ui'; + +// Validate data +const result = WidgetLifecycleSchema.parse(data); + +// Type-safe usage +const myWidgetLifecycle: WidgetLifecycle = { +}; +``` + diff --git a/content/docs/references/ui/widget/WidgetManifest.mdx b/content/docs/references/ui/widget/WidgetManifest.mdx index 3adbf5a67..baff40cec 100644 --- a/content/docs/references/ui/widget/WidgetManifest.mdx +++ b/content/docs/references/ui/widget/WidgetManifest.mdx @@ -1,8 +1,18 @@ --- title: WidgetManifest description: WidgetManifest Schema Reference +category: ui +zodFile: widget --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/widget.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -24,3 +34,20 @@ description: WidgetManifest Schema Reference | **documentation** | `string` | optional | Documentation URL | | **license** | `string` | optional | License (SPDX identifier) | | **tags** | `string[]` | optional | Tags for categorization | + +## TypeScript Usage + +```typescript +import { WidgetManifestSchema } from '@objectstack/spec/ui'; +import type { WidgetManifest } from '@objectstack/spec/ui'; + +// Validate data +const result = WidgetManifestSchema.parse(data); + +// Type-safe usage +const myWidgetManifest: WidgetManifest = { + name: 'name', + label: 'example' +}; +``` + diff --git a/content/docs/references/ui/widget/WidgetProperty.mdx b/content/docs/references/ui/widget/WidgetProperty.mdx index 5491179ba..9675890c5 100644 --- a/content/docs/references/ui/widget/WidgetProperty.mdx +++ b/content/docs/references/ui/widget/WidgetProperty.mdx @@ -1,8 +1,18 @@ --- title: WidgetProperty description: WidgetProperty Schema Reference +category: ui +zodFile: widget --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + + +**Source:** `packages/spec/src/ui/widget.zod.ts` + + ## Properties | Property | Type | Required | Description | @@ -15,3 +25,20 @@ description: WidgetProperty Schema Reference | **description** | `string` | optional | Property description | | **validation** | `Record` | optional | Validation rules | | **category** | `string` | optional | Property category | + +## TypeScript Usage + +```typescript +import { WidgetPropertySchema } from '@objectstack/spec/ui'; +import type { WidgetProperty } from '@objectstack/spec/ui'; + +// Validate data +const result = WidgetPropertySchema.parse(data); + +// Type-safe usage +const myWidgetProperty: WidgetProperty = { + name: 'name', + type: 'string' +}; +``` + diff --git a/packages/spec/scripts/build-docs.ts b/packages/spec/scripts/build-docs.ts index 68f31ea19..d425cf0f8 100644 --- a/packages/spec/scripts/build-docs.ts +++ b/packages/spec/scripts/build-docs.ts @@ -90,17 +90,33 @@ function formatType(prop: any): string { return prop.type || 'any'; } -function generateMarkdown(schemaName: string, schema: any) { +function generateMarkdown(schemaName: string, schema: any, category: string, zodFile: string) { const defs = schema.definitions || {}; const mainDef = defs[schemaName] || Object.values(defs)[0]; if (!mainDef) return ''; - let md = `---\ntitle: ${schemaName}\ndescription: ${mainDef.description || schemaName + ' Schema Reference'}\n---\n\n`; + // Enhanced frontmatter with more metadata + let md = `---\ntitle: ${schemaName}\ndescription: ${mainDef.description || schemaName + ' Schema Reference'}\n`; + md += `category: ${category}\n`; + md += `zodFile: ${zodFile}\n`; + md += `---\n\n`; + // Add breadcrumb navigation + const categoryTitle = getCategoryTitle(category); + md += `import { Card, Cards } from 'fumadocs-ui/components/card';\n`; + md += `import { Tab, Tabs } from 'fumadocs-ui/components/tabs';\n`; + md += `import { Callout } from 'fumadocs-ui/components/callout';\n\n`; + + // Add description with better formatting if (mainDef.description) { md += `${mainDef.description}\n\n`; } + + // Add source code reference + md += `\n`; + md += `**Source:** \`packages/spec/src/${category}/${zodFile}.zod.ts\`\n`; + md += `\n\n`; if (mainDef.type === 'object' && mainDef.properties) { md += `## Properties\n\n`; @@ -118,14 +134,96 @@ function generateMarkdown(schemaName: string, schema: any) { md += `| **${key}** | \`${typeStr}\` | ${isReq} | ${desc} |\n`; } + + // Add TypeScript usage example + md += `\n## TypeScript Usage\n\n`; + md += `\`\`\`typescript\n`; + md += `import { ${schemaName}Schema } from '@objectstack/spec/${category}';\n`; + md += `import type { ${schemaName} } from '@objectstack/spec/${category}';\n\n`; + md += `// Validate data\n`; + md += `const result = ${schemaName}Schema.parse(data);\n\n`; + md += `// Type-safe usage\n`; + md += `const my${schemaName}: ${schemaName} = {\n`; + + // Generate example based on required fields + const requiredProps = Array.from(required).slice(0, 3); // Show first 3 required fields + requiredProps.forEach((propName, idx) => { + const prop = (mainDef.properties as any)[propName]; + const exampleValue = getExampleValue(prop, propName as string); + md += ` ${propName}: ${exampleValue}${idx < requiredProps.length - 1 || mainDef.required?.length > 3 ? ',' : ''}\n`; + }); + + if (mainDef.required?.length > 3) { + md += ` // ... other fields\n`; + } + + md += `};\n`; + md += `\`\`\`\n\n`; + } else if (mainDef.type === 'string' && mainDef.enum) { md += `## Allowed Values\n\n`; md += mainDef.enum.map((e: string) => `* \`${e}\``).join('\n'); + md += `\n\n## TypeScript Usage\n\n`; + md += `\`\`\`typescript\n`; + md += `import { ${schemaName} } from '@objectstack/spec/${category}';\n\n`; + md += `// Type-safe enum value\n`; + md += `const value: ${schemaName} = '${mainDef.enum[0]}';\n`; + md += `\`\`\`\n\n`; + } + + // Add "See Also" section with related schemas + const relatedSchemas = findRelatedSchemas(schemaName, mainDef, category); + if (relatedSchemas.length > 0) { + md += `## Related\n\n`; + md += `\n`; + relatedSchemas.forEach(related => { + md += ` \n`; + }); + md += `\n\n`; } return md; } +// Helper to generate example values for fields +function getExampleValue(prop: any, fieldName: string): string { + if (prop.type === 'string') { + if (prop.enum) return `'${prop.enum[0]}'`; + if (fieldName.includes('name')) return `'${fieldName.replace(/_/g, ' ')}'`; + if (fieldName.includes('email')) return `'user@example.com'`; + if (fieldName.includes('url')) return `'https://example.com'`; + return `'example'`; + } + if (prop.type === 'number') return prop.default !== undefined ? prop.default : '0'; + if (prop.type === 'boolean') return prop.default !== undefined ? String(prop.default) : 'false'; + if (prop.type === 'array') return '[]'; + if (prop.type === 'object') return '{}'; + return 'null'; +} + +// Helper to find related schemas (referenced in properties) +function findRelatedSchemas(schemaName: string, mainDef: any, category: string): Array<{name: string, zodFile: string}> { + const related: Array<{name: string, zodFile: string}> = []; + const seen = new Set(); + + if (mainDef.properties) { + for (const prop of Object.values(mainDef.properties) as any[]) { + if (prop.$ref) { + const refName = prop.$ref.split('/').pop(); + if (refName && refName !== schemaName && !seen.has(refName)) { + const zodFile = schemaZodFileMap.get(refName); + if (zodFile && schemaCategoryMap.get(refName) === category) { + related.push({ name: refName, zodFile }); + seen.add(refName); + } + } + } + } + } + + return related.slice(0, 6); // Limit to 6 related items +} + // 2. Clean up old documentation structure // IMPORTANT: This removes old .mdx files and subdirectories to ensure a clean state. // Only category roots are cleaned (data/, ui/, system/, ai/, api/). The root meta.json is preserved. @@ -206,11 +304,10 @@ Object.keys(CATEGORIES).forEach(category => { const schemaName = file.replace('.json', ''); const schemaPath = path.join(categorySchemaDir, file); const content = JSON.parse(fs.readFileSync(schemaPath, 'utf-8')); - const mdx = generateMarkdown(schemaName, content); + const zodFile = schemaZodFileMap.get(schemaName) || 'misc'; + const mdx = generateMarkdown(schemaName, content, category, zodFile); if (mdx) { - const zodFile = schemaZodFileMap.get(schemaName); - // Determine output directory let outDir = path.join(DOCS_ROOT, category); if (zodFile) { @@ -227,6 +324,71 @@ Object.keys(CATEGORIES).forEach(category => { }); }); +// 4.5. Generate Protocol Overview Pages +// Create index.mdx for each category with overview of all schemas +Object.entries(CATEGORIES).forEach(([category, title]) => { + const categoryDir = path.join(DOCS_ROOT, category); + const zodFiles = categoryZodFiles.get(category) || new Set(); + + if (zodFiles.size === 0) return; + + let overviewMd = `---\ntitle: ${title} Overview\ndescription: Complete reference for all ${title.toLowerCase()} schemas\n---\n\n`; + overviewMd += `import { Card, Cards } from 'fumadocs-ui/components/card';\n`; + overviewMd += `import { Database, Cpu, Zap } from 'lucide-react';\n\n`; + + overviewMd += `# ${title}\n\n`; + overviewMd += `This section contains all protocol schemas for the ${category} layer of ObjectStack.\n\n`; + + // Group schemas by zod file + const zodFileGroups = new Map(); + + // Read category schema directory to get all schemas + const categorySchemaDir = path.join(SCHEMA_DIR, category); + if (fs.existsSync(categorySchemaDir)) { + const schemaFiles = fs.readdirSync(categorySchemaDir).filter(f => f.endsWith('.json')); + schemaFiles.forEach(file => { + const schemaName = file.replace('.json', ''); + const zodFile = schemaZodFileMap.get(schemaName) || 'misc'; + + if (!zodFileGroups.has(zodFile)) { + zodFileGroups.set(zodFile, []); + } + zodFileGroups.get(zodFile)!.push(schemaName); + }); + } + + // Generate overview sections + const sortedZodFiles = Array.from(zodFiles).sort(); + sortedZodFiles.forEach(zodFile => { + const schemas = zodFileGroups.get(zodFile) || []; + if (schemas.length === 0) return; + + const zodTitle = zodFile.split('-').map(w => w.charAt(0).toUpperCase() + w.slice(1)).join(' '); + overviewMd += `## ${zodTitle}\n\n`; + overviewMd += `Source: \`packages/spec/src/${category}/${zodFile}.zod.ts\`\n\n`; + overviewMd += `\n`; + + schemas.sort().forEach(schemaName => { + // Read schema to get description + const schemaPath = path.join(categorySchemaDir, `${schemaName}.json`); + if (fs.existsSync(schemaPath)) { + const schema = JSON.parse(fs.readFileSync(schemaPath, 'utf-8')); + const defs = schema.definitions || {}; + const mainDef = defs[schemaName] || Object.values(defs)[0]; + const description = mainDef?.description || `${schemaName} schema reference`; + + overviewMd += ` \n`; + } + }); + + overviewMd += `\n\n`; + }); + + // Write overview page + fs.writeFileSync(path.join(categoryDir, 'index.mdx'), overviewMd); + console.log(`✓ Generated overview page for ${category}`); +}); + // 5. Update Root meta.json // We want references to list categories in specific order const rootMetaProps = { From 1143194e8ef3d541cf1cf936829ba3de6b6e35c7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 14:33:18 +0000 Subject: [PATCH 03/10] Add protocol reference overview, quick reference guide, and architecture map Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- content/docs/references/index.mdx | 218 ++++++++++++ content/docs/references/meta.cn.json | 19 + content/docs/references/meta.json | 8 +- content/docs/references/protocol-map.mdx | 366 ++++++++++++++++++++ content/docs/references/quick-reference.mdx | 216 ++++++++++++ 5 files changed, 826 insertions(+), 1 deletion(-) create mode 100644 content/docs/references/index.mdx create mode 100644 content/docs/references/meta.cn.json create mode 100644 content/docs/references/protocol-map.mdx create mode 100644 content/docs/references/quick-reference.mdx diff --git a/content/docs/references/index.mdx b/content/docs/references/index.mdx new file mode 100644 index 000000000..8d96af75b --- /dev/null +++ b/content/docs/references/index.mdx @@ -0,0 +1,218 @@ +--- +title: Protocol Reference +description: Complete API reference for all ObjectStack protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Database, Layout, Settings, Brain, Zap, Shield, Package, Globe } from 'lucide-react'; + +# Protocol Reference + +ObjectStack is defined by **70+ protocol schemas** that standardize how business applications are built. Each protocol is implemented as a **Zod schema** with TypeScript types and JSON Schema generation. + +## Quick Navigation + + + } + /> + } + /> + } + /> + } + /> + } + /> + } + /> + } + /> + } + /> + + +## Protocol Architecture + +ObjectStack protocols are organized into three core layers: + +### 1. ObjectQL (Data Layer) +The foundation - defines how business data is modeled, validated, and queried. + +- **[Data Protocol](./data)** - Core business logic and data modeling +- **[Permission Protocol](./permission)** - Access control and security + +### 2. ObjectUI (Presentation Layer) +How data is presented and interacted with by end users. + +- **[UI Protocol](./ui)** - Views, forms, dashboards, and themes +- **[API Protocol](./api)** - REST/GraphQL endpoints and real-time + +### 3. ObjectOS (System Layer) +The runtime infrastructure that powers the platform. + +- **[System Protocol](./system)** - Core system configuration +- **[Auth Protocol](./auth)** - Authentication and authorization +- **[Automation Protocol](./automation)** - Workflows and integrations +- **[AI Protocol](./ai)** - AI/ML capabilities + +## Understanding Protocol Schemas + +Every protocol follows the same structure: + +### Zod Schema (Runtime Validation) +```typescript +// packages/spec/src/data/field.zod.ts +export const FieldSchema = z.object({ + name: z.string().regex(/^[a-z_][a-z0-9_]*$/), + label: z.string(), + type: FieldType, + required: z.boolean().optional(), + // ... more properties +}); +``` + +### TypeScript Types (Type Safety) +```typescript +// Auto-generated from Zod +export type Field = z.infer; +``` + +### JSON Schema (Tooling & IDE Support) +```bash +# Build generates JSON schemas +pnpm --filter @objectstack/spec build + +# Output: packages/spec/json-schema/data/Field.json +``` + +### Documentation (This Site) +Each schema has auto-generated documentation with: +- Property tables with types and descriptions +- TypeScript usage examples +- Related schema references +- Source code links + +## How to Use + +### 1. Import in TypeScript +```typescript +import { FieldSchema, ObjectSchema } from '@objectstack/spec/data'; +import { ViewSchema, AppSchema } from '@objectstack/spec/ui'; +import { ManifestSchema } from '@objectstack/spec/system'; +``` + +### 2. Runtime Validation +```typescript +import { FieldSchema } from '@objectstack/spec/data'; + +// Validate data at runtime +const field = FieldSchema.parse({ + name: 'email', + type: 'email', + label: 'Email Address', + required: true +}); +``` + +### 3. Type-Safe Development +```typescript +import type { Field } from '@objectstack/spec/data'; + +// Type-safe function parameters +function createField(config: Field) { + // TypeScript knows all valid properties +} +``` + +### 4. Define Business Objects +```yaml +# customer.object.yml +name: customer +label: Customer +fields: + email: + type: email + label: Email + required: true + company_name: + type: text + label: Company Name +``` + +## Version Information + +- **Protocol Version:** 0.4.1 +- **Total Protocols:** 70 +- **Zod Schemas:** 70 +- **TypeScript Types:** 70 +- **JSON Schemas:** 70 +- **Generated Docs:** 473 pages + +## Contributing + +Protocol schemas are the "DNA" of ObjectStack. Changes follow strict guidelines: + +1. **Zod First** - All definitions start with Zod schemas +2. **Type Derivation** - TypeScript types are inferred from Zod +3. **No Business Logic** - Schemas contain only definitions +4. **Naming Convention** - `camelCase` for properties, `snake_case` for data values +5. **Documentation** - Auto-generated from Zod schemas + +See [CONTRIBUTING.md](https://github.com/objectstack-ai/spec/blob/main/CONTRIBUTING.md) for details. + +## Learn More + + + + + + + diff --git a/content/docs/references/meta.cn.json b/content/docs/references/meta.cn.json new file mode 100644 index 000000000..04e340bd9 --- /dev/null +++ b/content/docs/references/meta.cn.json @@ -0,0 +1,19 @@ +{ + "title": "协议参考", + "pages": [ + "quick-reference", + "protocol-map", + "---", + "data", + "ui", + "automation", + "system", + "permission", + "ai", + "api", + "driver", + "auth", + "hub", + "shared" + ] +} diff --git a/content/docs/references/meta.json b/content/docs/references/meta.json index 577f212af..b2edec615 100644 --- a/content/docs/references/meta.json +++ b/content/docs/references/meta.json @@ -1,6 +1,9 @@ { "title": "Protocol Reference", "pages": [ + "quick-reference", + "protocol-map", + "---", "data", "ui", "automation", @@ -8,6 +11,9 @@ "permission", "ai", "api", - "driver" + "driver", + "auth", + "hub", + "shared" ] } \ No newline at end of file diff --git a/content/docs/references/protocol-map.mdx b/content/docs/references/protocol-map.mdx new file mode 100644 index 000000000..d1233961f --- /dev/null +++ b/content/docs/references/protocol-map.mdx @@ -0,0 +1,366 @@ +--- +title: Protocol Architecture Map +description: Visual guide to ObjectStack protocol relationships and dependencies +--- + +import { Callout } from 'fumadocs-ui/components/callout'; +import { Card, Cards } from 'fumadocs-ui/components/card'; + +# Protocol Architecture Map + +Understand how the 70 ObjectStack protocols fit together to form a complete business platform. + +## The Three-Layer Architecture + +``` +┌─────────────────────────────────────────────────────────────────┐ +│ APPLICATION LAYER (User-Facing) │ +│ ┌──────────┐ ┌──────────┐ ┌───────────┐ ┌──────────┐ │ +│ │ Apps │ │ Pages │ │Dashboards │ │ Reports │ │ +│ └────┬─────┘ └────┬─────┘ └─────┬─────┘ └────┬─────┘ │ +│ └─────────────┴──────────────┴─────────────┘ │ +└────────────────────────────┬─────────────────────────────────────┘ + │ + ┌────────▼────────┐ + │ ObjectUI (UI) │ + │ 10 Protocols │ + └────────┬────────┘ + │ +┌────────────────────────────┴─────────────────────────────────────┐ +│ BUSINESS LOGIC LAYER │ +│ ┌──────────┐ ┌──────────┐ ┌───────────┐ ┌──────────┐ │ +│ │ Objects │ │ Fields │ │ Queries │ │ Rules │ │ +│ └────┬─────┘ └────┬─────┘ └─────┬─────┘ └────┬─────┘ │ +│ └─────────────┴──────────────┴─────────────┘ │ +└────────────────────────────┬─────────────────────────────────────┘ + │ + ┌────────▼────────┐ + │ ObjectQL (Data) │ + │ 8 Protocols │ + └────────┬────────┘ + │ +┌────────────────────────────┴─────────────────────────────────────┐ +│ RUNTIME INFRASTRUCTURE LAYER │ +│ ┌──────────┐ ┌──────────┐ ┌───────────┐ ┌──────────┐ │ +│ │ Drivers │ │ Events │ │ Auth │ │ APIs │ │ +│ └────┬─────┘ └────┬─────┘ └─────┬─────┘ └────┬─────┘ │ +│ └─────────────┴──────────────┴─────────────┘ │ +└────────────────────────────┬─────────────────────────────────────┘ + │ + ┌────────▼────────┐ + │ ObjectOS (Sys) │ + │ 40+ Protocols │ + └─────────────────┘ +``` + +## Protocol Dependencies + +### Core Foundation + +The foundation protocols that everything else builds upon: + + + + + + +### Layer 1: Data (ObjectQL) + +Data layer protocols define business logic and data structure. + +``` +Field Protocol (Core) + ↓ + ├→ Object Protocol (uses Fields) + ├→ Query Protocol (references Fields) + ├→ Filter Protocol (filters on Fields) + └→ Validation Protocol (validates Fields) + ↓ + └→ Hook Protocol (extends validation with code) +``` + +**Dependencies:** +- `Field` → No dependencies (foundational) +- `Object` → Depends on `Field`, `Validation` +- `Query` → Depends on `Filter`, `Object` +- `Validation` → Depends on `Field` + +### Layer 2: UI (ObjectUI) + +UI protocols build on top of data protocols. + +``` +Theme Protocol (Foundation) + ↓ +View Protocol (uses Object, Query) + ├→ ListView (uses Query, Filter) + ├→ FormView (uses Object, Field) + └→ Dashboard (uses View, Widget) + ↓ + ├→ Page Protocol (composes Views) + └→ App Protocol (organizes Pages) + ↓ + └→ Action Protocol (UI interactions) +``` + +**Dependencies:** +- `Theme` → No data dependencies +- `View` → Depends on `Object`, `Query`, `Filter` +- `Page` → Depends on `View`, `Component` +- `App` → Depends on `Page`, `Dashboard` +- `Action` → Depends on `Flow`, `Workflow` + +### Layer 3: System (ObjectOS) + +System protocols provide runtime infrastructure. + +``` +Driver Protocol (Database Abstraction) + ↓ +Datasource Protocol (Connection Config) + ↓ + ├→ Context Protocol (Runtime State) + ├→ Events Protocol (Event Bus) + └→ Plugin Protocol (Extensibility) + ↓ + ├→ Auth Protocol (Identity) + ├→ Permission Protocol (Access Control) + ├→ API Protocol (External Access) + └→ Automation Protocol (Workflows) + ↓ + └→ AI Protocol (Intelligence) +``` + +**Key Dependencies:** +- `Driver` → Foundation for all data access +- `Datasource` → Depends on `Driver` +- `Context` → Provides runtime state to all protocols +- `Auth` → Used by `Permission`, `API`, `Automation` +- `Permission` → Depends on `Auth`, `Object` + +## Cross-Protocol Relationships + +### Example: Building a CRM Contact Form + +Here's how multiple protocols work together: + +```typescript +// 1. DEFINE DATA (ObjectQL) +// File: objects/contact.object.yml +const contactObject = { + name: 'contact', // Object Protocol + fields: { // Field Protocol + email: { + type: 'email', + required: true, + validation: [ // Validation Protocol + { rule: 'email_format' } + ] + } + } +}; + +// 2. CREATE UI (ObjectUI) +// File: views/contact_form.view.yml +const contactForm = { + type: 'form', // View Protocol + object: 'contact', // References Object Protocol + layout: { // Page Protocol + sections: [ + { fields: ['email', 'phone'] } + ] + }, + theme: 'default' // Theme Protocol +}; + +// 3. ADD TO APP (ObjectUI) +// File: apps/crm.app.yml +const crmApp = { + name: 'crm', // App Protocol + navigation: [ // Navigation Items + { + type: 'object', + object: 'contact', + defaultView: 'contact_form' + } + ] +}; + +// 4. CONFIGURE ACCESS (Permission) +// File: permissions/contact.permission.yml +const contactPermission = { + object: 'contact', // Permission Protocol + roles: ['sales_rep'], // Auth Protocol + access: { + read: true, + create: true, + edit: true + } +}; + +// 5. ADD AUTOMATION (Automation) +// File: flows/welcome_email.flow.yml +const welcomeFlow = { + trigger: { // Flow Protocol + object: 'contact', + event: 'after_insert' + }, + actions: [ + { + type: 'email', // Action Protocol + template: 'welcome' + } + ] +}; +``` + +## Protocol Usage Patterns + +### Pattern 1: Data-Driven UI + +When UI is automatically generated from data definitions: + +``` +Object → Field → View → Page → App +``` + +**Example:** Auto-generated CRUD interfaces + +### Pattern 2: Custom UI with Data Binding + +When you build custom UI that connects to data: + +``` +Page → Component → View (Custom) → Query → Object +``` + +**Example:** Custom dashboard with data visualizations + +### Pattern 3: Automation & Integration + +When adding business logic automation: + +``` +Object → Hook → Flow → Automation → API/Webhook +``` + +**Example:** Lead assignment workflow with Slack notifications + +### Pattern 4: AI-Enhanced Applications + +When adding AI capabilities: + +``` +Object → RAG Pipeline → Agent → Conversation → UI +``` + +**Example:** AI-powered customer support chatbot + +## Protocol Categories by Responsibility + +### 🗄️ Data Definition +- **Primary:** Field, Object, Validation +- **Secondary:** Dataset, Mapping, Hook + +### 🔍 Data Access +- **Primary:** Query, Filter +- **Secondary:** Driver, Datasource + +### 🎨 Presentation +- **Primary:** View, Page, Theme +- **Secondary:** Component, Widget, Block + +### 🏗️ Application Structure +- **Primary:** App, Manifest +- **Secondary:** Plugin, Feature + +### 📊 Analytics & Reporting +- **Primary:** Report, Dashboard +- **Secondary:** Query (aggregations) + +### ⚙️ Automation +- **Primary:** Flow, Workflow +- **Secondary:** Approval, Webhook, ETL + +### 🔐 Security +- **Primary:** Auth, Permission +- **Secondary:** RLS, Sharing, Policy + +### 🌐 External Integration +- **Primary:** API, Connector +- **Secondary:** OData, Realtime, Webhook + +### 🤖 AI/ML +- **Primary:** Agent, RAG Pipeline +- **Secondary:** NLQ, Conversation, Model Registry + +## Common Integration Points + +### ObjectQL ↔ ObjectUI +```typescript +// UI consumes data definitions +const view: View = { + object: 'customer', // Reference to Object Protocol + fields: ['name', 'email'], // Reference to Field Protocol + filters: [...] // Reference to Filter Protocol +}; +``` + +### ObjectQL ↔ ObjectOS +```typescript +// Data is stored via system drivers +const datasource: Datasource = { + driver: 'postgres', // Reference to Driver Protocol + connection: {...} +}; + +const object: Object = { + name: 'customer', + datasource: 'primary' // Uses system datasource +}; +``` + +### ObjectUI ↔ ObjectOS +```typescript +// UI is secured via permission system +const app: App = { + navigation: [ + { + object: 'customer', + visible: 'hasPermission("customer", "read")' // References Permission + } + ] +}; +``` + +## Next Steps + + +Use this map as a reference when designing your application architecture. + + + + + + + diff --git a/content/docs/references/quick-reference.mdx b/content/docs/references/quick-reference.mdx new file mode 100644 index 000000000..2da9b1bc8 --- /dev/null +++ b/content/docs/references/quick-reference.mdx @@ -0,0 +1,216 @@ +--- +title: Quick Reference Guide +description: Fast lookup table for all ObjectStack protocols +--- + +import { Tabs, Tab } from 'fumadocs-ui/components/tabs'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Quick Reference Guide + +Fast lookup for all 70 ObjectStack protocols organized by category. + + +Click on any protocol name to view its complete API reference. + + +## Data Protocol (8 protocols) + +Core business logic and data modeling schemas. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Field](./data/field)** | `field.zod.ts` | Field, FieldType, SelectOption | 44 field types for data modeling | +| **[Object](./data/object)** | `object.zod.ts` | Object, ObjectCapabilities | Object/table definitions | +| **[Query](./data/query)** | `query.zod.ts` | Query, QueryOptions | Query AST with joins, aggregations | +| **[Filter](./data/filter)** | `filter.zod.ts` | QueryFilter, FilterCondition | Advanced filtering operators | +| **[Validation](./data/validation)** | `validation.zod.ts` | ValidationRule | Business validation rules | +| **[Dataset](./data/dataset)** | `dataset.zod.ts` | Dataset, DatasetMode | Reusable dataset definitions | +| **[Mapping](./data/mapping)** | `mapping.zod.ts` | FieldMapping | Field transformation mappings | +| **[Hook](./data/hook)** | `hook.zod.ts` | Hook, HookEvent | Lifecycle event hooks | + +## UI Protocol (10 protocols) + +Presentation layer - views, forms, dashboards, and themes. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[View](./ui/view)** | `view.zod.ts` | View, ListView, FormView | List and form view configurations | +| **[Page](./ui/page)** | `page.zod.ts` | Page, PageComponent | FlexiPage layouts | +| **[App](./ui/app)** | `app.zod.ts` | App, NavigationItem | Application navigation structure | +| **[Dashboard](./ui/dashboard)** | `dashboard.zod.ts` | Dashboard, DashboardWidget | Dashboard layouts and widgets | +| **[Report](./ui/report)** | `report.zod.ts` | Report, ReportType | Report definitions | +| **[Action](./ui/action)** | `action.zod.ts` | Action, ActionType | UI button actions | +| **[Component](./ui/component)** | `component.zod.ts` | PageComponent variants | Reusable UI components | +| **[Block](./ui/block)** | `block.zod.ts` | Block, BlockType | UI building blocks | +| **[Theme](./ui/theme)** | `theme.zod.ts` | Theme, ColorPalette | Theming and branding | +| **[Widget](./ui/widget)** | `widget.zod.ts` | WidgetManifest | Custom widget definitions | + +## Automation Protocol (7 protocols) + +Workflows, flows, and integrations. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Flow](./automation/flow)** | `flow.zod.ts` | Flow, FlowNode | Visual workflow builder | +| **[Workflow](./automation/workflow)** | `workflow.zod.ts` | WorkflowRule | Record-triggered automation | +| **[Approval](./automation/approval)** | `approval.zod.ts` | ApprovalProcess | Multi-step approval flows | +| **[Webhook](./automation/webhook)** | `webhook.zod.ts` | Webhook, WebhookEvent | Outbound webhooks | +| **[ETL](./automation/etl)** | `etl.zod.ts` | ETLPipeline | Data transformation pipelines | +| **[Sync](./automation/sync)** | `sync.zod.ts` | SyncConfig | Bi-directional data sync | +| **[Connector](./automation/connector)** | `connector.zod.ts` | Connector, ConnectorType | External system connectors | + +## System Protocol (14 protocols) + +Core system configuration and runtime infrastructure. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Manifest](./system/manifest)** | `manifest.zod.ts` | Manifest | Package manifest (objectstack.config.ts) | +| **[Datasource](./system/datasource)** | `datasource.zod.ts` | Datasource, DatasourceType | Database connection configs | +| **[Driver](./system/driver)** | `driver.zod.ts` | Driver, DriverCapabilities | Database driver interface | +| **[Plugin](./system/plugin)** | `plugin.zod.ts` | Plugin, PluginHook | Plugin system interface | +| **[Context](./system/context)** | `context.zod.ts` | KernelContext | Runtime execution context | +| **[Events](./system/events)** | `events.zod.ts` | Event, EventBus | System event bus | +| **[Job](./system/job)** | `job.zod.ts` | Job, JobSchedule | Background job queue | +| **[Audit](./system/audit)** | `audit.zod.ts` | AuditLog, AuditEvent | Audit trail logging | +| **[Logger](./system/logger)** | `logger.zod.ts` | LoggerConfig | Logging configuration | +| **[Translation](./system/translation)** | `translation.zod.ts` | Translation | i18n support | +| **[Feature](./system/feature)** | `feature.zod.ts` | FeatureFlag | Feature flags | +| **[Storage](./system/scoped-storage)** | `scoped-storage.zod.ts` | ScopedStorage | Key-value storage | +| **[Postgres Driver](./system/driver/postgres)** | `postgres.zod.ts` | PostgresConfig | PostgreSQL driver config | +| **[Mongo Driver](./system/driver/mongo)** | `mongo.zod.ts` | MongoConfig | MongoDB driver config | + +## AI Protocol (8 protocols) + +AI/ML capabilities - agents, models, RAG, and cost tracking. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Agent](./ai/agent)** | `agent.zod.ts` | Agent, AITool | AI agent definitions | +| **[Model Registry](./ai/model-registry)** | `model-registry.zod.ts` | ModelRegistry, ModelProvider | LLM model management | +| **[RAG Pipeline](./ai/rag-pipeline)** | `rag-pipeline.zod.ts` | RAGPipelineConfig | Retrieval augmented generation | +| **[NLQ](./ai/nlq)** | `nlq.zod.ts` | NLQRequest, NLQResponse | Natural language to query | +| **[Conversation](./ai/conversation)** | `conversation.zod.ts` | ConversationSession | Conversation management | +| **[Cost](./ai/cost)** | `cost.zod.ts` | CostEntry, BudgetLimit | AI cost tracking and budgets | +| **[Predictive](./ai/predictive)** | `predictive.zod.ts` | PredictiveModel | Predictive ML models | +| **[Orchestration](./ai/orchestration)** | `orchestration.zod.ts` | AIOrchestration | Multi-agent orchestration | + +## API Protocol (6 protocols) + +REST/GraphQL endpoints and real-time subscriptions. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Contract](./api/contract)** | `contract.zod.ts` | APIContract | API contract definitions | +| **[Endpoint](./api/endpoint)** | `endpoint.zod.ts` | Endpoint, EndpointMethod | REST endpoint configuration | +| **[Router](./api/router)** | `router.zod.ts` | Router, Route | API routing rules | +| **[OData](./api/odata)** | `odata.zod.ts` | ODataQuery | OData protocol support | +| **[Realtime](./api/realtime)** | `realtime.zod.ts` | Subscription, Channel | WebSocket subscriptions | +| **[Discovery](./api/discovery)** | `discovery.zod.ts` | ServiceDiscovery | API discovery and metadata | + +## Auth Protocol (6 protocols) + +Authentication, authorization, and identity management. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Identity](./auth/identity)** | `identity.zod.ts` | Identity, User | User identity management | +| **[Role](./auth/role)** | `role.zod.ts` | Role, Permission | Role-based access control | +| **[Organization](./auth/organization)** | `organization.zod.ts` | Organization | Multi-organization support | +| **[Policy](./auth/policy)** | `policy.zod.ts` | SecurityPolicy | Security policies | +| **[Config](./auth/config)** | `config.zod.ts` | AuthConfig | OAuth/SAML/SSO configuration | +| **[SCIM](./auth/scim)** | `scim.zod.ts` | SCIMUser, SCIMGroup | SCIM 2.0 provisioning | + +## Permission Protocol (4 protocols) + +Access control and row-level security. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Permission](./permission/permission)** | `permission.zod.ts` | ObjectPermission | Object-level permissions | +| **[Sharing](./permission/sharing)** | `sharing.zod.ts` | SharingRule | Record sharing rules | +| **[RLS](./permission/rls)** | `rls.zod.ts` | RowLevelSecurity | Row-level security filters | +| **[Territory](./permission/territory)** | `territory.zod.ts` | Territory | Territory-based access | + +## Hub Protocol (5 protocols) + +Marketplace, licensing, and multi-tenancy. + +| Protocol | Source File | Key Schemas | Purpose | +|:---------|:-----------|:------------|:--------| +| **[Marketplace](./hub/marketplace)** | `marketplace.zod.ts` | Package, PackageVersion | Plugin marketplace | +| **[Composer](./hub/composer)** | `composer.zod.ts` | Dependency | Dependency management | +| **[License](./hub/license)** | `license.zod.ts` | License, LicenseType | Feature licensing | +| **[Tenant](./hub/tenant)** | `tenant.zod.ts` | Tenant | Multi-tenancy isolation | +| **[Space](./hub/space)** | `space.zod.ts` | Space, Workspace | Workspace management | + +## Common Patterns + +### Naming Conventions + + + + ```typescript + // Property names in schemas: camelCase + { + maxLength: 100, + defaultValue: 'example', + referenceFilters: ['active = true'] + } + ``` + + + ```typescript + // Machine identifiers in data: snake_case + { + name: 'project_task', + object: 'customer', + field: 'first_name' + } + ``` + + + ```typescript + // Export names: PascalCase + Schema suffix + export const FieldSchema = z.object({...}); + export type Field = z.infer; + ``` + + + +### Common Imports + +```typescript +// Data protocols +import { FieldSchema, ObjectSchema, QuerySchema } from '@objectstack/spec/data'; + +// UI protocols +import { ViewSchema, AppSchema, DashboardSchema } from '@objectstack/spec/ui'; + +// System protocols +import { ManifestSchema, DatasourceSchema } from '@objectstack/spec/system'; + +// AI protocols +import { AgentSchema, RAGPipelineConfigSchema } from '@objectstack/spec/ai'; + +// Types +import type { Field, Object, Query, View } from '@objectstack/spec'; +``` + +## Search Tips + +- **By Feature**: "How do I model relationships?" → [Field Protocol](./data/field) → `lookup` or `master_detail` types +- **By Use Case**: "Build a dashboard" → [Dashboard Protocol](./ui/dashboard) +- **By Layer**: Data → [Data Protocol](./data), UI → [UI Protocol](./ui), Runtime → [System Protocol](./system) + +## Next Steps + + +**New to ObjectStack?** Start with the [Introduction](../introduction) to learn core concepts before diving into specific protocols. + + +- [Protocol Reference Index](./index) - Full protocol documentation +- [ObjectQL Guide](../objectql) - Deep dive into data modeling +- [ObjectUI Guide](../objectui) - UI development guide +- [Contributing Guide](https://github.com/objectstack-ai/spec/blob/main/CONTRIBUTING.md) - How to contribute to protocols From 504c4096cbc23fadf628706f608bb4894724249f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 14:35:35 +0000 Subject: [PATCH 04/10] Fix lucide-react import issues in generated documentation Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- content/docs/references/ai/index.mdx | 1 - content/docs/references/api/index.mdx | 1 - content/docs/references/auth/index.mdx | 1 - content/docs/references/automation/index.mdx | 1 - content/docs/references/data/index.mdx | 1 - content/docs/references/hub/index.mdx | 1 - content/docs/references/index.mdx | 9 --------- content/docs/references/meta.json | 8 +------- content/docs/references/permission/index.mdx | 1 - content/docs/references/shared/index.mdx | 1 - content/docs/references/system/index.mdx | 1 - content/docs/references/ui/index.mdx | 1 - packages/spec/scripts/build-docs.ts | 3 +-- 13 files changed, 2 insertions(+), 28 deletions(-) diff --git a/content/docs/references/ai/index.mdx b/content/docs/references/ai/index.mdx index b0513f867..5cc82d258 100644 --- a/content/docs/references/ai/index.mdx +++ b/content/docs/references/ai/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all ai protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # AI Protocol diff --git a/content/docs/references/api/index.mdx b/content/docs/references/api/index.mdx index a440d8726..278c8ad12 100644 --- a/content/docs/references/api/index.mdx +++ b/content/docs/references/api/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all api protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # API Protocol diff --git a/content/docs/references/auth/index.mdx b/content/docs/references/auth/index.mdx index 117411ac1..3ee0dfd7b 100644 --- a/content/docs/references/auth/index.mdx +++ b/content/docs/references/auth/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all auth protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # Auth Protocol diff --git a/content/docs/references/automation/index.mdx b/content/docs/references/automation/index.mdx index d0e8ea9ad..63e8f70cd 100644 --- a/content/docs/references/automation/index.mdx +++ b/content/docs/references/automation/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all automation protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # Automation Protocol diff --git a/content/docs/references/data/index.mdx b/content/docs/references/data/index.mdx index 4964a9faa..16ae06db7 100644 --- a/content/docs/references/data/index.mdx +++ b/content/docs/references/data/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all data protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # Data Protocol diff --git a/content/docs/references/hub/index.mdx b/content/docs/references/hub/index.mdx index 94b116d79..aa41c6308 100644 --- a/content/docs/references/hub/index.mdx +++ b/content/docs/references/hub/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all hub protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # Hub Protocol diff --git a/content/docs/references/index.mdx b/content/docs/references/index.mdx index 8d96af75b..a5cc19a23 100644 --- a/content/docs/references/index.mdx +++ b/content/docs/references/index.mdx @@ -4,7 +4,6 @@ description: Complete API reference for all ObjectStack protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Layout, Settings, Brain, Zap, Shield, Package, Globe } from 'lucide-react'; # Protocol Reference @@ -17,49 +16,41 @@ ObjectStack is defined by **70+ protocol schemas** that standardize how business href="./data" title="Data Protocol" description="Objects, Fields, Queries, Filters, Validation (8 protocols)" - icon={} /> } /> } /> } /> } /> } /> } /> } /> diff --git a/content/docs/references/meta.json b/content/docs/references/meta.json index b2edec615..577f212af 100644 --- a/content/docs/references/meta.json +++ b/content/docs/references/meta.json @@ -1,9 +1,6 @@ { "title": "Protocol Reference", "pages": [ - "quick-reference", - "protocol-map", - "---", "data", "ui", "automation", @@ -11,9 +8,6 @@ "permission", "ai", "api", - "driver", - "auth", - "hub", - "shared" + "driver" ] } \ No newline at end of file diff --git a/content/docs/references/permission/index.mdx b/content/docs/references/permission/index.mdx index 7891734d8..7523ce41b 100644 --- a/content/docs/references/permission/index.mdx +++ b/content/docs/references/permission/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all permission protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # Permission Protocol diff --git a/content/docs/references/shared/index.mdx b/content/docs/references/shared/index.mdx index 89b76d580..c3d39c556 100644 --- a/content/docs/references/shared/index.mdx +++ b/content/docs/references/shared/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all shared protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # Shared Protocol diff --git a/content/docs/references/system/index.mdx b/content/docs/references/system/index.mdx index 82edbf53e..55c041bd3 100644 --- a/content/docs/references/system/index.mdx +++ b/content/docs/references/system/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all system protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # System Protocol diff --git a/content/docs/references/ui/index.mdx b/content/docs/references/ui/index.mdx index 2c3afd7bd..8ccb1f215 100644 --- a/content/docs/references/ui/index.mdx +++ b/content/docs/references/ui/index.mdx @@ -4,7 +4,6 @@ description: Complete reference for all ui protocol schemas --- import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Database, Cpu, Zap } from 'lucide-react'; # UI Protocol diff --git a/packages/spec/scripts/build-docs.ts b/packages/spec/scripts/build-docs.ts index d425cf0f8..34086dd7e 100644 --- a/packages/spec/scripts/build-docs.ts +++ b/packages/spec/scripts/build-docs.ts @@ -333,8 +333,7 @@ Object.entries(CATEGORIES).forEach(([category, title]) => { if (zodFiles.size === 0) return; let overviewMd = `---\ntitle: ${title} Overview\ndescription: Complete reference for all ${title.toLowerCase()} schemas\n---\n\n`; - overviewMd += `import { Card, Cards } from 'fumadocs-ui/components/card';\n`; - overviewMd += `import { Database, Cpu, Zap } from 'lucide-react';\n\n`; + overviewMd += `import { Card, Cards } from 'fumadocs-ui/components/card';\n\n`; overviewMd += `# ${title}\n\n`; overviewMd += `This section contains all protocol schemas for the ${category} layer of ObjectStack.\n\n`; From b10af91bd3d7a4b20cea299d1449140b8ea553af Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 14:38:37 +0000 Subject: [PATCH 05/10] Fix code review issues: improve comma logic, null safety, and file paths Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- content/docs/references/ai/agent/Agent.mdx | 2 +- .../references/ai/conversation/ConversationAnalytics.mdx | 2 +- .../references/ai/conversation/ConversationMessage.mdx | 2 +- .../references/ai/conversation/ConversationSession.mdx | 2 +- .../references/ai/conversation/ConversationSummary.mdx | 2 +- .../references/ai/conversation/MessagePruningEvent.mdx | 2 +- content/docs/references/ai/cost/BudgetStatus.mdx | 2 +- content/docs/references/ai/cost/CostAlert.mdx | 2 +- content/docs/references/ai/cost/CostAnalytics.mdx | 2 +- content/docs/references/ai/cost/CostBreakdownEntry.mdx | 2 +- content/docs/references/ai/cost/CostEntry.mdx | 2 +- .../references/ai/cost/CostOptimizationRecommendation.mdx | 2 +- content/docs/references/ai/cost/CostReport.mdx | 2 +- content/docs/references/ai/model-registry/ModelConfig.mdx | 2 +- .../docs/references/ai/model-registry/PromptTemplate.mdx | 2 +- content/docs/references/ai/nlq/NLQAnalytics.mdx | 2 +- content/docs/references/ai/nlq/NLQFieldMapping.mdx | 2 +- content/docs/references/ai/nlq/NLQParseResult.mdx | 2 +- content/docs/references/ai/nlq/QueryTemplate.mdx | 2 +- .../docs/references/ai/orchestration/AIOrchestration.mdx | 2 +- .../ai/orchestration/AIOrchestrationExecutionResult.mdx | 2 +- content/docs/references/ai/orchestration/AITask.mdx | 2 +- content/docs/references/ai/predictive/ModelDrift.mdx | 2 +- content/docs/references/ai/predictive/PredictiveModel.mdx | 2 +- content/docs/references/ai/rag-pipeline/DocumentChunk.mdx | 2 +- .../docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx | 2 +- content/docs/references/api/discovery/Discovery.mdx | 2 +- content/docs/references/api/endpoint/ApiEndpoint.mdx | 2 +- content/docs/references/auth/config/AuthConfig.mdx | 2 +- content/docs/references/auth/config/LDAPConfig.mdx | 2 +- content/docs/references/auth/identity/Account.mdx | 2 +- content/docs/references/auth/identity/Session.mdx | 2 +- content/docs/references/auth/identity/User.mdx | 2 +- .../docs/references/auth/identity/VerificationToken.mdx | 2 +- content/docs/references/auth/organization/Invitation.mdx | 2 +- content/docs/references/auth/organization/Member.mdx | 2 +- content/docs/references/auth/organization/Organization.mdx | 2 +- .../references/automation/approval/ApprovalProcess.mdx | 2 +- content/docs/references/automation/connector/Connector.mdx | 2 +- .../references/automation/connector/ConnectorInstance.mdx | 2 +- content/docs/references/automation/etl/ETLPipelineRun.mdx | 2 +- content/docs/references/automation/flow/Flow.mdx | 2 +- .../references/automation/sync/SyncExecutionResult.mdx | 2 +- content/docs/references/automation/webhook/Webhook.mdx | 2 +- .../references/automation/workflow/EmailAlertAction.mdx | 2 +- .../docs/references/automation/workflow/HttpCallAction.mdx | 2 +- .../automation/workflow/PushNotificationAction.mdx | 2 +- .../references/automation/workflow/SlackMessageAction.mdx | 2 +- .../automation/workflow/SmsNotificationAction.mdx | 2 +- .../references/automation/workflow/TaskCreationAction.mdx | 2 +- .../references/automation/workflow/TeamsMessageAction.mdx | 2 +- .../docs/references/automation/workflow/TimeTrigger.mdx | 2 +- .../docs/references/data/validation/AsyncValidation.mdx | 2 +- .../references/data/validation/ConditionalValidation.mdx | 2 +- .../references/data/validation/CrossFieldValidation.mdx | 2 +- .../docs/references/data/validation/CustomValidator.mdx | 2 +- .../docs/references/data/validation/FormatValidation.mdx | 2 +- content/docs/references/data/validation/JSONValidation.mdx | 2 +- .../docs/references/data/validation/ScriptValidation.mdx | 2 +- .../references/data/validation/StateMachineValidation.mdx | 2 +- .../references/data/validation/UniquenessValidation.mdx | 2 +- content/docs/references/hub/composer/ComposerResponse.mdx | 2 +- content/docs/references/hub/composer/ConflictReport.mdx | 2 +- content/docs/references/hub/license/License.mdx | 2 +- content/docs/references/hub/license/Plan.mdx | 2 +- content/docs/references/hub/space/HubSpace.mdx | 2 +- .../references/permission/sharing/CriteriaSharingRule.mdx | 2 +- .../references/permission/sharing/OwnerSharingRule.mdx | 2 +- content/docs/references/quick-reference.mdx | 4 ++-- content/docs/references/system/audit/AuditEvent.mdx | 2 +- .../references/system/audit/SuspiciousActivityRule.mdx | 2 +- content/docs/references/system/context/KernelContext.mdx | 2 +- .../docs/references/system/driver/DriverCapabilities.mdx | 2 +- content/docs/references/system/manifest/Manifest.mdx | 2 +- content/docs/references/system/plugin/PluginContext.mdx | 2 +- .../docs/references/system/scoped-storage/FileMetadata.mdx | 2 +- content/docs/references/ui/app/DashboardNavItem.mdx | 2 +- content/docs/references/ui/app/ObjectNavItem.mdx | 2 +- content/docs/references/ui/app/PageNavItem.mdx | 2 +- content/docs/references/ui/app/UrlNavItem.mdx | 2 +- content/docs/references/ui/report/Report.mdx | 2 +- packages/spec/scripts/build-docs.ts | 7 ++++--- 82 files changed, 86 insertions(+), 85 deletions(-) diff --git a/content/docs/references/ai/agent/Agent.mdx b/content/docs/references/ai/agent/Agent.mdx index 01b936fbd..1271db73f 100644 --- a/content/docs/references/ai/agent/Agent.mdx +++ b/content/docs/references/ai/agent/Agent.mdx @@ -42,7 +42,7 @@ const myAgent: Agent = { name: 'name', label: 'example', role: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/conversation/ConversationAnalytics.mdx b/content/docs/references/ai/conversation/ConversationAnalytics.mdx index 0191e6411..91b289b22 100644 --- a/content/docs/references/ai/conversation/ConversationAnalytics.mdx +++ b/content/docs/references/ai/conversation/ConversationAnalytics.mdx @@ -47,7 +47,7 @@ const myConversationAnalytics: ConversationAnalytics = { sessionId: 'example', totalMessages: null, userMessages: null, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/conversation/ConversationMessage.mdx b/content/docs/references/ai/conversation/ConversationMessage.mdx index 68c14e9e2..c72116b76 100644 --- a/content/docs/references/ai/conversation/ConversationMessage.mdx +++ b/content/docs/references/ai/conversation/ConversationMessage.mdx @@ -45,7 +45,7 @@ const myConversationMessage: ConversationMessage = { id: 'example', timestamp: 'example', role: 'system', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/conversation/ConversationSession.mdx b/content/docs/references/ai/conversation/ConversationSession.mdx index 02d66c7c7..1db27eed2 100644 --- a/content/docs/references/ai/conversation/ConversationSession.mdx +++ b/content/docs/references/ai/conversation/ConversationSession.mdx @@ -45,7 +45,7 @@ const myConversationSession: ConversationSession = { id: 'example', context: {}, tokenBudget: {}, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/conversation/ConversationSummary.mdx b/content/docs/references/ai/conversation/ConversationSummary.mdx index fa3becd1f..6b54e71ae 100644 --- a/content/docs/references/ai/conversation/ConversationSummary.mdx +++ b/content/docs/references/ai/conversation/ConversationSummary.mdx @@ -40,7 +40,7 @@ const myConversationSummary: ConversationSummary = { summary: 'example', originalTokens: null, summaryTokens: null, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/conversation/MessagePruningEvent.mdx b/content/docs/references/ai/conversation/MessagePruningEvent.mdx index ec4a88976..bc8a17584 100644 --- a/content/docs/references/ai/conversation/MessagePruningEvent.mdx +++ b/content/docs/references/ai/conversation/MessagePruningEvent.mdx @@ -40,7 +40,7 @@ const myMessagePruningEvent: MessagePruningEvent = { timestamp: 'example', strategy: 'fifo', reason: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/BudgetStatus.mdx b/content/docs/references/ai/cost/BudgetStatus.mdx index 224d2dfa6..4837df17f 100644 --- a/content/docs/references/ai/cost/BudgetStatus.mdx +++ b/content/docs/references/ai/cost/BudgetStatus.mdx @@ -47,7 +47,7 @@ const myBudgetStatus: BudgetStatus = { budgetId: 'example', type: 'global', periodStart: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/CostAlert.mdx b/content/docs/references/ai/cost/CostAlert.mdx index 88e49e759..de0e05180 100644 --- a/content/docs/references/ai/cost/CostAlert.mdx +++ b/content/docs/references/ai/cost/CostAlert.mdx @@ -50,7 +50,7 @@ const myCostAlert: CostAlert = { id: 'example', timestamp: 'example', type: 'threshold_warning', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/CostAnalytics.mdx b/content/docs/references/ai/cost/CostAnalytics.mdx index 82cec8f97..fe50740b1 100644 --- a/content/docs/references/ai/cost/CostAnalytics.mdx +++ b/content/docs/references/ai/cost/CostAnalytics.mdx @@ -54,7 +54,7 @@ const myCostAnalytics: CostAnalytics = { periodStart: 'example', periodEnd: 'example', totalCost: 0, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/CostBreakdownEntry.mdx b/content/docs/references/ai/cost/CostBreakdownEntry.mdx index 97ec60372..19c61ffac 100644 --- a/content/docs/references/ai/cost/CostBreakdownEntry.mdx +++ b/content/docs/references/ai/cost/CostBreakdownEntry.mdx @@ -40,7 +40,7 @@ const myCostBreakdownEntry: CostBreakdownEntry = { dimension: 'model', value: 'example', totalCost: 0, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/CostEntry.mdx b/content/docs/references/ai/cost/CostEntry.mdx index a7aa08ff9..0b6b41242 100644 --- a/content/docs/references/ai/cost/CostEntry.mdx +++ b/content/docs/references/ai/cost/CostEntry.mdx @@ -52,7 +52,7 @@ const myCostEntry: CostEntry = { id: 'example', timestamp: 'example', modelId: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx index b5ffb9413..935a28e1d 100644 --- a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx +++ b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx @@ -47,7 +47,7 @@ const myCostOptimizationRecommendation: CostOptimizationRecommendation = { id: 'example', type: 'switch_model', title: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/cost/CostReport.mdx b/content/docs/references/ai/cost/CostReport.mdx index ecc90e074..c740b3305 100644 --- a/content/docs/references/ai/cost/CostReport.mdx +++ b/content/docs/references/ai/cost/CostReport.mdx @@ -50,7 +50,7 @@ const myCostReport: CostReport = { id: 'example', name: 'name', generatedAt: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/model-registry/ModelConfig.mdx b/content/docs/references/ai/model-registry/ModelConfig.mdx index 7cd5cc1b4..1147ac7d0 100644 --- a/content/docs/references/ai/model-registry/ModelConfig.mdx +++ b/content/docs/references/ai/model-registry/ModelConfig.mdx @@ -46,7 +46,7 @@ const myModelConfig: ModelConfig = { id: 'example', name: 'name', version: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/model-registry/PromptTemplate.mdx b/content/docs/references/ai/model-registry/PromptTemplate.mdx index a8eca44f3..d2d5d5d56 100644 --- a/content/docs/references/ai/model-registry/PromptTemplate.mdx +++ b/content/docs/references/ai/model-registry/PromptTemplate.mdx @@ -51,7 +51,7 @@ const myPromptTemplate: PromptTemplate = { id: 'example', name: 'name', label: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/nlq/NLQAnalytics.mdx b/content/docs/references/ai/nlq/NLQAnalytics.mdx index 2eafdd3f3..b0ffe005c 100644 --- a/content/docs/references/ai/nlq/NLQAnalytics.mdx +++ b/content/docs/references/ai/nlq/NLQAnalytics.mdx @@ -43,7 +43,7 @@ const myNLQAnalytics: NLQAnalytics = { totalQueries: null, successfulQueries: null, failedQueries: null, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/nlq/NLQFieldMapping.mdx b/content/docs/references/ai/nlq/NLQFieldMapping.mdx index 50bfd52fc..d91622027 100644 --- a/content/docs/references/ai/nlq/NLQFieldMapping.mdx +++ b/content/docs/references/ai/nlq/NLQFieldMapping.mdx @@ -37,7 +37,7 @@ const myNLQFieldMapping: NLQFieldMapping = { naturalLanguage: 'example', objectField: 'example', object: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/nlq/NLQParseResult.mdx b/content/docs/references/ai/nlq/NLQParseResult.mdx index 5046f07cd..2c639990a 100644 --- a/content/docs/references/ai/nlq/NLQParseResult.mdx +++ b/content/docs/references/ai/nlq/NLQParseResult.mdx @@ -43,7 +43,7 @@ const myNLQParseResult: NLQParseResult = { originalQuery: 'example', intent: 'select', intentConfidence: 0, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/nlq/QueryTemplate.mdx b/content/docs/references/ai/nlq/QueryTemplate.mdx index c5d4ca3dc..36dabfd60 100644 --- a/content/docs/references/ai/nlq/QueryTemplate.mdx +++ b/content/docs/references/ai/nlq/QueryTemplate.mdx @@ -41,7 +41,7 @@ const myQueryTemplate: QueryTemplate = { id: 'example', name: 'name', label: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/orchestration/AIOrchestration.mdx b/content/docs/references/ai/orchestration/AIOrchestration.mdx index 4b3f26225..eda23bc0a 100644 --- a/content/docs/references/ai/orchestration/AIOrchestration.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestration.mdx @@ -57,7 +57,7 @@ const myAIOrchestration: AIOrchestration = { name: 'name', label: 'example', objectName: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx index d8818e1b8..2761fde3e 100644 --- a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx @@ -43,7 +43,7 @@ const myAIOrchestrationExecutionResult: AIOrchestrationExecutionResult = { workflowName: 'example', recordId: 'example', status: 'success', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/orchestration/AITask.mdx b/content/docs/references/ai/orchestration/AITask.mdx index 5fdb3c04d..2e54428ec 100644 --- a/content/docs/references/ai/orchestration/AITask.mdx +++ b/content/docs/references/ai/orchestration/AITask.mdx @@ -51,7 +51,7 @@ const myAITask: AITask = { name: 'name', type: 'classify', inputFields: [], - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/predictive/ModelDrift.mdx b/content/docs/references/ai/predictive/ModelDrift.mdx index 0bde39d32..ce570b847 100644 --- a/content/docs/references/ai/predictive/ModelDrift.mdx +++ b/content/docs/references/ai/predictive/ModelDrift.mdx @@ -39,7 +39,7 @@ const myModelDrift: ModelDrift = { modelName: 'example', driftType: 'feature_drift', severity: 'low', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/predictive/PredictiveModel.mdx b/content/docs/references/ai/predictive/PredictiveModel.mdx index 084e56046..8559112ec 100644 --- a/content/docs/references/ai/predictive/PredictiveModel.mdx +++ b/content/docs/references/ai/predictive/PredictiveModel.mdx @@ -63,7 +63,7 @@ const myPredictiveModel: PredictiveModel = { name: 'name', label: 'example', type: 'classification', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx index 73a311dd8..f3f4c56d8 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx @@ -38,7 +38,7 @@ const myDocumentChunk: DocumentChunk = { id: 'example', content: 'example', metadata: {}, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx index 05f5ed3a6..1e289670c 100644 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx @@ -47,7 +47,7 @@ const myRAGPipelineConfig: RAGPipelineConfig = { name: 'name', label: 'example', embedding: {}, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/api/discovery/Discovery.mdx b/content/docs/references/api/discovery/Discovery.mdx index 3033180e6..c89fa696a 100644 --- a/content/docs/references/api/discovery/Discovery.mdx +++ b/content/docs/references/api/discovery/Discovery.mdx @@ -38,7 +38,7 @@ const myDiscovery: Discovery = { name: 'name', version: 'example', environment: 'production', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/api/endpoint/ApiEndpoint.mdx b/content/docs/references/api/endpoint/ApiEndpoint.mdx index 1179d786d..d61a623a0 100644 --- a/content/docs/references/api/endpoint/ApiEndpoint.mdx +++ b/content/docs/references/api/endpoint/ApiEndpoint.mdx @@ -45,7 +45,7 @@ const myApiEndpoint: ApiEndpoint = { name: 'name', path: 'example', method: 'GET', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/config/AuthConfig.mdx b/content/docs/references/auth/config/AuthConfig.mdx index 660f9afbb..e771582bc 100644 --- a/content/docs/references/auth/config/AuthConfig.mdx +++ b/content/docs/references/auth/config/AuthConfig.mdx @@ -59,7 +59,7 @@ const myAuthConfig: AuthConfig = { name: 'name', label: 'example', strategies: [], - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/config/LDAPConfig.mdx b/content/docs/references/auth/config/LDAPConfig.mdx index ba6ca03c2..6706a48fb 100644 --- a/content/docs/references/auth/config/LDAPConfig.mdx +++ b/content/docs/references/auth/config/LDAPConfig.mdx @@ -41,7 +41,7 @@ const myLDAPConfig: LDAPConfig = { url: 'https://example.com', bindDn: 'example', bindCredentials: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/identity/Account.mdx b/content/docs/references/auth/identity/Account.mdx index 01d29500e..3584b9593 100644 --- a/content/docs/references/auth/identity/Account.mdx +++ b/content/docs/references/auth/identity/Account.mdx @@ -46,7 +46,7 @@ const myAccount: Account = { id: 'example', userId: 'example', type: 'oauth', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/identity/Session.mdx b/content/docs/references/auth/identity/Session.mdx index 68d98eeaf..f90973308 100644 --- a/content/docs/references/auth/identity/Session.mdx +++ b/content/docs/references/auth/identity/Session.mdx @@ -42,7 +42,7 @@ const mySession: Session = { id: 'example', sessionToken: 'example', userId: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/identity/User.mdx b/content/docs/references/auth/identity/User.mdx index 2c19402d7..a04a49f5a 100644 --- a/content/docs/references/auth/identity/User.mdx +++ b/content/docs/references/auth/identity/User.mdx @@ -39,7 +39,7 @@ const myUser: User = { id: 'example', email: 'user@example.com', createdAt: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/identity/VerificationToken.mdx b/content/docs/references/auth/identity/VerificationToken.mdx index b67f5a267..9c52fc9b6 100644 --- a/content/docs/references/auth/identity/VerificationToken.mdx +++ b/content/docs/references/auth/identity/VerificationToken.mdx @@ -36,7 +36,7 @@ const myVerificationToken: VerificationToken = { identifier: 'example', token: 'example', expires: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/organization/Invitation.mdx b/content/docs/references/auth/organization/Invitation.mdx index 9df3c51cd..18b8682b2 100644 --- a/content/docs/references/auth/organization/Invitation.mdx +++ b/content/docs/references/auth/organization/Invitation.mdx @@ -41,7 +41,7 @@ const myInvitation: Invitation = { id: 'example', organizationId: 'example', email: 'user@example.com', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/organization/Member.mdx b/content/docs/references/auth/organization/Member.mdx index 6bd6e7a25..e818c54e7 100644 --- a/content/docs/references/auth/organization/Member.mdx +++ b/content/docs/references/auth/organization/Member.mdx @@ -38,7 +38,7 @@ const myMember: Member = { id: 'example', organizationId: 'example', userId: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/auth/organization/Organization.mdx b/content/docs/references/auth/organization/Organization.mdx index 581ef86b2..42bdb2dbd 100644 --- a/content/docs/references/auth/organization/Organization.mdx +++ b/content/docs/references/auth/organization/Organization.mdx @@ -39,7 +39,7 @@ const myOrganization: Organization = { id: 'example', name: 'name', slug: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/approval/ApprovalProcess.mdx b/content/docs/references/automation/approval/ApprovalProcess.mdx index f7566bc34..634fddef2 100644 --- a/content/docs/references/automation/approval/ApprovalProcess.mdx +++ b/content/docs/references/automation/approval/ApprovalProcess.mdx @@ -44,7 +44,7 @@ const myApprovalProcess: ApprovalProcess = { name: 'name', label: 'example', object: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/connector/Connector.mdx b/content/docs/references/automation/connector/Connector.mdx index e8f72f489..91a746f1b 100644 --- a/content/docs/references/automation/connector/Connector.mdx +++ b/content/docs/references/automation/connector/Connector.mdx @@ -50,7 +50,7 @@ const myConnector: Connector = { id: 'example', name: 'name', category: 'crm', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/connector/ConnectorInstance.mdx b/content/docs/references/automation/connector/ConnectorInstance.mdx index ec61422b9..072ee45ac 100644 --- a/content/docs/references/automation/connector/ConnectorInstance.mdx +++ b/content/docs/references/automation/connector/ConnectorInstance.mdx @@ -42,7 +42,7 @@ const myConnectorInstance: ConnectorInstance = { id: 'example', connectorId: 'example', name: 'name', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/etl/ETLPipelineRun.mdx b/content/docs/references/automation/etl/ETLPipelineRun.mdx index f7a1bd191..3450c8fa4 100644 --- a/content/docs/references/automation/etl/ETLPipelineRun.mdx +++ b/content/docs/references/automation/etl/ETLPipelineRun.mdx @@ -41,7 +41,7 @@ const myETLPipelineRun: ETLPipelineRun = { id: 'example', pipelineName: 'example', status: 'pending', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/flow/Flow.mdx b/content/docs/references/automation/flow/Flow.mdx index f894b2832..f9a7f578e 100644 --- a/content/docs/references/automation/flow/Flow.mdx +++ b/content/docs/references/automation/flow/Flow.mdx @@ -44,7 +44,7 @@ const myFlow: Flow = { name: 'name', label: 'example', type: 'autolaunched', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/sync/SyncExecutionResult.mdx b/content/docs/references/automation/sync/SyncExecutionResult.mdx index 2d95b6629..6bba5eea8 100644 --- a/content/docs/references/automation/sync/SyncExecutionResult.mdx +++ b/content/docs/references/automation/sync/SyncExecutionResult.mdx @@ -41,7 +41,7 @@ const mySyncExecutionResult: SyncExecutionResult = { id: 'example', syncName: 'example', status: 'pending', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/webhook/Webhook.mdx b/content/docs/references/automation/webhook/Webhook.mdx index e0fa3e3d9..4a52d6867 100644 --- a/content/docs/references/automation/webhook/Webhook.mdx +++ b/content/docs/references/automation/webhook/Webhook.mdx @@ -44,7 +44,7 @@ const myWebhook: Webhook = { name: 'name', object: 'example', triggers: [], - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/EmailAlertAction.mdx b/content/docs/references/automation/workflow/EmailAlertAction.mdx index 9d0eb5e36..e3cb9e5ad 100644 --- a/content/docs/references/automation/workflow/EmailAlertAction.mdx +++ b/content/docs/references/automation/workflow/EmailAlertAction.mdx @@ -36,7 +36,7 @@ const myEmailAlertAction: EmailAlertAction = { name: 'name', type: 'example', template: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/HttpCallAction.mdx b/content/docs/references/automation/workflow/HttpCallAction.mdx index 8e45e85c6..428901698 100644 --- a/content/docs/references/automation/workflow/HttpCallAction.mdx +++ b/content/docs/references/automation/workflow/HttpCallAction.mdx @@ -40,7 +40,7 @@ const myHttpCallAction: HttpCallAction = { name: 'name', type: 'example', url: 'https://example.com', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/PushNotificationAction.mdx b/content/docs/references/automation/workflow/PushNotificationAction.mdx index 99479c4e0..97409a46a 100644 --- a/content/docs/references/automation/workflow/PushNotificationAction.mdx +++ b/content/docs/references/automation/workflow/PushNotificationAction.mdx @@ -41,7 +41,7 @@ const myPushNotificationAction: PushNotificationAction = { name: 'name', type: 'example', title: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/SlackMessageAction.mdx b/content/docs/references/automation/workflow/SlackMessageAction.mdx index 531a3ff2a..746223495 100644 --- a/content/docs/references/automation/workflow/SlackMessageAction.mdx +++ b/content/docs/references/automation/workflow/SlackMessageAction.mdx @@ -38,7 +38,7 @@ const mySlackMessageAction: SlackMessageAction = { name: 'name', type: 'example', channel: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/SmsNotificationAction.mdx b/content/docs/references/automation/workflow/SmsNotificationAction.mdx index 934d2b25c..1c25dc89e 100644 --- a/content/docs/references/automation/workflow/SmsNotificationAction.mdx +++ b/content/docs/references/automation/workflow/SmsNotificationAction.mdx @@ -38,7 +38,7 @@ const mySmsNotificationAction: SmsNotificationAction = { name: 'name', type: 'example', provider: 'twilio', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/TaskCreationAction.mdx b/content/docs/references/automation/workflow/TaskCreationAction.mdx index 93ef59fd3..c14230019 100644 --- a/content/docs/references/automation/workflow/TaskCreationAction.mdx +++ b/content/docs/references/automation/workflow/TaskCreationAction.mdx @@ -42,7 +42,7 @@ const myTaskCreationAction: TaskCreationAction = { name: 'name', type: 'example', taskObject: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/TeamsMessageAction.mdx b/content/docs/references/automation/workflow/TeamsMessageAction.mdx index 1ddecfe97..78a7921c6 100644 --- a/content/docs/references/automation/workflow/TeamsMessageAction.mdx +++ b/content/docs/references/automation/workflow/TeamsMessageAction.mdx @@ -38,7 +38,7 @@ const myTeamsMessageAction: TeamsMessageAction = { name: 'name', type: 'example', channel: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/automation/workflow/TimeTrigger.mdx b/content/docs/references/automation/workflow/TimeTrigger.mdx index 9f4c3160e..82fc8d19b 100644 --- a/content/docs/references/automation/workflow/TimeTrigger.mdx +++ b/content/docs/references/automation/workflow/TimeTrigger.mdx @@ -39,7 +39,7 @@ const myTimeTrigger: TimeTrigger = { timeLength: null, timeUnit: 'minutes', offsetDirection: 'before', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/AsyncValidation.mdx b/content/docs/references/data/validation/AsyncValidation.mdx index 7e9c2bc97..c7bfd9d4c 100644 --- a/content/docs/references/data/validation/AsyncValidation.mdx +++ b/content/docs/references/data/validation/AsyncValidation.mdx @@ -49,7 +49,7 @@ const myAsyncValidation: AsyncValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/ConditionalValidation.mdx b/content/docs/references/data/validation/ConditionalValidation.mdx index ecfae6662..64600fd45 100644 --- a/content/docs/references/data/validation/ConditionalValidation.mdx +++ b/content/docs/references/data/validation/ConditionalValidation.mdx @@ -44,7 +44,7 @@ const myConditionalValidation: ConditionalValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/CrossFieldValidation.mdx b/content/docs/references/data/validation/CrossFieldValidation.mdx index 96aa0d715..af9606de0 100644 --- a/content/docs/references/data/validation/CrossFieldValidation.mdx +++ b/content/docs/references/data/validation/CrossFieldValidation.mdx @@ -43,7 +43,7 @@ const myCrossFieldValidation: CrossFieldValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/CustomValidator.mdx b/content/docs/references/data/validation/CustomValidator.mdx index 3dc821d12..64936e4d9 100644 --- a/content/docs/references/data/validation/CustomValidator.mdx +++ b/content/docs/references/data/validation/CustomValidator.mdx @@ -43,7 +43,7 @@ const myCustomValidator: CustomValidator = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/FormatValidation.mdx b/content/docs/references/data/validation/FormatValidation.mdx index 59634283c..5d8e50ccf 100644 --- a/content/docs/references/data/validation/FormatValidation.mdx +++ b/content/docs/references/data/validation/FormatValidation.mdx @@ -44,7 +44,7 @@ const myFormatValidation: FormatValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/JSONValidation.mdx b/content/docs/references/data/validation/JSONValidation.mdx index b09b93df6..af57a3218 100644 --- a/content/docs/references/data/validation/JSONValidation.mdx +++ b/content/docs/references/data/validation/JSONValidation.mdx @@ -43,7 +43,7 @@ const myJSONValidation: JSONValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/ScriptValidation.mdx b/content/docs/references/data/validation/ScriptValidation.mdx index f3d3541ae..a2f98d166 100644 --- a/content/docs/references/data/validation/ScriptValidation.mdx +++ b/content/docs/references/data/validation/ScriptValidation.mdx @@ -42,7 +42,7 @@ const myScriptValidation: ScriptValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/StateMachineValidation.mdx b/content/docs/references/data/validation/StateMachineValidation.mdx index c95f941b9..dd7e86310 100644 --- a/content/docs/references/data/validation/StateMachineValidation.mdx +++ b/content/docs/references/data/validation/StateMachineValidation.mdx @@ -43,7 +43,7 @@ const myStateMachineValidation: StateMachineValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/data/validation/UniquenessValidation.mdx b/content/docs/references/data/validation/UniquenessValidation.mdx index da9f3d34d..edbdcf825 100644 --- a/content/docs/references/data/validation/UniquenessValidation.mdx +++ b/content/docs/references/data/validation/UniquenessValidation.mdx @@ -44,7 +44,7 @@ const myUniquenessValidation: UniquenessValidation = { name: 'name', message: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/hub/composer/ComposerResponse.mdx b/content/docs/references/hub/composer/ComposerResponse.mdx index c61bba161..94d6f4b34 100644 --- a/content/docs/references/hub/composer/ComposerResponse.mdx +++ b/content/docs/references/hub/composer/ComposerResponse.mdx @@ -40,7 +40,7 @@ const myComposerResponse: ComposerResponse = { success: false, buildId: 'example', timestamp: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/hub/composer/ConflictReport.mdx b/content/docs/references/hub/composer/ConflictReport.mdx index 96a96afb6..e84138a17 100644 --- a/content/docs/references/hub/composer/ConflictReport.mdx +++ b/content/docs/references/hub/composer/ConflictReport.mdx @@ -37,7 +37,7 @@ const myConflictReport: ConflictReport = { resourceType: 'object', resourceId: 'example', sources: [], - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/hub/license/License.mdx b/content/docs/references/hub/license/License.mdx index 2cc53f4db..0e4b38f99 100644 --- a/content/docs/references/hub/license/License.mdx +++ b/content/docs/references/hub/license/License.mdx @@ -41,7 +41,7 @@ const myLicense: License = { spaceId: 'example', planCode: 'example', issuedAt: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/hub/license/Plan.mdx b/content/docs/references/hub/license/Plan.mdx index 99aab27d2..b21762519 100644 --- a/content/docs/references/hub/license/Plan.mdx +++ b/content/docs/references/hub/license/Plan.mdx @@ -40,7 +40,7 @@ const myPlan: Plan = { code: 'example', label: 'example', features: [], - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/hub/space/HubSpace.mdx b/content/docs/references/hub/space/HubSpace.mdx index 70ef10471..cd17bf3d9 100644 --- a/content/docs/references/hub/space/HubSpace.mdx +++ b/content/docs/references/hub/space/HubSpace.mdx @@ -43,7 +43,7 @@ const myHubSpace: HubSpace = { id: 'example', name: 'name', slug: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx index 42b48c80a..f849a65ef 100644 --- a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx +++ b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx @@ -41,7 +41,7 @@ const myCriteriaSharingRule: CriteriaSharingRule = { name: 'name', object: 'example', sharedWith: {}, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/permission/sharing/OwnerSharingRule.mdx b/content/docs/references/permission/sharing/OwnerSharingRule.mdx index 842c3659a..9b49a3f8e 100644 --- a/content/docs/references/permission/sharing/OwnerSharingRule.mdx +++ b/content/docs/references/permission/sharing/OwnerSharingRule.mdx @@ -41,7 +41,7 @@ const myOwnerSharingRule: OwnerSharingRule = { name: 'name', object: 'example', sharedWith: {}, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/quick-reference.mdx b/content/docs/references/quick-reference.mdx index 2da9b1bc8..932a83ece 100644 --- a/content/docs/references/quick-reference.mdx +++ b/content/docs/references/quick-reference.mdx @@ -78,8 +78,8 @@ Core system configuration and runtime infrastructure. | **[Translation](./system/translation)** | `translation.zod.ts` | Translation | i18n support | | **[Feature](./system/feature)** | `feature.zod.ts` | FeatureFlag | Feature flags | | **[Storage](./system/scoped-storage)** | `scoped-storage.zod.ts` | ScopedStorage | Key-value storage | -| **[Postgres Driver](./system/driver/postgres)** | `postgres.zod.ts` | PostgresConfig | PostgreSQL driver config | -| **[Mongo Driver](./system/driver/mongo)** | `mongo.zod.ts` | MongoConfig | MongoDB driver config | +| **[Postgres Config](./system/misc)** | `postgres.zod.ts` | PostgresConfig | PostgreSQL driver config | +| **[Mongo Config](./system/misc)** | `mongo.zod.ts` | MongoConfig | MongoDB driver config | ## AI Protocol (8 protocols) diff --git a/content/docs/references/system/audit/AuditEvent.mdx b/content/docs/references/system/audit/AuditEvent.mdx index c29db026d..332096561 100644 --- a/content/docs/references/system/audit/AuditEvent.mdx +++ b/content/docs/references/system/audit/AuditEvent.mdx @@ -46,7 +46,7 @@ const myAuditEvent: AuditEvent = { id: 'example', eventType: 'data.create', timestamp: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/system/audit/SuspiciousActivityRule.mdx b/content/docs/references/system/audit/SuspiciousActivityRule.mdx index 38706640d..1b8fb2140 100644 --- a/content/docs/references/system/audit/SuspiciousActivityRule.mdx +++ b/content/docs/references/system/audit/SuspiciousActivityRule.mdx @@ -41,7 +41,7 @@ const mySuspiciousActivityRule: SuspiciousActivityRule = { id: 'example', name: 'name', eventTypes: [], - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/system/context/KernelContext.mdx b/content/docs/references/system/context/KernelContext.mdx index 58365c1fe..674d5890e 100644 --- a/content/docs/references/system/context/KernelContext.mdx +++ b/content/docs/references/system/context/KernelContext.mdx @@ -40,7 +40,7 @@ const myKernelContext: KernelContext = { instanceId: 'example', version: 'example', cwd: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/system/driver/DriverCapabilities.mdx b/content/docs/references/system/driver/DriverCapabilities.mdx index 91e8e5f87..0f2e424bd 100644 --- a/content/docs/references/system/driver/DriverCapabilities.mdx +++ b/content/docs/references/system/driver/DriverCapabilities.mdx @@ -45,7 +45,7 @@ const myDriverCapabilities: DriverCapabilities = { transactions: false, queryFilters: false, queryAggregations: false, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/system/manifest/Manifest.mdx b/content/docs/references/system/manifest/Manifest.mdx index bb2c395f0..bf435bc5c 100644 --- a/content/docs/references/system/manifest/Manifest.mdx +++ b/content/docs/references/system/manifest/Manifest.mdx @@ -45,7 +45,7 @@ const myManifest: Manifest = { id: 'example', version: 'example', type: 'app', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/system/plugin/PluginContext.mdx b/content/docs/references/system/plugin/PluginContext.mdx index a3d05319f..2b284dbbb 100644 --- a/content/docs/references/system/plugin/PluginContext.mdx +++ b/content/docs/references/system/plugin/PluginContext.mdx @@ -41,7 +41,7 @@ const myPluginContext: PluginContext = { ql: {}, os: {}, logger: {}, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/system/scoped-storage/FileMetadata.mdx b/content/docs/references/system/scoped-storage/FileMetadata.mdx index da0074287..1401ef407 100644 --- a/content/docs/references/system/scoped-storage/FileMetadata.mdx +++ b/content/docs/references/system/scoped-storage/FileMetadata.mdx @@ -39,7 +39,7 @@ const myFileMetadata: FileMetadata = { path: 'example', name: 'name', size: null, - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ui/app/DashboardNavItem.mdx b/content/docs/references/ui/app/DashboardNavItem.mdx index 6989613b9..1cd900269 100644 --- a/content/docs/references/ui/app/DashboardNavItem.mdx +++ b/content/docs/references/ui/app/DashboardNavItem.mdx @@ -38,7 +38,7 @@ const myDashboardNavItem: DashboardNavItem = { id: 'example', label: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ui/app/ObjectNavItem.mdx b/content/docs/references/ui/app/ObjectNavItem.mdx index 9a9c9441a..23dcc74fb 100644 --- a/content/docs/references/ui/app/ObjectNavItem.mdx +++ b/content/docs/references/ui/app/ObjectNavItem.mdx @@ -39,7 +39,7 @@ const myObjectNavItem: ObjectNavItem = { id: 'example', label: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ui/app/PageNavItem.mdx b/content/docs/references/ui/app/PageNavItem.mdx index 6bb454cd0..b1b5d64ac 100644 --- a/content/docs/references/ui/app/PageNavItem.mdx +++ b/content/docs/references/ui/app/PageNavItem.mdx @@ -39,7 +39,7 @@ const myPageNavItem: PageNavItem = { id: 'example', label: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ui/app/UrlNavItem.mdx b/content/docs/references/ui/app/UrlNavItem.mdx index bcc3b2b67..6ffd51941 100644 --- a/content/docs/references/ui/app/UrlNavItem.mdx +++ b/content/docs/references/ui/app/UrlNavItem.mdx @@ -39,7 +39,7 @@ const myUrlNavItem: UrlNavItem = { id: 'example', label: 'example', type: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/content/docs/references/ui/report/Report.mdx b/content/docs/references/ui/report/Report.mdx index 82cf3b397..0032794ba 100644 --- a/content/docs/references/ui/report/Report.mdx +++ b/content/docs/references/ui/report/Report.mdx @@ -42,7 +42,7 @@ const myReport: Report = { name: 'name', label: 'example', objectName: 'example', - // ... other fields + // ... other required fields }; ``` diff --git a/packages/spec/scripts/build-docs.ts b/packages/spec/scripts/build-docs.ts index 34086dd7e..432d3ccdf 100644 --- a/packages/spec/scripts/build-docs.ts +++ b/packages/spec/scripts/build-docs.ts @@ -150,11 +150,12 @@ function generateMarkdown(schemaName: string, schema: any, category: string, zod requiredProps.forEach((propName, idx) => { const prop = (mainDef.properties as any)[propName]; const exampleValue = getExampleValue(prop, propName as string); - md += ` ${propName}: ${exampleValue}${idx < requiredProps.length - 1 || mainDef.required?.length > 3 ? ',' : ''}\n`; + const isLast = (idx === requiredProps.length - 1) && (mainDef.required?.length <= 3); + md += ` ${propName}: ${exampleValue}${isLast ? '' : ','}\n`; }); if (mainDef.required?.length > 3) { - md += ` // ... other fields\n`; + md += ` // ... other required fields\n`; } md += `};\n`; @@ -208,7 +209,7 @@ function findRelatedSchemas(schemaName: string, mainDef: any, category: string): if (mainDef.properties) { for (const prop of Object.values(mainDef.properties) as any[]) { - if (prop.$ref) { + if (prop.$ref && typeof prop.$ref === 'string' && prop.$ref.includes('/')) { const refName = prop.$ref.split('/').pop(); if (refName && refName !== schemaName && !seen.has(refName)) { const zodFile = schemaZodFileMap.get(refName); From 14dbb89438b5f49385b7741a248f34c59f995020 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 15:00:29 +0000 Subject: [PATCH 06/10] Initial plan From 7cfd54416dbe3ff0cf20915f934e2be788d56f44 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 15:06:42 +0000 Subject: [PATCH 07/10] Add Tab and Tabs to available MDX components Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- apps/docs/app/[lang]/docs/[[...slug]]/page.tsx | 3 +++ apps/docs/next.config.mjs | 11 +++-------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx b/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx index e68476651..3a7fed801 100644 --- a/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx +++ b/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx @@ -5,6 +5,7 @@ import { notFound } from 'next/navigation'; import defaultMdxComponents from 'fumadocs-ui/mdx'; import { Step, Steps } from 'fumadocs-ui/components/steps'; import { File, Folder, Files } from 'fumadocs-ui/components/files'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; const components = { ...defaultMdxComponents, @@ -14,6 +15,8 @@ const components = { Folder, Files, FileTree: Files, + Tab, + Tabs, }; export default async function Page(props: { diff --git a/apps/docs/next.config.mjs b/apps/docs/next.config.mjs index 622c0829a..12116ad4d 100644 --- a/apps/docs/next.config.mjs +++ b/apps/docs/next.config.mjs @@ -18,20 +18,15 @@ const config = { }, ], }, - experimental: { - turbo: { - resolveAlias: { - 'fumadocs-ui/components/callout': 'fumadocs-ui/dist/components/callout.js', - }, - }, - }, webpack: (config, { isServer }) => { // Resolve the fumadocs virtual collection import to the local .source directory config.resolve = config.resolve || {}; config.resolve.alias = { ...(config.resolve.alias || {}), 'fumadocs-mdx:collections': path.resolve(__dirname, '.source'), - 'fumadocs-ui/components/callout$': path.resolve(__dirname, '../../node_modules/fumadocs-ui/dist/components/callout.js'), + 'fumadocs-ui/components/callout$': path.resolve(__dirname, './node_modules/fumadocs-ui/dist/components/callout.js'), + 'fumadocs-ui/components/card$': path.resolve(__dirname, './node_modules/fumadocs-ui/dist/components/card.js'), + 'fumadocs-ui/components/tabs$': path.resolve(__dirname, './node_modules/fumadocs-ui/dist/components/tabs.js'), }; return config; }, From d70e011bc46c7baad5a967b0ac36cbd5d73271ce Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 15:13:36 +0000 Subject: [PATCH 08/10] Remove fumadocs-ui component imports from MDX files Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- apps/docs/next.config.mjs | 1 + apps/docs/package.json | 2 +- content/docs/references/ai/agent/AIKnowledge.mdx | 3 --- content/docs/references/ai/agent/AIModelConfig.mdx | 3 --- content/docs/references/ai/agent/AITool.mdx | 3 --- content/docs/references/ai/agent/Agent.mdx | 3 --- .../docs/references/ai/conversation/ConversationAnalytics.mdx | 3 --- .../docs/references/ai/conversation/ConversationContext.mdx | 3 --- .../docs/references/ai/conversation/ConversationMessage.mdx | 3 --- .../docs/references/ai/conversation/ConversationSession.mdx | 3 --- .../docs/references/ai/conversation/ConversationSummary.mdx | 3 --- content/docs/references/ai/conversation/FunctionCall.mdx | 3 --- content/docs/references/ai/conversation/MessageContent.mdx | 3 --- content/docs/references/ai/conversation/MessageContentType.mdx | 3 --- .../docs/references/ai/conversation/MessagePruningEvent.mdx | 3 --- content/docs/references/ai/conversation/MessageRole.mdx | 3 --- content/docs/references/ai/conversation/TokenBudgetConfig.mdx | 3 --- .../docs/references/ai/conversation/TokenBudgetStrategy.mdx | 3 --- content/docs/references/ai/conversation/TokenUsageStats.mdx | 3 --- content/docs/references/ai/conversation/ToolCall.mdx | 3 --- content/docs/references/ai/cost/BillingPeriod.mdx | 3 --- content/docs/references/ai/cost/BudgetLimit.mdx | 3 --- content/docs/references/ai/cost/BudgetStatus.mdx | 3 --- content/docs/references/ai/cost/BudgetType.mdx | 3 --- content/docs/references/ai/cost/CostAlert.mdx | 3 --- content/docs/references/ai/cost/CostAlertType.mdx | 3 --- content/docs/references/ai/cost/CostAnalytics.mdx | 3 --- content/docs/references/ai/cost/CostBreakdownDimension.mdx | 3 --- content/docs/references/ai/cost/CostBreakdownEntry.mdx | 3 --- content/docs/references/ai/cost/CostEntry.mdx | 3 --- content/docs/references/ai/cost/CostMetricType.mdx | 3 --- .../docs/references/ai/cost/CostOptimizationRecommendation.mdx | 3 --- content/docs/references/ai/cost/CostQueryFilters.mdx | 3 --- content/docs/references/ai/cost/CostReport.mdx | 3 --- content/docs/references/ai/index.mdx | 1 - content/docs/references/ai/model-registry/ModelCapability.mdx | 3 --- content/docs/references/ai/model-registry/ModelConfig.mdx | 3 --- content/docs/references/ai/model-registry/ModelLimits.mdx | 3 --- content/docs/references/ai/model-registry/ModelPricing.mdx | 3 --- content/docs/references/ai/model-registry/ModelProvider.mdx | 3 --- content/docs/references/ai/model-registry/ModelRegistry.mdx | 3 --- .../docs/references/ai/model-registry/ModelRegistryEntry.mdx | 3 --- .../references/ai/model-registry/ModelSelectionCriteria.mdx | 3 --- content/docs/references/ai/model-registry/PromptTemplate.mdx | 3 --- content/docs/references/ai/model-registry/PromptVariable.mdx | 3 --- content/docs/references/ai/nlq/Entity.mdx | 3 --- content/docs/references/ai/nlq/FieldSynonymConfig.mdx | 3 --- content/docs/references/ai/nlq/NLQAnalytics.mdx | 3 --- content/docs/references/ai/nlq/NLQFieldMapping.mdx | 3 --- content/docs/references/ai/nlq/NLQModelConfig.mdx | 3 --- content/docs/references/ai/nlq/NLQParseResult.mdx | 3 --- content/docs/references/ai/nlq/NLQRequest.mdx | 3 --- content/docs/references/ai/nlq/NLQResponse.mdx | 3 --- content/docs/references/ai/nlq/NLQTrainingExample.mdx | 3 --- content/docs/references/ai/nlq/QueryContext.mdx | 3 --- content/docs/references/ai/nlq/QueryIntent.mdx | 3 --- content/docs/references/ai/nlq/QueryTemplate.mdx | 3 --- content/docs/references/ai/nlq/Timeframe.mdx | 3 --- content/docs/references/ai/orchestration/AIOrchestration.mdx | 3 --- .../ai/orchestration/AIOrchestrationExecutionResult.mdx | 3 --- .../references/ai/orchestration/AIOrchestrationTrigger.mdx | 3 --- content/docs/references/ai/orchestration/AITask.mdx | 3 --- content/docs/references/ai/orchestration/AITaskType.mdx | 3 --- .../ai/orchestration/BatchAIOrchestrationExecution.mdx | 3 --- .../docs/references/ai/orchestration/PostProcessingAction.mdx | 3 --- .../references/ai/orchestration/WorkflowFieldCondition.mdx | 3 --- content/docs/references/ai/orchestration/WorkflowSchedule.mdx | 3 --- content/docs/references/ai/predictive/EvaluationMetrics.mdx | 3 --- content/docs/references/ai/predictive/Hyperparameters.mdx | 3 --- content/docs/references/ai/predictive/ModelDrift.mdx | 3 --- content/docs/references/ai/predictive/ModelFeature.mdx | 3 --- content/docs/references/ai/predictive/PredictionRequest.mdx | 3 --- content/docs/references/ai/predictive/PredictionResult.mdx | 3 --- content/docs/references/ai/predictive/PredictiveModel.mdx | 3 --- content/docs/references/ai/predictive/PredictiveModelType.mdx | 3 --- content/docs/references/ai/predictive/TrainingConfig.mdx | 3 --- content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx | 3 --- content/docs/references/ai/rag-pipeline/DocumentChunk.mdx | 3 --- .../docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx | 3 --- content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx | 3 --- content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx | 3 --- content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx | 3 --- content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx | 3 --- content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx | 3 --- content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx | 3 --- content/docs/references/ai/rag-pipeline/RerankingConfig.mdx | 3 --- content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx | 3 --- content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx | 3 --- .../docs/references/ai/rag-pipeline/VectorStoreProvider.mdx | 3 --- content/docs/references/api/contract/ApiError.mdx | 3 --- content/docs/references/api/contract/BaseResponse.mdx | 3 --- content/docs/references/api/contract/BulkRequest.mdx | 3 --- content/docs/references/api/contract/BulkResponse.mdx | 3 --- content/docs/references/api/contract/CreateRequest.mdx | 3 --- content/docs/references/api/contract/DeleteResponse.mdx | 3 --- content/docs/references/api/contract/ExportRequest.mdx | 3 --- content/docs/references/api/contract/ListRecordResponse.mdx | 3 --- content/docs/references/api/contract/ModificationResult.mdx | 3 --- content/docs/references/api/contract/RecordData.mdx | 3 --- content/docs/references/api/contract/SingleRecordResponse.mdx | 3 --- content/docs/references/api/contract/UpdateRequest.mdx | 3 --- content/docs/references/api/discovery/ApiCapabilities.mdx | 3 --- content/docs/references/api/discovery/ApiRoutes.mdx | 3 --- content/docs/references/api/discovery/Discovery.mdx | 3 --- content/docs/references/api/endpoint/ApiEndpoint.mdx | 3 --- content/docs/references/api/endpoint/ApiMapping.mdx | 3 --- content/docs/references/api/endpoint/RateLimit.mdx | 3 --- content/docs/references/api/index.mdx | 1 - content/docs/references/api/odata/ODataError.mdx | 3 --- content/docs/references/api/odata/ODataFilterFunction.mdx | 3 --- content/docs/references/api/odata/ODataFilterOperator.mdx | 3 --- content/docs/references/api/odata/ODataMetadata.mdx | 3 --- content/docs/references/api/odata/ODataQuery.mdx | 3 --- content/docs/references/api/odata/ODataResponse.mdx | 3 --- content/docs/references/api/realtime/Presence.mdx | 3 --- content/docs/references/api/realtime/PresenceStatus.mdx | 3 --- content/docs/references/api/realtime/RealtimeAction.mdx | 3 --- content/docs/references/api/realtime/RealtimeEvent.mdx | 3 --- content/docs/references/api/realtime/RealtimeEventType.mdx | 3 --- content/docs/references/api/realtime/Subscription.mdx | 3 --- content/docs/references/api/realtime/SubscriptionEvent.mdx | 3 --- content/docs/references/api/realtime/TransportProtocol.mdx | 3 --- content/docs/references/api/router/RouteCategory.mdx | 3 --- content/docs/references/api/router/RouteDefinition.mdx | 3 --- content/docs/references/api/router/RouterConfig.mdx | 3 --- content/docs/references/api/view/HttpMethod.mdx | 3 --- content/docs/references/auth/config/AccountLinkingConfig.mdx | 3 --- content/docs/references/auth/config/AuthConfig.mdx | 3 --- content/docs/references/auth/config/AuthPluginConfig.mdx | 3 --- content/docs/references/auth/config/AuthStrategy.mdx | 3 --- content/docs/references/auth/config/CSRFConfig.mdx | 3 --- content/docs/references/auth/config/DatabaseAdapter.mdx | 3 --- content/docs/references/auth/config/DatabaseMapping.mdx | 3 --- content/docs/references/auth/config/EmailPasswordConfig.mdx | 3 --- content/docs/references/auth/config/EnterpriseAuthConfig.mdx | 3 --- content/docs/references/auth/config/LDAPConfig.mdx | 3 --- content/docs/references/auth/config/MagicLinkConfig.mdx | 3 --- content/docs/references/auth/config/OAuthProvider.mdx | 3 --- content/docs/references/auth/config/OIDCConfig.mdx | 3 --- content/docs/references/auth/config/PasskeyConfig.mdx | 3 --- content/docs/references/auth/config/RateLimitConfig.mdx | 3 --- content/docs/references/auth/config/SAMLConfig.mdx | 3 --- content/docs/references/auth/config/SessionConfig.mdx | 3 --- content/docs/references/auth/config/StandardAuthProvider.mdx | 3 --- content/docs/references/auth/config/TwoFactorConfig.mdx | 3 --- content/docs/references/auth/config/UserFieldMapping.mdx | 3 --- content/docs/references/auth/identity/Account.mdx | 3 --- content/docs/references/auth/identity/Session.mdx | 3 --- content/docs/references/auth/identity/User.mdx | 3 --- content/docs/references/auth/identity/VerificationToken.mdx | 3 --- content/docs/references/auth/index.mdx | 1 - content/docs/references/auth/organization/Invitation.mdx | 3 --- content/docs/references/auth/organization/InvitationStatus.mdx | 3 --- content/docs/references/auth/organization/Member.mdx | 3 --- content/docs/references/auth/organization/Organization.mdx | 3 --- content/docs/references/auth/policy/AuditPolicy.mdx | 3 --- content/docs/references/auth/policy/NetworkPolicy.mdx | 3 --- content/docs/references/auth/policy/PasswordPolicy.mdx | 3 --- content/docs/references/auth/policy/Policy.mdx | 3 --- content/docs/references/auth/policy/SessionPolicy.mdx | 3 --- content/docs/references/auth/role/Role.mdx | 3 --- content/docs/references/auth/scim/SCIMAddress.mdx | 3 --- content/docs/references/auth/scim/SCIMEmail.mdx | 3 --- content/docs/references/auth/scim/SCIMEnterpriseUser.mdx | 3 --- content/docs/references/auth/scim/SCIMError.mdx | 3 --- content/docs/references/auth/scim/SCIMGroup.mdx | 3 --- content/docs/references/auth/scim/SCIMGroupReference.mdx | 3 --- content/docs/references/auth/scim/SCIMListResponse.mdx | 3 --- content/docs/references/auth/scim/SCIMMemberReference.mdx | 3 --- content/docs/references/auth/scim/SCIMMeta.mdx | 3 --- content/docs/references/auth/scim/SCIMName.mdx | 3 --- content/docs/references/auth/scim/SCIMPatchOperation.mdx | 3 --- content/docs/references/auth/scim/SCIMPatchRequest.mdx | 3 --- content/docs/references/auth/scim/SCIMPhoneNumber.mdx | 3 --- content/docs/references/auth/scim/SCIMUser.mdx | 3 --- content/docs/references/automation/approval/ApprovalAction.mdx | 3 --- .../docs/references/automation/approval/ApprovalActionType.mdx | 3 --- .../docs/references/automation/approval/ApprovalProcess.mdx | 3 --- content/docs/references/automation/approval/ApprovalStep.mdx | 3 --- content/docs/references/automation/approval/ApproverType.mdx | 3 --- content/docs/references/automation/connector/AuthField.mdx | 3 --- .../docs/references/automation/connector/Authentication.mdx | 3 --- .../references/automation/connector/AuthenticationType.mdx | 3 --- content/docs/references/automation/connector/Connector.mdx | 3 --- .../docs/references/automation/connector/ConnectorCategory.mdx | 3 --- .../docs/references/automation/connector/ConnectorInstance.mdx | 3 --- .../references/automation/connector/ConnectorOperation.mdx | 3 --- .../docs/references/automation/connector/ConnectorTrigger.mdx | 3 --- content/docs/references/automation/connector/OAuth2Config.mdx | 3 --- .../references/automation/connector/OperationParameter.mdx | 3 --- content/docs/references/automation/connector/OperationType.mdx | 3 --- content/docs/references/automation/etl/ETLDestination.mdx | 3 --- content/docs/references/automation/etl/ETLEndpointType.mdx | 3 --- content/docs/references/automation/etl/ETLPipeline.mdx | 3 --- content/docs/references/automation/etl/ETLPipelineRun.mdx | 3 --- content/docs/references/automation/etl/ETLRunStatus.mdx | 3 --- content/docs/references/automation/etl/ETLSource.mdx | 3 --- content/docs/references/automation/etl/ETLSyncMode.mdx | 3 --- content/docs/references/automation/etl/ETLTransformation.mdx | 3 --- .../docs/references/automation/etl/ETLTransformationType.mdx | 3 --- content/docs/references/automation/flow/Flow.mdx | 3 --- content/docs/references/automation/flow/FlowEdge.mdx | 3 --- content/docs/references/automation/flow/FlowNode.mdx | 3 --- content/docs/references/automation/flow/FlowNodeAction.mdx | 3 --- content/docs/references/automation/flow/FlowVariable.mdx | 3 --- content/docs/references/automation/index.mdx | 1 - content/docs/references/automation/mapping/FieldMapping.mdx | 3 --- content/docs/references/automation/sync/ConflictResolution.mdx | 3 --- .../docs/references/automation/sync/DataDestinationConfig.mdx | 3 --- content/docs/references/automation/sync/DataSourceConfig.mdx | 3 --- content/docs/references/automation/sync/DataSyncConfig.mdx | 3 --- content/docs/references/automation/sync/SyncDirection.mdx | 3 --- .../docs/references/automation/sync/SyncExecutionResult.mdx | 3 --- .../docs/references/automation/sync/SyncExecutionStatus.mdx | 3 --- content/docs/references/automation/sync/SyncMode.mdx | 3 --- content/docs/references/automation/webhook/Webhook.mdx | 3 --- content/docs/references/automation/webhook/WebhookReceiver.mdx | 3 --- .../docs/references/automation/webhook/WebhookTriggerType.mdx | 3 --- .../docs/references/automation/workflow/CustomScriptAction.mdx | 3 --- .../docs/references/automation/workflow/EmailAlertAction.mdx | 3 --- .../docs/references/automation/workflow/FieldUpdateAction.mdx | 3 --- content/docs/references/automation/workflow/HttpCallAction.mdx | 3 --- .../references/automation/workflow/PushNotificationAction.mdx | 3 --- .../docs/references/automation/workflow/SlackMessageAction.mdx | 3 --- .../references/automation/workflow/SmsNotificationAction.mdx | 3 --- .../docs/references/automation/workflow/TaskCreationAction.mdx | 3 --- .../docs/references/automation/workflow/TeamsMessageAction.mdx | 3 --- content/docs/references/automation/workflow/TimeTrigger.mdx | 3 --- .../references/automation/workflow/WebhookTriggerAction.mdx | 3 --- content/docs/references/automation/workflow/WorkflowAction.mdx | 3 --- content/docs/references/automation/workflow/WorkflowRule.mdx | 3 --- .../references/automation/workflow/WorkflowTriggerType.mdx | 3 --- content/docs/references/data/dataset/Dataset.mdx | 3 --- content/docs/references/data/dataset/DatasetMode.mdx | 3 --- content/docs/references/data/field/Address.mdx | 3 --- content/docs/references/data/field/CurrencyConfig.mdx | 3 --- content/docs/references/data/field/CurrencyValue.mdx | 3 --- content/docs/references/data/field/Field.mdx | 3 --- content/docs/references/data/field/FieldType.mdx | 3 --- content/docs/references/data/field/LocationCoordinates.mdx | 3 --- content/docs/references/data/field/SelectOption.mdx | 3 --- content/docs/references/data/field/VectorConfig.mdx | 3 --- content/docs/references/data/filter/ComparisonOperator.mdx | 3 --- content/docs/references/data/filter/EqualityOperator.mdx | 3 --- content/docs/references/data/filter/FieldOperators.mdx | 3 --- content/docs/references/data/filter/FieldReference.mdx | 3 --- content/docs/references/data/filter/FilterCondition.mdx | 3 --- content/docs/references/data/filter/NormalizedFilter.mdx | 3 --- content/docs/references/data/filter/QueryFilter.mdx | 3 --- content/docs/references/data/filter/RangeOperator.mdx | 3 --- content/docs/references/data/filter/SetOperator.mdx | 3 --- content/docs/references/data/filter/SpecialOperator.mdx | 3 --- content/docs/references/data/filter/StringOperator.mdx | 3 --- content/docs/references/data/hook/Hook.mdx | 3 --- content/docs/references/data/hook/HookContext.mdx | 3 --- content/docs/references/data/hook/HookEvent.mdx | 3 --- content/docs/references/data/index.mdx | 1 - content/docs/references/data/object/Index.mdx | 3 --- content/docs/references/data/object/Object.mdx | 3 --- content/docs/references/data/object/ObjectCapabilities.mdx | 3 --- content/docs/references/data/object/SearchConfig.mdx | 3 --- content/docs/references/data/query/AggregationFunction.mdx | 3 --- content/docs/references/data/query/AggregationNode.mdx | 3 --- content/docs/references/data/query/FieldNode.mdx | 3 --- content/docs/references/data/query/JoinNode.mdx | 3 --- content/docs/references/data/query/JoinStrategy.mdx | 3 --- content/docs/references/data/query/JoinType.mdx | 3 --- content/docs/references/data/query/Query.mdx | 3 --- content/docs/references/data/query/SortNode.mdx | 3 --- content/docs/references/data/query/WindowFunction.mdx | 3 --- content/docs/references/data/query/WindowFunctionNode.mdx | 3 --- content/docs/references/data/query/WindowSpec.mdx | 3 --- content/docs/references/data/validation/AsyncValidation.mdx | 3 --- .../docs/references/data/validation/ConditionalValidation.mdx | 3 --- .../docs/references/data/validation/CrossFieldValidation.mdx | 3 --- content/docs/references/data/validation/CustomValidator.mdx | 3 --- content/docs/references/data/validation/FormatValidation.mdx | 3 --- content/docs/references/data/validation/JSONValidation.mdx | 3 --- content/docs/references/data/validation/ScriptValidation.mdx | 3 --- .../docs/references/data/validation/StateMachineValidation.mdx | 3 --- .../docs/references/data/validation/UniquenessValidation.mdx | 3 --- content/docs/references/data/validation/ValidationRule.mdx | 3 --- content/docs/references/hub/composer/BillOfMaterials.mdx | 3 --- content/docs/references/hub/composer/ComposerRequest.mdx | 3 --- content/docs/references/hub/composer/ComposerResponse.mdx | 3 --- content/docs/references/hub/composer/ConflictReport.mdx | 3 --- content/docs/references/hub/composer/DependencyRequirement.mdx | 3 --- content/docs/references/hub/index.mdx | 1 - content/docs/references/hub/license/Feature.mdx | 3 --- content/docs/references/hub/license/License.mdx | 3 --- content/docs/references/hub/license/MetricType.mdx | 3 --- content/docs/references/hub/license/Plan.mdx | 3 --- content/docs/references/hub/marketplace/MarketplacePlugin.mdx | 3 --- content/docs/references/hub/marketplace/PluginAuthor.mdx | 3 --- content/docs/references/hub/marketplace/PluginPricing.mdx | 3 --- content/docs/references/hub/space/DeploymentTarget.mdx | 3 --- content/docs/references/hub/space/HubSpace.mdx | 3 --- content/docs/references/hub/space/SpaceSubscription.mdx | 3 --- content/docs/references/hub/space/SubscriptionStatus.mdx | 3 --- .../references/hub/tenant/DatabaseLevelIsolationStrategy.mdx | 3 --- .../references/hub/tenant/LevelIsolationStrategySchema.mdx | 3 --- .../docs/references/hub/tenant/RowLevelIsolationStrategy.mdx | 3 --- content/docs/references/hub/tenant/Tenant.mdx | 3 --- content/docs/references/hub/tenant/TenantIsolationConfig.mdx | 3 --- content/docs/references/hub/tenant/TenantIsolationLevel.mdx | 3 --- content/docs/references/hub/tenant/TenantQuota.mdx | 3 --- content/docs/references/hub/tenant/TenantSecurityPolicy.mdx | 3 --- content/docs/references/index.mdx | 1 - content/docs/references/permission/index.mdx | 1 - .../docs/references/permission/permission/FieldPermission.mdx | 3 --- .../docs/references/permission/permission/ObjectPermission.mdx | 3 --- .../docs/references/permission/permission/PermissionSet.mdx | 3 --- content/docs/references/permission/rls/RLSConfig.mdx | 3 --- content/docs/references/permission/rls/RLSEvaluationResult.mdx | 3 --- content/docs/references/permission/rls/RLSOperation.mdx | 3 --- content/docs/references/permission/rls/RLSUserContext.mdx | 3 --- .../docs/references/permission/rls/RowLevelSecurityPolicy.mdx | 3 --- .../docs/references/permission/sharing/CriteriaSharingRule.mdx | 3 --- content/docs/references/permission/sharing/OWDModel.mdx | 3 --- .../docs/references/permission/sharing/OwnerSharingRule.mdx | 3 --- .../docs/references/permission/sharing/ShareRecipientType.mdx | 3 --- content/docs/references/permission/sharing/SharingLevel.mdx | 3 --- content/docs/references/permission/sharing/SharingRule.mdx | 3 --- content/docs/references/permission/sharing/SharingRuleType.mdx | 3 --- content/docs/references/permission/territory/Territory.mdx | 3 --- .../docs/references/permission/territory/TerritoryModel.mdx | 3 --- content/docs/references/permission/territory/TerritoryType.mdx | 3 --- content/docs/references/protocol-map.mdx | 2 -- content/docs/references/quick-reference.mdx | 2 -- content/docs/references/shared/identifiers/EventName.mdx | 3 --- .../docs/references/shared/identifiers/SnakeCaseIdentifier.mdx | 3 --- .../docs/references/shared/identifiers/SystemIdentifier.mdx | 3 --- content/docs/references/shared/index.mdx | 1 - content/docs/references/system/audit/AuditConfig.mdx | 3 --- content/docs/references/system/audit/AuditEvent.mdx | 3 --- content/docs/references/system/audit/AuditEventActor.mdx | 3 --- content/docs/references/system/audit/AuditEventChange.mdx | 3 --- content/docs/references/system/audit/AuditEventFilter.mdx | 3 --- content/docs/references/system/audit/AuditEventSeverity.mdx | 3 --- content/docs/references/system/audit/AuditEventTarget.mdx | 3 --- content/docs/references/system/audit/AuditEventType.mdx | 3 --- content/docs/references/system/audit/AuditRetentionPolicy.mdx | 3 --- content/docs/references/system/audit/AuditStorageConfig.mdx | 3 --- .../docs/references/system/audit/SuspiciousActivityRule.mdx | 3 --- content/docs/references/system/context/KernelContext.mdx | 3 --- content/docs/references/system/context/RuntimeMode.mdx | 3 --- content/docs/references/system/datasource/Datasource.mdx | 3 --- .../references/system/datasource/DatasourceCapabilities.mdx | 3 --- content/docs/references/system/datasource/DriverDefinition.mdx | 3 --- content/docs/references/system/datasource/DriverType.mdx | 3 --- content/docs/references/system/driver/DriverCapabilities.mdx | 3 --- content/docs/references/system/driver/DriverInterface.mdx | 3 --- content/docs/references/system/driver/DriverOptions.mdx | 3 --- content/docs/references/system/events/Event.mdx | 3 --- content/docs/references/system/events/EventHandler.mdx | 3 --- content/docs/references/system/events/EventMetadata.mdx | 3 --- content/docs/references/system/events/EventPersistence.mdx | 3 --- content/docs/references/system/events/EventRoute.mdx | 3 --- content/docs/references/system/feature/FeatureFlag.mdx | 3 --- content/docs/references/system/feature/FeatureStrategy.mdx | 3 --- content/docs/references/system/index.mdx | 1 - content/docs/references/system/job/CronSchedule.mdx | 3 --- content/docs/references/system/job/IntervalSchedule.mdx | 3 --- content/docs/references/system/job/Job.mdx | 3 --- content/docs/references/system/job/JobExecution.mdx | 3 --- content/docs/references/system/job/JobExecutionStatus.mdx | 3 --- content/docs/references/system/job/OnceSchedule.mdx | 3 --- content/docs/references/system/job/RetryPolicy.mdx | 3 --- content/docs/references/system/job/Schedule.mdx | 3 --- content/docs/references/system/logger/LogEntry.mdx | 3 --- content/docs/references/system/logger/LogFormat.mdx | 3 --- content/docs/references/system/logger/LogLevel.mdx | 3 --- content/docs/references/system/logger/LoggerConfig.mdx | 3 --- content/docs/references/system/manifest/Manifest.mdx | 3 --- content/docs/references/system/misc/MongoConfig.mdx | 3 --- content/docs/references/system/misc/PostgresConfig.mdx | 3 --- content/docs/references/system/plugin/I18nContext.mdx | 3 --- content/docs/references/system/plugin/Logger.mdx | 3 --- content/docs/references/system/plugin/ObjectQLClient.mdx | 3 --- content/docs/references/system/plugin/Plugin.mdx | 3 --- content/docs/references/system/plugin/PluginContext.mdx | 3 --- content/docs/references/system/plugin/PluginLifecycle.mdx | 3 --- content/docs/references/system/plugin/Router.mdx | 3 --- content/docs/references/system/plugin/Scheduler.mdx | 3 --- content/docs/references/system/plugin/ScopedStorage.mdx | 3 --- content/docs/references/system/plugin/SystemAPI.mdx | 3 --- content/docs/references/system/scoped-storage/FileMetadata.mdx | 3 --- .../references/system/scoped-storage/ScopedStorageConfig.mdx | 3 --- .../references/system/scoped-storage/StorageAdapterType.mdx | 3 --- content/docs/references/system/scoped-storage/StorageScope.mdx | 3 --- content/docs/references/system/translation/Locale.mdx | 3 --- .../docs/references/system/translation/TranslationBundle.mdx | 3 --- content/docs/references/system/translation/TranslationData.mdx | 3 --- content/docs/references/ui/action/Action.mdx | 3 --- content/docs/references/ui/action/ActionParam.mdx | 3 --- content/docs/references/ui/app/App.mdx | 3 --- content/docs/references/ui/app/AppBranding.mdx | 3 --- content/docs/references/ui/app/DashboardNavItem.mdx | 3 --- content/docs/references/ui/app/GroupNavItem.mdx | 3 --- content/docs/references/ui/app/NavigationItem.mdx | 3 --- content/docs/references/ui/app/ObjectNavItem.mdx | 3 --- content/docs/references/ui/app/PageNavItem.mdx | 3 --- content/docs/references/ui/app/UrlNavItem.mdx | 3 --- content/docs/references/ui/component/PageCardProps.mdx | 3 --- content/docs/references/ui/component/PageHeaderProps.mdx | 3 --- content/docs/references/ui/component/PageTabsProps.mdx | 3 --- content/docs/references/ui/component/RecordDetailsProps.mdx | 3 --- content/docs/references/ui/component/RecordHighlightsProps.mdx | 3 --- .../docs/references/ui/component/RecordRelatedListProps.mdx | 3 --- content/docs/references/ui/dashboard/ChartType.mdx | 3 --- content/docs/references/ui/dashboard/Dashboard.mdx | 3 --- content/docs/references/ui/dashboard/DashboardWidget.mdx | 3 --- content/docs/references/ui/index.mdx | 1 - content/docs/references/ui/page/Page.mdx | 3 --- content/docs/references/ui/page/PageComponent.mdx | 3 --- content/docs/references/ui/page/PageComponentType.mdx | 3 --- content/docs/references/ui/page/PageRegion.mdx | 3 --- content/docs/references/ui/report/Report.mdx | 3 --- content/docs/references/ui/report/ReportChart.mdx | 3 --- content/docs/references/ui/report/ReportColumn.mdx | 3 --- content/docs/references/ui/report/ReportGrouping.mdx | 3 --- content/docs/references/ui/report/ReportType.mdx | 3 --- content/docs/references/ui/theme/Animation.mdx | 3 --- content/docs/references/ui/theme/BorderRadius.mdx | 3 --- content/docs/references/ui/theme/Breakpoints.mdx | 3 --- content/docs/references/ui/theme/ColorPalette.mdx | 3 --- content/docs/references/ui/theme/Shadow.mdx | 3 --- content/docs/references/ui/theme/Spacing.mdx | 3 --- content/docs/references/ui/theme/Theme.mdx | 3 --- content/docs/references/ui/theme/ThemeMode.mdx | 3 --- content/docs/references/ui/theme/Typography.mdx | 3 --- content/docs/references/ui/theme/ZIndex.mdx | 3 --- content/docs/references/ui/view/CalendarConfig.mdx | 3 --- content/docs/references/ui/view/FormField.mdx | 3 --- content/docs/references/ui/view/FormSection.mdx | 3 --- content/docs/references/ui/view/FormView.mdx | 3 --- content/docs/references/ui/view/GanttConfig.mdx | 3 --- content/docs/references/ui/view/HttpMethod.mdx | 3 --- content/docs/references/ui/view/HttpRequest.mdx | 3 --- content/docs/references/ui/view/KanbanConfig.mdx | 3 --- content/docs/references/ui/view/ListColumn.mdx | 3 --- content/docs/references/ui/view/ListView.mdx | 3 --- content/docs/references/ui/view/PaginationConfig.mdx | 3 --- content/docs/references/ui/view/SelectionConfig.mdx | 3 --- content/docs/references/ui/view/View.mdx | 3 --- content/docs/references/ui/view/ViewData.mdx | 3 --- content/docs/references/ui/widget/FieldWidgetProps.mdx | 3 --- content/docs/references/ui/widget/WidgetEvent.mdx | 3 --- content/docs/references/ui/widget/WidgetLifecycle.mdx | 3 --- content/docs/references/ui/widget/WidgetManifest.mdx | 3 --- content/docs/references/ui/widget/WidgetProperty.mdx | 3 --- 451 files changed, 2 insertions(+), 1324 deletions(-) diff --git a/apps/docs/next.config.mjs b/apps/docs/next.config.mjs index 12116ad4d..d4af6c5da 100644 --- a/apps/docs/next.config.mjs +++ b/apps/docs/next.config.mjs @@ -27,6 +27,7 @@ const config = { 'fumadocs-ui/components/callout$': path.resolve(__dirname, './node_modules/fumadocs-ui/dist/components/callout.js'), 'fumadocs-ui/components/card$': path.resolve(__dirname, './node_modules/fumadocs-ui/dist/components/card.js'), 'fumadocs-ui/components/tabs$': path.resolve(__dirname, './node_modules/fumadocs-ui/dist/components/tabs.js'), + 'lucide-react$': path.resolve(__dirname, './node_modules/lucide-react/dist/cjs/lucide-react.js'), }; return config; }, diff --git a/apps/docs/package.json b/apps/docs/package.json index e3b17a5cd..fb852dc3a 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -5,7 +5,7 @@ "description": "ObjectStack Protocol Documentation Site", "scripts": { "dev": "next dev", - "build": "NEXT_PRIVATE_BUILD_WORKER=1 next build", + "build": "next build", "site:start": "next start", "site:lint": "next lint" }, diff --git a/content/docs/references/ai/agent/AIKnowledge.mdx b/content/docs/references/ai/agent/AIKnowledge.mdx index 2e63e5193..0655a9c85 100644 --- a/content/docs/references/ai/agent/AIKnowledge.mdx +++ b/content/docs/references/ai/agent/AIKnowledge.mdx @@ -5,9 +5,6 @@ category: ai zodFile: agent --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/agent.zod.ts` diff --git a/content/docs/references/ai/agent/AIModelConfig.mdx b/content/docs/references/ai/agent/AIModelConfig.mdx index ddcc59a9e..1cc2ec8ee 100644 --- a/content/docs/references/ai/agent/AIModelConfig.mdx +++ b/content/docs/references/ai/agent/AIModelConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: agent --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/agent.zod.ts` diff --git a/content/docs/references/ai/agent/AITool.mdx b/content/docs/references/ai/agent/AITool.mdx index db933da0d..979a14bdf 100644 --- a/content/docs/references/ai/agent/AITool.mdx +++ b/content/docs/references/ai/agent/AITool.mdx @@ -5,9 +5,6 @@ category: ai zodFile: agent --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/agent.zod.ts` diff --git a/content/docs/references/ai/agent/Agent.mdx b/content/docs/references/ai/agent/Agent.mdx index 1271db73f..9fef37ca9 100644 --- a/content/docs/references/ai/agent/Agent.mdx +++ b/content/docs/references/ai/agent/Agent.mdx @@ -5,9 +5,6 @@ category: ai zodFile: agent --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/agent.zod.ts` diff --git a/content/docs/references/ai/conversation/ConversationAnalytics.mdx b/content/docs/references/ai/conversation/ConversationAnalytics.mdx index 91b289b22..15f930ad8 100644 --- a/content/docs/references/ai/conversation/ConversationAnalytics.mdx +++ b/content/docs/references/ai/conversation/ConversationAnalytics.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/ConversationContext.mdx b/content/docs/references/ai/conversation/ConversationContext.mdx index dd6ece4df..990363b75 100644 --- a/content/docs/references/ai/conversation/ConversationContext.mdx +++ b/content/docs/references/ai/conversation/ConversationContext.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/ConversationMessage.mdx b/content/docs/references/ai/conversation/ConversationMessage.mdx index c72116b76..deeb4cfef 100644 --- a/content/docs/references/ai/conversation/ConversationMessage.mdx +++ b/content/docs/references/ai/conversation/ConversationMessage.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/ConversationSession.mdx b/content/docs/references/ai/conversation/ConversationSession.mdx index 1db27eed2..392f83f2a 100644 --- a/content/docs/references/ai/conversation/ConversationSession.mdx +++ b/content/docs/references/ai/conversation/ConversationSession.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/ConversationSummary.mdx b/content/docs/references/ai/conversation/ConversationSummary.mdx index 6b54e71ae..205447df5 100644 --- a/content/docs/references/ai/conversation/ConversationSummary.mdx +++ b/content/docs/references/ai/conversation/ConversationSummary.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/FunctionCall.mdx b/content/docs/references/ai/conversation/FunctionCall.mdx index 4f1a2cf2b..08ef1ae1a 100644 --- a/content/docs/references/ai/conversation/FunctionCall.mdx +++ b/content/docs/references/ai/conversation/FunctionCall.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/MessageContent.mdx b/content/docs/references/ai/conversation/MessageContent.mdx index d3e5b2791..32b11691a 100644 --- a/content/docs/references/ai/conversation/MessageContent.mdx +++ b/content/docs/references/ai/conversation/MessageContent.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/MessageContentType.mdx b/content/docs/references/ai/conversation/MessageContentType.mdx index 65edf6751..53181917b 100644 --- a/content/docs/references/ai/conversation/MessageContentType.mdx +++ b/content/docs/references/ai/conversation/MessageContentType.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/MessagePruningEvent.mdx b/content/docs/references/ai/conversation/MessagePruningEvent.mdx index bc8a17584..1bf74de60 100644 --- a/content/docs/references/ai/conversation/MessagePruningEvent.mdx +++ b/content/docs/references/ai/conversation/MessagePruningEvent.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/MessageRole.mdx b/content/docs/references/ai/conversation/MessageRole.mdx index daba810d3..b64841739 100644 --- a/content/docs/references/ai/conversation/MessageRole.mdx +++ b/content/docs/references/ai/conversation/MessageRole.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/TokenBudgetConfig.mdx b/content/docs/references/ai/conversation/TokenBudgetConfig.mdx index 172184276..229164ae7 100644 --- a/content/docs/references/ai/conversation/TokenBudgetConfig.mdx +++ b/content/docs/references/ai/conversation/TokenBudgetConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx b/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx index 1d189f356..0742bd3ef 100644 --- a/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx +++ b/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/TokenUsageStats.mdx b/content/docs/references/ai/conversation/TokenUsageStats.mdx index 6698f641d..3147eb6b7 100644 --- a/content/docs/references/ai/conversation/TokenUsageStats.mdx +++ b/content/docs/references/ai/conversation/TokenUsageStats.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/conversation/ToolCall.mdx b/content/docs/references/ai/conversation/ToolCall.mdx index 1d7ae2f73..e5a6f1d5a 100644 --- a/content/docs/references/ai/conversation/ToolCall.mdx +++ b/content/docs/references/ai/conversation/ToolCall.mdx @@ -5,9 +5,6 @@ category: ai zodFile: conversation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/conversation.zod.ts` diff --git a/content/docs/references/ai/cost/BillingPeriod.mdx b/content/docs/references/ai/cost/BillingPeriod.mdx index 45eb14955..79edfd7ac 100644 --- a/content/docs/references/ai/cost/BillingPeriod.mdx +++ b/content/docs/references/ai/cost/BillingPeriod.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/BudgetLimit.mdx b/content/docs/references/ai/cost/BudgetLimit.mdx index 22eab2039..4b5cee994 100644 --- a/content/docs/references/ai/cost/BudgetLimit.mdx +++ b/content/docs/references/ai/cost/BudgetLimit.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/BudgetStatus.mdx b/content/docs/references/ai/cost/BudgetStatus.mdx index 4837df17f..a164bd95c 100644 --- a/content/docs/references/ai/cost/BudgetStatus.mdx +++ b/content/docs/references/ai/cost/BudgetStatus.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/BudgetType.mdx b/content/docs/references/ai/cost/BudgetType.mdx index 84eb4ad91..cef8cc7e6 100644 --- a/content/docs/references/ai/cost/BudgetType.mdx +++ b/content/docs/references/ai/cost/BudgetType.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostAlert.mdx b/content/docs/references/ai/cost/CostAlert.mdx index de0e05180..731ad848f 100644 --- a/content/docs/references/ai/cost/CostAlert.mdx +++ b/content/docs/references/ai/cost/CostAlert.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostAlertType.mdx b/content/docs/references/ai/cost/CostAlertType.mdx index cbc04be87..f05486f6c 100644 --- a/content/docs/references/ai/cost/CostAlertType.mdx +++ b/content/docs/references/ai/cost/CostAlertType.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostAnalytics.mdx b/content/docs/references/ai/cost/CostAnalytics.mdx index fe50740b1..496116f51 100644 --- a/content/docs/references/ai/cost/CostAnalytics.mdx +++ b/content/docs/references/ai/cost/CostAnalytics.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostBreakdownDimension.mdx b/content/docs/references/ai/cost/CostBreakdownDimension.mdx index 63638bd06..279ee1ec5 100644 --- a/content/docs/references/ai/cost/CostBreakdownDimension.mdx +++ b/content/docs/references/ai/cost/CostBreakdownDimension.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostBreakdownEntry.mdx b/content/docs/references/ai/cost/CostBreakdownEntry.mdx index 19c61ffac..66eeae0f1 100644 --- a/content/docs/references/ai/cost/CostBreakdownEntry.mdx +++ b/content/docs/references/ai/cost/CostBreakdownEntry.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostEntry.mdx b/content/docs/references/ai/cost/CostEntry.mdx index 0b6b41242..952087b64 100644 --- a/content/docs/references/ai/cost/CostEntry.mdx +++ b/content/docs/references/ai/cost/CostEntry.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostMetricType.mdx b/content/docs/references/ai/cost/CostMetricType.mdx index 6e93b4e1d..91f0baf81 100644 --- a/content/docs/references/ai/cost/CostMetricType.mdx +++ b/content/docs/references/ai/cost/CostMetricType.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx index 935a28e1d..a5d1156f9 100644 --- a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx +++ b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostQueryFilters.mdx b/content/docs/references/ai/cost/CostQueryFilters.mdx index 2831c9a92..248a489c4 100644 --- a/content/docs/references/ai/cost/CostQueryFilters.mdx +++ b/content/docs/references/ai/cost/CostQueryFilters.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/cost/CostReport.mdx b/content/docs/references/ai/cost/CostReport.mdx index c740b3305..984a63f5c 100644 --- a/content/docs/references/ai/cost/CostReport.mdx +++ b/content/docs/references/ai/cost/CostReport.mdx @@ -5,9 +5,6 @@ category: ai zodFile: cost --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/cost.zod.ts` diff --git a/content/docs/references/ai/index.mdx b/content/docs/references/ai/index.mdx index 5cc82d258..2d8212b89 100644 --- a/content/docs/references/ai/index.mdx +++ b/content/docs/references/ai/index.mdx @@ -3,7 +3,6 @@ title: AI Protocol Overview description: Complete reference for all ai protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # AI Protocol diff --git a/content/docs/references/ai/model-registry/ModelCapability.mdx b/content/docs/references/ai/model-registry/ModelCapability.mdx index 69c826e81..e5a65992c 100644 --- a/content/docs/references/ai/model-registry/ModelCapability.mdx +++ b/content/docs/references/ai/model-registry/ModelCapability.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelConfig.mdx b/content/docs/references/ai/model-registry/ModelConfig.mdx index 1147ac7d0..759c80fcc 100644 --- a/content/docs/references/ai/model-registry/ModelConfig.mdx +++ b/content/docs/references/ai/model-registry/ModelConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelLimits.mdx b/content/docs/references/ai/model-registry/ModelLimits.mdx index be041e553..98ac6c2c6 100644 --- a/content/docs/references/ai/model-registry/ModelLimits.mdx +++ b/content/docs/references/ai/model-registry/ModelLimits.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelPricing.mdx b/content/docs/references/ai/model-registry/ModelPricing.mdx index 4c2d52635..2ce149c42 100644 --- a/content/docs/references/ai/model-registry/ModelPricing.mdx +++ b/content/docs/references/ai/model-registry/ModelPricing.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelProvider.mdx b/content/docs/references/ai/model-registry/ModelProvider.mdx index b02a9d0c0..754b21236 100644 --- a/content/docs/references/ai/model-registry/ModelProvider.mdx +++ b/content/docs/references/ai/model-registry/ModelProvider.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelRegistry.mdx b/content/docs/references/ai/model-registry/ModelRegistry.mdx index 32ed05894..d927741c8 100644 --- a/content/docs/references/ai/model-registry/ModelRegistry.mdx +++ b/content/docs/references/ai/model-registry/ModelRegistry.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx b/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx index c744cfa4e..a33563e0e 100644 --- a/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx +++ b/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx b/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx index 7a3e7de26..8d9352eeb 100644 --- a/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx +++ b/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/PromptTemplate.mdx b/content/docs/references/ai/model-registry/PromptTemplate.mdx index d2d5d5d56..b723a8d94 100644 --- a/content/docs/references/ai/model-registry/PromptTemplate.mdx +++ b/content/docs/references/ai/model-registry/PromptTemplate.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/model-registry/PromptVariable.mdx b/content/docs/references/ai/model-registry/PromptVariable.mdx index 4ea187d8b..c281ed0a1 100644 --- a/content/docs/references/ai/model-registry/PromptVariable.mdx +++ b/content/docs/references/ai/model-registry/PromptVariable.mdx @@ -5,9 +5,6 @@ category: ai zodFile: model-registry --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/model-registry.zod.ts` diff --git a/content/docs/references/ai/nlq/Entity.mdx b/content/docs/references/ai/nlq/Entity.mdx index eb3336da9..f4ff57734 100644 --- a/content/docs/references/ai/nlq/Entity.mdx +++ b/content/docs/references/ai/nlq/Entity.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/FieldSynonymConfig.mdx b/content/docs/references/ai/nlq/FieldSynonymConfig.mdx index b4f0ac8cf..d5ac00d58 100644 --- a/content/docs/references/ai/nlq/FieldSynonymConfig.mdx +++ b/content/docs/references/ai/nlq/FieldSynonymConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQAnalytics.mdx b/content/docs/references/ai/nlq/NLQAnalytics.mdx index b0ffe005c..d1c75443b 100644 --- a/content/docs/references/ai/nlq/NLQAnalytics.mdx +++ b/content/docs/references/ai/nlq/NLQAnalytics.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQFieldMapping.mdx b/content/docs/references/ai/nlq/NLQFieldMapping.mdx index d91622027..21433ce35 100644 --- a/content/docs/references/ai/nlq/NLQFieldMapping.mdx +++ b/content/docs/references/ai/nlq/NLQFieldMapping.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQModelConfig.mdx b/content/docs/references/ai/nlq/NLQModelConfig.mdx index ce0422141..e041a9c19 100644 --- a/content/docs/references/ai/nlq/NLQModelConfig.mdx +++ b/content/docs/references/ai/nlq/NLQModelConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQParseResult.mdx b/content/docs/references/ai/nlq/NLQParseResult.mdx index 2c639990a..28f8ddef6 100644 --- a/content/docs/references/ai/nlq/NLQParseResult.mdx +++ b/content/docs/references/ai/nlq/NLQParseResult.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQRequest.mdx b/content/docs/references/ai/nlq/NLQRequest.mdx index 115fcf458..bb7f4d97f 100644 --- a/content/docs/references/ai/nlq/NLQRequest.mdx +++ b/content/docs/references/ai/nlq/NLQRequest.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQResponse.mdx b/content/docs/references/ai/nlq/NLQResponse.mdx index 2629d03a1..3997880fe 100644 --- a/content/docs/references/ai/nlq/NLQResponse.mdx +++ b/content/docs/references/ai/nlq/NLQResponse.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/NLQTrainingExample.mdx b/content/docs/references/ai/nlq/NLQTrainingExample.mdx index c7f62046f..83861737e 100644 --- a/content/docs/references/ai/nlq/NLQTrainingExample.mdx +++ b/content/docs/references/ai/nlq/NLQTrainingExample.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/QueryContext.mdx b/content/docs/references/ai/nlq/QueryContext.mdx index 9c286db6b..0216cdebb 100644 --- a/content/docs/references/ai/nlq/QueryContext.mdx +++ b/content/docs/references/ai/nlq/QueryContext.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/QueryIntent.mdx b/content/docs/references/ai/nlq/QueryIntent.mdx index 0309d0423..a99eb4724 100644 --- a/content/docs/references/ai/nlq/QueryIntent.mdx +++ b/content/docs/references/ai/nlq/QueryIntent.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/QueryTemplate.mdx b/content/docs/references/ai/nlq/QueryTemplate.mdx index 36dabfd60..3ab57de06 100644 --- a/content/docs/references/ai/nlq/QueryTemplate.mdx +++ b/content/docs/references/ai/nlq/QueryTemplate.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/nlq/Timeframe.mdx b/content/docs/references/ai/nlq/Timeframe.mdx index 111fba0f9..0a24d4b74 100644 --- a/content/docs/references/ai/nlq/Timeframe.mdx +++ b/content/docs/references/ai/nlq/Timeframe.mdx @@ -5,9 +5,6 @@ category: ai zodFile: nlq --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/nlq.zod.ts` diff --git a/content/docs/references/ai/orchestration/AIOrchestration.mdx b/content/docs/references/ai/orchestration/AIOrchestration.mdx index eda23bc0a..2c713123d 100644 --- a/content/docs/references/ai/orchestration/AIOrchestration.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestration.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx index 2761fde3e..7592d50c7 100644 --- a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx b/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx index bbfebd981..c98afdb58 100644 --- a/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx +++ b/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/AITask.mdx b/content/docs/references/ai/orchestration/AITask.mdx index 2e54428ec..ac7ad8eff 100644 --- a/content/docs/references/ai/orchestration/AITask.mdx +++ b/content/docs/references/ai/orchestration/AITask.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/AITaskType.mdx b/content/docs/references/ai/orchestration/AITaskType.mdx index 8511464c5..608cbb409 100644 --- a/content/docs/references/ai/orchestration/AITaskType.mdx +++ b/content/docs/references/ai/orchestration/AITaskType.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx b/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx index 459712f2e..a96c359c8 100644 --- a/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx +++ b/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/PostProcessingAction.mdx b/content/docs/references/ai/orchestration/PostProcessingAction.mdx index 87e1e6661..d1aa65973 100644 --- a/content/docs/references/ai/orchestration/PostProcessingAction.mdx +++ b/content/docs/references/ai/orchestration/PostProcessingAction.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx b/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx index 079cf963e..992f27998 100644 --- a/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx +++ b/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/orchestration/WorkflowSchedule.mdx b/content/docs/references/ai/orchestration/WorkflowSchedule.mdx index 57a2be24e..e51403547 100644 --- a/content/docs/references/ai/orchestration/WorkflowSchedule.mdx +++ b/content/docs/references/ai/orchestration/WorkflowSchedule.mdx @@ -5,9 +5,6 @@ category: ai zodFile: orchestration --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/orchestration.zod.ts` diff --git a/content/docs/references/ai/predictive/EvaluationMetrics.mdx b/content/docs/references/ai/predictive/EvaluationMetrics.mdx index 4d56190a1..9d05509d0 100644 --- a/content/docs/references/ai/predictive/EvaluationMetrics.mdx +++ b/content/docs/references/ai/predictive/EvaluationMetrics.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/Hyperparameters.mdx b/content/docs/references/ai/predictive/Hyperparameters.mdx index 70f06f94e..03ad72791 100644 --- a/content/docs/references/ai/predictive/Hyperparameters.mdx +++ b/content/docs/references/ai/predictive/Hyperparameters.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/ModelDrift.mdx b/content/docs/references/ai/predictive/ModelDrift.mdx index ce570b847..873c109e1 100644 --- a/content/docs/references/ai/predictive/ModelDrift.mdx +++ b/content/docs/references/ai/predictive/ModelDrift.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/ModelFeature.mdx b/content/docs/references/ai/predictive/ModelFeature.mdx index a3bc12a65..e7640e6f7 100644 --- a/content/docs/references/ai/predictive/ModelFeature.mdx +++ b/content/docs/references/ai/predictive/ModelFeature.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/PredictionRequest.mdx b/content/docs/references/ai/predictive/PredictionRequest.mdx index ed9dac76e..c8065d43a 100644 --- a/content/docs/references/ai/predictive/PredictionRequest.mdx +++ b/content/docs/references/ai/predictive/PredictionRequest.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/PredictionResult.mdx b/content/docs/references/ai/predictive/PredictionResult.mdx index 67dc621db..3be121497 100644 --- a/content/docs/references/ai/predictive/PredictionResult.mdx +++ b/content/docs/references/ai/predictive/PredictionResult.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/PredictiveModel.mdx b/content/docs/references/ai/predictive/PredictiveModel.mdx index 8559112ec..fbe2ccfca 100644 --- a/content/docs/references/ai/predictive/PredictiveModel.mdx +++ b/content/docs/references/ai/predictive/PredictiveModel.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/PredictiveModelType.mdx b/content/docs/references/ai/predictive/PredictiveModelType.mdx index 4903d97a0..285ecc8de 100644 --- a/content/docs/references/ai/predictive/PredictiveModelType.mdx +++ b/content/docs/references/ai/predictive/PredictiveModelType.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/predictive/TrainingConfig.mdx b/content/docs/references/ai/predictive/TrainingConfig.mdx index c83782713..38a3df087 100644 --- a/content/docs/references/ai/predictive/TrainingConfig.mdx +++ b/content/docs/references/ai/predictive/TrainingConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: predictive --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/predictive.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx b/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx index 391850c42..aa35e44af 100644 --- a/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx +++ b/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx index f3f4c56d8..effb3617e 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx b/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx index 34321bea0..713b601cb 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx b/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx index 2b139db62..778eaae6b 100644 --- a/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx +++ b/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx b/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx index a89d0cc90..17de427b0 100644 --- a/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx +++ b/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx index 1e289670c..eddcfc3a3 100644 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx index c39d5ef55..7eec63404 100644 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx b/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx index 6cbb91931..0415441c0 100644 --- a/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx b/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx index 30cb6ba5a..8f7a06bb9 100644 --- a/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx +++ b/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx b/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx index 8289a0005..13f2c94c8 100644 --- a/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx b/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx index 3614a66fe..4368653dd 100644 --- a/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx +++ b/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx b/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx index c4172f740..824af54c4 100644 --- a/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx +++ b/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx b/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx index 73fcdcfea..2d456310c 100644 --- a/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx +++ b/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx @@ -5,9 +5,6 @@ category: ai zodFile: rag-pipeline --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` diff --git a/content/docs/references/api/contract/ApiError.mdx b/content/docs/references/api/contract/ApiError.mdx index 2b8f997bf..11ca539ed 100644 --- a/content/docs/references/api/contract/ApiError.mdx +++ b/content/docs/references/api/contract/ApiError.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/BaseResponse.mdx b/content/docs/references/api/contract/BaseResponse.mdx index 004796d76..18c99aacc 100644 --- a/content/docs/references/api/contract/BaseResponse.mdx +++ b/content/docs/references/api/contract/BaseResponse.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/BulkRequest.mdx b/content/docs/references/api/contract/BulkRequest.mdx index ba47b0832..9917c09f1 100644 --- a/content/docs/references/api/contract/BulkRequest.mdx +++ b/content/docs/references/api/contract/BulkRequest.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/BulkResponse.mdx b/content/docs/references/api/contract/BulkResponse.mdx index 6c5a29619..3c2a00ca6 100644 --- a/content/docs/references/api/contract/BulkResponse.mdx +++ b/content/docs/references/api/contract/BulkResponse.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/CreateRequest.mdx b/content/docs/references/api/contract/CreateRequest.mdx index 222c07ce3..7ba9ed808 100644 --- a/content/docs/references/api/contract/CreateRequest.mdx +++ b/content/docs/references/api/contract/CreateRequest.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/DeleteResponse.mdx b/content/docs/references/api/contract/DeleteResponse.mdx index 9a74b3b5f..b6f5b691a 100644 --- a/content/docs/references/api/contract/DeleteResponse.mdx +++ b/content/docs/references/api/contract/DeleteResponse.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/ExportRequest.mdx b/content/docs/references/api/contract/ExportRequest.mdx index b6f153c77..4b3d51b55 100644 --- a/content/docs/references/api/contract/ExportRequest.mdx +++ b/content/docs/references/api/contract/ExportRequest.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/ListRecordResponse.mdx b/content/docs/references/api/contract/ListRecordResponse.mdx index 22f01f1d5..ccfa95b7c 100644 --- a/content/docs/references/api/contract/ListRecordResponse.mdx +++ b/content/docs/references/api/contract/ListRecordResponse.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/ModificationResult.mdx b/content/docs/references/api/contract/ModificationResult.mdx index f48f9bc5c..24af2997b 100644 --- a/content/docs/references/api/contract/ModificationResult.mdx +++ b/content/docs/references/api/contract/ModificationResult.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/RecordData.mdx b/content/docs/references/api/contract/RecordData.mdx index 06470f3c0..8d5c4150e 100644 --- a/content/docs/references/api/contract/RecordData.mdx +++ b/content/docs/references/api/contract/RecordData.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Key-value map of record data diff --git a/content/docs/references/api/contract/SingleRecordResponse.mdx b/content/docs/references/api/contract/SingleRecordResponse.mdx index e9b4bf2c0..f12cbb503 100644 --- a/content/docs/references/api/contract/SingleRecordResponse.mdx +++ b/content/docs/references/api/contract/SingleRecordResponse.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/contract/UpdateRequest.mdx b/content/docs/references/api/contract/UpdateRequest.mdx index 93eebd555..3de9be142 100644 --- a/content/docs/references/api/contract/UpdateRequest.mdx +++ b/content/docs/references/api/contract/UpdateRequest.mdx @@ -5,9 +5,6 @@ category: api zodFile: contract --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/contract.zod.ts` diff --git a/content/docs/references/api/discovery/ApiCapabilities.mdx b/content/docs/references/api/discovery/ApiCapabilities.mdx index 87354d3a7..ac92b5da9 100644 --- a/content/docs/references/api/discovery/ApiCapabilities.mdx +++ b/content/docs/references/api/discovery/ApiCapabilities.mdx @@ -5,9 +5,6 @@ category: api zodFile: discovery --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/discovery.zod.ts` diff --git a/content/docs/references/api/discovery/ApiRoutes.mdx b/content/docs/references/api/discovery/ApiRoutes.mdx index 238b10ecf..4452f67c7 100644 --- a/content/docs/references/api/discovery/ApiRoutes.mdx +++ b/content/docs/references/api/discovery/ApiRoutes.mdx @@ -5,9 +5,6 @@ category: api zodFile: discovery --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/discovery.zod.ts` diff --git a/content/docs/references/api/discovery/Discovery.mdx b/content/docs/references/api/discovery/Discovery.mdx index c89fa696a..78bf7bc75 100644 --- a/content/docs/references/api/discovery/Discovery.mdx +++ b/content/docs/references/api/discovery/Discovery.mdx @@ -5,9 +5,6 @@ category: api zodFile: discovery --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/discovery.zod.ts` diff --git a/content/docs/references/api/endpoint/ApiEndpoint.mdx b/content/docs/references/api/endpoint/ApiEndpoint.mdx index d61a623a0..9d283de5a 100644 --- a/content/docs/references/api/endpoint/ApiEndpoint.mdx +++ b/content/docs/references/api/endpoint/ApiEndpoint.mdx @@ -5,9 +5,6 @@ category: api zodFile: endpoint --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/endpoint.zod.ts` diff --git a/content/docs/references/api/endpoint/ApiMapping.mdx b/content/docs/references/api/endpoint/ApiMapping.mdx index 37c8f5480..5aa45328a 100644 --- a/content/docs/references/api/endpoint/ApiMapping.mdx +++ b/content/docs/references/api/endpoint/ApiMapping.mdx @@ -5,9 +5,6 @@ category: api zodFile: endpoint --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/endpoint.zod.ts` diff --git a/content/docs/references/api/endpoint/RateLimit.mdx b/content/docs/references/api/endpoint/RateLimit.mdx index 2af59d4a1..666c45f54 100644 --- a/content/docs/references/api/endpoint/RateLimit.mdx +++ b/content/docs/references/api/endpoint/RateLimit.mdx @@ -5,9 +5,6 @@ category: api zodFile: endpoint --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/endpoint.zod.ts` diff --git a/content/docs/references/api/index.mdx b/content/docs/references/api/index.mdx index 278c8ad12..b62c9e521 100644 --- a/content/docs/references/api/index.mdx +++ b/content/docs/references/api/index.mdx @@ -3,7 +3,6 @@ title: API Protocol Overview description: Complete reference for all api protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # API Protocol diff --git a/content/docs/references/api/odata/ODataError.mdx b/content/docs/references/api/odata/ODataError.mdx index f4dfbfd0e..cc814f826 100644 --- a/content/docs/references/api/odata/ODataError.mdx +++ b/content/docs/references/api/odata/ODataError.mdx @@ -5,9 +5,6 @@ category: api zodFile: odata --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/odata.zod.ts` diff --git a/content/docs/references/api/odata/ODataFilterFunction.mdx b/content/docs/references/api/odata/ODataFilterFunction.mdx index cc41ae1cd..4d67ed223 100644 --- a/content/docs/references/api/odata/ODataFilterFunction.mdx +++ b/content/docs/references/api/odata/ODataFilterFunction.mdx @@ -5,9 +5,6 @@ category: api zodFile: odata --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/odata.zod.ts` diff --git a/content/docs/references/api/odata/ODataFilterOperator.mdx b/content/docs/references/api/odata/ODataFilterOperator.mdx index fedc3d61a..869831ae7 100644 --- a/content/docs/references/api/odata/ODataFilterOperator.mdx +++ b/content/docs/references/api/odata/ODataFilterOperator.mdx @@ -5,9 +5,6 @@ category: api zodFile: odata --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/odata.zod.ts` diff --git a/content/docs/references/api/odata/ODataMetadata.mdx b/content/docs/references/api/odata/ODataMetadata.mdx index b589f9f0f..071895b9e 100644 --- a/content/docs/references/api/odata/ODataMetadata.mdx +++ b/content/docs/references/api/odata/ODataMetadata.mdx @@ -5,9 +5,6 @@ category: api zodFile: odata --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/odata.zod.ts` diff --git a/content/docs/references/api/odata/ODataQuery.mdx b/content/docs/references/api/odata/ODataQuery.mdx index d881c84af..47d7aa01a 100644 --- a/content/docs/references/api/odata/ODataQuery.mdx +++ b/content/docs/references/api/odata/ODataQuery.mdx @@ -5,9 +5,6 @@ category: api zodFile: odata --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/odata.zod.ts` diff --git a/content/docs/references/api/odata/ODataResponse.mdx b/content/docs/references/api/odata/ODataResponse.mdx index 63b357e1a..ed59f747e 100644 --- a/content/docs/references/api/odata/ODataResponse.mdx +++ b/content/docs/references/api/odata/ODataResponse.mdx @@ -5,9 +5,6 @@ category: api zodFile: odata --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/odata.zod.ts` diff --git a/content/docs/references/api/realtime/Presence.mdx b/content/docs/references/api/realtime/Presence.mdx index a3475d126..9664a28c8 100644 --- a/content/docs/references/api/realtime/Presence.mdx +++ b/content/docs/references/api/realtime/Presence.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/PresenceStatus.mdx b/content/docs/references/api/realtime/PresenceStatus.mdx index e668a8cf8..9dd97e3f7 100644 --- a/content/docs/references/api/realtime/PresenceStatus.mdx +++ b/content/docs/references/api/realtime/PresenceStatus.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/RealtimeAction.mdx b/content/docs/references/api/realtime/RealtimeAction.mdx index 7993df9c3..62ab17dc5 100644 --- a/content/docs/references/api/realtime/RealtimeAction.mdx +++ b/content/docs/references/api/realtime/RealtimeAction.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/RealtimeEvent.mdx b/content/docs/references/api/realtime/RealtimeEvent.mdx index e682edd0d..47a600bb0 100644 --- a/content/docs/references/api/realtime/RealtimeEvent.mdx +++ b/content/docs/references/api/realtime/RealtimeEvent.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/RealtimeEventType.mdx b/content/docs/references/api/realtime/RealtimeEventType.mdx index be43423f8..68ee1f2f3 100644 --- a/content/docs/references/api/realtime/RealtimeEventType.mdx +++ b/content/docs/references/api/realtime/RealtimeEventType.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/Subscription.mdx b/content/docs/references/api/realtime/Subscription.mdx index 258f9170c..d27617976 100644 --- a/content/docs/references/api/realtime/Subscription.mdx +++ b/content/docs/references/api/realtime/Subscription.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/SubscriptionEvent.mdx b/content/docs/references/api/realtime/SubscriptionEvent.mdx index a6af28371..e15fe9757 100644 --- a/content/docs/references/api/realtime/SubscriptionEvent.mdx +++ b/content/docs/references/api/realtime/SubscriptionEvent.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/realtime/TransportProtocol.mdx b/content/docs/references/api/realtime/TransportProtocol.mdx index 58a4ffca6..253172acf 100644 --- a/content/docs/references/api/realtime/TransportProtocol.mdx +++ b/content/docs/references/api/realtime/TransportProtocol.mdx @@ -5,9 +5,6 @@ category: api zodFile: realtime --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/realtime.zod.ts` diff --git a/content/docs/references/api/router/RouteCategory.mdx b/content/docs/references/api/router/RouteCategory.mdx index bb6201b73..3adaf9991 100644 --- a/content/docs/references/api/router/RouteCategory.mdx +++ b/content/docs/references/api/router/RouteCategory.mdx @@ -5,9 +5,6 @@ category: api zodFile: router --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/router.zod.ts` diff --git a/content/docs/references/api/router/RouteDefinition.mdx b/content/docs/references/api/router/RouteDefinition.mdx index 06a5932bd..64cb75549 100644 --- a/content/docs/references/api/router/RouteDefinition.mdx +++ b/content/docs/references/api/router/RouteDefinition.mdx @@ -5,9 +5,6 @@ category: api zodFile: router --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/router.zod.ts` diff --git a/content/docs/references/api/router/RouterConfig.mdx b/content/docs/references/api/router/RouterConfig.mdx index 81cc5f7ca..deec8b457 100644 --- a/content/docs/references/api/router/RouterConfig.mdx +++ b/content/docs/references/api/router/RouterConfig.mdx @@ -5,9 +5,6 @@ category: api zodFile: router --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/router.zod.ts` diff --git a/content/docs/references/api/view/HttpMethod.mdx b/content/docs/references/api/view/HttpMethod.mdx index b55ef14d4..2186f8a97 100644 --- a/content/docs/references/api/view/HttpMethod.mdx +++ b/content/docs/references/api/view/HttpMethod.mdx @@ -5,9 +5,6 @@ category: api zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/api/view.zod.ts` diff --git a/content/docs/references/auth/config/AccountLinkingConfig.mdx b/content/docs/references/auth/config/AccountLinkingConfig.mdx index 2f6b88299..c431d2968 100644 --- a/content/docs/references/auth/config/AccountLinkingConfig.mdx +++ b/content/docs/references/auth/config/AccountLinkingConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/AuthConfig.mdx b/content/docs/references/auth/config/AuthConfig.mdx index e771582bc..510214882 100644 --- a/content/docs/references/auth/config/AuthConfig.mdx +++ b/content/docs/references/auth/config/AuthConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/AuthPluginConfig.mdx b/content/docs/references/auth/config/AuthPluginConfig.mdx index 80ec23ea8..a729ab68d 100644 --- a/content/docs/references/auth/config/AuthPluginConfig.mdx +++ b/content/docs/references/auth/config/AuthPluginConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/AuthStrategy.mdx b/content/docs/references/auth/config/AuthStrategy.mdx index 50fedf739..c0fd8a890 100644 --- a/content/docs/references/auth/config/AuthStrategy.mdx +++ b/content/docs/references/auth/config/AuthStrategy.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/CSRFConfig.mdx b/content/docs/references/auth/config/CSRFConfig.mdx index 53d04c167..a6aef30f1 100644 --- a/content/docs/references/auth/config/CSRFConfig.mdx +++ b/content/docs/references/auth/config/CSRFConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/DatabaseAdapter.mdx b/content/docs/references/auth/config/DatabaseAdapter.mdx index 1cd259f84..4f81ffd88 100644 --- a/content/docs/references/auth/config/DatabaseAdapter.mdx +++ b/content/docs/references/auth/config/DatabaseAdapter.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/DatabaseMapping.mdx b/content/docs/references/auth/config/DatabaseMapping.mdx index bb5e07d74..f16f39a76 100644 --- a/content/docs/references/auth/config/DatabaseMapping.mdx +++ b/content/docs/references/auth/config/DatabaseMapping.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/EmailPasswordConfig.mdx b/content/docs/references/auth/config/EmailPasswordConfig.mdx index 56637f8a2..eb3ecc3fc 100644 --- a/content/docs/references/auth/config/EmailPasswordConfig.mdx +++ b/content/docs/references/auth/config/EmailPasswordConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/EnterpriseAuthConfig.mdx b/content/docs/references/auth/config/EnterpriseAuthConfig.mdx index e6a48622b..f0c1b663c 100644 --- a/content/docs/references/auth/config/EnterpriseAuthConfig.mdx +++ b/content/docs/references/auth/config/EnterpriseAuthConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/LDAPConfig.mdx b/content/docs/references/auth/config/LDAPConfig.mdx index 6706a48fb..5ff023035 100644 --- a/content/docs/references/auth/config/LDAPConfig.mdx +++ b/content/docs/references/auth/config/LDAPConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/MagicLinkConfig.mdx b/content/docs/references/auth/config/MagicLinkConfig.mdx index 20fd6f735..464388ad1 100644 --- a/content/docs/references/auth/config/MagicLinkConfig.mdx +++ b/content/docs/references/auth/config/MagicLinkConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/OAuthProvider.mdx b/content/docs/references/auth/config/OAuthProvider.mdx index e69e93afa..fc8508014 100644 --- a/content/docs/references/auth/config/OAuthProvider.mdx +++ b/content/docs/references/auth/config/OAuthProvider.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/OIDCConfig.mdx b/content/docs/references/auth/config/OIDCConfig.mdx index f7e360a86..feddb5d98 100644 --- a/content/docs/references/auth/config/OIDCConfig.mdx +++ b/content/docs/references/auth/config/OIDCConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/PasskeyConfig.mdx b/content/docs/references/auth/config/PasskeyConfig.mdx index bd5448afb..21672d0dc 100644 --- a/content/docs/references/auth/config/PasskeyConfig.mdx +++ b/content/docs/references/auth/config/PasskeyConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/RateLimitConfig.mdx b/content/docs/references/auth/config/RateLimitConfig.mdx index 033db0195..52b27b3f5 100644 --- a/content/docs/references/auth/config/RateLimitConfig.mdx +++ b/content/docs/references/auth/config/RateLimitConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/SAMLConfig.mdx b/content/docs/references/auth/config/SAMLConfig.mdx index 3cfa1bf53..6316e74d4 100644 --- a/content/docs/references/auth/config/SAMLConfig.mdx +++ b/content/docs/references/auth/config/SAMLConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/SessionConfig.mdx b/content/docs/references/auth/config/SessionConfig.mdx index 7659f28c1..bd9f18c5e 100644 --- a/content/docs/references/auth/config/SessionConfig.mdx +++ b/content/docs/references/auth/config/SessionConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/StandardAuthProvider.mdx b/content/docs/references/auth/config/StandardAuthProvider.mdx index 5337f42c2..c47fa9be8 100644 --- a/content/docs/references/auth/config/StandardAuthProvider.mdx +++ b/content/docs/references/auth/config/StandardAuthProvider.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/TwoFactorConfig.mdx b/content/docs/references/auth/config/TwoFactorConfig.mdx index 6004f0d12..c7024652e 100644 --- a/content/docs/references/auth/config/TwoFactorConfig.mdx +++ b/content/docs/references/auth/config/TwoFactorConfig.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/config/UserFieldMapping.mdx b/content/docs/references/auth/config/UserFieldMapping.mdx index 8eb2da656..3f1d8151e 100644 --- a/content/docs/references/auth/config/UserFieldMapping.mdx +++ b/content/docs/references/auth/config/UserFieldMapping.mdx @@ -5,9 +5,6 @@ category: auth zodFile: config --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/config.zod.ts` diff --git a/content/docs/references/auth/identity/Account.mdx b/content/docs/references/auth/identity/Account.mdx index 3584b9593..3057fbdbd 100644 --- a/content/docs/references/auth/identity/Account.mdx +++ b/content/docs/references/auth/identity/Account.mdx @@ -5,9 +5,6 @@ category: auth zodFile: identity --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/identity.zod.ts` diff --git a/content/docs/references/auth/identity/Session.mdx b/content/docs/references/auth/identity/Session.mdx index f90973308..995c8fd20 100644 --- a/content/docs/references/auth/identity/Session.mdx +++ b/content/docs/references/auth/identity/Session.mdx @@ -5,9 +5,6 @@ category: auth zodFile: identity --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/identity.zod.ts` diff --git a/content/docs/references/auth/identity/User.mdx b/content/docs/references/auth/identity/User.mdx index a04a49f5a..89fb56d9c 100644 --- a/content/docs/references/auth/identity/User.mdx +++ b/content/docs/references/auth/identity/User.mdx @@ -5,9 +5,6 @@ category: auth zodFile: identity --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/identity.zod.ts` diff --git a/content/docs/references/auth/identity/VerificationToken.mdx b/content/docs/references/auth/identity/VerificationToken.mdx index 9c52fc9b6..940de43fd 100644 --- a/content/docs/references/auth/identity/VerificationToken.mdx +++ b/content/docs/references/auth/identity/VerificationToken.mdx @@ -5,9 +5,6 @@ category: auth zodFile: identity --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/identity.zod.ts` diff --git a/content/docs/references/auth/index.mdx b/content/docs/references/auth/index.mdx index 3ee0dfd7b..d8f4aa59b 100644 --- a/content/docs/references/auth/index.mdx +++ b/content/docs/references/auth/index.mdx @@ -3,7 +3,6 @@ title: Auth Protocol Overview description: Complete reference for all auth protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Auth Protocol diff --git a/content/docs/references/auth/organization/Invitation.mdx b/content/docs/references/auth/organization/Invitation.mdx index 18b8682b2..ae5ff8ea9 100644 --- a/content/docs/references/auth/organization/Invitation.mdx +++ b/content/docs/references/auth/organization/Invitation.mdx @@ -5,9 +5,6 @@ category: auth zodFile: organization --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/organization.zod.ts` diff --git a/content/docs/references/auth/organization/InvitationStatus.mdx b/content/docs/references/auth/organization/InvitationStatus.mdx index 7f5eedacb..ad23c1320 100644 --- a/content/docs/references/auth/organization/InvitationStatus.mdx +++ b/content/docs/references/auth/organization/InvitationStatus.mdx @@ -5,9 +5,6 @@ category: auth zodFile: organization --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/organization.zod.ts` diff --git a/content/docs/references/auth/organization/Member.mdx b/content/docs/references/auth/organization/Member.mdx index e818c54e7..dcf7ccc30 100644 --- a/content/docs/references/auth/organization/Member.mdx +++ b/content/docs/references/auth/organization/Member.mdx @@ -5,9 +5,6 @@ category: auth zodFile: organization --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/organization.zod.ts` diff --git a/content/docs/references/auth/organization/Organization.mdx b/content/docs/references/auth/organization/Organization.mdx index 42bdb2dbd..8e2092ade 100644 --- a/content/docs/references/auth/organization/Organization.mdx +++ b/content/docs/references/auth/organization/Organization.mdx @@ -5,9 +5,6 @@ category: auth zodFile: organization --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/organization.zod.ts` diff --git a/content/docs/references/auth/policy/AuditPolicy.mdx b/content/docs/references/auth/policy/AuditPolicy.mdx index bc70cc5ba..1aacc509b 100644 --- a/content/docs/references/auth/policy/AuditPolicy.mdx +++ b/content/docs/references/auth/policy/AuditPolicy.mdx @@ -5,9 +5,6 @@ category: auth zodFile: policy --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/policy.zod.ts` diff --git a/content/docs/references/auth/policy/NetworkPolicy.mdx b/content/docs/references/auth/policy/NetworkPolicy.mdx index 65d16368a..b1bb472b5 100644 --- a/content/docs/references/auth/policy/NetworkPolicy.mdx +++ b/content/docs/references/auth/policy/NetworkPolicy.mdx @@ -5,9 +5,6 @@ category: auth zodFile: policy --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/policy.zod.ts` diff --git a/content/docs/references/auth/policy/PasswordPolicy.mdx b/content/docs/references/auth/policy/PasswordPolicy.mdx index 5e281649f..938071c2a 100644 --- a/content/docs/references/auth/policy/PasswordPolicy.mdx +++ b/content/docs/references/auth/policy/PasswordPolicy.mdx @@ -5,9 +5,6 @@ category: auth zodFile: policy --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/policy.zod.ts` diff --git a/content/docs/references/auth/policy/Policy.mdx b/content/docs/references/auth/policy/Policy.mdx index 620a85b69..1dae0c678 100644 --- a/content/docs/references/auth/policy/Policy.mdx +++ b/content/docs/references/auth/policy/Policy.mdx @@ -5,9 +5,6 @@ category: auth zodFile: policy --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/policy.zod.ts` diff --git a/content/docs/references/auth/policy/SessionPolicy.mdx b/content/docs/references/auth/policy/SessionPolicy.mdx index 0481fa710..c403f7416 100644 --- a/content/docs/references/auth/policy/SessionPolicy.mdx +++ b/content/docs/references/auth/policy/SessionPolicy.mdx @@ -5,9 +5,6 @@ category: auth zodFile: policy --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/policy.zod.ts` diff --git a/content/docs/references/auth/role/Role.mdx b/content/docs/references/auth/role/Role.mdx index 489b70e13..90b6bccc8 100644 --- a/content/docs/references/auth/role/Role.mdx +++ b/content/docs/references/auth/role/Role.mdx @@ -5,9 +5,6 @@ category: auth zodFile: role --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/role.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMAddress.mdx b/content/docs/references/auth/scim/SCIMAddress.mdx index db9f2825f..1aba33b77 100644 --- a/content/docs/references/auth/scim/SCIMAddress.mdx +++ b/content/docs/references/auth/scim/SCIMAddress.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMEmail.mdx b/content/docs/references/auth/scim/SCIMEmail.mdx index 083d3ddde..d81cd2134 100644 --- a/content/docs/references/auth/scim/SCIMEmail.mdx +++ b/content/docs/references/auth/scim/SCIMEmail.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx b/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx index 109977634..a2779fee3 100644 --- a/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx +++ b/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMError.mdx b/content/docs/references/auth/scim/SCIMError.mdx index 496a0b613..fc4510f52 100644 --- a/content/docs/references/auth/scim/SCIMError.mdx +++ b/content/docs/references/auth/scim/SCIMError.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMGroup.mdx b/content/docs/references/auth/scim/SCIMGroup.mdx index cfedeb567..69856a6e6 100644 --- a/content/docs/references/auth/scim/SCIMGroup.mdx +++ b/content/docs/references/auth/scim/SCIMGroup.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMGroupReference.mdx b/content/docs/references/auth/scim/SCIMGroupReference.mdx index 372361ea2..7117fe0cc 100644 --- a/content/docs/references/auth/scim/SCIMGroupReference.mdx +++ b/content/docs/references/auth/scim/SCIMGroupReference.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMListResponse.mdx b/content/docs/references/auth/scim/SCIMListResponse.mdx index 95df17a02..3ef786de9 100644 --- a/content/docs/references/auth/scim/SCIMListResponse.mdx +++ b/content/docs/references/auth/scim/SCIMListResponse.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMMemberReference.mdx b/content/docs/references/auth/scim/SCIMMemberReference.mdx index fc78efdff..ce4d108a7 100644 --- a/content/docs/references/auth/scim/SCIMMemberReference.mdx +++ b/content/docs/references/auth/scim/SCIMMemberReference.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMMeta.mdx b/content/docs/references/auth/scim/SCIMMeta.mdx index 054424b84..fbe94c544 100644 --- a/content/docs/references/auth/scim/SCIMMeta.mdx +++ b/content/docs/references/auth/scim/SCIMMeta.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMName.mdx b/content/docs/references/auth/scim/SCIMName.mdx index ac4ca9066..776c9cb0c 100644 --- a/content/docs/references/auth/scim/SCIMName.mdx +++ b/content/docs/references/auth/scim/SCIMName.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMPatchOperation.mdx b/content/docs/references/auth/scim/SCIMPatchOperation.mdx index 2f01fb513..25b935ca8 100644 --- a/content/docs/references/auth/scim/SCIMPatchOperation.mdx +++ b/content/docs/references/auth/scim/SCIMPatchOperation.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMPatchRequest.mdx b/content/docs/references/auth/scim/SCIMPatchRequest.mdx index bdc7916f4..285cc3283 100644 --- a/content/docs/references/auth/scim/SCIMPatchRequest.mdx +++ b/content/docs/references/auth/scim/SCIMPatchRequest.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMPhoneNumber.mdx b/content/docs/references/auth/scim/SCIMPhoneNumber.mdx index 607ffd374..671d1a91e 100644 --- a/content/docs/references/auth/scim/SCIMPhoneNumber.mdx +++ b/content/docs/references/auth/scim/SCIMPhoneNumber.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/auth/scim/SCIMUser.mdx b/content/docs/references/auth/scim/SCIMUser.mdx index 6e6108bc1..76560413a 100644 --- a/content/docs/references/auth/scim/SCIMUser.mdx +++ b/content/docs/references/auth/scim/SCIMUser.mdx @@ -5,9 +5,6 @@ category: auth zodFile: scim --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/auth/scim.zod.ts` diff --git a/content/docs/references/automation/approval/ApprovalAction.mdx b/content/docs/references/automation/approval/ApprovalAction.mdx index 471b5d889..56f7abda1 100644 --- a/content/docs/references/automation/approval/ApprovalAction.mdx +++ b/content/docs/references/automation/approval/ApprovalAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: approval --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/approval.zod.ts` diff --git a/content/docs/references/automation/approval/ApprovalActionType.mdx b/content/docs/references/automation/approval/ApprovalActionType.mdx index a58f83438..6a38c9aa1 100644 --- a/content/docs/references/automation/approval/ApprovalActionType.mdx +++ b/content/docs/references/automation/approval/ApprovalActionType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: approval --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/approval.zod.ts` diff --git a/content/docs/references/automation/approval/ApprovalProcess.mdx b/content/docs/references/automation/approval/ApprovalProcess.mdx index 634fddef2..a0534cd2d 100644 --- a/content/docs/references/automation/approval/ApprovalProcess.mdx +++ b/content/docs/references/automation/approval/ApprovalProcess.mdx @@ -5,9 +5,6 @@ category: automation zodFile: approval --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/approval.zod.ts` diff --git a/content/docs/references/automation/approval/ApprovalStep.mdx b/content/docs/references/automation/approval/ApprovalStep.mdx index f219ca2cc..4b7220934 100644 --- a/content/docs/references/automation/approval/ApprovalStep.mdx +++ b/content/docs/references/automation/approval/ApprovalStep.mdx @@ -5,9 +5,6 @@ category: automation zodFile: approval --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/approval.zod.ts` diff --git a/content/docs/references/automation/approval/ApproverType.mdx b/content/docs/references/automation/approval/ApproverType.mdx index 6bde621d2..303ce3c9f 100644 --- a/content/docs/references/automation/approval/ApproverType.mdx +++ b/content/docs/references/automation/approval/ApproverType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: approval --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/approval.zod.ts` diff --git a/content/docs/references/automation/connector/AuthField.mdx b/content/docs/references/automation/connector/AuthField.mdx index 69aa1d293..3c6689c60 100644 --- a/content/docs/references/automation/connector/AuthField.mdx +++ b/content/docs/references/automation/connector/AuthField.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/Authentication.mdx b/content/docs/references/automation/connector/Authentication.mdx index bca0dbe59..3e7412f09 100644 --- a/content/docs/references/automation/connector/Authentication.mdx +++ b/content/docs/references/automation/connector/Authentication.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/AuthenticationType.mdx b/content/docs/references/automation/connector/AuthenticationType.mdx index d0b391700..6574f44fe 100644 --- a/content/docs/references/automation/connector/AuthenticationType.mdx +++ b/content/docs/references/automation/connector/AuthenticationType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/Connector.mdx b/content/docs/references/automation/connector/Connector.mdx index 91a746f1b..3e1b5ed30 100644 --- a/content/docs/references/automation/connector/Connector.mdx +++ b/content/docs/references/automation/connector/Connector.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/ConnectorCategory.mdx b/content/docs/references/automation/connector/ConnectorCategory.mdx index 6495211bf..279568e96 100644 --- a/content/docs/references/automation/connector/ConnectorCategory.mdx +++ b/content/docs/references/automation/connector/ConnectorCategory.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/ConnectorInstance.mdx b/content/docs/references/automation/connector/ConnectorInstance.mdx index 072ee45ac..5f007d11c 100644 --- a/content/docs/references/automation/connector/ConnectorInstance.mdx +++ b/content/docs/references/automation/connector/ConnectorInstance.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/ConnectorOperation.mdx b/content/docs/references/automation/connector/ConnectorOperation.mdx index 1e64b219c..6fc0ef549 100644 --- a/content/docs/references/automation/connector/ConnectorOperation.mdx +++ b/content/docs/references/automation/connector/ConnectorOperation.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/ConnectorTrigger.mdx b/content/docs/references/automation/connector/ConnectorTrigger.mdx index 867b1fcf1..400118062 100644 --- a/content/docs/references/automation/connector/ConnectorTrigger.mdx +++ b/content/docs/references/automation/connector/ConnectorTrigger.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/OAuth2Config.mdx b/content/docs/references/automation/connector/OAuth2Config.mdx index f785d10b1..37314decd 100644 --- a/content/docs/references/automation/connector/OAuth2Config.mdx +++ b/content/docs/references/automation/connector/OAuth2Config.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/OperationParameter.mdx b/content/docs/references/automation/connector/OperationParameter.mdx index 5f2b73d14..363aff6e6 100644 --- a/content/docs/references/automation/connector/OperationParameter.mdx +++ b/content/docs/references/automation/connector/OperationParameter.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/connector/OperationType.mdx b/content/docs/references/automation/connector/OperationType.mdx index 0d8d6399e..40aeeba1d 100644 --- a/content/docs/references/automation/connector/OperationType.mdx +++ b/content/docs/references/automation/connector/OperationType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: connector --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/connector.zod.ts` diff --git a/content/docs/references/automation/etl/ETLDestination.mdx b/content/docs/references/automation/etl/ETLDestination.mdx index bba08e19e..f5bbe0797 100644 --- a/content/docs/references/automation/etl/ETLDestination.mdx +++ b/content/docs/references/automation/etl/ETLDestination.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLEndpointType.mdx b/content/docs/references/automation/etl/ETLEndpointType.mdx index c466df080..e2a9e913c 100644 --- a/content/docs/references/automation/etl/ETLEndpointType.mdx +++ b/content/docs/references/automation/etl/ETLEndpointType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLPipeline.mdx b/content/docs/references/automation/etl/ETLPipeline.mdx index a8a89b9af..3c53a71b8 100644 --- a/content/docs/references/automation/etl/ETLPipeline.mdx +++ b/content/docs/references/automation/etl/ETLPipeline.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLPipelineRun.mdx b/content/docs/references/automation/etl/ETLPipelineRun.mdx index 3450c8fa4..d9f7d94df 100644 --- a/content/docs/references/automation/etl/ETLPipelineRun.mdx +++ b/content/docs/references/automation/etl/ETLPipelineRun.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLRunStatus.mdx b/content/docs/references/automation/etl/ETLRunStatus.mdx index 2a48aac20..29bdfd298 100644 --- a/content/docs/references/automation/etl/ETLRunStatus.mdx +++ b/content/docs/references/automation/etl/ETLRunStatus.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLSource.mdx b/content/docs/references/automation/etl/ETLSource.mdx index 28932bdc3..d62b45530 100644 --- a/content/docs/references/automation/etl/ETLSource.mdx +++ b/content/docs/references/automation/etl/ETLSource.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLSyncMode.mdx b/content/docs/references/automation/etl/ETLSyncMode.mdx index fa10915ba..072c82052 100644 --- a/content/docs/references/automation/etl/ETLSyncMode.mdx +++ b/content/docs/references/automation/etl/ETLSyncMode.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLTransformation.mdx b/content/docs/references/automation/etl/ETLTransformation.mdx index 57416ec64..d3a070f2c 100644 --- a/content/docs/references/automation/etl/ETLTransformation.mdx +++ b/content/docs/references/automation/etl/ETLTransformation.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/etl/ETLTransformationType.mdx b/content/docs/references/automation/etl/ETLTransformationType.mdx index 70219a446..3cce6ed20 100644 --- a/content/docs/references/automation/etl/ETLTransformationType.mdx +++ b/content/docs/references/automation/etl/ETLTransformationType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: etl --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/etl.zod.ts` diff --git a/content/docs/references/automation/flow/Flow.mdx b/content/docs/references/automation/flow/Flow.mdx index f9a7f578e..c6ca01803 100644 --- a/content/docs/references/automation/flow/Flow.mdx +++ b/content/docs/references/automation/flow/Flow.mdx @@ -5,9 +5,6 @@ category: automation zodFile: flow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/flow.zod.ts` diff --git a/content/docs/references/automation/flow/FlowEdge.mdx b/content/docs/references/automation/flow/FlowEdge.mdx index 7ebef3aa1..3d9f369ee 100644 --- a/content/docs/references/automation/flow/FlowEdge.mdx +++ b/content/docs/references/automation/flow/FlowEdge.mdx @@ -5,9 +5,6 @@ category: automation zodFile: flow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/flow.zod.ts` diff --git a/content/docs/references/automation/flow/FlowNode.mdx b/content/docs/references/automation/flow/FlowNode.mdx index 04b5b4694..26a0d2804 100644 --- a/content/docs/references/automation/flow/FlowNode.mdx +++ b/content/docs/references/automation/flow/FlowNode.mdx @@ -5,9 +5,6 @@ category: automation zodFile: flow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/flow.zod.ts` diff --git a/content/docs/references/automation/flow/FlowNodeAction.mdx b/content/docs/references/automation/flow/FlowNodeAction.mdx index 33ace7027..7f77857b6 100644 --- a/content/docs/references/automation/flow/FlowNodeAction.mdx +++ b/content/docs/references/automation/flow/FlowNodeAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: flow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/flow.zod.ts` diff --git a/content/docs/references/automation/flow/FlowVariable.mdx b/content/docs/references/automation/flow/FlowVariable.mdx index c00f7c6c1..19ef35205 100644 --- a/content/docs/references/automation/flow/FlowVariable.mdx +++ b/content/docs/references/automation/flow/FlowVariable.mdx @@ -5,9 +5,6 @@ category: automation zodFile: flow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/flow.zod.ts` diff --git a/content/docs/references/automation/index.mdx b/content/docs/references/automation/index.mdx index 63e8f70cd..413461bf2 100644 --- a/content/docs/references/automation/index.mdx +++ b/content/docs/references/automation/index.mdx @@ -3,7 +3,6 @@ title: Automation Protocol Overview description: Complete reference for all automation protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Automation Protocol diff --git a/content/docs/references/automation/mapping/FieldMapping.mdx b/content/docs/references/automation/mapping/FieldMapping.mdx index 6c9438154..686ee1a3c 100644 --- a/content/docs/references/automation/mapping/FieldMapping.mdx +++ b/content/docs/references/automation/mapping/FieldMapping.mdx @@ -5,9 +5,6 @@ category: automation zodFile: mapping --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/mapping.zod.ts` diff --git a/content/docs/references/automation/sync/ConflictResolution.mdx b/content/docs/references/automation/sync/ConflictResolution.mdx index 57a8822d9..b24c576ab 100644 --- a/content/docs/references/automation/sync/ConflictResolution.mdx +++ b/content/docs/references/automation/sync/ConflictResolution.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/DataDestinationConfig.mdx b/content/docs/references/automation/sync/DataDestinationConfig.mdx index f1607cc5f..e01f377dc 100644 --- a/content/docs/references/automation/sync/DataDestinationConfig.mdx +++ b/content/docs/references/automation/sync/DataDestinationConfig.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/DataSourceConfig.mdx b/content/docs/references/automation/sync/DataSourceConfig.mdx index d0bb7168f..4edb3f698 100644 --- a/content/docs/references/automation/sync/DataSourceConfig.mdx +++ b/content/docs/references/automation/sync/DataSourceConfig.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/DataSyncConfig.mdx b/content/docs/references/automation/sync/DataSyncConfig.mdx index f301effad..5aa8cdbc6 100644 --- a/content/docs/references/automation/sync/DataSyncConfig.mdx +++ b/content/docs/references/automation/sync/DataSyncConfig.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/SyncDirection.mdx b/content/docs/references/automation/sync/SyncDirection.mdx index a0e04a8cb..6c2ab3cbb 100644 --- a/content/docs/references/automation/sync/SyncDirection.mdx +++ b/content/docs/references/automation/sync/SyncDirection.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/SyncExecutionResult.mdx b/content/docs/references/automation/sync/SyncExecutionResult.mdx index 6bba5eea8..01b2c96d8 100644 --- a/content/docs/references/automation/sync/SyncExecutionResult.mdx +++ b/content/docs/references/automation/sync/SyncExecutionResult.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/SyncExecutionStatus.mdx b/content/docs/references/automation/sync/SyncExecutionStatus.mdx index bde062c4a..d2624a80b 100644 --- a/content/docs/references/automation/sync/SyncExecutionStatus.mdx +++ b/content/docs/references/automation/sync/SyncExecutionStatus.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/sync/SyncMode.mdx b/content/docs/references/automation/sync/SyncMode.mdx index 0ca761bad..2cbc9db1e 100644 --- a/content/docs/references/automation/sync/SyncMode.mdx +++ b/content/docs/references/automation/sync/SyncMode.mdx @@ -5,9 +5,6 @@ category: automation zodFile: sync --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/sync.zod.ts` diff --git a/content/docs/references/automation/webhook/Webhook.mdx b/content/docs/references/automation/webhook/Webhook.mdx index 4a52d6867..7b3931e30 100644 --- a/content/docs/references/automation/webhook/Webhook.mdx +++ b/content/docs/references/automation/webhook/Webhook.mdx @@ -5,9 +5,6 @@ category: automation zodFile: webhook --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/webhook.zod.ts` diff --git a/content/docs/references/automation/webhook/WebhookReceiver.mdx b/content/docs/references/automation/webhook/WebhookReceiver.mdx index 0ae96ffe9..7a290fea1 100644 --- a/content/docs/references/automation/webhook/WebhookReceiver.mdx +++ b/content/docs/references/automation/webhook/WebhookReceiver.mdx @@ -5,9 +5,6 @@ category: automation zodFile: webhook --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/webhook.zod.ts` diff --git a/content/docs/references/automation/webhook/WebhookTriggerType.mdx b/content/docs/references/automation/webhook/WebhookTriggerType.mdx index 5412ea8b9..74d5f9efe 100644 --- a/content/docs/references/automation/webhook/WebhookTriggerType.mdx +++ b/content/docs/references/automation/webhook/WebhookTriggerType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: webhook --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/webhook.zod.ts` diff --git a/content/docs/references/automation/workflow/CustomScriptAction.mdx b/content/docs/references/automation/workflow/CustomScriptAction.mdx index d45192df5..7d209732e 100644 --- a/content/docs/references/automation/workflow/CustomScriptAction.mdx +++ b/content/docs/references/automation/workflow/CustomScriptAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/EmailAlertAction.mdx b/content/docs/references/automation/workflow/EmailAlertAction.mdx index e3cb9e5ad..389b147f5 100644 --- a/content/docs/references/automation/workflow/EmailAlertAction.mdx +++ b/content/docs/references/automation/workflow/EmailAlertAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/FieldUpdateAction.mdx b/content/docs/references/automation/workflow/FieldUpdateAction.mdx index 169b631ca..7ab72492b 100644 --- a/content/docs/references/automation/workflow/FieldUpdateAction.mdx +++ b/content/docs/references/automation/workflow/FieldUpdateAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/HttpCallAction.mdx b/content/docs/references/automation/workflow/HttpCallAction.mdx index 428901698..ec06fd80e 100644 --- a/content/docs/references/automation/workflow/HttpCallAction.mdx +++ b/content/docs/references/automation/workflow/HttpCallAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/PushNotificationAction.mdx b/content/docs/references/automation/workflow/PushNotificationAction.mdx index 97409a46a..51e89933f 100644 --- a/content/docs/references/automation/workflow/PushNotificationAction.mdx +++ b/content/docs/references/automation/workflow/PushNotificationAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/SlackMessageAction.mdx b/content/docs/references/automation/workflow/SlackMessageAction.mdx index 746223495..7b179e10d 100644 --- a/content/docs/references/automation/workflow/SlackMessageAction.mdx +++ b/content/docs/references/automation/workflow/SlackMessageAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/SmsNotificationAction.mdx b/content/docs/references/automation/workflow/SmsNotificationAction.mdx index 1c25dc89e..f81ba0979 100644 --- a/content/docs/references/automation/workflow/SmsNotificationAction.mdx +++ b/content/docs/references/automation/workflow/SmsNotificationAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/TaskCreationAction.mdx b/content/docs/references/automation/workflow/TaskCreationAction.mdx index c14230019..8793dc879 100644 --- a/content/docs/references/automation/workflow/TaskCreationAction.mdx +++ b/content/docs/references/automation/workflow/TaskCreationAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/TeamsMessageAction.mdx b/content/docs/references/automation/workflow/TeamsMessageAction.mdx index 78a7921c6..4ce7803de 100644 --- a/content/docs/references/automation/workflow/TeamsMessageAction.mdx +++ b/content/docs/references/automation/workflow/TeamsMessageAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/TimeTrigger.mdx b/content/docs/references/automation/workflow/TimeTrigger.mdx index 82fc8d19b..6139951a1 100644 --- a/content/docs/references/automation/workflow/TimeTrigger.mdx +++ b/content/docs/references/automation/workflow/TimeTrigger.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/WebhookTriggerAction.mdx b/content/docs/references/automation/workflow/WebhookTriggerAction.mdx index 9af225016..f8777e6d7 100644 --- a/content/docs/references/automation/workflow/WebhookTriggerAction.mdx +++ b/content/docs/references/automation/workflow/WebhookTriggerAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/WorkflowAction.mdx b/content/docs/references/automation/workflow/WorkflowAction.mdx index ab806c17b..103a245df 100644 --- a/content/docs/references/automation/workflow/WorkflowAction.mdx +++ b/content/docs/references/automation/workflow/WorkflowAction.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/WorkflowRule.mdx b/content/docs/references/automation/workflow/WorkflowRule.mdx index 74eac7f69..31839fcb4 100644 --- a/content/docs/references/automation/workflow/WorkflowRule.mdx +++ b/content/docs/references/automation/workflow/WorkflowRule.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/automation/workflow/WorkflowTriggerType.mdx b/content/docs/references/automation/workflow/WorkflowTriggerType.mdx index 01c154507..48ee6aba2 100644 --- a/content/docs/references/automation/workflow/WorkflowTriggerType.mdx +++ b/content/docs/references/automation/workflow/WorkflowTriggerType.mdx @@ -5,9 +5,6 @@ category: automation zodFile: workflow --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/automation/workflow.zod.ts` diff --git a/content/docs/references/data/dataset/Dataset.mdx b/content/docs/references/data/dataset/Dataset.mdx index 46af6962f..be874e811 100644 --- a/content/docs/references/data/dataset/Dataset.mdx +++ b/content/docs/references/data/dataset/Dataset.mdx @@ -5,9 +5,6 @@ category: data zodFile: dataset --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/dataset.zod.ts` diff --git a/content/docs/references/data/dataset/DatasetMode.mdx b/content/docs/references/data/dataset/DatasetMode.mdx index 9b43b8cff..85fbc46db 100644 --- a/content/docs/references/data/dataset/DatasetMode.mdx +++ b/content/docs/references/data/dataset/DatasetMode.mdx @@ -5,9 +5,6 @@ category: data zodFile: dataset --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/dataset.zod.ts` diff --git a/content/docs/references/data/field/Address.mdx b/content/docs/references/data/field/Address.mdx index 412fd50ae..bfa946dea 100644 --- a/content/docs/references/data/field/Address.mdx +++ b/content/docs/references/data/field/Address.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/CurrencyConfig.mdx b/content/docs/references/data/field/CurrencyConfig.mdx index 128d86128..65d56d06c 100644 --- a/content/docs/references/data/field/CurrencyConfig.mdx +++ b/content/docs/references/data/field/CurrencyConfig.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/CurrencyValue.mdx b/content/docs/references/data/field/CurrencyValue.mdx index ab101c674..f0fa84bb4 100644 --- a/content/docs/references/data/field/CurrencyValue.mdx +++ b/content/docs/references/data/field/CurrencyValue.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/Field.mdx b/content/docs/references/data/field/Field.mdx index bcbd9dddd..90dfa58dc 100644 --- a/content/docs/references/data/field/Field.mdx +++ b/content/docs/references/data/field/Field.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/FieldType.mdx b/content/docs/references/data/field/FieldType.mdx index 38e75e0fd..c8aefebc0 100644 --- a/content/docs/references/data/field/FieldType.mdx +++ b/content/docs/references/data/field/FieldType.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/LocationCoordinates.mdx b/content/docs/references/data/field/LocationCoordinates.mdx index c8d2ed8b2..e8a15457f 100644 --- a/content/docs/references/data/field/LocationCoordinates.mdx +++ b/content/docs/references/data/field/LocationCoordinates.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/SelectOption.mdx b/content/docs/references/data/field/SelectOption.mdx index 2d930a158..23751b994 100644 --- a/content/docs/references/data/field/SelectOption.mdx +++ b/content/docs/references/data/field/SelectOption.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/field/VectorConfig.mdx b/content/docs/references/data/field/VectorConfig.mdx index 483310826..39f7f3bb0 100644 --- a/content/docs/references/data/field/VectorConfig.mdx +++ b/content/docs/references/data/field/VectorConfig.mdx @@ -5,9 +5,6 @@ category: data zodFile: field --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/field.zod.ts` diff --git a/content/docs/references/data/filter/ComparisonOperator.mdx b/content/docs/references/data/filter/ComparisonOperator.mdx index c8b3692cc..6dbbeef2c 100644 --- a/content/docs/references/data/filter/ComparisonOperator.mdx +++ b/content/docs/references/data/filter/ComparisonOperator.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/EqualityOperator.mdx b/content/docs/references/data/filter/EqualityOperator.mdx index 9af9e0052..e97253bd8 100644 --- a/content/docs/references/data/filter/EqualityOperator.mdx +++ b/content/docs/references/data/filter/EqualityOperator.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/FieldOperators.mdx b/content/docs/references/data/filter/FieldOperators.mdx index be28fe0f5..302b8ad3f 100644 --- a/content/docs/references/data/filter/FieldOperators.mdx +++ b/content/docs/references/data/filter/FieldOperators.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/FieldReference.mdx b/content/docs/references/data/filter/FieldReference.mdx index 2249f92a1..ce8ccbd63 100644 --- a/content/docs/references/data/filter/FieldReference.mdx +++ b/content/docs/references/data/filter/FieldReference.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/FilterCondition.mdx b/content/docs/references/data/filter/FilterCondition.mdx index 4cff03a9e..fbc3c415b 100644 --- a/content/docs/references/data/filter/FilterCondition.mdx +++ b/content/docs/references/data/filter/FilterCondition.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/NormalizedFilter.mdx b/content/docs/references/data/filter/NormalizedFilter.mdx index 2e559d6d5..7c6daac58 100644 --- a/content/docs/references/data/filter/NormalizedFilter.mdx +++ b/content/docs/references/data/filter/NormalizedFilter.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/QueryFilter.mdx b/content/docs/references/data/filter/QueryFilter.mdx index 55d13b3e0..82ad21bbd 100644 --- a/content/docs/references/data/filter/QueryFilter.mdx +++ b/content/docs/references/data/filter/QueryFilter.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/RangeOperator.mdx b/content/docs/references/data/filter/RangeOperator.mdx index 5b0311b12..53786a120 100644 --- a/content/docs/references/data/filter/RangeOperator.mdx +++ b/content/docs/references/data/filter/RangeOperator.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/SetOperator.mdx b/content/docs/references/data/filter/SetOperator.mdx index 284164424..e9d7dd186 100644 --- a/content/docs/references/data/filter/SetOperator.mdx +++ b/content/docs/references/data/filter/SetOperator.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/SpecialOperator.mdx b/content/docs/references/data/filter/SpecialOperator.mdx index 34a847316..3bbeb519e 100644 --- a/content/docs/references/data/filter/SpecialOperator.mdx +++ b/content/docs/references/data/filter/SpecialOperator.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/filter/StringOperator.mdx b/content/docs/references/data/filter/StringOperator.mdx index 554031e9a..33db2ff95 100644 --- a/content/docs/references/data/filter/StringOperator.mdx +++ b/content/docs/references/data/filter/StringOperator.mdx @@ -5,9 +5,6 @@ category: data zodFile: filter --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/filter.zod.ts` diff --git a/content/docs/references/data/hook/Hook.mdx b/content/docs/references/data/hook/Hook.mdx index bb90c5cdf..1240b69ca 100644 --- a/content/docs/references/data/hook/Hook.mdx +++ b/content/docs/references/data/hook/Hook.mdx @@ -5,9 +5,6 @@ category: data zodFile: hook --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/hook.zod.ts` diff --git a/content/docs/references/data/hook/HookContext.mdx b/content/docs/references/data/hook/HookContext.mdx index 712579251..218bc11bc 100644 --- a/content/docs/references/data/hook/HookContext.mdx +++ b/content/docs/references/data/hook/HookContext.mdx @@ -5,9 +5,6 @@ category: data zodFile: hook --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/hook.zod.ts` diff --git a/content/docs/references/data/hook/HookEvent.mdx b/content/docs/references/data/hook/HookEvent.mdx index 6136248a3..76f37ee1b 100644 --- a/content/docs/references/data/hook/HookEvent.mdx +++ b/content/docs/references/data/hook/HookEvent.mdx @@ -5,9 +5,6 @@ category: data zodFile: hook --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/hook.zod.ts` diff --git a/content/docs/references/data/index.mdx b/content/docs/references/data/index.mdx index 16ae06db7..e67fb60e2 100644 --- a/content/docs/references/data/index.mdx +++ b/content/docs/references/data/index.mdx @@ -3,7 +3,6 @@ title: Data Protocol Overview description: Complete reference for all data protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Data Protocol diff --git a/content/docs/references/data/object/Index.mdx b/content/docs/references/data/object/Index.mdx index f7ac488c2..32244c642 100644 --- a/content/docs/references/data/object/Index.mdx +++ b/content/docs/references/data/object/Index.mdx @@ -5,9 +5,6 @@ category: data zodFile: object --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/object.zod.ts` diff --git a/content/docs/references/data/object/Object.mdx b/content/docs/references/data/object/Object.mdx index 21f7abfe0..8cf2e07b7 100644 --- a/content/docs/references/data/object/Object.mdx +++ b/content/docs/references/data/object/Object.mdx @@ -5,9 +5,6 @@ category: data zodFile: object --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/object.zod.ts` diff --git a/content/docs/references/data/object/ObjectCapabilities.mdx b/content/docs/references/data/object/ObjectCapabilities.mdx index bc160c26a..87bc79fa7 100644 --- a/content/docs/references/data/object/ObjectCapabilities.mdx +++ b/content/docs/references/data/object/ObjectCapabilities.mdx @@ -5,9 +5,6 @@ category: data zodFile: object --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/object.zod.ts` diff --git a/content/docs/references/data/object/SearchConfig.mdx b/content/docs/references/data/object/SearchConfig.mdx index e2b0a77c9..915d28e9c 100644 --- a/content/docs/references/data/object/SearchConfig.mdx +++ b/content/docs/references/data/object/SearchConfig.mdx @@ -5,9 +5,6 @@ category: data zodFile: object --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/object.zod.ts` diff --git a/content/docs/references/data/query/AggregationFunction.mdx b/content/docs/references/data/query/AggregationFunction.mdx index 950694610..345df91fa 100644 --- a/content/docs/references/data/query/AggregationFunction.mdx +++ b/content/docs/references/data/query/AggregationFunction.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/AggregationNode.mdx b/content/docs/references/data/query/AggregationNode.mdx index 9ab3d187a..296d93580 100644 --- a/content/docs/references/data/query/AggregationNode.mdx +++ b/content/docs/references/data/query/AggregationNode.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/FieldNode.mdx b/content/docs/references/data/query/FieldNode.mdx index ce12e5661..781957f4f 100644 --- a/content/docs/references/data/query/FieldNode.mdx +++ b/content/docs/references/data/query/FieldNode.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/JoinNode.mdx b/content/docs/references/data/query/JoinNode.mdx index 10c487348..2b16b43f7 100644 --- a/content/docs/references/data/query/JoinNode.mdx +++ b/content/docs/references/data/query/JoinNode.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/JoinStrategy.mdx b/content/docs/references/data/query/JoinStrategy.mdx index 264ca4c52..2434f2ac6 100644 --- a/content/docs/references/data/query/JoinStrategy.mdx +++ b/content/docs/references/data/query/JoinStrategy.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/JoinType.mdx b/content/docs/references/data/query/JoinType.mdx index 265975df6..4155a1a5e 100644 --- a/content/docs/references/data/query/JoinType.mdx +++ b/content/docs/references/data/query/JoinType.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/Query.mdx b/content/docs/references/data/query/Query.mdx index 6d6e657d0..be7ea41bb 100644 --- a/content/docs/references/data/query/Query.mdx +++ b/content/docs/references/data/query/Query.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/SortNode.mdx b/content/docs/references/data/query/SortNode.mdx index ec06497ad..4554ed9e2 100644 --- a/content/docs/references/data/query/SortNode.mdx +++ b/content/docs/references/data/query/SortNode.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/WindowFunction.mdx b/content/docs/references/data/query/WindowFunction.mdx index ba826256a..2046049e6 100644 --- a/content/docs/references/data/query/WindowFunction.mdx +++ b/content/docs/references/data/query/WindowFunction.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/WindowFunctionNode.mdx b/content/docs/references/data/query/WindowFunctionNode.mdx index 17ca683ec..66f9ba679 100644 --- a/content/docs/references/data/query/WindowFunctionNode.mdx +++ b/content/docs/references/data/query/WindowFunctionNode.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/query/WindowSpec.mdx b/content/docs/references/data/query/WindowSpec.mdx index deeed0e89..c8c23a53e 100644 --- a/content/docs/references/data/query/WindowSpec.mdx +++ b/content/docs/references/data/query/WindowSpec.mdx @@ -5,9 +5,6 @@ category: data zodFile: query --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/query.zod.ts` diff --git a/content/docs/references/data/validation/AsyncValidation.mdx b/content/docs/references/data/validation/AsyncValidation.mdx index c7bfd9d4c..1a44fa498 100644 --- a/content/docs/references/data/validation/AsyncValidation.mdx +++ b/content/docs/references/data/validation/AsyncValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/ConditionalValidation.mdx b/content/docs/references/data/validation/ConditionalValidation.mdx index 64600fd45..10e79b861 100644 --- a/content/docs/references/data/validation/ConditionalValidation.mdx +++ b/content/docs/references/data/validation/ConditionalValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/CrossFieldValidation.mdx b/content/docs/references/data/validation/CrossFieldValidation.mdx index af9606de0..722efc9fe 100644 --- a/content/docs/references/data/validation/CrossFieldValidation.mdx +++ b/content/docs/references/data/validation/CrossFieldValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/CustomValidator.mdx b/content/docs/references/data/validation/CustomValidator.mdx index 64936e4d9..d7b665c61 100644 --- a/content/docs/references/data/validation/CustomValidator.mdx +++ b/content/docs/references/data/validation/CustomValidator.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/FormatValidation.mdx b/content/docs/references/data/validation/FormatValidation.mdx index 5d8e50ccf..0d8b9e62f 100644 --- a/content/docs/references/data/validation/FormatValidation.mdx +++ b/content/docs/references/data/validation/FormatValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/JSONValidation.mdx b/content/docs/references/data/validation/JSONValidation.mdx index af57a3218..54cf67427 100644 --- a/content/docs/references/data/validation/JSONValidation.mdx +++ b/content/docs/references/data/validation/JSONValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/ScriptValidation.mdx b/content/docs/references/data/validation/ScriptValidation.mdx index a2f98d166..0e41ddfdb 100644 --- a/content/docs/references/data/validation/ScriptValidation.mdx +++ b/content/docs/references/data/validation/ScriptValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/StateMachineValidation.mdx b/content/docs/references/data/validation/StateMachineValidation.mdx index dd7e86310..fa1211149 100644 --- a/content/docs/references/data/validation/StateMachineValidation.mdx +++ b/content/docs/references/data/validation/StateMachineValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/UniquenessValidation.mdx b/content/docs/references/data/validation/UniquenessValidation.mdx index edbdcf825..122257917 100644 --- a/content/docs/references/data/validation/UniquenessValidation.mdx +++ b/content/docs/references/data/validation/UniquenessValidation.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/data/validation/ValidationRule.mdx b/content/docs/references/data/validation/ValidationRule.mdx index d200d58e3..8ba14a3a0 100644 --- a/content/docs/references/data/validation/ValidationRule.mdx +++ b/content/docs/references/data/validation/ValidationRule.mdx @@ -5,9 +5,6 @@ category: data zodFile: validation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/data/validation.zod.ts` diff --git a/content/docs/references/hub/composer/BillOfMaterials.mdx b/content/docs/references/hub/composer/BillOfMaterials.mdx index f647f02b6..7f6aee114 100644 --- a/content/docs/references/hub/composer/BillOfMaterials.mdx +++ b/content/docs/references/hub/composer/BillOfMaterials.mdx @@ -5,9 +5,6 @@ category: hub zodFile: composer --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/composer.zod.ts` diff --git a/content/docs/references/hub/composer/ComposerRequest.mdx b/content/docs/references/hub/composer/ComposerRequest.mdx index 94f4a4890..e642767ca 100644 --- a/content/docs/references/hub/composer/ComposerRequest.mdx +++ b/content/docs/references/hub/composer/ComposerRequest.mdx @@ -5,9 +5,6 @@ category: hub zodFile: composer --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/composer.zod.ts` diff --git a/content/docs/references/hub/composer/ComposerResponse.mdx b/content/docs/references/hub/composer/ComposerResponse.mdx index 94d6f4b34..3d47977f7 100644 --- a/content/docs/references/hub/composer/ComposerResponse.mdx +++ b/content/docs/references/hub/composer/ComposerResponse.mdx @@ -5,9 +5,6 @@ category: hub zodFile: composer --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/composer.zod.ts` diff --git a/content/docs/references/hub/composer/ConflictReport.mdx b/content/docs/references/hub/composer/ConflictReport.mdx index e84138a17..ffaa5e8e1 100644 --- a/content/docs/references/hub/composer/ConflictReport.mdx +++ b/content/docs/references/hub/composer/ConflictReport.mdx @@ -5,9 +5,6 @@ category: hub zodFile: composer --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/composer.zod.ts` diff --git a/content/docs/references/hub/composer/DependencyRequirement.mdx b/content/docs/references/hub/composer/DependencyRequirement.mdx index 2d6bac497..9553d2158 100644 --- a/content/docs/references/hub/composer/DependencyRequirement.mdx +++ b/content/docs/references/hub/composer/DependencyRequirement.mdx @@ -5,9 +5,6 @@ category: hub zodFile: composer --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/composer.zod.ts` diff --git a/content/docs/references/hub/index.mdx b/content/docs/references/hub/index.mdx index aa41c6308..400392eca 100644 --- a/content/docs/references/hub/index.mdx +++ b/content/docs/references/hub/index.mdx @@ -3,7 +3,6 @@ title: Hub Protocol Overview description: Complete reference for all hub protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Hub Protocol diff --git a/content/docs/references/hub/license/Feature.mdx b/content/docs/references/hub/license/Feature.mdx index 0602fa690..30d399f51 100644 --- a/content/docs/references/hub/license/Feature.mdx +++ b/content/docs/references/hub/license/Feature.mdx @@ -5,9 +5,6 @@ category: hub zodFile: license --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/license.zod.ts` diff --git a/content/docs/references/hub/license/License.mdx b/content/docs/references/hub/license/License.mdx index 0e4b38f99..4cfc9136a 100644 --- a/content/docs/references/hub/license/License.mdx +++ b/content/docs/references/hub/license/License.mdx @@ -5,9 +5,6 @@ category: hub zodFile: license --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/license.zod.ts` diff --git a/content/docs/references/hub/license/MetricType.mdx b/content/docs/references/hub/license/MetricType.mdx index b05e0a939..7a80e8a04 100644 --- a/content/docs/references/hub/license/MetricType.mdx +++ b/content/docs/references/hub/license/MetricType.mdx @@ -5,9 +5,6 @@ category: hub zodFile: license --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/license.zod.ts` diff --git a/content/docs/references/hub/license/Plan.mdx b/content/docs/references/hub/license/Plan.mdx index b21762519..3f9f1e954 100644 --- a/content/docs/references/hub/license/Plan.mdx +++ b/content/docs/references/hub/license/Plan.mdx @@ -5,9 +5,6 @@ category: hub zodFile: license --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/license.zod.ts` diff --git a/content/docs/references/hub/marketplace/MarketplacePlugin.mdx b/content/docs/references/hub/marketplace/MarketplacePlugin.mdx index 75ad24145..1104da02c 100644 --- a/content/docs/references/hub/marketplace/MarketplacePlugin.mdx +++ b/content/docs/references/hub/marketplace/MarketplacePlugin.mdx @@ -5,9 +5,6 @@ category: hub zodFile: marketplace --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/marketplace.zod.ts` diff --git a/content/docs/references/hub/marketplace/PluginAuthor.mdx b/content/docs/references/hub/marketplace/PluginAuthor.mdx index 36ce0c3b6..ad5732d4c 100644 --- a/content/docs/references/hub/marketplace/PluginAuthor.mdx +++ b/content/docs/references/hub/marketplace/PluginAuthor.mdx @@ -5,9 +5,6 @@ category: hub zodFile: marketplace --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/marketplace.zod.ts` diff --git a/content/docs/references/hub/marketplace/PluginPricing.mdx b/content/docs/references/hub/marketplace/PluginPricing.mdx index 79b7480bd..8c7c4a747 100644 --- a/content/docs/references/hub/marketplace/PluginPricing.mdx +++ b/content/docs/references/hub/marketplace/PluginPricing.mdx @@ -5,9 +5,6 @@ category: hub zodFile: marketplace --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/marketplace.zod.ts` diff --git a/content/docs/references/hub/space/DeploymentTarget.mdx b/content/docs/references/hub/space/DeploymentTarget.mdx index e1edf1aef..9cc356d92 100644 --- a/content/docs/references/hub/space/DeploymentTarget.mdx +++ b/content/docs/references/hub/space/DeploymentTarget.mdx @@ -5,9 +5,6 @@ category: hub zodFile: space --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/space.zod.ts` diff --git a/content/docs/references/hub/space/HubSpace.mdx b/content/docs/references/hub/space/HubSpace.mdx index cd17bf3d9..0c8d68675 100644 --- a/content/docs/references/hub/space/HubSpace.mdx +++ b/content/docs/references/hub/space/HubSpace.mdx @@ -5,9 +5,6 @@ category: hub zodFile: space --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/space.zod.ts` diff --git a/content/docs/references/hub/space/SpaceSubscription.mdx b/content/docs/references/hub/space/SpaceSubscription.mdx index 3651441d5..14cd798e0 100644 --- a/content/docs/references/hub/space/SpaceSubscription.mdx +++ b/content/docs/references/hub/space/SpaceSubscription.mdx @@ -5,9 +5,6 @@ category: hub zodFile: space --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/space.zod.ts` diff --git a/content/docs/references/hub/space/SubscriptionStatus.mdx b/content/docs/references/hub/space/SubscriptionStatus.mdx index 544fccead..ead6549d2 100644 --- a/content/docs/references/hub/space/SubscriptionStatus.mdx +++ b/content/docs/references/hub/space/SubscriptionStatus.mdx @@ -5,9 +5,6 @@ category: hub zodFile: space --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/space.zod.ts` diff --git a/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx b/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx index 0bdcd6f20..e0fa7304d 100644 --- a/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx +++ b/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx b/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx index 52df9d720..fa8f652a8 100644 --- a/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx +++ b/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx b/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx index 80c1f39a3..a80a893fc 100644 --- a/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx +++ b/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/Tenant.mdx b/content/docs/references/hub/tenant/Tenant.mdx index b8bfdeffb..d082e9adf 100644 --- a/content/docs/references/hub/tenant/Tenant.mdx +++ b/content/docs/references/hub/tenant/Tenant.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/TenantIsolationConfig.mdx b/content/docs/references/hub/tenant/TenantIsolationConfig.mdx index 90eefe6cc..dd99923bb 100644 --- a/content/docs/references/hub/tenant/TenantIsolationConfig.mdx +++ b/content/docs/references/hub/tenant/TenantIsolationConfig.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/TenantIsolationLevel.mdx b/content/docs/references/hub/tenant/TenantIsolationLevel.mdx index f1cd1f80e..8f61bc454 100644 --- a/content/docs/references/hub/tenant/TenantIsolationLevel.mdx +++ b/content/docs/references/hub/tenant/TenantIsolationLevel.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/TenantQuota.mdx b/content/docs/references/hub/tenant/TenantQuota.mdx index a4c19ed5c..c32ac8dcc 100644 --- a/content/docs/references/hub/tenant/TenantQuota.mdx +++ b/content/docs/references/hub/tenant/TenantQuota.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx b/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx index 992b45d4f..89068f38d 100644 --- a/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx +++ b/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx @@ -5,9 +5,6 @@ category: hub zodFile: tenant --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/hub/tenant.zod.ts` diff --git a/content/docs/references/index.mdx b/content/docs/references/index.mdx index a5cc19a23..c99c85655 100644 --- a/content/docs/references/index.mdx +++ b/content/docs/references/index.mdx @@ -3,7 +3,6 @@ title: Protocol Reference description: Complete API reference for all ObjectStack protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Protocol Reference diff --git a/content/docs/references/permission/index.mdx b/content/docs/references/permission/index.mdx index 7523ce41b..e1366bbd2 100644 --- a/content/docs/references/permission/index.mdx +++ b/content/docs/references/permission/index.mdx @@ -3,7 +3,6 @@ title: Permission Protocol Overview description: Complete reference for all permission protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Permission Protocol diff --git a/content/docs/references/permission/permission/FieldPermission.mdx b/content/docs/references/permission/permission/FieldPermission.mdx index 5201cd3fa..bf6204a59 100644 --- a/content/docs/references/permission/permission/FieldPermission.mdx +++ b/content/docs/references/permission/permission/FieldPermission.mdx @@ -5,9 +5,6 @@ category: permission zodFile: permission --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/permission.zod.ts` diff --git a/content/docs/references/permission/permission/ObjectPermission.mdx b/content/docs/references/permission/permission/ObjectPermission.mdx index 5aa5e6993..8a3e399e9 100644 --- a/content/docs/references/permission/permission/ObjectPermission.mdx +++ b/content/docs/references/permission/permission/ObjectPermission.mdx @@ -5,9 +5,6 @@ category: permission zodFile: permission --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/permission.zod.ts` diff --git a/content/docs/references/permission/permission/PermissionSet.mdx b/content/docs/references/permission/permission/PermissionSet.mdx index 0809c2777..ca6e372d8 100644 --- a/content/docs/references/permission/permission/PermissionSet.mdx +++ b/content/docs/references/permission/permission/PermissionSet.mdx @@ -5,9 +5,6 @@ category: permission zodFile: permission --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/permission.zod.ts` diff --git a/content/docs/references/permission/rls/RLSConfig.mdx b/content/docs/references/permission/rls/RLSConfig.mdx index de17b6eee..e14e7ffa3 100644 --- a/content/docs/references/permission/rls/RLSConfig.mdx +++ b/content/docs/references/permission/rls/RLSConfig.mdx @@ -5,9 +5,6 @@ category: permission zodFile: rls --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/rls.zod.ts` diff --git a/content/docs/references/permission/rls/RLSEvaluationResult.mdx b/content/docs/references/permission/rls/RLSEvaluationResult.mdx index 9ec7ad694..d09baf5de 100644 --- a/content/docs/references/permission/rls/RLSEvaluationResult.mdx +++ b/content/docs/references/permission/rls/RLSEvaluationResult.mdx @@ -5,9 +5,6 @@ category: permission zodFile: rls --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/rls.zod.ts` diff --git a/content/docs/references/permission/rls/RLSOperation.mdx b/content/docs/references/permission/rls/RLSOperation.mdx index 6a27f52a4..96ae64635 100644 --- a/content/docs/references/permission/rls/RLSOperation.mdx +++ b/content/docs/references/permission/rls/RLSOperation.mdx @@ -5,9 +5,6 @@ category: permission zodFile: rls --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/rls.zod.ts` diff --git a/content/docs/references/permission/rls/RLSUserContext.mdx b/content/docs/references/permission/rls/RLSUserContext.mdx index 318081760..e85d0fd0a 100644 --- a/content/docs/references/permission/rls/RLSUserContext.mdx +++ b/content/docs/references/permission/rls/RLSUserContext.mdx @@ -5,9 +5,6 @@ category: permission zodFile: rls --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/rls.zod.ts` diff --git a/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx b/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx index cbc20f1c0..e3f4aa6b9 100644 --- a/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx +++ b/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx @@ -5,9 +5,6 @@ category: permission zodFile: rls --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/rls.zod.ts` diff --git a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx index f849a65ef..29fe79123 100644 --- a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx +++ b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/sharing/OWDModel.mdx b/content/docs/references/permission/sharing/OWDModel.mdx index 7e2869fdd..68f578dff 100644 --- a/content/docs/references/permission/sharing/OWDModel.mdx +++ b/content/docs/references/permission/sharing/OWDModel.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/sharing/OwnerSharingRule.mdx b/content/docs/references/permission/sharing/OwnerSharingRule.mdx index 9b49a3f8e..b49519609 100644 --- a/content/docs/references/permission/sharing/OwnerSharingRule.mdx +++ b/content/docs/references/permission/sharing/OwnerSharingRule.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/sharing/ShareRecipientType.mdx b/content/docs/references/permission/sharing/ShareRecipientType.mdx index 59ee40853..2a23e3cca 100644 --- a/content/docs/references/permission/sharing/ShareRecipientType.mdx +++ b/content/docs/references/permission/sharing/ShareRecipientType.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/sharing/SharingLevel.mdx b/content/docs/references/permission/sharing/SharingLevel.mdx index fbfb0b32c..d86cbbb63 100644 --- a/content/docs/references/permission/sharing/SharingLevel.mdx +++ b/content/docs/references/permission/sharing/SharingLevel.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/sharing/SharingRule.mdx b/content/docs/references/permission/sharing/SharingRule.mdx index 48d9aaae0..9148169e6 100644 --- a/content/docs/references/permission/sharing/SharingRule.mdx +++ b/content/docs/references/permission/sharing/SharingRule.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/sharing/SharingRuleType.mdx b/content/docs/references/permission/sharing/SharingRuleType.mdx index 5865f5f30..51aeee259 100644 --- a/content/docs/references/permission/sharing/SharingRuleType.mdx +++ b/content/docs/references/permission/sharing/SharingRuleType.mdx @@ -5,9 +5,6 @@ category: permission zodFile: sharing --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/sharing.zod.ts` diff --git a/content/docs/references/permission/territory/Territory.mdx b/content/docs/references/permission/territory/Territory.mdx index 7731997d2..90c2cf76c 100644 --- a/content/docs/references/permission/territory/Territory.mdx +++ b/content/docs/references/permission/territory/Territory.mdx @@ -5,9 +5,6 @@ category: permission zodFile: territory --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/territory.zod.ts` diff --git a/content/docs/references/permission/territory/TerritoryModel.mdx b/content/docs/references/permission/territory/TerritoryModel.mdx index 5ed23dec2..f0d305241 100644 --- a/content/docs/references/permission/territory/TerritoryModel.mdx +++ b/content/docs/references/permission/territory/TerritoryModel.mdx @@ -5,9 +5,6 @@ category: permission zodFile: territory --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/territory.zod.ts` diff --git a/content/docs/references/permission/territory/TerritoryType.mdx b/content/docs/references/permission/territory/TerritoryType.mdx index cb5e3a4aa..98a86d704 100644 --- a/content/docs/references/permission/territory/TerritoryType.mdx +++ b/content/docs/references/permission/territory/TerritoryType.mdx @@ -5,9 +5,6 @@ category: permission zodFile: territory --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/permission/territory.zod.ts` diff --git a/content/docs/references/protocol-map.mdx b/content/docs/references/protocol-map.mdx index d1233961f..e786a6354 100644 --- a/content/docs/references/protocol-map.mdx +++ b/content/docs/references/protocol-map.mdx @@ -3,8 +3,6 @@ title: Protocol Architecture Map description: Visual guide to ObjectStack protocol relationships and dependencies --- -import { Callout } from 'fumadocs-ui/components/callout'; -import { Card, Cards } from 'fumadocs-ui/components/card'; # Protocol Architecture Map diff --git a/content/docs/references/quick-reference.mdx b/content/docs/references/quick-reference.mdx index 932a83ece..48f8dcd86 100644 --- a/content/docs/references/quick-reference.mdx +++ b/content/docs/references/quick-reference.mdx @@ -3,8 +3,6 @@ title: Quick Reference Guide description: Fast lookup table for all ObjectStack protocols --- -import { Tabs, Tab } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; # Quick Reference Guide diff --git a/content/docs/references/shared/identifiers/EventName.mdx b/content/docs/references/shared/identifiers/EventName.mdx index c7cd5ad14..4cf40a384 100644 --- a/content/docs/references/shared/identifiers/EventName.mdx +++ b/content/docs/references/shared/identifiers/EventName.mdx @@ -5,9 +5,6 @@ category: shared zodFile: identifiers --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Event name (lowercase with dot notation for namespacing) diff --git a/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx b/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx index af36a8320..9f296b945 100644 --- a/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx +++ b/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx @@ -5,9 +5,6 @@ category: shared zodFile: identifiers --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Snake case identifier (lowercase with underscores only) diff --git a/content/docs/references/shared/identifiers/SystemIdentifier.mdx b/content/docs/references/shared/identifiers/SystemIdentifier.mdx index c32744e11..aeb82dd23 100644 --- a/content/docs/references/shared/identifiers/SystemIdentifier.mdx +++ b/content/docs/references/shared/identifiers/SystemIdentifier.mdx @@ -5,9 +5,6 @@ category: shared zodFile: identifiers --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; System identifier (lowercase with underscores or dots) diff --git a/content/docs/references/shared/index.mdx b/content/docs/references/shared/index.mdx index c3d39c556..50bf2d8f1 100644 --- a/content/docs/references/shared/index.mdx +++ b/content/docs/references/shared/index.mdx @@ -3,7 +3,6 @@ title: Shared Protocol Overview description: Complete reference for all shared protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # Shared Protocol diff --git a/content/docs/references/system/audit/AuditConfig.mdx b/content/docs/references/system/audit/AuditConfig.mdx index 74d17bd71..5b942b1a3 100644 --- a/content/docs/references/system/audit/AuditConfig.mdx +++ b/content/docs/references/system/audit/AuditConfig.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEvent.mdx b/content/docs/references/system/audit/AuditEvent.mdx index 332096561..f5d080d54 100644 --- a/content/docs/references/system/audit/AuditEvent.mdx +++ b/content/docs/references/system/audit/AuditEvent.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEventActor.mdx b/content/docs/references/system/audit/AuditEventActor.mdx index 40f3fa760..cb7bf05cd 100644 --- a/content/docs/references/system/audit/AuditEventActor.mdx +++ b/content/docs/references/system/audit/AuditEventActor.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEventChange.mdx b/content/docs/references/system/audit/AuditEventChange.mdx index ec7e587c4..72b020ec5 100644 --- a/content/docs/references/system/audit/AuditEventChange.mdx +++ b/content/docs/references/system/audit/AuditEventChange.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEventFilter.mdx b/content/docs/references/system/audit/AuditEventFilter.mdx index c5e6fac98..df99baaac 100644 --- a/content/docs/references/system/audit/AuditEventFilter.mdx +++ b/content/docs/references/system/audit/AuditEventFilter.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEventSeverity.mdx b/content/docs/references/system/audit/AuditEventSeverity.mdx index 44cdcd301..ada0adc4e 100644 --- a/content/docs/references/system/audit/AuditEventSeverity.mdx +++ b/content/docs/references/system/audit/AuditEventSeverity.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEventTarget.mdx b/content/docs/references/system/audit/AuditEventTarget.mdx index 8091dd09e..7c0e4e3f3 100644 --- a/content/docs/references/system/audit/AuditEventTarget.mdx +++ b/content/docs/references/system/audit/AuditEventTarget.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditEventType.mdx b/content/docs/references/system/audit/AuditEventType.mdx index 0e9fa85f6..41d563983 100644 --- a/content/docs/references/system/audit/AuditEventType.mdx +++ b/content/docs/references/system/audit/AuditEventType.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditRetentionPolicy.mdx b/content/docs/references/system/audit/AuditRetentionPolicy.mdx index 87fe3b6b2..a37de681d 100644 --- a/content/docs/references/system/audit/AuditRetentionPolicy.mdx +++ b/content/docs/references/system/audit/AuditRetentionPolicy.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/AuditStorageConfig.mdx b/content/docs/references/system/audit/AuditStorageConfig.mdx index afa716a83..0f6379b4f 100644 --- a/content/docs/references/system/audit/AuditStorageConfig.mdx +++ b/content/docs/references/system/audit/AuditStorageConfig.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/audit/SuspiciousActivityRule.mdx b/content/docs/references/system/audit/SuspiciousActivityRule.mdx index 1b8fb2140..a6661d028 100644 --- a/content/docs/references/system/audit/SuspiciousActivityRule.mdx +++ b/content/docs/references/system/audit/SuspiciousActivityRule.mdx @@ -5,9 +5,6 @@ category: system zodFile: audit --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/audit.zod.ts` diff --git a/content/docs/references/system/context/KernelContext.mdx b/content/docs/references/system/context/KernelContext.mdx index 674d5890e..fa868fe86 100644 --- a/content/docs/references/system/context/KernelContext.mdx +++ b/content/docs/references/system/context/KernelContext.mdx @@ -5,9 +5,6 @@ category: system zodFile: context --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/context.zod.ts` diff --git a/content/docs/references/system/context/RuntimeMode.mdx b/content/docs/references/system/context/RuntimeMode.mdx index b9ffa16a5..d35309640 100644 --- a/content/docs/references/system/context/RuntimeMode.mdx +++ b/content/docs/references/system/context/RuntimeMode.mdx @@ -5,9 +5,6 @@ category: system zodFile: context --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Kernel operating mode diff --git a/content/docs/references/system/datasource/Datasource.mdx b/content/docs/references/system/datasource/Datasource.mdx index 59860631f..e0633ff62 100644 --- a/content/docs/references/system/datasource/Datasource.mdx +++ b/content/docs/references/system/datasource/Datasource.mdx @@ -5,9 +5,6 @@ category: system zodFile: datasource --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/datasource.zod.ts` diff --git a/content/docs/references/system/datasource/DatasourceCapabilities.mdx b/content/docs/references/system/datasource/DatasourceCapabilities.mdx index a4ab55314..4a5d229df 100644 --- a/content/docs/references/system/datasource/DatasourceCapabilities.mdx +++ b/content/docs/references/system/datasource/DatasourceCapabilities.mdx @@ -5,9 +5,6 @@ category: system zodFile: datasource --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/datasource.zod.ts` diff --git a/content/docs/references/system/datasource/DriverDefinition.mdx b/content/docs/references/system/datasource/DriverDefinition.mdx index d0b95dfcf..568d70938 100644 --- a/content/docs/references/system/datasource/DriverDefinition.mdx +++ b/content/docs/references/system/datasource/DriverDefinition.mdx @@ -5,9 +5,6 @@ category: system zodFile: datasource --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/datasource.zod.ts` diff --git a/content/docs/references/system/datasource/DriverType.mdx b/content/docs/references/system/datasource/DriverType.mdx index f2cff3c56..fc10154f4 100644 --- a/content/docs/references/system/datasource/DriverType.mdx +++ b/content/docs/references/system/datasource/DriverType.mdx @@ -5,9 +5,6 @@ category: system zodFile: datasource --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Underlying driver identifier diff --git a/content/docs/references/system/driver/DriverCapabilities.mdx b/content/docs/references/system/driver/DriverCapabilities.mdx index 0f2e424bd..f619a2df0 100644 --- a/content/docs/references/system/driver/DriverCapabilities.mdx +++ b/content/docs/references/system/driver/DriverCapabilities.mdx @@ -5,9 +5,6 @@ category: system zodFile: driver --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/driver.zod.ts` diff --git a/content/docs/references/system/driver/DriverInterface.mdx b/content/docs/references/system/driver/DriverInterface.mdx index dc8951e4c..98861c870 100644 --- a/content/docs/references/system/driver/DriverInterface.mdx +++ b/content/docs/references/system/driver/DriverInterface.mdx @@ -5,9 +5,6 @@ category: system zodFile: driver --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/driver.zod.ts` diff --git a/content/docs/references/system/driver/DriverOptions.mdx b/content/docs/references/system/driver/DriverOptions.mdx index fbc423a17..5f73036d6 100644 --- a/content/docs/references/system/driver/DriverOptions.mdx +++ b/content/docs/references/system/driver/DriverOptions.mdx @@ -5,9 +5,6 @@ category: system zodFile: driver --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/driver.zod.ts` diff --git a/content/docs/references/system/events/Event.mdx b/content/docs/references/system/events/Event.mdx index 35a8eee62..fe01cb2b5 100644 --- a/content/docs/references/system/events/Event.mdx +++ b/content/docs/references/system/events/Event.mdx @@ -5,9 +5,6 @@ category: system zodFile: events --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/events.zod.ts` diff --git a/content/docs/references/system/events/EventHandler.mdx b/content/docs/references/system/events/EventHandler.mdx index 4fd2bec2e..c0a04ba91 100644 --- a/content/docs/references/system/events/EventHandler.mdx +++ b/content/docs/references/system/events/EventHandler.mdx @@ -5,9 +5,6 @@ category: system zodFile: events --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/events.zod.ts` diff --git a/content/docs/references/system/events/EventMetadata.mdx b/content/docs/references/system/events/EventMetadata.mdx index a778a0305..f8b5af6ae 100644 --- a/content/docs/references/system/events/EventMetadata.mdx +++ b/content/docs/references/system/events/EventMetadata.mdx @@ -5,9 +5,6 @@ category: system zodFile: events --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/events.zod.ts` diff --git a/content/docs/references/system/events/EventPersistence.mdx b/content/docs/references/system/events/EventPersistence.mdx index f006222cd..ee037ef8f 100644 --- a/content/docs/references/system/events/EventPersistence.mdx +++ b/content/docs/references/system/events/EventPersistence.mdx @@ -5,9 +5,6 @@ category: system zodFile: events --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/events.zod.ts` diff --git a/content/docs/references/system/events/EventRoute.mdx b/content/docs/references/system/events/EventRoute.mdx index 0b17beaef..8301914d9 100644 --- a/content/docs/references/system/events/EventRoute.mdx +++ b/content/docs/references/system/events/EventRoute.mdx @@ -5,9 +5,6 @@ category: system zodFile: events --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/events.zod.ts` diff --git a/content/docs/references/system/feature/FeatureFlag.mdx b/content/docs/references/system/feature/FeatureFlag.mdx index 133aeb5fa..0ee334a03 100644 --- a/content/docs/references/system/feature/FeatureFlag.mdx +++ b/content/docs/references/system/feature/FeatureFlag.mdx @@ -5,9 +5,6 @@ category: system zodFile: feature --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/feature.zod.ts` diff --git a/content/docs/references/system/feature/FeatureStrategy.mdx b/content/docs/references/system/feature/FeatureStrategy.mdx index d366448b0..5c2af0c75 100644 --- a/content/docs/references/system/feature/FeatureStrategy.mdx +++ b/content/docs/references/system/feature/FeatureStrategy.mdx @@ -5,9 +5,6 @@ category: system zodFile: feature --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/feature.zod.ts` diff --git a/content/docs/references/system/index.mdx b/content/docs/references/system/index.mdx index 55c041bd3..233f43d70 100644 --- a/content/docs/references/system/index.mdx +++ b/content/docs/references/system/index.mdx @@ -3,7 +3,6 @@ title: System Protocol Overview description: Complete reference for all system protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # System Protocol diff --git a/content/docs/references/system/job/CronSchedule.mdx b/content/docs/references/system/job/CronSchedule.mdx index b778f9c4b..d5ca20a9c 100644 --- a/content/docs/references/system/job/CronSchedule.mdx +++ b/content/docs/references/system/job/CronSchedule.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/IntervalSchedule.mdx b/content/docs/references/system/job/IntervalSchedule.mdx index c7d769e44..bd0bc5673 100644 --- a/content/docs/references/system/job/IntervalSchedule.mdx +++ b/content/docs/references/system/job/IntervalSchedule.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/Job.mdx b/content/docs/references/system/job/Job.mdx index ef587722e..524215ce8 100644 --- a/content/docs/references/system/job/Job.mdx +++ b/content/docs/references/system/job/Job.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/JobExecution.mdx b/content/docs/references/system/job/JobExecution.mdx index e9c7f194d..8b40ceddb 100644 --- a/content/docs/references/system/job/JobExecution.mdx +++ b/content/docs/references/system/job/JobExecution.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/JobExecutionStatus.mdx b/content/docs/references/system/job/JobExecutionStatus.mdx index a31357782..7d3cde079 100644 --- a/content/docs/references/system/job/JobExecutionStatus.mdx +++ b/content/docs/references/system/job/JobExecutionStatus.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/OnceSchedule.mdx b/content/docs/references/system/job/OnceSchedule.mdx index a9401e70c..221e967fb 100644 --- a/content/docs/references/system/job/OnceSchedule.mdx +++ b/content/docs/references/system/job/OnceSchedule.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/RetryPolicy.mdx b/content/docs/references/system/job/RetryPolicy.mdx index 5882d1f14..c114bd300 100644 --- a/content/docs/references/system/job/RetryPolicy.mdx +++ b/content/docs/references/system/job/RetryPolicy.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/job/Schedule.mdx b/content/docs/references/system/job/Schedule.mdx index 23729708b..5c7f3b549 100644 --- a/content/docs/references/system/job/Schedule.mdx +++ b/content/docs/references/system/job/Schedule.mdx @@ -5,9 +5,6 @@ category: system zodFile: job --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/job.zod.ts` diff --git a/content/docs/references/system/logger/LogEntry.mdx b/content/docs/references/system/logger/LogEntry.mdx index 8614951ee..9c1d4a56c 100644 --- a/content/docs/references/system/logger/LogEntry.mdx +++ b/content/docs/references/system/logger/LogEntry.mdx @@ -5,9 +5,6 @@ category: system zodFile: logger --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/logger.zod.ts` diff --git a/content/docs/references/system/logger/LogFormat.mdx b/content/docs/references/system/logger/LogFormat.mdx index be9ca9855..a588bcd43 100644 --- a/content/docs/references/system/logger/LogFormat.mdx +++ b/content/docs/references/system/logger/LogFormat.mdx @@ -5,9 +5,6 @@ category: system zodFile: logger --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Log output format diff --git a/content/docs/references/system/logger/LogLevel.mdx b/content/docs/references/system/logger/LogLevel.mdx index ca8798d9c..d6a5eeb45 100644 --- a/content/docs/references/system/logger/LogLevel.mdx +++ b/content/docs/references/system/logger/LogLevel.mdx @@ -5,9 +5,6 @@ category: system zodFile: logger --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Log severity level diff --git a/content/docs/references/system/logger/LoggerConfig.mdx b/content/docs/references/system/logger/LoggerConfig.mdx index 9ee1c8c9d..6084f4cc4 100644 --- a/content/docs/references/system/logger/LoggerConfig.mdx +++ b/content/docs/references/system/logger/LoggerConfig.mdx @@ -5,9 +5,6 @@ category: system zodFile: logger --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/logger.zod.ts` diff --git a/content/docs/references/system/manifest/Manifest.mdx b/content/docs/references/system/manifest/Manifest.mdx index bf435bc5c..7a0112592 100644 --- a/content/docs/references/system/manifest/Manifest.mdx +++ b/content/docs/references/system/manifest/Manifest.mdx @@ -5,9 +5,6 @@ category: system zodFile: manifest --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/manifest.zod.ts` diff --git a/content/docs/references/system/misc/MongoConfig.mdx b/content/docs/references/system/misc/MongoConfig.mdx index fbc72ac80..b0fd47143 100644 --- a/content/docs/references/system/misc/MongoConfig.mdx +++ b/content/docs/references/system/misc/MongoConfig.mdx @@ -5,9 +5,6 @@ category: system zodFile: misc --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/misc.zod.ts` diff --git a/content/docs/references/system/misc/PostgresConfig.mdx b/content/docs/references/system/misc/PostgresConfig.mdx index 9291490da..c53740d27 100644 --- a/content/docs/references/system/misc/PostgresConfig.mdx +++ b/content/docs/references/system/misc/PostgresConfig.mdx @@ -5,9 +5,6 @@ category: system zodFile: misc --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/misc.zod.ts` diff --git a/content/docs/references/system/plugin/I18nContext.mdx b/content/docs/references/system/plugin/I18nContext.mdx index 64eeeb65b..83334b304 100644 --- a/content/docs/references/system/plugin/I18nContext.mdx +++ b/content/docs/references/system/plugin/I18nContext.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Internationalization Helper diff --git a/content/docs/references/system/plugin/Logger.mdx b/content/docs/references/system/plugin/Logger.mdx index bcf18f8b3..e5a08a780 100644 --- a/content/docs/references/system/plugin/Logger.mdx +++ b/content/docs/references/system/plugin/Logger.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Structured Logger diff --git a/content/docs/references/system/plugin/ObjectQLClient.mdx b/content/docs/references/system/plugin/ObjectQLClient.mdx index 6eb4143f8..f403f56f1 100644 --- a/content/docs/references/system/plugin/ObjectQLClient.mdx +++ b/content/docs/references/system/plugin/ObjectQLClient.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; ObjectQL Data Access Client diff --git a/content/docs/references/system/plugin/Plugin.mdx b/content/docs/references/system/plugin/Plugin.mdx index d3aa58f04..c5aa3310a 100644 --- a/content/docs/references/system/plugin/Plugin.mdx +++ b/content/docs/references/system/plugin/Plugin.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/plugin.zod.ts` diff --git a/content/docs/references/system/plugin/PluginContext.mdx b/content/docs/references/system/plugin/PluginContext.mdx index 2b284dbbb..d9fec97ee 100644 --- a/content/docs/references/system/plugin/PluginContext.mdx +++ b/content/docs/references/system/plugin/PluginContext.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/plugin.zod.ts` diff --git a/content/docs/references/system/plugin/PluginLifecycle.mdx b/content/docs/references/system/plugin/PluginLifecycle.mdx index 9ca46bbcd..aa9e88a83 100644 --- a/content/docs/references/system/plugin/PluginLifecycle.mdx +++ b/content/docs/references/system/plugin/PluginLifecycle.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/plugin.zod.ts` diff --git a/content/docs/references/system/plugin/Router.mdx b/content/docs/references/system/plugin/Router.mdx index 700c2eb8f..e47be7df3 100644 --- a/content/docs/references/system/plugin/Router.mdx +++ b/content/docs/references/system/plugin/Router.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; HTTP Router Interface diff --git a/content/docs/references/system/plugin/Scheduler.mdx b/content/docs/references/system/plugin/Scheduler.mdx index 9ac08b156..3034b7788 100644 --- a/content/docs/references/system/plugin/Scheduler.mdx +++ b/content/docs/references/system/plugin/Scheduler.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Job Scheduler Interface diff --git a/content/docs/references/system/plugin/ScopedStorage.mdx b/content/docs/references/system/plugin/ScopedStorage.mdx index 8c4b454ca..5e0bde096 100644 --- a/content/docs/references/system/plugin/ScopedStorage.mdx +++ b/content/docs/references/system/plugin/ScopedStorage.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Plugin Scoped Data Storage (KV) diff --git a/content/docs/references/system/plugin/SystemAPI.mdx b/content/docs/references/system/plugin/SystemAPI.mdx index f4a68b1ba..ab00b912d 100644 --- a/content/docs/references/system/plugin/SystemAPI.mdx +++ b/content/docs/references/system/plugin/SystemAPI.mdx @@ -5,9 +5,6 @@ category: system zodFile: plugin --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Access to System Core diff --git a/content/docs/references/system/scoped-storage/FileMetadata.mdx b/content/docs/references/system/scoped-storage/FileMetadata.mdx index 1401ef407..3fbb1cc9a 100644 --- a/content/docs/references/system/scoped-storage/FileMetadata.mdx +++ b/content/docs/references/system/scoped-storage/FileMetadata.mdx @@ -5,9 +5,6 @@ category: system zodFile: scoped-storage --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/scoped-storage.zod.ts` diff --git a/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx b/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx index b96b07b8b..a8d0fbcae 100644 --- a/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx +++ b/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx @@ -5,9 +5,6 @@ category: system zodFile: scoped-storage --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/scoped-storage.zod.ts` diff --git a/content/docs/references/system/scoped-storage/StorageAdapterType.mdx b/content/docs/references/system/scoped-storage/StorageAdapterType.mdx index 49fa452ca..71104f04c 100644 --- a/content/docs/references/system/scoped-storage/StorageAdapterType.mdx +++ b/content/docs/references/system/scoped-storage/StorageAdapterType.mdx @@ -5,9 +5,6 @@ category: system zodFile: scoped-storage --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/scoped-storage.zod.ts` diff --git a/content/docs/references/system/scoped-storage/StorageScope.mdx b/content/docs/references/system/scoped-storage/StorageScope.mdx index b56577eaf..c05feb579 100644 --- a/content/docs/references/system/scoped-storage/StorageScope.mdx +++ b/content/docs/references/system/scoped-storage/StorageScope.mdx @@ -5,9 +5,6 @@ category: system zodFile: scoped-storage --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; Generic storage scope classification diff --git a/content/docs/references/system/translation/Locale.mdx b/content/docs/references/system/translation/Locale.mdx index 0665d76da..13374cd81 100644 --- a/content/docs/references/system/translation/Locale.mdx +++ b/content/docs/references/system/translation/Locale.mdx @@ -5,9 +5,6 @@ category: system zodFile: translation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; BCP-47 Language Tag (e.g. en-US, zh-CN) diff --git a/content/docs/references/system/translation/TranslationBundle.mdx b/content/docs/references/system/translation/TranslationBundle.mdx index ebe834faf..ccddeacf2 100644 --- a/content/docs/references/system/translation/TranslationBundle.mdx +++ b/content/docs/references/system/translation/TranslationBundle.mdx @@ -5,9 +5,6 @@ category: system zodFile: translation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/translation.zod.ts` diff --git a/content/docs/references/system/translation/TranslationData.mdx b/content/docs/references/system/translation/TranslationData.mdx index 38c07ab0c..43a820138 100644 --- a/content/docs/references/system/translation/TranslationData.mdx +++ b/content/docs/references/system/translation/TranslationData.mdx @@ -5,9 +5,6 @@ category: system zodFile: translation --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/system/translation.zod.ts` diff --git a/content/docs/references/ui/action/Action.mdx b/content/docs/references/ui/action/Action.mdx index 5e62ee619..691d0dd29 100644 --- a/content/docs/references/ui/action/Action.mdx +++ b/content/docs/references/ui/action/Action.mdx @@ -5,9 +5,6 @@ category: ui zodFile: action --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/action.zod.ts` diff --git a/content/docs/references/ui/action/ActionParam.mdx b/content/docs/references/ui/action/ActionParam.mdx index e614ae991..d3eb10fc5 100644 --- a/content/docs/references/ui/action/ActionParam.mdx +++ b/content/docs/references/ui/action/ActionParam.mdx @@ -5,9 +5,6 @@ category: ui zodFile: action --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/action.zod.ts` diff --git a/content/docs/references/ui/app/App.mdx b/content/docs/references/ui/app/App.mdx index ab07ebdcb..9e0940387 100644 --- a/content/docs/references/ui/app/App.mdx +++ b/content/docs/references/ui/app/App.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/AppBranding.mdx b/content/docs/references/ui/app/AppBranding.mdx index 386f35b18..75412e626 100644 --- a/content/docs/references/ui/app/AppBranding.mdx +++ b/content/docs/references/ui/app/AppBranding.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/DashboardNavItem.mdx b/content/docs/references/ui/app/DashboardNavItem.mdx index 1cd900269..aadd62d21 100644 --- a/content/docs/references/ui/app/DashboardNavItem.mdx +++ b/content/docs/references/ui/app/DashboardNavItem.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/GroupNavItem.mdx b/content/docs/references/ui/app/GroupNavItem.mdx index d60d1949a..9482539fd 100644 --- a/content/docs/references/ui/app/GroupNavItem.mdx +++ b/content/docs/references/ui/app/GroupNavItem.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/NavigationItem.mdx b/content/docs/references/ui/app/NavigationItem.mdx index 50110bce1..2ba6d23ee 100644 --- a/content/docs/references/ui/app/NavigationItem.mdx +++ b/content/docs/references/ui/app/NavigationItem.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/ObjectNavItem.mdx b/content/docs/references/ui/app/ObjectNavItem.mdx index 23dcc74fb..727cb054b 100644 --- a/content/docs/references/ui/app/ObjectNavItem.mdx +++ b/content/docs/references/ui/app/ObjectNavItem.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/PageNavItem.mdx b/content/docs/references/ui/app/PageNavItem.mdx index b1b5d64ac..9c00b48b5 100644 --- a/content/docs/references/ui/app/PageNavItem.mdx +++ b/content/docs/references/ui/app/PageNavItem.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/app/UrlNavItem.mdx b/content/docs/references/ui/app/UrlNavItem.mdx index 6ffd51941..6beabf08b 100644 --- a/content/docs/references/ui/app/UrlNavItem.mdx +++ b/content/docs/references/ui/app/UrlNavItem.mdx @@ -5,9 +5,6 @@ category: ui zodFile: app --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/app.zod.ts` diff --git a/content/docs/references/ui/component/PageCardProps.mdx b/content/docs/references/ui/component/PageCardProps.mdx index ac94f884d..091ee5f3b 100644 --- a/content/docs/references/ui/component/PageCardProps.mdx +++ b/content/docs/references/ui/component/PageCardProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: component --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/component.zod.ts` diff --git a/content/docs/references/ui/component/PageHeaderProps.mdx b/content/docs/references/ui/component/PageHeaderProps.mdx index 37d33a1ac..d7b71e749 100644 --- a/content/docs/references/ui/component/PageHeaderProps.mdx +++ b/content/docs/references/ui/component/PageHeaderProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: component --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/component.zod.ts` diff --git a/content/docs/references/ui/component/PageTabsProps.mdx b/content/docs/references/ui/component/PageTabsProps.mdx index 908ff91fc..3f28ab337 100644 --- a/content/docs/references/ui/component/PageTabsProps.mdx +++ b/content/docs/references/ui/component/PageTabsProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: component --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/component.zod.ts` diff --git a/content/docs/references/ui/component/RecordDetailsProps.mdx b/content/docs/references/ui/component/RecordDetailsProps.mdx index c56290920..197197279 100644 --- a/content/docs/references/ui/component/RecordDetailsProps.mdx +++ b/content/docs/references/ui/component/RecordDetailsProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: component --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/component.zod.ts` diff --git a/content/docs/references/ui/component/RecordHighlightsProps.mdx b/content/docs/references/ui/component/RecordHighlightsProps.mdx index 3330cbf27..116e01ab4 100644 --- a/content/docs/references/ui/component/RecordHighlightsProps.mdx +++ b/content/docs/references/ui/component/RecordHighlightsProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: component --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/component.zod.ts` diff --git a/content/docs/references/ui/component/RecordRelatedListProps.mdx b/content/docs/references/ui/component/RecordRelatedListProps.mdx index a383b7a98..bb17932a5 100644 --- a/content/docs/references/ui/component/RecordRelatedListProps.mdx +++ b/content/docs/references/ui/component/RecordRelatedListProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: component --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/component.zod.ts` diff --git a/content/docs/references/ui/dashboard/ChartType.mdx b/content/docs/references/ui/dashboard/ChartType.mdx index 0e313f926..d52df9f56 100644 --- a/content/docs/references/ui/dashboard/ChartType.mdx +++ b/content/docs/references/ui/dashboard/ChartType.mdx @@ -5,9 +5,6 @@ category: ui zodFile: dashboard --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/dashboard.zod.ts` diff --git a/content/docs/references/ui/dashboard/Dashboard.mdx b/content/docs/references/ui/dashboard/Dashboard.mdx index 03cf5a21f..97d77a9ad 100644 --- a/content/docs/references/ui/dashboard/Dashboard.mdx +++ b/content/docs/references/ui/dashboard/Dashboard.mdx @@ -5,9 +5,6 @@ category: ui zodFile: dashboard --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/dashboard.zod.ts` diff --git a/content/docs/references/ui/dashboard/DashboardWidget.mdx b/content/docs/references/ui/dashboard/DashboardWidget.mdx index 0c14f45b6..b7c9b6490 100644 --- a/content/docs/references/ui/dashboard/DashboardWidget.mdx +++ b/content/docs/references/ui/dashboard/DashboardWidget.mdx @@ -5,9 +5,6 @@ category: ui zodFile: dashboard --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/dashboard.zod.ts` diff --git a/content/docs/references/ui/index.mdx b/content/docs/references/ui/index.mdx index 8ccb1f215..4696930aa 100644 --- a/content/docs/references/ui/index.mdx +++ b/content/docs/references/ui/index.mdx @@ -3,7 +3,6 @@ title: UI Protocol Overview description: Complete reference for all ui protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; # UI Protocol diff --git a/content/docs/references/ui/page/Page.mdx b/content/docs/references/ui/page/Page.mdx index edd98d36e..1598b47b6 100644 --- a/content/docs/references/ui/page/Page.mdx +++ b/content/docs/references/ui/page/Page.mdx @@ -5,9 +5,6 @@ category: ui zodFile: page --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/page.zod.ts` diff --git a/content/docs/references/ui/page/PageComponent.mdx b/content/docs/references/ui/page/PageComponent.mdx index ac5ef737e..0c28660a2 100644 --- a/content/docs/references/ui/page/PageComponent.mdx +++ b/content/docs/references/ui/page/PageComponent.mdx @@ -5,9 +5,6 @@ category: ui zodFile: page --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/page.zod.ts` diff --git a/content/docs/references/ui/page/PageComponentType.mdx b/content/docs/references/ui/page/PageComponentType.mdx index bf7f8693f..e5fae63a3 100644 --- a/content/docs/references/ui/page/PageComponentType.mdx +++ b/content/docs/references/ui/page/PageComponentType.mdx @@ -5,9 +5,6 @@ category: ui zodFile: page --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/page.zod.ts` diff --git a/content/docs/references/ui/page/PageRegion.mdx b/content/docs/references/ui/page/PageRegion.mdx index dac43aef9..bdcc0967c 100644 --- a/content/docs/references/ui/page/PageRegion.mdx +++ b/content/docs/references/ui/page/PageRegion.mdx @@ -5,9 +5,6 @@ category: ui zodFile: page --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/page.zod.ts` diff --git a/content/docs/references/ui/report/Report.mdx b/content/docs/references/ui/report/Report.mdx index 0032794ba..49cc8a44b 100644 --- a/content/docs/references/ui/report/Report.mdx +++ b/content/docs/references/ui/report/Report.mdx @@ -5,9 +5,6 @@ category: ui zodFile: report --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/report.zod.ts` diff --git a/content/docs/references/ui/report/ReportChart.mdx b/content/docs/references/ui/report/ReportChart.mdx index 37a2e2840..d74665915 100644 --- a/content/docs/references/ui/report/ReportChart.mdx +++ b/content/docs/references/ui/report/ReportChart.mdx @@ -5,9 +5,6 @@ category: ui zodFile: report --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/report.zod.ts` diff --git a/content/docs/references/ui/report/ReportColumn.mdx b/content/docs/references/ui/report/ReportColumn.mdx index 9d67239c3..5b2223fa6 100644 --- a/content/docs/references/ui/report/ReportColumn.mdx +++ b/content/docs/references/ui/report/ReportColumn.mdx @@ -5,9 +5,6 @@ category: ui zodFile: report --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/report.zod.ts` diff --git a/content/docs/references/ui/report/ReportGrouping.mdx b/content/docs/references/ui/report/ReportGrouping.mdx index 5dc10dfa6..46314109e 100644 --- a/content/docs/references/ui/report/ReportGrouping.mdx +++ b/content/docs/references/ui/report/ReportGrouping.mdx @@ -5,9 +5,6 @@ category: ui zodFile: report --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/report.zod.ts` diff --git a/content/docs/references/ui/report/ReportType.mdx b/content/docs/references/ui/report/ReportType.mdx index 3763e6468..d33132c72 100644 --- a/content/docs/references/ui/report/ReportType.mdx +++ b/content/docs/references/ui/report/ReportType.mdx @@ -5,9 +5,6 @@ category: ui zodFile: report --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/report.zod.ts` diff --git a/content/docs/references/ui/theme/Animation.mdx b/content/docs/references/ui/theme/Animation.mdx index c9e414fcd..86efeba0a 100644 --- a/content/docs/references/ui/theme/Animation.mdx +++ b/content/docs/references/ui/theme/Animation.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/BorderRadius.mdx b/content/docs/references/ui/theme/BorderRadius.mdx index 2ee787234..ff17120a2 100644 --- a/content/docs/references/ui/theme/BorderRadius.mdx +++ b/content/docs/references/ui/theme/BorderRadius.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/Breakpoints.mdx b/content/docs/references/ui/theme/Breakpoints.mdx index b70e3fbbf..8bb0e9bf5 100644 --- a/content/docs/references/ui/theme/Breakpoints.mdx +++ b/content/docs/references/ui/theme/Breakpoints.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/ColorPalette.mdx b/content/docs/references/ui/theme/ColorPalette.mdx index e210464a2..e67839758 100644 --- a/content/docs/references/ui/theme/ColorPalette.mdx +++ b/content/docs/references/ui/theme/ColorPalette.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/Shadow.mdx b/content/docs/references/ui/theme/Shadow.mdx index d8cc42c91..71bdd00de 100644 --- a/content/docs/references/ui/theme/Shadow.mdx +++ b/content/docs/references/ui/theme/Shadow.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/Spacing.mdx b/content/docs/references/ui/theme/Spacing.mdx index 4d6915d9f..06eadc572 100644 --- a/content/docs/references/ui/theme/Spacing.mdx +++ b/content/docs/references/ui/theme/Spacing.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/Theme.mdx b/content/docs/references/ui/theme/Theme.mdx index 121ca79d7..4a663cc26 100644 --- a/content/docs/references/ui/theme/Theme.mdx +++ b/content/docs/references/ui/theme/Theme.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/ThemeMode.mdx b/content/docs/references/ui/theme/ThemeMode.mdx index 4a2136364..c8c926c66 100644 --- a/content/docs/references/ui/theme/ThemeMode.mdx +++ b/content/docs/references/ui/theme/ThemeMode.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/Typography.mdx b/content/docs/references/ui/theme/Typography.mdx index 5f5254b2b..d2c3b180c 100644 --- a/content/docs/references/ui/theme/Typography.mdx +++ b/content/docs/references/ui/theme/Typography.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/theme/ZIndex.mdx b/content/docs/references/ui/theme/ZIndex.mdx index 79b02ec74..52003a3f1 100644 --- a/content/docs/references/ui/theme/ZIndex.mdx +++ b/content/docs/references/ui/theme/ZIndex.mdx @@ -5,9 +5,6 @@ category: ui zodFile: theme --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/theme.zod.ts` diff --git a/content/docs/references/ui/view/CalendarConfig.mdx b/content/docs/references/ui/view/CalendarConfig.mdx index 5238030c9..50b508a4d 100644 --- a/content/docs/references/ui/view/CalendarConfig.mdx +++ b/content/docs/references/ui/view/CalendarConfig.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/FormField.mdx b/content/docs/references/ui/view/FormField.mdx index d14fca978..3433beed8 100644 --- a/content/docs/references/ui/view/FormField.mdx +++ b/content/docs/references/ui/view/FormField.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/FormSection.mdx b/content/docs/references/ui/view/FormSection.mdx index db34312c2..20de614ff 100644 --- a/content/docs/references/ui/view/FormSection.mdx +++ b/content/docs/references/ui/view/FormSection.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/FormView.mdx b/content/docs/references/ui/view/FormView.mdx index 18b6b17bb..fca3fb43d 100644 --- a/content/docs/references/ui/view/FormView.mdx +++ b/content/docs/references/ui/view/FormView.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/GanttConfig.mdx b/content/docs/references/ui/view/GanttConfig.mdx index dc7b82e28..64fe69c67 100644 --- a/content/docs/references/ui/view/GanttConfig.mdx +++ b/content/docs/references/ui/view/GanttConfig.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/HttpMethod.mdx b/content/docs/references/ui/view/HttpMethod.mdx index 3cc6290cb..73939ba9b 100644 --- a/content/docs/references/ui/view/HttpMethod.mdx +++ b/content/docs/references/ui/view/HttpMethod.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/HttpRequest.mdx b/content/docs/references/ui/view/HttpRequest.mdx index 7e08a5d76..93cee31a7 100644 --- a/content/docs/references/ui/view/HttpRequest.mdx +++ b/content/docs/references/ui/view/HttpRequest.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/KanbanConfig.mdx b/content/docs/references/ui/view/KanbanConfig.mdx index 00ad6ea24..f57159b62 100644 --- a/content/docs/references/ui/view/KanbanConfig.mdx +++ b/content/docs/references/ui/view/KanbanConfig.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/ListColumn.mdx b/content/docs/references/ui/view/ListColumn.mdx index 6ec1c6db1..6287282c5 100644 --- a/content/docs/references/ui/view/ListColumn.mdx +++ b/content/docs/references/ui/view/ListColumn.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/ListView.mdx b/content/docs/references/ui/view/ListView.mdx index dd1904cb0..8f446cd9d 100644 --- a/content/docs/references/ui/view/ListView.mdx +++ b/content/docs/references/ui/view/ListView.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/PaginationConfig.mdx b/content/docs/references/ui/view/PaginationConfig.mdx index 72f5e7893..6c8d29a83 100644 --- a/content/docs/references/ui/view/PaginationConfig.mdx +++ b/content/docs/references/ui/view/PaginationConfig.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/SelectionConfig.mdx b/content/docs/references/ui/view/SelectionConfig.mdx index 35750fcab..50f9dca3e 100644 --- a/content/docs/references/ui/view/SelectionConfig.mdx +++ b/content/docs/references/ui/view/SelectionConfig.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/View.mdx b/content/docs/references/ui/view/View.mdx index fc82e3864..75ebcf1d4 100644 --- a/content/docs/references/ui/view/View.mdx +++ b/content/docs/references/ui/view/View.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/view/ViewData.mdx b/content/docs/references/ui/view/ViewData.mdx index 1a7969634..3b33b9b6c 100644 --- a/content/docs/references/ui/view/ViewData.mdx +++ b/content/docs/references/ui/view/ViewData.mdx @@ -5,9 +5,6 @@ category: ui zodFile: view --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/view.zod.ts` diff --git a/content/docs/references/ui/widget/FieldWidgetProps.mdx b/content/docs/references/ui/widget/FieldWidgetProps.mdx index 59d0bf2b3..7efa357df 100644 --- a/content/docs/references/ui/widget/FieldWidgetProps.mdx +++ b/content/docs/references/ui/widget/FieldWidgetProps.mdx @@ -5,9 +5,6 @@ category: ui zodFile: widget --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/widget.zod.ts` diff --git a/content/docs/references/ui/widget/WidgetEvent.mdx b/content/docs/references/ui/widget/WidgetEvent.mdx index 3fc9ad832..0891ddfa2 100644 --- a/content/docs/references/ui/widget/WidgetEvent.mdx +++ b/content/docs/references/ui/widget/WidgetEvent.mdx @@ -5,9 +5,6 @@ category: ui zodFile: widget --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/widget.zod.ts` diff --git a/content/docs/references/ui/widget/WidgetLifecycle.mdx b/content/docs/references/ui/widget/WidgetLifecycle.mdx index c12578423..7beea3875 100644 --- a/content/docs/references/ui/widget/WidgetLifecycle.mdx +++ b/content/docs/references/ui/widget/WidgetLifecycle.mdx @@ -5,9 +5,6 @@ category: ui zodFile: widget --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/widget.zod.ts` diff --git a/content/docs/references/ui/widget/WidgetManifest.mdx b/content/docs/references/ui/widget/WidgetManifest.mdx index baff40cec..69f9f5dc9 100644 --- a/content/docs/references/ui/widget/WidgetManifest.mdx +++ b/content/docs/references/ui/widget/WidgetManifest.mdx @@ -5,9 +5,6 @@ category: ui zodFile: widget --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/widget.zod.ts` diff --git a/content/docs/references/ui/widget/WidgetProperty.mdx b/content/docs/references/ui/widget/WidgetProperty.mdx index 9675890c5..5133d59c1 100644 --- a/content/docs/references/ui/widget/WidgetProperty.mdx +++ b/content/docs/references/ui/widget/WidgetProperty.mdx @@ -5,9 +5,6 @@ category: ui zodFile: widget --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Callout } from 'fumadocs-ui/components/callout'; **Source:** `packages/spec/src/ui/widget.zod.ts` From c249b31a6e45e51dca19be8560fbc6ba7d959ac2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 15:29:41 +0000 Subject: [PATCH 09/10] Restructure docs to zod file level - one MDX file per .zod.ts file Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- content/docs/references/ai/agent.mdx | 80 +++++ .../docs/references/ai/agent/AIKnowledge.mdx | 35 -- .../references/ai/agent/AIModelConfig.mdx | 37 -- content/docs/references/ai/agent/AITool.mdx | 36 -- content/docs/references/ai/agent/Agent.mdx | 45 --- content/docs/references/ai/agent/meta.json | 3 - content/docs/references/ai/conversation.mdx | 259 ++++++++++++++ .../ai/conversation/ConversationAnalytics.mdx | 50 --- .../ai/conversation/ConversationContext.mdx | 40 --- .../ai/conversation/ConversationMessage.mdx | 48 --- .../ai/conversation/ConversationSession.mdx | 48 --- .../ai/conversation/ConversationSummary.mdx | 43 --- .../ai/conversation/FunctionCall.mdx | 36 -- .../ai/conversation/MessageContent.mdx | 37 -- .../ai/conversation/MessageContentType.mdx | 29 -- .../ai/conversation/MessagePruningEvent.mdx | 43 --- .../ai/conversation/MessageRole.mdx | 29 -- .../ai/conversation/TokenBudgetConfig.mdx | 45 --- .../ai/conversation/TokenBudgetStrategy.mdx | 29 -- .../ai/conversation/TokenUsageStats.mdx | 44 --- .../references/ai/conversation/ToolCall.mdx | 36 -- .../docs/references/ai/conversation/meta.json | 3 - content/docs/references/ai/cost.mdx | 321 +++++++++++++++++ .../docs/references/ai/cost/BillingPeriod.mdx | 31 -- .../docs/references/ai/cost/BudgetLimit.mdx | 50 --- .../docs/references/ai/cost/BudgetStatus.mdx | 50 --- .../docs/references/ai/cost/BudgetType.mdx | 30 -- content/docs/references/ai/cost/CostAlert.mdx | 53 --- .../docs/references/ai/cost/CostAlertType.mdx | 29 -- .../docs/references/ai/cost/CostAnalytics.mdx | 57 --- .../ai/cost/CostBreakdownDimension.mdx | 33 -- .../references/ai/cost/CostBreakdownEntry.mdx | 43 --- content/docs/references/ai/cost/CostEntry.mdx | 55 --- .../references/ai/cost/CostMetricType.mdx | 30 -- .../cost/CostOptimizationRecommendation.mdx | 50 --- .../references/ai/cost/CostQueryFilters.mdx | 47 --- .../docs/references/ai/cost/CostReport.mdx | 53 --- content/docs/references/ai/cost/meta.json | 3 - content/docs/references/ai/index.mdx | 148 +------- content/docs/references/ai/model-registry.mdx | 190 ++++++++++ .../ai/model-registry/ModelCapability.mdx | 38 -- .../ai/model-registry/ModelConfig.mdx | 49 --- .../ai/model-registry/ModelLimits.mdx | 37 -- .../ai/model-registry/ModelPricing.mdx | 35 -- .../ai/model-registry/ModelProvider.mdx | 32 -- .../ai/model-registry/ModelRegistry.mdx | 38 -- .../ai/model-registry/ModelRegistryEntry.mdx | 37 -- .../model-registry/ModelSelectionCriteria.mdx | 37 -- .../ai/model-registry/PromptTemplate.mdx | 54 --- .../ai/model-registry/PromptVariable.mdx | 38 -- .../references/ai/model-registry/meta.json | 3 - content/docs/references/ai/nlq.mdx | 242 +++++++++++++ content/docs/references/ai/nlq/Entity.mdx | 39 --- .../references/ai/nlq/FieldSynonymConfig.mdx | 38 -- .../docs/references/ai/nlq/NLQAnalytics.mdx | 46 --- .../references/ai/nlq/NLQFieldMapping.mdx | 40 --- .../docs/references/ai/nlq/NLQModelConfig.mdx | 46 --- .../docs/references/ai/nlq/NLQParseResult.mdx | 46 --- content/docs/references/ai/nlq/NLQRequest.mdx | 39 --- .../docs/references/ai/nlq/NLQResponse.mdx | 39 --- .../references/ai/nlq/NLQTrainingExample.mdx | 41 --- .../docs/references/ai/nlq/QueryContext.mdx | 39 --- .../docs/references/ai/nlq/QueryIntent.mdx | 34 -- .../docs/references/ai/nlq/QueryTemplate.mdx | 44 --- content/docs/references/ai/nlq/Timeframe.mdx | 38 -- content/docs/references/ai/nlq/meta.json | 3 - content/docs/references/ai/orchestration.mdx | 192 ++++++++++ .../ai/orchestration/AIOrchestration.mdx | 60 ---- .../AIOrchestrationExecutionResult.mdx | 46 --- .../orchestration/AIOrchestrationTrigger.mdx | 31 -- .../references/ai/orchestration/AITask.mdx | 54 --- .../ai/orchestration/AITaskType.mdx | 34 -- .../BatchAIOrchestrationExecution.mdx | 38 -- .../ai/orchestration/PostProcessingAction.mdx | 38 -- .../orchestration/WorkflowFieldCondition.mdx | 35 -- .../ai/orchestration/WorkflowSchedule.mdx | 38 -- .../references/ai/orchestration/meta.json | 3 - content/docs/references/ai/predictive.mdx | 215 ++++++++++++ .../ai/predictive/EvaluationMetrics.mdx | 45 --- .../ai/predictive/Hyperparameters.mdx | 47 --- .../references/ai/predictive/ModelDrift.mdx | 42 --- .../references/ai/predictive/ModelFeature.mdx | 44 --- .../ai/predictive/PredictionRequest.mdx | 37 -- .../ai/predictive/PredictionResult.mdx | 41 --- .../ai/predictive/PredictiveModel.mdx | 66 ---- .../ai/predictive/PredictiveModelType.mdx | 31 -- .../ai/predictive/TrainingConfig.mdx | 45 --- .../docs/references/ai/predictive/meta.json | 3 - content/docs/references/ai/rag-pipeline.mdx | 219 ++++++++++++ .../ai/rag-pipeline/ChunkingStrategy.mdx | 12 - .../ai/rag-pipeline/DocumentChunk.mdx | 41 --- .../ai/rag-pipeline/DocumentLoaderConfig.mdx | 42 --- .../ai/rag-pipeline/DocumentMetadata.mdx | 42 --- .../ai/rag-pipeline/EmbeddingModel.mdx | 41 --- .../ai/rag-pipeline/RAGPipelineConfig.mdx | 50 --- .../ai/rag-pipeline/RAGPipelineStatus.mdx | 40 --- .../ai/rag-pipeline/RAGQueryRequest.mdx | 40 --- .../ai/rag-pipeline/RAGQueryResponse.mdx | 39 --- .../ai/rag-pipeline/RerankingConfig.mdx | 35 -- .../ai/rag-pipeline/RetrievalStrategy.mdx | 12 - .../ai/rag-pipeline/VectorStoreConfig.mdx | 45 --- .../ai/rag-pipeline/VectorStoreProvider.mdx | 34 -- .../docs/references/ai/rag-pipeline/meta.json | 3 - content/docs/references/api/contract.mdx | 173 +++++++++ .../docs/references/api/contract/ApiError.mdx | 36 -- .../references/api/contract/BaseResponse.mdx | 35 -- .../references/api/contract/BulkRequest.mdx | 34 -- .../references/api/contract/BulkResponse.mdx | 37 -- .../references/api/contract/CreateRequest.mdx | 33 -- .../api/contract/DeleteResponse.mdx | 37 -- .../references/api/contract/ExportRequest.mdx | 46 --- .../api/contract/ListRecordResponse.mdx | 39 --- .../api/contract/ModificationResult.mdx | 35 -- .../references/api/contract/RecordData.mdx | 14 - .../api/contract/SingleRecordResponse.mdx | 37 -- .../references/api/contract/UpdateRequest.mdx | 33 -- .../docs/references/api/contract/meta.json | 3 - content/docs/references/api/discovery.mdx | 67 ++++ .../api/discovery/ApiCapabilities.mdx | 35 -- .../references/api/discovery/ApiRoutes.mdx | 40 --- .../references/api/discovery/Discovery.mdx | 41 --- .../docs/references/api/discovery/meta.json | 3 - .../ApiEndpoint.mdx => endpoint.mdx} | 60 +++- .../references/api/endpoint/ApiMapping.mdx | 36 -- .../references/api/endpoint/RateLimit.mdx | 34 -- .../docs/references/api/endpoint/meta.json | 3 - content/docs/references/api/index.mdx | 81 +---- content/docs/references/api/odata.mdx | 133 +++++++ .../docs/references/api/odata/ODataError.mdx | 33 -- .../api/odata/ODataFilterFunction.mdx | 52 --- .../api/odata/ODataFilterOperator.mdx | 37 -- .../references/api/odata/ODataMetadata.mdx | 37 -- .../docs/references/api/odata/ODataQuery.mdx | 41 --- .../references/api/odata/ODataResponse.mdx | 36 -- content/docs/references/api/odata/meta.json | 3 - content/docs/references/api/realtime.mdx | 119 +++++++ .../docs/references/api/realtime/Presence.mdx | 38 -- .../api/realtime/PresenceStatus.mdx | 27 -- .../api/realtime/RealtimeAction.mdx | 27 -- .../references/api/realtime/RealtimeEvent.mdx | 41 --- .../api/realtime/RealtimeEventType.mdx | 28 -- .../references/api/realtime/Subscription.mdx | 38 -- .../api/realtime/SubscriptionEvent.mdx | 35 -- .../api/realtime/TransportProtocol.mdx | 27 -- .../docs/references/api/realtime/meta.json | 3 - .../RouteDefinition.mdx => router.mdx} | 63 +++- .../references/api/router/RouteCategory.mdx | 30 -- .../references/api/router/RouterConfig.mdx | 35 -- content/docs/references/api/router/meta.json | 3 - content/docs/references/api/view.mdx | 38 ++ .../docs/references/api/view/HttpMethod.mdx | 31 -- content/docs/references/auth/config.mdx | 329 ++++++++++++++++++ .../auth/config/AccountLinkingConfig.mdx | 34 -- .../references/auth/config/AuthConfig.mdx | 62 ---- .../auth/config/AuthPluginConfig.mdx | 35 -- .../references/auth/config/AuthStrategy.mdx | 30 -- .../references/auth/config/CSRFConfig.mdx | 35 -- .../auth/config/DatabaseAdapter.mdx | 36 -- .../auth/config/DatabaseMapping.mdx | 35 -- .../auth/config/EmailPasswordConfig.mdx | 37 -- .../auth/config/EnterpriseAuthConfig.mdx | 34 -- .../references/auth/config/LDAPConfig.mdx | 44 --- .../auth/config/MagicLinkConfig.mdx | 33 -- .../references/auth/config/OAuthProvider.mdx | 42 --- .../references/auth/config/OIDCConfig.mdx | 42 --- .../references/auth/config/PasskeyConfig.mdx | 38 -- .../auth/config/RateLimitConfig.mdx | 36 -- .../references/auth/config/SAMLConfig.mdx | 42 --- .../references/auth/config/SessionConfig.mdx | 39 --- .../auth/config/StandardAuthProvider.mdx | 35 -- .../auth/config/TwoFactorConfig.mdx | 35 -- .../auth/config/UserFieldMapping.mdx | 38 -- content/docs/references/auth/config/meta.json | 3 - content/docs/references/auth/identity.mdx | 95 +++++ .../docs/references/auth/identity/Account.mdx | 49 --- .../docs/references/auth/identity/Session.mdx | 45 --- .../docs/references/auth/identity/User.mdx | 42 --- .../auth/identity/VerificationToken.mdx | 39 --- .../docs/references/auth/identity/meta.json | 3 - content/docs/references/auth/index.mdx | 94 +---- content/docs/references/auth/organization.mdx | 84 +++++ .../auth/organization/Invitation.mdx | 44 --- .../auth/organization/InvitationStatus.mdx | 28 -- .../references/auth/organization/Member.mdx | 41 --- .../auth/organization/Organization.mdx | 42 --- .../references/auth/organization/meta.json | 3 - content/docs/references/auth/policy.mdx | 92 +++++ .../references/auth/policy/AuditPolicy.mdx | 35 -- .../references/auth/policy/NetworkPolicy.mdx | 35 -- .../references/auth/policy/PasswordPolicy.mdx | 38 -- .../docs/references/auth/policy/Policy.mdx | 39 --- .../references/auth/policy/SessionPolicy.mdx | 34 -- content/docs/references/auth/policy/meta.json | 3 - .../auth/{role/Role.mdx => role.mdx} | 36 +- content/docs/references/auth/role/meta.json | 3 - content/docs/references/auth/scim.mdx | 237 +++++++++++++ .../docs/references/auth/scim/SCIMAddress.mdx | 39 --- .../docs/references/auth/scim/SCIMEmail.mdx | 36 -- .../auth/scim/SCIMEnterpriseUser.mdx | 37 -- .../docs/references/auth/scim/SCIMError.mdx | 36 -- .../docs/references/auth/scim/SCIMGroup.mdx | 38 -- .../auth/scim/SCIMGroupReference.mdx | 36 -- .../references/auth/scim/SCIMListResponse.mdx | 38 -- .../auth/scim/SCIMMemberReference.mdx | 36 -- .../docs/references/auth/scim/SCIMMeta.mdx | 36 -- .../docs/references/auth/scim/SCIMName.mdx | 37 -- .../auth/scim/SCIMPatchOperation.mdx | 35 -- .../references/auth/scim/SCIMPatchRequest.mdx | 34 -- .../references/auth/scim/SCIMPhoneNumber.mdx | 36 -- .../docs/references/auth/scim/SCIMUser.mdx | 58 --- content/docs/references/auth/scim/meta.json | 3 - .../docs/references/automation/approval.mdx | 98 ++++++ .../automation/approval/ApprovalAction.mdx | 37 -- .../approval/ApprovalActionType.mdx | 28 -- .../automation/approval/ApprovalProcess.mdx | 47 --- .../automation/approval/ApprovalStep.mdx | 43 --- .../automation/approval/ApproverType.mdx | 29 -- .../references/automation/approval/meta.json | 3 - .../docs/references/automation/connector.mdx | 214 ++++++++++++ .../automation/connector/AuthField.mdx | 41 --- .../automation/connector/Authentication.mdx | 36 -- .../connector/AuthenticationType.mdx | 31 -- .../automation/connector/Connector.mdx | 53 --- .../connector/ConnectorCategory.mdx | 39 --- .../connector/ConnectorInstance.mdx | 45 --- .../connector/ConnectorOperation.mdx | 43 --- .../automation/connector/ConnectorTrigger.mdx | 41 --- .../automation/connector/OAuth2Config.mdx | 38 -- .../connector/OperationParameter.mdx | 42 --- .../automation/connector/OperationType.mdx | 30 -- .../references/automation/connector/meta.json | 3 - content/docs/references/automation/etl.mdx | 159 +++++++++ .../automation/etl/ETLDestination.mdx | 38 -- .../automation/etl/ETLEndpointType.mdx | 32 -- .../references/automation/etl/ETLPipeline.mdx | 47 --- .../automation/etl/ETLPipelineRun.mdx | 44 --- .../automation/etl/ETLRunStatus.mdx | 30 -- .../references/automation/etl/ETLSource.mdx | 37 -- .../references/automation/etl/ETLSyncMode.mdx | 27 -- .../automation/etl/ETLTransformation.mdx | 37 -- .../automation/etl/ETLTransformationType.mdx | 34 -- .../docs/references/automation/etl/meta.json | 3 - content/docs/references/automation/flow.mdx | 107 ++++++ .../docs/references/automation/flow/Flow.mdx | 47 --- .../references/automation/flow/FlowEdge.mdx | 40 --- .../references/automation/flow/FlowNode.mdx | 39 --- .../automation/flow/FlowNodeAction.mdx | 37 -- .../automation/flow/FlowVariable.mdx | 37 -- .../docs/references/automation/flow/meta.json | 3 - content/docs/references/automation/index.mdx | 109 +----- .../{mapping/FieldMapping.mdx => mapping.mdx} | 40 +-- content/docs/references/automation/sync.mdx | 144 ++++++++ .../automation/sync/ConflictResolution.mdx | 29 -- .../automation/sync/DataDestinationConfig.mdx | 38 -- .../automation/sync/DataSourceConfig.mdx | 36 -- .../automation/sync/DataSyncConfig.mdx | 53 --- .../automation/sync/SyncDirection.mdx | 27 -- .../automation/sync/SyncExecutionResult.mdx | 44 --- .../automation/sync/SyncExecutionStatus.mdx | 30 -- .../references/automation/sync/SyncMode.mdx | 27 -- .../docs/references/automation/sync/meta.json | 3 - .../{webhook/Webhook.mdx => webhook.mdx} | 61 +++- .../automation/webhook/WebhookReceiver.mdx | 40 --- .../automation/webhook/WebhookTriggerType.mdx | 29 -- .../references/automation/webhook/meta.json | 3 - .../docs/references/automation/workflow.mdx | 230 ++++++++++++ .../workflow/CustomScriptAction.mdx | 40 --- .../automation/workflow/EmailAlertAction.mdx | 39 --- .../automation/workflow/FieldUpdateAction.mdx | 38 -- .../automation/workflow/HttpCallAction.mdx | 43 --- .../workflow/PushNotificationAction.mdx | 44 --- .../workflow/SlackMessageAction.mdx | 41 --- .../workflow/SmsNotificationAction.mdx | 41 --- .../workflow/TaskCreationAction.mdx | 45 --- .../workflow/TeamsMessageAction.mdx | 41 --- .../automation/workflow/TimeTrigger.mdx | 42 --- .../workflow/WebhookTriggerAction.mdx | 42 --- .../automation/workflow/WorkflowAction.mdx | 12 - .../automation/workflow/WorkflowRule.mdx | 42 --- .../workflow/WorkflowTriggerType.mdx | 29 -- .../references/automation/workflow/meta.json | 3 - .../data/{dataset/Dataset.mdx => dataset.mdx} | 44 ++- .../references/data/dataset/DatasetMode.mdx | 29 -- .../docs/references/data/dataset/meta.json | 3 - .../data/{field/Field.mdx => field.mdx} | 161 ++++++++- .../docs/references/data/field/Address.mdx | 38 -- .../references/data/field/CurrencyConfig.mdx | 34 -- .../references/data/field/CurrencyValue.mdx | 35 -- .../docs/references/data/field/FieldType.mdx | 68 ---- .../data/field/LocationCoordinates.mdx | 37 -- .../references/data/field/SelectOption.mdx | 37 -- .../references/data/field/VectorConfig.mdx | 37 -- content/docs/references/data/field/meta.json | 3 - content/docs/references/data/filter.mdx | 151 ++++++++ .../data/filter/ComparisonOperator.mdx | 35 -- .../data/filter/EqualityOperator.mdx | 33 -- .../references/data/filter/FieldOperators.mdx | 45 --- .../references/data/filter/FieldReference.mdx | 33 -- .../data/filter/FilterCondition.mdx | 12 - .../data/filter/NormalizedFilter.mdx | 34 -- .../references/data/filter/QueryFilter.mdx | 32 -- .../references/data/filter/RangeOperator.mdx | 32 -- .../references/data/filter/SetOperator.mdx | 33 -- .../data/filter/SpecialOperator.mdx | 33 -- .../references/data/filter/StringOperator.mdx | 34 -- content/docs/references/data/filter/meta.json | 3 - content/docs/references/data/hook.mdx | 84 +++++ content/docs/references/data/hook/Hook.mdx | 42 --- .../docs/references/data/hook/HookContext.mdx | 43 --- .../docs/references/data/hook/HookEvent.mdx | 42 --- content/docs/references/data/hook/meta.json | 3 - content/docs/references/data/index.mdx | 104 +----- .../docs/references/data/mapping/meta.json | 3 - content/docs/references/data/object.mdx | 95 +++++ content/docs/references/data/object/Index.mdx | 36 -- .../docs/references/data/object/Object.mdx | 51 --- .../data/object/ObjectCapabilities.mdx | 41 --- .../references/data/object/SearchConfig.mdx | 35 -- content/docs/references/data/object/meta.json | 3 - content/docs/references/data/query.mdx | 172 +++++++++ .../data/query/AggregationFunction.mdx | 32 -- .../references/data/query/AggregationNode.mdx | 38 -- .../docs/references/data/query/FieldNode.mdx | 12 - .../docs/references/data/query/JoinNode.mdx | 40 --- .../references/data/query/JoinStrategy.mdx | 28 -- .../docs/references/data/query/JoinType.mdx | 28 -- content/docs/references/data/query/Query.mdx | 45 --- .../docs/references/data/query/SortNode.mdx | 34 -- .../references/data/query/WindowFunction.mdx | 37 -- .../data/query/WindowFunctionNode.mdx | 38 -- .../docs/references/data/query/WindowSpec.mdx | 34 -- content/docs/references/data/query/meta.json | 3 - content/docs/references/data/validation.mdx | 216 ++++++++++++ .../data/validation/AsyncValidation.mdx | 52 --- .../data/validation/ConditionalValidation.mdx | 47 --- .../data/validation/CrossFieldValidation.mdx | 46 --- .../data/validation/CustomValidator.mdx | 46 --- .../data/validation/FormatValidation.mdx | 47 --- .../data/validation/JSONValidation.mdx | 46 --- .../data/validation/ScriptValidation.mdx | 45 --- .../validation/StateMachineValidation.mdx | 46 --- .../data/validation/UniquenessValidation.mdx | 47 --- .../data/validation/ValidationRule.mdx | 12 - .../docs/references/data/validation/meta.json | 3 - content/docs/references/hub/composer.mdx | 93 +++++ .../hub/composer/BillOfMaterials.mdx | 37 -- .../hub/composer/ComposerRequest.mdx | 35 -- .../hub/composer/ComposerResponse.mdx | 43 --- .../hub/composer/ConflictReport.mdx | 40 --- .../hub/composer/DependencyRequirement.mdx | 36 -- .../docs/references/hub/composer/meta.json | 3 - content/docs/references/hub/index.mdx | 62 +--- content/docs/references/hub/license.mdx | 84 +++++ .../docs/references/hub/license/Feature.mdx | 39 --- .../docs/references/hub/license/License.mdx | 44 --- .../references/hub/license/MetricType.mdx | 27 -- content/docs/references/hub/license/Plan.mdx | 43 --- content/docs/references/hub/license/meta.json | 3 - .../MarketplacePlugin.mdx => marketplace.mdx} | 61 +++- .../hub/marketplace/PluginAuthor.mdx | 35 -- .../hub/marketplace/PluginPricing.mdx | 38 -- .../docs/references/hub/marketplace/meta.json | 3 - content/docs/references/hub/space.mdx | 85 +++++ .../references/hub/space/DeploymentTarget.mdx | 36 -- .../docs/references/hub/space/HubSpace.mdx | 46 --- .../hub/space/SpaceSubscription.mdx | 40 --- .../hub/space/SubscriptionStatus.mdx | 29 -- content/docs/references/hub/space/meta.json | 3 - content/docs/references/hub/tenant.mdx | 115 ++++++ .../tenant/DatabaseLevelIsolationStrategy.mdx | 37 -- .../tenant/LevelIsolationStrategySchema.mdx | 36 -- .../hub/tenant/RowLevelIsolationStrategy.mdx | 35 -- content/docs/references/hub/tenant/Tenant.mdx | 39 --- .../hub/tenant/TenantIsolationConfig.mdx | 12 - .../hub/tenant/TenantIsolationLevel.mdx | 27 -- .../references/hub/tenant/TenantQuota.mdx | 34 -- .../hub/tenant/TenantSecurityPolicy.mdx | 34 -- content/docs/references/hub/tenant/meta.json | 3 - content/docs/references/permission/index.mdx | 48 +-- .../docs/references/permission/permission.mdx | 68 ++++ .../permission/permission/FieldPermission.mdx | 33 -- .../permission/ObjectPermission.mdx | 40 --- .../permission/permission/PermissionSet.mdx | 39 --- .../permission/permission/meta.json | 3 - content/docs/references/permission/rls.mdx | 103 ++++++ .../references/permission/rls/RLSConfig.mdx | 39 --- .../permission/rls/RLSEvaluationResult.mdx | 39 --- .../permission/rls/RLSOperation.mdx | 29 -- .../permission/rls/RLSUserContext.mdx | 38 -- .../permission/rls/RowLevelSecurityPolicy.mdx | 45 --- .../docs/references/permission/rls/meta.json | 3 - .../docs/references/permission/sharing.mdx | 106 ++++++ .../sharing/CriteriaSharingRule.mdx | 44 --- .../permission/sharing/OWDModel.mdx | 28 -- .../permission/sharing/OwnerSharingRule.mdx | 44 --- .../permission/sharing/ShareRecipientType.mdx | 29 -- .../permission/sharing/SharingLevel.mdx | 27 -- .../permission/sharing/SharingRule.mdx | 12 - .../permission/sharing/SharingRuleType.mdx | 26 -- .../references/permission/sharing/meta.json | 3 - .../Territory.mdx => territory.mdx} | 57 ++- .../permission/territory/TerritoryModel.mdx | 36 -- .../permission/territory/TerritoryType.mdx | 28 -- .../references/permission/territory/meta.json | 3 - .../docs/references/shared/identifiers.mdx | 42 +++ .../shared/identifiers/EventName.mdx | 14 - .../identifiers/SnakeCaseIdentifier.mdx | 14 - .../shared/identifiers/SystemIdentifier.mdx | 14 - .../references/shared/identifiers/meta.json | 3 - content/docs/references/shared/index.mdx | 9 +- content/docs/references/system/audit.mdx | 241 +++++++++++++ .../references/system/audit/AuditConfig.mdx | 50 --- .../references/system/audit/AuditEvent.mdx | 49 --- .../system/audit/AuditEventActor.mdx | 39 --- .../system/audit/AuditEventChange.mdx | 35 -- .../system/audit/AuditEventFilter.mdx | 39 --- .../system/audit/AuditEventSeverity.mdx | 32 -- .../system/audit/AuditEventTarget.mdx | 37 -- .../system/audit/AuditEventType.mdx | 66 ---- .../system/audit/AuditRetentionPolicy.mdx | 36 -- .../system/audit/AuditStorageConfig.mdx | 39 --- .../system/audit/SuspiciousActivityRule.mdx | 44 --- .../docs/references/system/audit/meta.json | 3 - .../KernelContext.mdx => context.mdx} | 49 ++- .../references/system/context/RuntimeMode.mdx | 30 -- .../docs/references/system/context/meta.json | 3 - content/docs/references/system/datasource.mdx | 83 +++++ .../system/datasource/Datasource.mdx | 43 --- .../datasource/DatasourceCapabilities.mdx | 42 --- .../system/datasource/DriverDefinition.mdx | 40 --- .../system/datasource/DriverType.mdx | 14 - .../references/system/datasource/meta.json | 3 - .../DriverCapabilities.mdx => driver.mdx} | 62 +++- .../system/driver/DriverInterface.mdx | 37 -- .../system/driver/DriverOptions.mdx | 36 -- .../docs/references/system/driver/meta.json | 3 - content/docs/references/system/events.mdx | 83 +++++ .../docs/references/system/events/Event.mdx | 36 -- .../references/system/events/EventHandler.mdx | 35 -- .../system/events/EventMetadata.mdx | 37 -- .../system/events/EventPersistence.mdx | 34 -- .../references/system/events/EventRoute.mdx | 35 -- .../docs/references/system/events/meta.json | 3 - .../{feature/FeatureFlag.mdx => feature.mdx} | 45 ++- .../system/feature/FeatureStrategy.mdx | 29 -- .../docs/references/system/feature/meta.json | 3 - content/docs/references/system/index.mdx | 151 +------- content/docs/references/system/job.mdx | 115 ++++++ .../references/system/job/CronSchedule.mdx | 36 -- .../system/job/IntervalSchedule.mdx | 35 -- content/docs/references/system/job/Job.mdx | 40 --- .../references/system/job/JobExecution.mdx | 40 --- .../system/job/JobExecutionStatus.mdx | 28 -- .../references/system/job/OnceSchedule.mdx | 35 -- .../references/system/job/RetryPolicy.mdx | 34 -- .../docs/references/system/job/Schedule.mdx | 12 - content/docs/references/system/job/meta.json | 3 - content/docs/references/system/logger.mdx | 83 +++++ .../references/system/logger/LogEntry.mdx | 43 --- .../references/system/logger/LogFormat.mdx | 29 -- .../references/system/logger/LogLevel.mdx | 31 -- .../references/system/logger/LoggerConfig.mdx | 37 -- .../docs/references/system/logger/meta.json | 3 - .../{manifest/Manifest.mdx => manifest.mdx} | 42 ++- .../docs/references/system/manifest/meta.json | 3 - content/docs/references/system/misc.mdx | 70 ++++ .../references/system/misc/MongoConfig.mdx | 46 --- .../references/system/misc/PostgresConfig.mdx | 46 --- content/docs/references/system/plugin.mdx | 143 ++++++++ .../references/system/plugin/I18nContext.mdx | 33 -- .../docs/references/system/plugin/Logger.mdx | 37 -- .../system/plugin/ObjectQLClient.mdx | 33 -- .../docs/references/system/plugin/Plugin.mdx | 33 -- .../system/plugin/PluginContext.mdx | 44 --- .../system/plugin/PluginLifecycle.mdx | 31 -- .../docs/references/system/plugin/Router.mdx | 33 -- .../references/system/plugin/Scheduler.mdx | 33 -- .../system/plugin/ScopedStorage.mdx | 33 -- .../references/system/plugin/SystemAPI.mdx | 33 -- .../docs/references/system/plugin/meta.json | 3 - .../docs/references/system/scoped-storage.mdx | 82 +++++ .../system/scoped-storage/FileMetadata.mdx | 42 --- .../scoped-storage/ScopedStorageConfig.mdx | 38 -- .../scoped-storage/StorageAdapterType.mdx | 30 -- .../system/scoped-storage/StorageScope.mdx | 32 -- .../system/scoped-storage/meta.json | 3 - .../docs/references/system/translation.mdx | 46 +++ .../references/system/translation/Locale.mdx | 14 - .../system/translation/TranslationBundle.mdx | 12 - .../system/translation/TranslationData.mdx | 34 -- .../references/system/translation/meta.json | 3 - .../ui/{action/Action.mdx => action.mdx} | 46 ++- .../docs/references/ui/action/ActionParam.mdx | 39 --- content/docs/references/ui/action/meta.json | 3 - content/docs/references/ui/app.mdx | 140 ++++++++ content/docs/references/ui/app/App.mdx | 46 --- .../docs/references/ui/app/AppBranding.mdx | 34 -- .../references/ui/app/DashboardNavItem.mdx | 41 --- .../docs/references/ui/app/GroupNavItem.mdx | 40 --- .../docs/references/ui/app/NavigationItem.mdx | 12 - .../docs/references/ui/app/ObjectNavItem.mdx | 42 --- .../docs/references/ui/app/PageNavItem.mdx | 42 --- content/docs/references/ui/app/UrlNavItem.mdx | 42 --- content/docs/references/ui/app/meta.json | 3 - content/docs/references/ui/block/meta.json | 3 - content/docs/references/ui/component.mdx | 99 ++++++ .../references/ui/component/PageCardProps.mdx | 36 -- .../ui/component/PageHeaderProps.mdx | 37 -- .../references/ui/component/PageTabsProps.mdx | 35 -- .../ui/component/RecordDetailsProps.mdx | 34 -- .../ui/component/RecordHighlightsProps.mdx | 33 -- .../ui/component/RecordRelatedListProps.mdx | 39 --- .../docs/references/ui/component/meta.json | 3 - .../DashboardWidget.mdx => dashboard.mdx} | 77 ++-- .../references/ui/dashboard/ChartType.mdx | 40 --- .../references/ui/dashboard/Dashboard.mdx | 38 -- .../docs/references/ui/dashboard/meta.json | 3 - content/docs/references/ui/index.mdx | 128 +------ content/docs/references/ui/page.mdx | 96 +++++ content/docs/references/ui/page/Page.mdx | 43 --- .../docs/references/ui/page/PageComponent.mdx | 38 -- .../references/ui/page/PageComponentType.mdx | 45 --- .../docs/references/ui/page/PageRegion.mdx | 36 -- content/docs/references/ui/page/meta.json | 3 - content/docs/references/ui/report.mdx | 92 +++++ content/docs/references/ui/report/Report.mdx | 45 --- .../docs/references/ui/report/ReportChart.mdx | 39 --- .../references/ui/report/ReportColumn.mdx | 35 -- .../references/ui/report/ReportGrouping.mdx | 35 -- .../docs/references/ui/report/ReportType.mdx | 28 -- content/docs/references/ui/report/meta.json | 3 - content/docs/references/ui/theme.mdx | 197 +++++++++++ .../docs/references/ui/theme/Animation.mdx | 33 -- .../docs/references/ui/theme/BorderRadius.mdx | 39 --- .../docs/references/ui/theme/Breakpoints.mdx | 37 -- .../docs/references/ui/theme/ColorPalette.mdx | 49 --- content/docs/references/ui/theme/Shadow.mdx | 39 --- content/docs/references/ui/theme/Spacing.mdx | 44 --- content/docs/references/ui/theme/Theme.mdx | 49 --- .../docs/references/ui/theme/ThemeMode.mdx | 27 -- .../docs/references/ui/theme/Typography.mdx | 36 -- content/docs/references/ui/theme/ZIndex.mdx | 39 --- content/docs/references/ui/theme/meta.json | 3 - content/docs/references/ui/view.mdx | 217 ++++++++++++ .../references/ui/view/CalendarConfig.mdx | 37 -- content/docs/references/ui/view/FormField.mdx | 43 --- .../docs/references/ui/view/FormSection.mdx | 37 -- content/docs/references/ui/view/FormView.mdx | 35 -- .../docs/references/ui/view/GanttConfig.mdx | 39 --- .../docs/references/ui/view/HttpMethod.mdx | 29 -- .../docs/references/ui/view/HttpRequest.mdx | 37 -- .../docs/references/ui/view/KanbanConfig.mdx | 36 -- .../docs/references/ui/view/ListColumn.mdx | 41 --- content/docs/references/ui/view/ListView.mdx | 48 --- .../references/ui/view/PaginationConfig.mdx | 33 -- .../references/ui/view/SelectionConfig.mdx | 32 -- content/docs/references/ui/view/View.mdx | 35 -- content/docs/references/ui/view/ViewData.mdx | 12 - content/docs/references/ui/view/meta.json | 3 - content/docs/references/ui/widget.mdx | 114 ++++++ .../references/ui/widget/FieldWidgetProps.mdx | 39 --- .../docs/references/ui/widget/WidgetEvent.mdx | 38 -- .../references/ui/widget/WidgetLifecycle.mdx | 38 -- .../references/ui/widget/WidgetManifest.mdx | 50 --- .../references/ui/widget/WidgetProperty.mdx | 41 --- content/docs/references/ui/widget/meta.json | 3 - packages/spec/scripts/build-docs.ts | 254 +++++--------- 567 files changed, 8145 insertions(+), 17249 deletions(-) create mode 100644 content/docs/references/ai/agent.mdx delete mode 100644 content/docs/references/ai/agent/AIKnowledge.mdx delete mode 100644 content/docs/references/ai/agent/AIModelConfig.mdx delete mode 100644 content/docs/references/ai/agent/AITool.mdx delete mode 100644 content/docs/references/ai/agent/Agent.mdx delete mode 100644 content/docs/references/ai/agent/meta.json create mode 100644 content/docs/references/ai/conversation.mdx delete mode 100644 content/docs/references/ai/conversation/ConversationAnalytics.mdx delete mode 100644 content/docs/references/ai/conversation/ConversationContext.mdx delete mode 100644 content/docs/references/ai/conversation/ConversationMessage.mdx delete mode 100644 content/docs/references/ai/conversation/ConversationSession.mdx delete mode 100644 content/docs/references/ai/conversation/ConversationSummary.mdx delete mode 100644 content/docs/references/ai/conversation/FunctionCall.mdx delete mode 100644 content/docs/references/ai/conversation/MessageContent.mdx delete mode 100644 content/docs/references/ai/conversation/MessageContentType.mdx delete mode 100644 content/docs/references/ai/conversation/MessagePruningEvent.mdx delete mode 100644 content/docs/references/ai/conversation/MessageRole.mdx delete mode 100644 content/docs/references/ai/conversation/TokenBudgetConfig.mdx delete mode 100644 content/docs/references/ai/conversation/TokenBudgetStrategy.mdx delete mode 100644 content/docs/references/ai/conversation/TokenUsageStats.mdx delete mode 100644 content/docs/references/ai/conversation/ToolCall.mdx delete mode 100644 content/docs/references/ai/conversation/meta.json create mode 100644 content/docs/references/ai/cost.mdx delete mode 100644 content/docs/references/ai/cost/BillingPeriod.mdx delete mode 100644 content/docs/references/ai/cost/BudgetLimit.mdx delete mode 100644 content/docs/references/ai/cost/BudgetStatus.mdx delete mode 100644 content/docs/references/ai/cost/BudgetType.mdx delete mode 100644 content/docs/references/ai/cost/CostAlert.mdx delete mode 100644 content/docs/references/ai/cost/CostAlertType.mdx delete mode 100644 content/docs/references/ai/cost/CostAnalytics.mdx delete mode 100644 content/docs/references/ai/cost/CostBreakdownDimension.mdx delete mode 100644 content/docs/references/ai/cost/CostBreakdownEntry.mdx delete mode 100644 content/docs/references/ai/cost/CostEntry.mdx delete mode 100644 content/docs/references/ai/cost/CostMetricType.mdx delete mode 100644 content/docs/references/ai/cost/CostOptimizationRecommendation.mdx delete mode 100644 content/docs/references/ai/cost/CostQueryFilters.mdx delete mode 100644 content/docs/references/ai/cost/CostReport.mdx delete mode 100644 content/docs/references/ai/cost/meta.json create mode 100644 content/docs/references/ai/model-registry.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelCapability.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelConfig.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelLimits.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelPricing.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelProvider.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelRegistry.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelRegistryEntry.mdx delete mode 100644 content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx delete mode 100644 content/docs/references/ai/model-registry/PromptTemplate.mdx delete mode 100644 content/docs/references/ai/model-registry/PromptVariable.mdx delete mode 100644 content/docs/references/ai/model-registry/meta.json create mode 100644 content/docs/references/ai/nlq.mdx delete mode 100644 content/docs/references/ai/nlq/Entity.mdx delete mode 100644 content/docs/references/ai/nlq/FieldSynonymConfig.mdx delete mode 100644 content/docs/references/ai/nlq/NLQAnalytics.mdx delete mode 100644 content/docs/references/ai/nlq/NLQFieldMapping.mdx delete mode 100644 content/docs/references/ai/nlq/NLQModelConfig.mdx delete mode 100644 content/docs/references/ai/nlq/NLQParseResult.mdx delete mode 100644 content/docs/references/ai/nlq/NLQRequest.mdx delete mode 100644 content/docs/references/ai/nlq/NLQResponse.mdx delete mode 100644 content/docs/references/ai/nlq/NLQTrainingExample.mdx delete mode 100644 content/docs/references/ai/nlq/QueryContext.mdx delete mode 100644 content/docs/references/ai/nlq/QueryIntent.mdx delete mode 100644 content/docs/references/ai/nlq/QueryTemplate.mdx delete mode 100644 content/docs/references/ai/nlq/Timeframe.mdx delete mode 100644 content/docs/references/ai/nlq/meta.json create mode 100644 content/docs/references/ai/orchestration.mdx delete mode 100644 content/docs/references/ai/orchestration/AIOrchestration.mdx delete mode 100644 content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx delete mode 100644 content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx delete mode 100644 content/docs/references/ai/orchestration/AITask.mdx delete mode 100644 content/docs/references/ai/orchestration/AITaskType.mdx delete mode 100644 content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx delete mode 100644 content/docs/references/ai/orchestration/PostProcessingAction.mdx delete mode 100644 content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx delete mode 100644 content/docs/references/ai/orchestration/WorkflowSchedule.mdx delete mode 100644 content/docs/references/ai/orchestration/meta.json create mode 100644 content/docs/references/ai/predictive.mdx delete mode 100644 content/docs/references/ai/predictive/EvaluationMetrics.mdx delete mode 100644 content/docs/references/ai/predictive/Hyperparameters.mdx delete mode 100644 content/docs/references/ai/predictive/ModelDrift.mdx delete mode 100644 content/docs/references/ai/predictive/ModelFeature.mdx delete mode 100644 content/docs/references/ai/predictive/PredictionRequest.mdx delete mode 100644 content/docs/references/ai/predictive/PredictionResult.mdx delete mode 100644 content/docs/references/ai/predictive/PredictiveModel.mdx delete mode 100644 content/docs/references/ai/predictive/PredictiveModelType.mdx delete mode 100644 content/docs/references/ai/predictive/TrainingConfig.mdx delete mode 100644 content/docs/references/ai/predictive/meta.json create mode 100644 content/docs/references/ai/rag-pipeline.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/DocumentChunk.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/RerankingConfig.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx delete mode 100644 content/docs/references/ai/rag-pipeline/meta.json create mode 100644 content/docs/references/api/contract.mdx delete mode 100644 content/docs/references/api/contract/ApiError.mdx delete mode 100644 content/docs/references/api/contract/BaseResponse.mdx delete mode 100644 content/docs/references/api/contract/BulkRequest.mdx delete mode 100644 content/docs/references/api/contract/BulkResponse.mdx delete mode 100644 content/docs/references/api/contract/CreateRequest.mdx delete mode 100644 content/docs/references/api/contract/DeleteResponse.mdx delete mode 100644 content/docs/references/api/contract/ExportRequest.mdx delete mode 100644 content/docs/references/api/contract/ListRecordResponse.mdx delete mode 100644 content/docs/references/api/contract/ModificationResult.mdx delete mode 100644 content/docs/references/api/contract/RecordData.mdx delete mode 100644 content/docs/references/api/contract/SingleRecordResponse.mdx delete mode 100644 content/docs/references/api/contract/UpdateRequest.mdx delete mode 100644 content/docs/references/api/contract/meta.json create mode 100644 content/docs/references/api/discovery.mdx delete mode 100644 content/docs/references/api/discovery/ApiCapabilities.mdx delete mode 100644 content/docs/references/api/discovery/ApiRoutes.mdx delete mode 100644 content/docs/references/api/discovery/Discovery.mdx delete mode 100644 content/docs/references/api/discovery/meta.json rename content/docs/references/api/{endpoint/ApiEndpoint.mdx => endpoint.mdx} (55%) delete mode 100644 content/docs/references/api/endpoint/ApiMapping.mdx delete mode 100644 content/docs/references/api/endpoint/RateLimit.mdx delete mode 100644 content/docs/references/api/endpoint/meta.json create mode 100644 content/docs/references/api/odata.mdx delete mode 100644 content/docs/references/api/odata/ODataError.mdx delete mode 100644 content/docs/references/api/odata/ODataFilterFunction.mdx delete mode 100644 content/docs/references/api/odata/ODataFilterOperator.mdx delete mode 100644 content/docs/references/api/odata/ODataMetadata.mdx delete mode 100644 content/docs/references/api/odata/ODataQuery.mdx delete mode 100644 content/docs/references/api/odata/ODataResponse.mdx delete mode 100644 content/docs/references/api/odata/meta.json create mode 100644 content/docs/references/api/realtime.mdx delete mode 100644 content/docs/references/api/realtime/Presence.mdx delete mode 100644 content/docs/references/api/realtime/PresenceStatus.mdx delete mode 100644 content/docs/references/api/realtime/RealtimeAction.mdx delete mode 100644 content/docs/references/api/realtime/RealtimeEvent.mdx delete mode 100644 content/docs/references/api/realtime/RealtimeEventType.mdx delete mode 100644 content/docs/references/api/realtime/Subscription.mdx delete mode 100644 content/docs/references/api/realtime/SubscriptionEvent.mdx delete mode 100644 content/docs/references/api/realtime/TransportProtocol.mdx delete mode 100644 content/docs/references/api/realtime/meta.json rename content/docs/references/api/{router/RouteDefinition.mdx => router.mdx} (51%) delete mode 100644 content/docs/references/api/router/RouteCategory.mdx delete mode 100644 content/docs/references/api/router/RouterConfig.mdx delete mode 100644 content/docs/references/api/router/meta.json create mode 100644 content/docs/references/api/view.mdx delete mode 100644 content/docs/references/api/view/HttpMethod.mdx create mode 100644 content/docs/references/auth/config.mdx delete mode 100644 content/docs/references/auth/config/AccountLinkingConfig.mdx delete mode 100644 content/docs/references/auth/config/AuthConfig.mdx delete mode 100644 content/docs/references/auth/config/AuthPluginConfig.mdx delete mode 100644 content/docs/references/auth/config/AuthStrategy.mdx delete mode 100644 content/docs/references/auth/config/CSRFConfig.mdx delete mode 100644 content/docs/references/auth/config/DatabaseAdapter.mdx delete mode 100644 content/docs/references/auth/config/DatabaseMapping.mdx delete mode 100644 content/docs/references/auth/config/EmailPasswordConfig.mdx delete mode 100644 content/docs/references/auth/config/EnterpriseAuthConfig.mdx delete mode 100644 content/docs/references/auth/config/LDAPConfig.mdx delete mode 100644 content/docs/references/auth/config/MagicLinkConfig.mdx delete mode 100644 content/docs/references/auth/config/OAuthProvider.mdx delete mode 100644 content/docs/references/auth/config/OIDCConfig.mdx delete mode 100644 content/docs/references/auth/config/PasskeyConfig.mdx delete mode 100644 content/docs/references/auth/config/RateLimitConfig.mdx delete mode 100644 content/docs/references/auth/config/SAMLConfig.mdx delete mode 100644 content/docs/references/auth/config/SessionConfig.mdx delete mode 100644 content/docs/references/auth/config/StandardAuthProvider.mdx delete mode 100644 content/docs/references/auth/config/TwoFactorConfig.mdx delete mode 100644 content/docs/references/auth/config/UserFieldMapping.mdx delete mode 100644 content/docs/references/auth/config/meta.json create mode 100644 content/docs/references/auth/identity.mdx delete mode 100644 content/docs/references/auth/identity/Account.mdx delete mode 100644 content/docs/references/auth/identity/Session.mdx delete mode 100644 content/docs/references/auth/identity/User.mdx delete mode 100644 content/docs/references/auth/identity/VerificationToken.mdx delete mode 100644 content/docs/references/auth/identity/meta.json create mode 100644 content/docs/references/auth/organization.mdx delete mode 100644 content/docs/references/auth/organization/Invitation.mdx delete mode 100644 content/docs/references/auth/organization/InvitationStatus.mdx delete mode 100644 content/docs/references/auth/organization/Member.mdx delete mode 100644 content/docs/references/auth/organization/Organization.mdx delete mode 100644 content/docs/references/auth/organization/meta.json create mode 100644 content/docs/references/auth/policy.mdx delete mode 100644 content/docs/references/auth/policy/AuditPolicy.mdx delete mode 100644 content/docs/references/auth/policy/NetworkPolicy.mdx delete mode 100644 content/docs/references/auth/policy/PasswordPolicy.mdx delete mode 100644 content/docs/references/auth/policy/Policy.mdx delete mode 100644 content/docs/references/auth/policy/SessionPolicy.mdx delete mode 100644 content/docs/references/auth/policy/meta.json rename content/docs/references/auth/{role/Role.mdx => role.mdx} (77%) delete mode 100644 content/docs/references/auth/role/meta.json create mode 100644 content/docs/references/auth/scim.mdx delete mode 100644 content/docs/references/auth/scim/SCIMAddress.mdx delete mode 100644 content/docs/references/auth/scim/SCIMEmail.mdx delete mode 100644 content/docs/references/auth/scim/SCIMEnterpriseUser.mdx delete mode 100644 content/docs/references/auth/scim/SCIMError.mdx delete mode 100644 content/docs/references/auth/scim/SCIMGroup.mdx delete mode 100644 content/docs/references/auth/scim/SCIMGroupReference.mdx delete mode 100644 content/docs/references/auth/scim/SCIMListResponse.mdx delete mode 100644 content/docs/references/auth/scim/SCIMMemberReference.mdx delete mode 100644 content/docs/references/auth/scim/SCIMMeta.mdx delete mode 100644 content/docs/references/auth/scim/SCIMName.mdx delete mode 100644 content/docs/references/auth/scim/SCIMPatchOperation.mdx delete mode 100644 content/docs/references/auth/scim/SCIMPatchRequest.mdx delete mode 100644 content/docs/references/auth/scim/SCIMPhoneNumber.mdx delete mode 100644 content/docs/references/auth/scim/SCIMUser.mdx delete mode 100644 content/docs/references/auth/scim/meta.json create mode 100644 content/docs/references/automation/approval.mdx delete mode 100644 content/docs/references/automation/approval/ApprovalAction.mdx delete mode 100644 content/docs/references/automation/approval/ApprovalActionType.mdx delete mode 100644 content/docs/references/automation/approval/ApprovalProcess.mdx delete mode 100644 content/docs/references/automation/approval/ApprovalStep.mdx delete mode 100644 content/docs/references/automation/approval/ApproverType.mdx delete mode 100644 content/docs/references/automation/approval/meta.json create mode 100644 content/docs/references/automation/connector.mdx delete mode 100644 content/docs/references/automation/connector/AuthField.mdx delete mode 100644 content/docs/references/automation/connector/Authentication.mdx delete mode 100644 content/docs/references/automation/connector/AuthenticationType.mdx delete mode 100644 content/docs/references/automation/connector/Connector.mdx delete mode 100644 content/docs/references/automation/connector/ConnectorCategory.mdx delete mode 100644 content/docs/references/automation/connector/ConnectorInstance.mdx delete mode 100644 content/docs/references/automation/connector/ConnectorOperation.mdx delete mode 100644 content/docs/references/automation/connector/ConnectorTrigger.mdx delete mode 100644 content/docs/references/automation/connector/OAuth2Config.mdx delete mode 100644 content/docs/references/automation/connector/OperationParameter.mdx delete mode 100644 content/docs/references/automation/connector/OperationType.mdx delete mode 100644 content/docs/references/automation/connector/meta.json create mode 100644 content/docs/references/automation/etl.mdx delete mode 100644 content/docs/references/automation/etl/ETLDestination.mdx delete mode 100644 content/docs/references/automation/etl/ETLEndpointType.mdx delete mode 100644 content/docs/references/automation/etl/ETLPipeline.mdx delete mode 100644 content/docs/references/automation/etl/ETLPipelineRun.mdx delete mode 100644 content/docs/references/automation/etl/ETLRunStatus.mdx delete mode 100644 content/docs/references/automation/etl/ETLSource.mdx delete mode 100644 content/docs/references/automation/etl/ETLSyncMode.mdx delete mode 100644 content/docs/references/automation/etl/ETLTransformation.mdx delete mode 100644 content/docs/references/automation/etl/ETLTransformationType.mdx delete mode 100644 content/docs/references/automation/etl/meta.json create mode 100644 content/docs/references/automation/flow.mdx delete mode 100644 content/docs/references/automation/flow/Flow.mdx delete mode 100644 content/docs/references/automation/flow/FlowEdge.mdx delete mode 100644 content/docs/references/automation/flow/FlowNode.mdx delete mode 100644 content/docs/references/automation/flow/FlowNodeAction.mdx delete mode 100644 content/docs/references/automation/flow/FlowVariable.mdx delete mode 100644 content/docs/references/automation/flow/meta.json rename content/docs/references/automation/{mapping/FieldMapping.mdx => mapping.mdx} (75%) create mode 100644 content/docs/references/automation/sync.mdx delete mode 100644 content/docs/references/automation/sync/ConflictResolution.mdx delete mode 100644 content/docs/references/automation/sync/DataDestinationConfig.mdx delete mode 100644 content/docs/references/automation/sync/DataSourceConfig.mdx delete mode 100644 content/docs/references/automation/sync/DataSyncConfig.mdx delete mode 100644 content/docs/references/automation/sync/SyncDirection.mdx delete mode 100644 content/docs/references/automation/sync/SyncExecutionResult.mdx delete mode 100644 content/docs/references/automation/sync/SyncExecutionStatus.mdx delete mode 100644 content/docs/references/automation/sync/SyncMode.mdx delete mode 100644 content/docs/references/automation/sync/meta.json rename content/docs/references/automation/{webhook/Webhook.mdx => webhook.mdx} (50%) delete mode 100644 content/docs/references/automation/webhook/WebhookReceiver.mdx delete mode 100644 content/docs/references/automation/webhook/WebhookTriggerType.mdx delete mode 100644 content/docs/references/automation/webhook/meta.json create mode 100644 content/docs/references/automation/workflow.mdx delete mode 100644 content/docs/references/automation/workflow/CustomScriptAction.mdx delete mode 100644 content/docs/references/automation/workflow/EmailAlertAction.mdx delete mode 100644 content/docs/references/automation/workflow/FieldUpdateAction.mdx delete mode 100644 content/docs/references/automation/workflow/HttpCallAction.mdx delete mode 100644 content/docs/references/automation/workflow/PushNotificationAction.mdx delete mode 100644 content/docs/references/automation/workflow/SlackMessageAction.mdx delete mode 100644 content/docs/references/automation/workflow/SmsNotificationAction.mdx delete mode 100644 content/docs/references/automation/workflow/TaskCreationAction.mdx delete mode 100644 content/docs/references/automation/workflow/TeamsMessageAction.mdx delete mode 100644 content/docs/references/automation/workflow/TimeTrigger.mdx delete mode 100644 content/docs/references/automation/workflow/WebhookTriggerAction.mdx delete mode 100644 content/docs/references/automation/workflow/WorkflowAction.mdx delete mode 100644 content/docs/references/automation/workflow/WorkflowRule.mdx delete mode 100644 content/docs/references/automation/workflow/WorkflowTriggerType.mdx delete mode 100644 content/docs/references/automation/workflow/meta.json rename content/docs/references/data/{dataset/Dataset.mdx => dataset.mdx} (61%) delete mode 100644 content/docs/references/data/dataset/DatasetMode.mdx delete mode 100644 content/docs/references/data/dataset/meta.json rename content/docs/references/data/{field/Field.mdx => field.mdx} (55%) delete mode 100644 content/docs/references/data/field/Address.mdx delete mode 100644 content/docs/references/data/field/CurrencyConfig.mdx delete mode 100644 content/docs/references/data/field/CurrencyValue.mdx delete mode 100644 content/docs/references/data/field/FieldType.mdx delete mode 100644 content/docs/references/data/field/LocationCoordinates.mdx delete mode 100644 content/docs/references/data/field/SelectOption.mdx delete mode 100644 content/docs/references/data/field/VectorConfig.mdx delete mode 100644 content/docs/references/data/field/meta.json create mode 100644 content/docs/references/data/filter.mdx delete mode 100644 content/docs/references/data/filter/ComparisonOperator.mdx delete mode 100644 content/docs/references/data/filter/EqualityOperator.mdx delete mode 100644 content/docs/references/data/filter/FieldOperators.mdx delete mode 100644 content/docs/references/data/filter/FieldReference.mdx delete mode 100644 content/docs/references/data/filter/FilterCondition.mdx delete mode 100644 content/docs/references/data/filter/NormalizedFilter.mdx delete mode 100644 content/docs/references/data/filter/QueryFilter.mdx delete mode 100644 content/docs/references/data/filter/RangeOperator.mdx delete mode 100644 content/docs/references/data/filter/SetOperator.mdx delete mode 100644 content/docs/references/data/filter/SpecialOperator.mdx delete mode 100644 content/docs/references/data/filter/StringOperator.mdx delete mode 100644 content/docs/references/data/filter/meta.json create mode 100644 content/docs/references/data/hook.mdx delete mode 100644 content/docs/references/data/hook/Hook.mdx delete mode 100644 content/docs/references/data/hook/HookContext.mdx delete mode 100644 content/docs/references/data/hook/HookEvent.mdx delete mode 100644 content/docs/references/data/hook/meta.json delete mode 100644 content/docs/references/data/mapping/meta.json create mode 100644 content/docs/references/data/object.mdx delete mode 100644 content/docs/references/data/object/Index.mdx delete mode 100644 content/docs/references/data/object/Object.mdx delete mode 100644 content/docs/references/data/object/ObjectCapabilities.mdx delete mode 100644 content/docs/references/data/object/SearchConfig.mdx delete mode 100644 content/docs/references/data/object/meta.json create mode 100644 content/docs/references/data/query.mdx delete mode 100644 content/docs/references/data/query/AggregationFunction.mdx delete mode 100644 content/docs/references/data/query/AggregationNode.mdx delete mode 100644 content/docs/references/data/query/FieldNode.mdx delete mode 100644 content/docs/references/data/query/JoinNode.mdx delete mode 100644 content/docs/references/data/query/JoinStrategy.mdx delete mode 100644 content/docs/references/data/query/JoinType.mdx delete mode 100644 content/docs/references/data/query/Query.mdx delete mode 100644 content/docs/references/data/query/SortNode.mdx delete mode 100644 content/docs/references/data/query/WindowFunction.mdx delete mode 100644 content/docs/references/data/query/WindowFunctionNode.mdx delete mode 100644 content/docs/references/data/query/WindowSpec.mdx delete mode 100644 content/docs/references/data/query/meta.json create mode 100644 content/docs/references/data/validation.mdx delete mode 100644 content/docs/references/data/validation/AsyncValidation.mdx delete mode 100644 content/docs/references/data/validation/ConditionalValidation.mdx delete mode 100644 content/docs/references/data/validation/CrossFieldValidation.mdx delete mode 100644 content/docs/references/data/validation/CustomValidator.mdx delete mode 100644 content/docs/references/data/validation/FormatValidation.mdx delete mode 100644 content/docs/references/data/validation/JSONValidation.mdx delete mode 100644 content/docs/references/data/validation/ScriptValidation.mdx delete mode 100644 content/docs/references/data/validation/StateMachineValidation.mdx delete mode 100644 content/docs/references/data/validation/UniquenessValidation.mdx delete mode 100644 content/docs/references/data/validation/ValidationRule.mdx delete mode 100644 content/docs/references/data/validation/meta.json create mode 100644 content/docs/references/hub/composer.mdx delete mode 100644 content/docs/references/hub/composer/BillOfMaterials.mdx delete mode 100644 content/docs/references/hub/composer/ComposerRequest.mdx delete mode 100644 content/docs/references/hub/composer/ComposerResponse.mdx delete mode 100644 content/docs/references/hub/composer/ConflictReport.mdx delete mode 100644 content/docs/references/hub/composer/DependencyRequirement.mdx delete mode 100644 content/docs/references/hub/composer/meta.json create mode 100644 content/docs/references/hub/license.mdx delete mode 100644 content/docs/references/hub/license/Feature.mdx delete mode 100644 content/docs/references/hub/license/License.mdx delete mode 100644 content/docs/references/hub/license/MetricType.mdx delete mode 100644 content/docs/references/hub/license/Plan.mdx delete mode 100644 content/docs/references/hub/license/meta.json rename content/docs/references/hub/{marketplace/MarketplacePlugin.mdx => marketplace.mdx} (50%) delete mode 100644 content/docs/references/hub/marketplace/PluginAuthor.mdx delete mode 100644 content/docs/references/hub/marketplace/PluginPricing.mdx delete mode 100644 content/docs/references/hub/marketplace/meta.json create mode 100644 content/docs/references/hub/space.mdx delete mode 100644 content/docs/references/hub/space/DeploymentTarget.mdx delete mode 100644 content/docs/references/hub/space/HubSpace.mdx delete mode 100644 content/docs/references/hub/space/SpaceSubscription.mdx delete mode 100644 content/docs/references/hub/space/SubscriptionStatus.mdx delete mode 100644 content/docs/references/hub/space/meta.json create mode 100644 content/docs/references/hub/tenant.mdx delete mode 100644 content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx delete mode 100644 content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx delete mode 100644 content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx delete mode 100644 content/docs/references/hub/tenant/Tenant.mdx delete mode 100644 content/docs/references/hub/tenant/TenantIsolationConfig.mdx delete mode 100644 content/docs/references/hub/tenant/TenantIsolationLevel.mdx delete mode 100644 content/docs/references/hub/tenant/TenantQuota.mdx delete mode 100644 content/docs/references/hub/tenant/TenantSecurityPolicy.mdx delete mode 100644 content/docs/references/hub/tenant/meta.json create mode 100644 content/docs/references/permission/permission.mdx delete mode 100644 content/docs/references/permission/permission/FieldPermission.mdx delete mode 100644 content/docs/references/permission/permission/ObjectPermission.mdx delete mode 100644 content/docs/references/permission/permission/PermissionSet.mdx delete mode 100644 content/docs/references/permission/permission/meta.json create mode 100644 content/docs/references/permission/rls.mdx delete mode 100644 content/docs/references/permission/rls/RLSConfig.mdx delete mode 100644 content/docs/references/permission/rls/RLSEvaluationResult.mdx delete mode 100644 content/docs/references/permission/rls/RLSOperation.mdx delete mode 100644 content/docs/references/permission/rls/RLSUserContext.mdx delete mode 100644 content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx delete mode 100644 content/docs/references/permission/rls/meta.json create mode 100644 content/docs/references/permission/sharing.mdx delete mode 100644 content/docs/references/permission/sharing/CriteriaSharingRule.mdx delete mode 100644 content/docs/references/permission/sharing/OWDModel.mdx delete mode 100644 content/docs/references/permission/sharing/OwnerSharingRule.mdx delete mode 100644 content/docs/references/permission/sharing/ShareRecipientType.mdx delete mode 100644 content/docs/references/permission/sharing/SharingLevel.mdx delete mode 100644 content/docs/references/permission/sharing/SharingRule.mdx delete mode 100644 content/docs/references/permission/sharing/SharingRuleType.mdx delete mode 100644 content/docs/references/permission/sharing/meta.json rename content/docs/references/permission/{territory/Territory.mdx => territory.mdx} (53%) delete mode 100644 content/docs/references/permission/territory/TerritoryModel.mdx delete mode 100644 content/docs/references/permission/territory/TerritoryType.mdx delete mode 100644 content/docs/references/permission/territory/meta.json create mode 100644 content/docs/references/shared/identifiers.mdx delete mode 100644 content/docs/references/shared/identifiers/EventName.mdx delete mode 100644 content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx delete mode 100644 content/docs/references/shared/identifiers/SystemIdentifier.mdx delete mode 100644 content/docs/references/shared/identifiers/meta.json create mode 100644 content/docs/references/system/audit.mdx delete mode 100644 content/docs/references/system/audit/AuditConfig.mdx delete mode 100644 content/docs/references/system/audit/AuditEvent.mdx delete mode 100644 content/docs/references/system/audit/AuditEventActor.mdx delete mode 100644 content/docs/references/system/audit/AuditEventChange.mdx delete mode 100644 content/docs/references/system/audit/AuditEventFilter.mdx delete mode 100644 content/docs/references/system/audit/AuditEventSeverity.mdx delete mode 100644 content/docs/references/system/audit/AuditEventTarget.mdx delete mode 100644 content/docs/references/system/audit/AuditEventType.mdx delete mode 100644 content/docs/references/system/audit/AuditRetentionPolicy.mdx delete mode 100644 content/docs/references/system/audit/AuditStorageConfig.mdx delete mode 100644 content/docs/references/system/audit/SuspiciousActivityRule.mdx delete mode 100644 content/docs/references/system/audit/meta.json rename content/docs/references/system/{context/KernelContext.mdx => context.mdx} (63%) delete mode 100644 content/docs/references/system/context/RuntimeMode.mdx delete mode 100644 content/docs/references/system/context/meta.json create mode 100644 content/docs/references/system/datasource.mdx delete mode 100644 content/docs/references/system/datasource/Datasource.mdx delete mode 100644 content/docs/references/system/datasource/DatasourceCapabilities.mdx delete mode 100644 content/docs/references/system/datasource/DriverDefinition.mdx delete mode 100644 content/docs/references/system/datasource/DriverType.mdx delete mode 100644 content/docs/references/system/datasource/meta.json rename content/docs/references/system/{driver/DriverCapabilities.mdx => driver.mdx} (51%) delete mode 100644 content/docs/references/system/driver/DriverInterface.mdx delete mode 100644 content/docs/references/system/driver/DriverOptions.mdx delete mode 100644 content/docs/references/system/driver/meta.json create mode 100644 content/docs/references/system/events.mdx delete mode 100644 content/docs/references/system/events/Event.mdx delete mode 100644 content/docs/references/system/events/EventHandler.mdx delete mode 100644 content/docs/references/system/events/EventMetadata.mdx delete mode 100644 content/docs/references/system/events/EventPersistence.mdx delete mode 100644 content/docs/references/system/events/EventRoute.mdx delete mode 100644 content/docs/references/system/events/meta.json rename content/docs/references/system/{feature/FeatureFlag.mdx => feature.mdx} (62%) delete mode 100644 content/docs/references/system/feature/FeatureStrategy.mdx delete mode 100644 content/docs/references/system/feature/meta.json create mode 100644 content/docs/references/system/job.mdx delete mode 100644 content/docs/references/system/job/CronSchedule.mdx delete mode 100644 content/docs/references/system/job/IntervalSchedule.mdx delete mode 100644 content/docs/references/system/job/Job.mdx delete mode 100644 content/docs/references/system/job/JobExecution.mdx delete mode 100644 content/docs/references/system/job/JobExecutionStatus.mdx delete mode 100644 content/docs/references/system/job/OnceSchedule.mdx delete mode 100644 content/docs/references/system/job/RetryPolicy.mdx delete mode 100644 content/docs/references/system/job/Schedule.mdx delete mode 100644 content/docs/references/system/job/meta.json create mode 100644 content/docs/references/system/logger.mdx delete mode 100644 content/docs/references/system/logger/LogEntry.mdx delete mode 100644 content/docs/references/system/logger/LogFormat.mdx delete mode 100644 content/docs/references/system/logger/LogLevel.mdx delete mode 100644 content/docs/references/system/logger/LoggerConfig.mdx delete mode 100644 content/docs/references/system/logger/meta.json rename content/docs/references/system/{manifest/Manifest.mdx => manifest.mdx} (86%) delete mode 100644 content/docs/references/system/manifest/meta.json create mode 100644 content/docs/references/system/misc.mdx delete mode 100644 content/docs/references/system/misc/MongoConfig.mdx delete mode 100644 content/docs/references/system/misc/PostgresConfig.mdx create mode 100644 content/docs/references/system/plugin.mdx delete mode 100644 content/docs/references/system/plugin/I18nContext.mdx delete mode 100644 content/docs/references/system/plugin/Logger.mdx delete mode 100644 content/docs/references/system/plugin/ObjectQLClient.mdx delete mode 100644 content/docs/references/system/plugin/Plugin.mdx delete mode 100644 content/docs/references/system/plugin/PluginContext.mdx delete mode 100644 content/docs/references/system/plugin/PluginLifecycle.mdx delete mode 100644 content/docs/references/system/plugin/Router.mdx delete mode 100644 content/docs/references/system/plugin/Scheduler.mdx delete mode 100644 content/docs/references/system/plugin/ScopedStorage.mdx delete mode 100644 content/docs/references/system/plugin/SystemAPI.mdx delete mode 100644 content/docs/references/system/plugin/meta.json create mode 100644 content/docs/references/system/scoped-storage.mdx delete mode 100644 content/docs/references/system/scoped-storage/FileMetadata.mdx delete mode 100644 content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx delete mode 100644 content/docs/references/system/scoped-storage/StorageAdapterType.mdx delete mode 100644 content/docs/references/system/scoped-storage/StorageScope.mdx delete mode 100644 content/docs/references/system/scoped-storage/meta.json create mode 100644 content/docs/references/system/translation.mdx delete mode 100644 content/docs/references/system/translation/Locale.mdx delete mode 100644 content/docs/references/system/translation/TranslationBundle.mdx delete mode 100644 content/docs/references/system/translation/TranslationData.mdx delete mode 100644 content/docs/references/system/translation/meta.json rename content/docs/references/ui/{action/Action.mdx => action.mdx} (55%) delete mode 100644 content/docs/references/ui/action/ActionParam.mdx delete mode 100644 content/docs/references/ui/action/meta.json create mode 100644 content/docs/references/ui/app.mdx delete mode 100644 content/docs/references/ui/app/App.mdx delete mode 100644 content/docs/references/ui/app/AppBranding.mdx delete mode 100644 content/docs/references/ui/app/DashboardNavItem.mdx delete mode 100644 content/docs/references/ui/app/GroupNavItem.mdx delete mode 100644 content/docs/references/ui/app/NavigationItem.mdx delete mode 100644 content/docs/references/ui/app/ObjectNavItem.mdx delete mode 100644 content/docs/references/ui/app/PageNavItem.mdx delete mode 100644 content/docs/references/ui/app/UrlNavItem.mdx delete mode 100644 content/docs/references/ui/app/meta.json delete mode 100644 content/docs/references/ui/block/meta.json create mode 100644 content/docs/references/ui/component.mdx delete mode 100644 content/docs/references/ui/component/PageCardProps.mdx delete mode 100644 content/docs/references/ui/component/PageHeaderProps.mdx delete mode 100644 content/docs/references/ui/component/PageTabsProps.mdx delete mode 100644 content/docs/references/ui/component/RecordDetailsProps.mdx delete mode 100644 content/docs/references/ui/component/RecordHighlightsProps.mdx delete mode 100644 content/docs/references/ui/component/RecordRelatedListProps.mdx delete mode 100644 content/docs/references/ui/component/meta.json rename content/docs/references/ui/{dashboard/DashboardWidget.mdx => dashboard.mdx} (50%) delete mode 100644 content/docs/references/ui/dashboard/ChartType.mdx delete mode 100644 content/docs/references/ui/dashboard/Dashboard.mdx delete mode 100644 content/docs/references/ui/dashboard/meta.json create mode 100644 content/docs/references/ui/page.mdx delete mode 100644 content/docs/references/ui/page/Page.mdx delete mode 100644 content/docs/references/ui/page/PageComponent.mdx delete mode 100644 content/docs/references/ui/page/PageComponentType.mdx delete mode 100644 content/docs/references/ui/page/PageRegion.mdx delete mode 100644 content/docs/references/ui/page/meta.json create mode 100644 content/docs/references/ui/report.mdx delete mode 100644 content/docs/references/ui/report/Report.mdx delete mode 100644 content/docs/references/ui/report/ReportChart.mdx delete mode 100644 content/docs/references/ui/report/ReportColumn.mdx delete mode 100644 content/docs/references/ui/report/ReportGrouping.mdx delete mode 100644 content/docs/references/ui/report/ReportType.mdx delete mode 100644 content/docs/references/ui/report/meta.json create mode 100644 content/docs/references/ui/theme.mdx delete mode 100644 content/docs/references/ui/theme/Animation.mdx delete mode 100644 content/docs/references/ui/theme/BorderRadius.mdx delete mode 100644 content/docs/references/ui/theme/Breakpoints.mdx delete mode 100644 content/docs/references/ui/theme/ColorPalette.mdx delete mode 100644 content/docs/references/ui/theme/Shadow.mdx delete mode 100644 content/docs/references/ui/theme/Spacing.mdx delete mode 100644 content/docs/references/ui/theme/Theme.mdx delete mode 100644 content/docs/references/ui/theme/ThemeMode.mdx delete mode 100644 content/docs/references/ui/theme/Typography.mdx delete mode 100644 content/docs/references/ui/theme/ZIndex.mdx delete mode 100644 content/docs/references/ui/theme/meta.json create mode 100644 content/docs/references/ui/view.mdx delete mode 100644 content/docs/references/ui/view/CalendarConfig.mdx delete mode 100644 content/docs/references/ui/view/FormField.mdx delete mode 100644 content/docs/references/ui/view/FormSection.mdx delete mode 100644 content/docs/references/ui/view/FormView.mdx delete mode 100644 content/docs/references/ui/view/GanttConfig.mdx delete mode 100644 content/docs/references/ui/view/HttpMethod.mdx delete mode 100644 content/docs/references/ui/view/HttpRequest.mdx delete mode 100644 content/docs/references/ui/view/KanbanConfig.mdx delete mode 100644 content/docs/references/ui/view/ListColumn.mdx delete mode 100644 content/docs/references/ui/view/ListView.mdx delete mode 100644 content/docs/references/ui/view/PaginationConfig.mdx delete mode 100644 content/docs/references/ui/view/SelectionConfig.mdx delete mode 100644 content/docs/references/ui/view/View.mdx delete mode 100644 content/docs/references/ui/view/ViewData.mdx delete mode 100644 content/docs/references/ui/view/meta.json create mode 100644 content/docs/references/ui/widget.mdx delete mode 100644 content/docs/references/ui/widget/FieldWidgetProps.mdx delete mode 100644 content/docs/references/ui/widget/WidgetEvent.mdx delete mode 100644 content/docs/references/ui/widget/WidgetLifecycle.mdx delete mode 100644 content/docs/references/ui/widget/WidgetManifest.mdx delete mode 100644 content/docs/references/ui/widget/WidgetProperty.mdx delete mode 100644 content/docs/references/ui/widget/meta.json diff --git a/content/docs/references/ai/agent.mdx b/content/docs/references/ai/agent.mdx new file mode 100644 index 000000000..5d73188c3 --- /dev/null +++ b/content/docs/references/ai/agent.mdx @@ -0,0 +1,80 @@ +--- +title: Agent +description: Agent protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Agent + + +**Source:** `packages/spec/src/ai/agent.zod.ts` + + +## TypeScript Usage + +```typescript +import { AIKnowledgeSchema, AIModelConfigSchema, AIToolSchema, AgentSchema } from '@objectstack/spec/ai'; +import type { AIKnowledge, AIModelConfig, AITool, Agent } from '@objectstack/spec/ai'; + +// Validate data +const result = AIKnowledgeSchema.parse(data); +``` + +--- + +## AIKnowledge + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **topics** | `string[]` | ✅ | Topics/Tags to recruit knowledge from | +| **indexes** | `string[]` | ✅ | Vector Store Indexes | + +--- + +## AIModelConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'local'>` | optional | | +| **model** | `string` | ✅ | Model name (e.g. gpt-4, claude-3-opus) | +| **temperature** | `number` | optional | | +| **maxTokens** | `number` | optional | | +| **topP** | `number` | optional | | + +--- + +## AITool + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'action' \| 'flow' \| 'query' \| 'vector_search'>` | ✅ | | +| **name** | `string` | ✅ | Reference name (Action Name, Flow Name) | +| **description** | `string` | optional | Override description for the LLM | + +--- + +## Agent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Agent unique identifier | +| **label** | `string` | ✅ | Agent display name | +| **avatar** | `string` | optional | | +| **role** | `string` | ✅ | The persona/role (e.g. "Senior Support Engineer") | +| **instructions** | `string` | ✅ | System Prompt / Prime Directives | +| **model** | `object` | optional | | +| **tools** | `object[]` | optional | Available tools | +| **knowledge** | `object` | optional | RAG access | +| **active** | `boolean` | optional | | +| **access** | `string[]` | optional | Who can chat with this agent | + diff --git a/content/docs/references/ai/agent/AIKnowledge.mdx b/content/docs/references/ai/agent/AIKnowledge.mdx deleted file mode 100644 index 0655a9c85..000000000 --- a/content/docs/references/ai/agent/AIKnowledge.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AIKnowledge -description: AIKnowledge Schema Reference -category: ai -zodFile: agent ---- - - - -**Source:** `packages/spec/src/ai/agent.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **topics** | `string[]` | ✅ | Topics/Tags to recruit knowledge from | -| **indexes** | `string[]` | ✅ | Vector Store Indexes | - -## TypeScript Usage - -```typescript -import { AIKnowledgeSchema } from '@objectstack/spec/ai'; -import type { AIKnowledge } from '@objectstack/spec/ai'; - -// Validate data -const result = AIKnowledgeSchema.parse(data); - -// Type-safe usage -const myAIKnowledge: AIKnowledge = { - topics: [], - indexes: [] -}; -``` - diff --git a/content/docs/references/ai/agent/AIModelConfig.mdx b/content/docs/references/ai/agent/AIModelConfig.mdx deleted file mode 100644 index 1cc2ec8ee..000000000 --- a/content/docs/references/ai/agent/AIModelConfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AIModelConfig -description: AIModelConfig Schema Reference -category: ai -zodFile: agent ---- - - - -**Source:** `packages/spec/src/ai/agent.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'local'>` | optional | | -| **model** | `string` | ✅ | Model name (e.g. gpt-4, claude-3-opus) | -| **temperature** | `number` | optional | | -| **maxTokens** | `number` | optional | | -| **topP** | `number` | optional | | - -## TypeScript Usage - -```typescript -import { AIModelConfigSchema } from '@objectstack/spec/ai'; -import type { AIModelConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = AIModelConfigSchema.parse(data); - -// Type-safe usage -const myAIModelConfig: AIModelConfig = { - model: 'example' -}; -``` - diff --git a/content/docs/references/ai/agent/AITool.mdx b/content/docs/references/ai/agent/AITool.mdx deleted file mode 100644 index 979a14bdf..000000000 --- a/content/docs/references/ai/agent/AITool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AITool -description: AITool Schema Reference -category: ai -zodFile: agent ---- - - - -**Source:** `packages/spec/src/ai/agent.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'action' \| 'flow' \| 'query' \| 'vector_search'>` | ✅ | | -| **name** | `string` | ✅ | Reference name (Action Name, Flow Name) | -| **description** | `string` | optional | Override description for the LLM | - -## TypeScript Usage - -```typescript -import { AIToolSchema } from '@objectstack/spec/ai'; -import type { AITool } from '@objectstack/spec/ai'; - -// Validate data -const result = AIToolSchema.parse(data); - -// Type-safe usage -const myAITool: AITool = { - type: 'action', - name: 'name' -}; -``` - diff --git a/content/docs/references/ai/agent/Agent.mdx b/content/docs/references/ai/agent/Agent.mdx deleted file mode 100644 index 9fef37ca9..000000000 --- a/content/docs/references/ai/agent/Agent.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Agent -description: Agent Schema Reference -category: ai -zodFile: agent ---- - - - -**Source:** `packages/spec/src/ai/agent.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Agent unique identifier | -| **label** | `string` | ✅ | Agent display name | -| **avatar** | `string` | optional | | -| **role** | `string` | ✅ | The persona/role (e.g. "Senior Support Engineer") | -| **instructions** | `string` | ✅ | System Prompt / Prime Directives | -| **model** | `object` | optional | | -| **tools** | `object[]` | optional | Available tools | -| **knowledge** | `object` | optional | RAG access | -| **active** | `boolean` | optional | | -| **access** | `string[]` | optional | Who can chat with this agent | - -## TypeScript Usage - -```typescript -import { AgentSchema } from '@objectstack/spec/ai'; -import type { Agent } from '@objectstack/spec/ai'; - -// Validate data -const result = AgentSchema.parse(data); - -// Type-safe usage -const myAgent: Agent = { - name: 'name', - label: 'example', - role: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/agent/meta.json b/content/docs/references/ai/agent/meta.json deleted file mode 100644 index 6fbb63fe0..000000000 --- a/content/docs/references/ai/agent/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Agent" -} \ No newline at end of file diff --git a/content/docs/references/ai/conversation.mdx b/content/docs/references/ai/conversation.mdx new file mode 100644 index 000000000..9e5626bef --- /dev/null +++ b/content/docs/references/ai/conversation.mdx @@ -0,0 +1,259 @@ +--- +title: Conversation +description: Conversation protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Conversation + + +**Source:** `packages/spec/src/ai/conversation.zod.ts` + + +## TypeScript Usage + +```typescript +import { ConversationAnalyticsSchema, ConversationContextSchema, ConversationMessageSchema, ConversationSessionSchema, ConversationSummarySchema, FunctionCallSchema, MessageContentSchema, MessageContentTypeSchema, MessagePruningEventSchema, MessageRoleSchema, 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 = ConversationAnalyticsSchema.parse(data); +``` + +--- + +## ConversationAnalytics + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **sessionId** | `string` | ✅ | | +| **totalMessages** | `integer` | ✅ | | +| **userMessages** | `integer` | ✅ | | +| **assistantMessages** | `integer` | ✅ | | +| **systemMessages** | `integer` | ✅ | | +| **totalTokens** | `integer` | ✅ | | +| **averageTokensPerMessage** | `number` | ✅ | | +| **peakTokenUsage** | `integer` | ✅ | | +| **pruningEvents** | `integer` | optional | | +| **summarizationEvents** | `integer` | optional | | +| **tokensSavedByPruning** | `integer` | optional | | +| **tokensSavedBySummarization** | `integer` | optional | | +| **duration** | `number` | optional | Session duration in seconds | +| **firstMessageAt** | `string` | optional | ISO 8601 timestamp | +| **lastMessageAt** | `string` | optional | ISO 8601 timestamp | + +--- + +## ConversationContext + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **sessionId** | `string` | ✅ | Conversation session ID | +| **userId** | `string` | optional | User identifier | +| **agentId** | `string` | optional | AI agent identifier | +| **object** | `string` | optional | Related object (e.g., "case", "project") | +| **recordId** | `string` | optional | Related record ID | +| **scope** | `Record` | optional | Additional context scope | +| **systemMessage** | `string` | optional | System prompt/instructions | +| **metadata** | `Record` | optional | | + +--- + +## ConversationMessage + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique message ID | +| **timestamp** | `string` | ✅ | ISO 8601 timestamp | +| **role** | `Enum<'system' \| 'user' \| 'assistant' \| 'function' \| 'tool'>` | ✅ | | +| **content** | `string \| object[]` | ✅ | Message content (text or multimodal) | +| **functionCall** | `object` | optional | Legacy function call | +| **toolCalls** | `object[]` | optional | Tool calls | +| **toolCallId** | `string` | optional | Tool call ID this message responds to | +| **name** | `string` | optional | Name of the function/user | +| **tokens** | `object` | optional | Token usage for this message | +| **pinned** | `boolean` | optional | Prevent removal during pruning | +| **importance** | `number` | optional | Importance score for pruning | +| **embedding** | `number[]` | optional | Vector embedding for semantic search | +| **metadata** | `Record` | optional | | + +--- + +## ConversationSession + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique session ID | +| **name** | `string` | optional | Session name/title | +| **context** | `object` | ✅ | | +| **modelId** | `string` | optional | AI model ID | +| **tokenBudget** | `object` | ✅ | | +| **messages** | `object[]` | optional | | +| **tokens** | `object` | optional | | +| **status** | `Enum<'active' \| 'paused' \| 'completed' \| 'archived'>` | optional | | +| **createdAt** | `string` | ✅ | ISO 8601 timestamp | +| **updatedAt** | `string` | ✅ | ISO 8601 timestamp | +| **expiresAt** | `string` | optional | ISO 8601 timestamp | +| **tags** | `string[]` | optional | | +| **metadata** | `Record` | optional | | + +--- + +## ConversationSummary + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **summary** | `string` | ✅ | Conversation summary | +| **keyPoints** | `string[]` | optional | Key discussion points | +| **originalTokens** | `integer` | ✅ | Original token count | +| **summaryTokens** | `integer` | ✅ | Summary token count | +| **tokensSaved** | `integer` | ✅ | Tokens saved | +| **messageRange** | `object` | ✅ | Range of messages summarized | +| **generatedAt** | `string` | ✅ | ISO 8601 timestamp | +| **modelId** | `string` | optional | Model used for summarization | + +--- + +## FunctionCall + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Function name | +| **arguments** | `string` | ✅ | JSON string of function arguments | +| **result** | `string` | optional | Function execution result | + +--- + +## MessageContent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'text' \| 'image' \| 'file' \| 'code' \| 'structured'>` | optional | | +| **text** | `string` | optional | Text content | +| **imageUrl** | `string` | optional | Image URL for vision models | +| **fileUrl** | `string` | optional | File attachment URL | +| **mimeType** | `string` | optional | MIME type for files | +| **metadata** | `Record` | optional | Additional metadata | + +--- + +## MessageContentType + +### Allowed Values + +* `text` +* `image` +* `file` +* `code` +* `structured` + +--- + +## MessagePruningEvent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **timestamp** | `string` | ✅ | ISO 8601 timestamp | +| **strategy** | `Enum<'fifo' \| 'importance' \| 'semantic' \| 'sliding_window' \| 'summary'>` | ✅ | | +| **reason** | `string` | ✅ | Reason for pruning | +| **prunedMessages** | `object[]` | ✅ | | +| **tokensFreed** | `integer` | ✅ | | +| **messagesRemoved** | `integer` | ✅ | | +| **remainingTokens** | `integer` | ✅ | | +| **remainingMessages** | `integer` | ✅ | | + +--- + +## MessageRole + +### Allowed Values + +* `system` +* `user` +* `assistant` +* `function` +* `tool` + +--- + +## TokenBudgetConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **maxTokens** | `integer` | ✅ | Maximum total tokens | +| **maxPromptTokens** | `integer` | optional | Max tokens for prompt | +| **maxCompletionTokens** | `integer` | optional | Max tokens for completion | +| **reserveTokens** | `integer` | optional | Reserve tokens for system messages | +| **bufferPercentage** | `number` | optional | Buffer percentage (0.1 = 10%) | +| **strategy** | `Enum<'fifo' \| 'importance' \| 'semantic' \| 'sliding_window' \| 'summary'>` | optional | | +| **slidingWindowSize** | `integer` | optional | Number of recent messages to keep | +| **minImportanceScore** | `number` | optional | Minimum importance to keep | +| **semanticThreshold** | `number` | optional | Semantic similarity threshold | +| **enableSummarization** | `boolean` | optional | Enable context summarization | +| **summarizationThreshold** | `integer` | optional | Trigger summarization at N tokens | +| **summaryModel** | `string` | optional | Model ID for summarization | +| **warnThreshold** | `number` | optional | Warn at % of budget (0.8 = 80%) | + +--- + +## TokenBudgetStrategy + +### Allowed Values + +* `fifo` +* `importance` +* `semantic` +* `sliding_window` +* `summary` + +--- + +## TokenUsageStats + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **promptTokens** | `integer` | optional | | +| **completionTokens** | `integer` | optional | | +| **totalTokens** | `integer` | optional | | +| **budgetLimit** | `integer` | ✅ | | +| **budgetUsed** | `integer` | optional | | +| **budgetRemaining** | `integer` | ✅ | | +| **budgetPercentage** | `number` | ✅ | Usage as percentage of budget | +| **messageCount** | `integer` | optional | | +| **prunedMessageCount** | `integer` | optional | | +| **summarizedMessageCount** | `integer` | optional | | + +--- + +## ToolCall + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Tool call ID | +| **type** | `Enum<'function'>` | optional | | +| **function** | `object` | ✅ | | + diff --git a/content/docs/references/ai/conversation/ConversationAnalytics.mdx b/content/docs/references/ai/conversation/ConversationAnalytics.mdx deleted file mode 100644 index 15f930ad8..000000000 --- a/content/docs/references/ai/conversation/ConversationAnalytics.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ConversationAnalytics -description: ConversationAnalytics Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **sessionId** | `string` | ✅ | | -| **totalMessages** | `integer` | ✅ | | -| **userMessages** | `integer` | ✅ | | -| **assistantMessages** | `integer` | ✅ | | -| **systemMessages** | `integer` | ✅ | | -| **totalTokens** | `integer` | ✅ | | -| **averageTokensPerMessage** | `number` | ✅ | | -| **peakTokenUsage** | `integer` | ✅ | | -| **pruningEvents** | `integer` | optional | | -| **summarizationEvents** | `integer` | optional | | -| **tokensSavedByPruning** | `integer` | optional | | -| **tokensSavedBySummarization** | `integer` | optional | | -| **duration** | `number` | optional | Session duration in seconds | -| **firstMessageAt** | `string` | optional | ISO 8601 timestamp | -| **lastMessageAt** | `string` | optional | ISO 8601 timestamp | - -## TypeScript Usage - -```typescript -import { ConversationAnalyticsSchema } from '@objectstack/spec/ai'; -import type { ConversationAnalytics } from '@objectstack/spec/ai'; - -// Validate data -const result = ConversationAnalyticsSchema.parse(data); - -// Type-safe usage -const myConversationAnalytics: ConversationAnalytics = { - sessionId: 'example', - totalMessages: null, - userMessages: null, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/conversation/ConversationContext.mdx b/content/docs/references/ai/conversation/ConversationContext.mdx deleted file mode 100644 index 990363b75..000000000 --- a/content/docs/references/ai/conversation/ConversationContext.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ConversationContext -description: ConversationContext Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **sessionId** | `string` | ✅ | Conversation session ID | -| **userId** | `string` | optional | User identifier | -| **agentId** | `string` | optional | AI agent identifier | -| **object** | `string` | optional | Related object (e.g., "case", "project") | -| **recordId** | `string` | optional | Related record ID | -| **scope** | `Record` | optional | Additional context scope | -| **systemMessage** | `string` | optional | System prompt/instructions | -| **metadata** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { ConversationContextSchema } from '@objectstack/spec/ai'; -import type { ConversationContext } from '@objectstack/spec/ai'; - -// Validate data -const result = ConversationContextSchema.parse(data); - -// Type-safe usage -const myConversationContext: ConversationContext = { - sessionId: 'example' -}; -``` - diff --git a/content/docs/references/ai/conversation/ConversationMessage.mdx b/content/docs/references/ai/conversation/ConversationMessage.mdx deleted file mode 100644 index deeb4cfef..000000000 --- a/content/docs/references/ai/conversation/ConversationMessage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ConversationMessage -description: ConversationMessage Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique message ID | -| **timestamp** | `string` | ✅ | ISO 8601 timestamp | -| **role** | `Enum<'system' \| 'user' \| 'assistant' \| 'function' \| 'tool'>` | ✅ | | -| **content** | `string \| object[]` | ✅ | Message content (text or multimodal) | -| **functionCall** | `object` | optional | Legacy function call | -| **toolCalls** | `object[]` | optional | Tool calls | -| **toolCallId** | `string` | optional | Tool call ID this message responds to | -| **name** | `string` | optional | Name of the function/user | -| **tokens** | `object` | optional | Token usage for this message | -| **pinned** | `boolean` | optional | Prevent removal during pruning | -| **importance** | `number` | optional | Importance score for pruning | -| **embedding** | `number[]` | optional | Vector embedding for semantic search | -| **metadata** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { ConversationMessageSchema } from '@objectstack/spec/ai'; -import type { ConversationMessage } from '@objectstack/spec/ai'; - -// Validate data -const result = ConversationMessageSchema.parse(data); - -// Type-safe usage -const myConversationMessage: ConversationMessage = { - id: 'example', - timestamp: 'example', - role: 'system', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/conversation/ConversationSession.mdx b/content/docs/references/ai/conversation/ConversationSession.mdx deleted file mode 100644 index 392f83f2a..000000000 --- a/content/docs/references/ai/conversation/ConversationSession.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ConversationSession -description: ConversationSession Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique session ID | -| **name** | `string` | optional | Session name/title | -| **context** | `object` | ✅ | | -| **modelId** | `string` | optional | AI model ID | -| **tokenBudget** | `object` | ✅ | | -| **messages** | `object[]` | optional | | -| **tokens** | `object` | optional | | -| **status** | `Enum<'active' \| 'paused' \| 'completed' \| 'archived'>` | optional | | -| **createdAt** | `string` | ✅ | ISO 8601 timestamp | -| **updatedAt** | `string` | ✅ | ISO 8601 timestamp | -| **expiresAt** | `string` | optional | ISO 8601 timestamp | -| **tags** | `string[]` | optional | | -| **metadata** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { ConversationSessionSchema } from '@objectstack/spec/ai'; -import type { ConversationSession } from '@objectstack/spec/ai'; - -// Validate data -const result = ConversationSessionSchema.parse(data); - -// Type-safe usage -const myConversationSession: ConversationSession = { - id: 'example', - context: {}, - tokenBudget: {}, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/conversation/ConversationSummary.mdx b/content/docs/references/ai/conversation/ConversationSummary.mdx deleted file mode 100644 index 205447df5..000000000 --- a/content/docs/references/ai/conversation/ConversationSummary.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ConversationSummary -description: ConversationSummary Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **summary** | `string` | ✅ | Conversation summary | -| **keyPoints** | `string[]` | optional | Key discussion points | -| **originalTokens** | `integer` | ✅ | Original token count | -| **summaryTokens** | `integer` | ✅ | Summary token count | -| **tokensSaved** | `integer` | ✅ | Tokens saved | -| **messageRange** | `object` | ✅ | Range of messages summarized | -| **generatedAt** | `string` | ✅ | ISO 8601 timestamp | -| **modelId** | `string` | optional | Model used for summarization | - -## TypeScript Usage - -```typescript -import { ConversationSummarySchema } from '@objectstack/spec/ai'; -import type { ConversationSummary } from '@objectstack/spec/ai'; - -// Validate data -const result = ConversationSummarySchema.parse(data); - -// Type-safe usage -const myConversationSummary: ConversationSummary = { - summary: 'example', - originalTokens: null, - summaryTokens: null, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/conversation/FunctionCall.mdx b/content/docs/references/ai/conversation/FunctionCall.mdx deleted file mode 100644 index 08ef1ae1a..000000000 --- a/content/docs/references/ai/conversation/FunctionCall.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FunctionCall -description: FunctionCall Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Function name | -| **arguments** | `string` | ✅ | JSON string of function arguments | -| **result** | `string` | optional | Function execution result | - -## TypeScript Usage - -```typescript -import { FunctionCallSchema } from '@objectstack/spec/ai'; -import type { FunctionCall } from '@objectstack/spec/ai'; - -// Validate data -const result = FunctionCallSchema.parse(data); - -// Type-safe usage -const myFunctionCall: FunctionCall = { - name: 'name', - arguments: 'example' -}; -``` - diff --git a/content/docs/references/ai/conversation/MessageContent.mdx b/content/docs/references/ai/conversation/MessageContent.mdx deleted file mode 100644 index 32b11691a..000000000 --- a/content/docs/references/ai/conversation/MessageContent.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: MessageContent -description: MessageContent Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'text' \| 'image' \| 'file' \| 'code' \| 'structured'>` | optional | | -| **text** | `string` | optional | Text content | -| **imageUrl** | `string` | optional | Image URL for vision models | -| **fileUrl** | `string` | optional | File attachment URL | -| **mimeType** | `string` | optional | MIME type for files | -| **metadata** | `Record` | optional | Additional metadata | - -## TypeScript Usage - -```typescript -import { MessageContentSchema } from '@objectstack/spec/ai'; -import type { MessageContent } from '@objectstack/spec/ai'; - -// Validate data -const result = MessageContentSchema.parse(data); - -// Type-safe usage -const myMessageContent: MessageContent = { -}; -``` - diff --git a/content/docs/references/ai/conversation/MessageContentType.mdx b/content/docs/references/ai/conversation/MessageContentType.mdx deleted file mode 100644 index 53181917b..000000000 --- a/content/docs/references/ai/conversation/MessageContentType.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: MessageContentType -description: MessageContentType Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Allowed Values - -* `text` -* `image` -* `file` -* `code` -* `structured` - -## TypeScript Usage - -```typescript -import { MessageContentType } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: MessageContentType = 'text'; -``` - diff --git a/content/docs/references/ai/conversation/MessagePruningEvent.mdx b/content/docs/references/ai/conversation/MessagePruningEvent.mdx deleted file mode 100644 index 1bf74de60..000000000 --- a/content/docs/references/ai/conversation/MessagePruningEvent.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MessagePruningEvent -description: MessagePruningEvent Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **timestamp** | `string` | ✅ | ISO 8601 timestamp | -| **strategy** | `Enum<'fifo' \| 'importance' \| 'semantic' \| 'sliding_window' \| 'summary'>` | ✅ | | -| **reason** | `string` | ✅ | Reason for pruning | -| **prunedMessages** | `object[]` | ✅ | | -| **tokensFreed** | `integer` | ✅ | | -| **messagesRemoved** | `integer` | ✅ | | -| **remainingTokens** | `integer` | ✅ | | -| **remainingMessages** | `integer` | ✅ | | - -## TypeScript Usage - -```typescript -import { MessagePruningEventSchema } from '@objectstack/spec/ai'; -import type { MessagePruningEvent } from '@objectstack/spec/ai'; - -// Validate data -const result = MessagePruningEventSchema.parse(data); - -// Type-safe usage -const myMessagePruningEvent: MessagePruningEvent = { - timestamp: 'example', - strategy: 'fifo', - reason: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/conversation/MessageRole.mdx b/content/docs/references/ai/conversation/MessageRole.mdx deleted file mode 100644 index b64841739..000000000 --- a/content/docs/references/ai/conversation/MessageRole.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: MessageRole -description: MessageRole Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Allowed Values - -* `system` -* `user` -* `assistant` -* `function` -* `tool` - -## TypeScript Usage - -```typescript -import { MessageRole } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: MessageRole = 'system'; -``` - diff --git a/content/docs/references/ai/conversation/TokenBudgetConfig.mdx b/content/docs/references/ai/conversation/TokenBudgetConfig.mdx deleted file mode 100644 index 229164ae7..000000000 --- a/content/docs/references/ai/conversation/TokenBudgetConfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: TokenBudgetConfig -description: TokenBudgetConfig Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **maxTokens** | `integer` | ✅ | Maximum total tokens | -| **maxPromptTokens** | `integer` | optional | Max tokens for prompt | -| **maxCompletionTokens** | `integer` | optional | Max tokens for completion | -| **reserveTokens** | `integer` | optional | Reserve tokens for system messages | -| **bufferPercentage** | `number` | optional | Buffer percentage (0.1 = 10%) | -| **strategy** | `Enum<'fifo' \| 'importance' \| 'semantic' \| 'sliding_window' \| 'summary'>` | optional | | -| **slidingWindowSize** | `integer` | optional | Number of recent messages to keep | -| **minImportanceScore** | `number` | optional | Minimum importance to keep | -| **semanticThreshold** | `number` | optional | Semantic similarity threshold | -| **enableSummarization** | `boolean` | optional | Enable context summarization | -| **summarizationThreshold** | `integer` | optional | Trigger summarization at N tokens | -| **summaryModel** | `string` | optional | Model ID for summarization | -| **warnThreshold** | `number` | optional | Warn at % of budget (0.8 = 80%) | - -## TypeScript Usage - -```typescript -import { TokenBudgetConfigSchema } from '@objectstack/spec/ai'; -import type { TokenBudgetConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = TokenBudgetConfigSchema.parse(data); - -// Type-safe usage -const myTokenBudgetConfig: TokenBudgetConfig = { - maxTokens: null -}; -``` - diff --git a/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx b/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx deleted file mode 100644 index 0742bd3ef..000000000 --- a/content/docs/references/ai/conversation/TokenBudgetStrategy.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: TokenBudgetStrategy -description: TokenBudgetStrategy Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Allowed Values - -* `fifo` -* `importance` -* `semantic` -* `sliding_window` -* `summary` - -## TypeScript Usage - -```typescript -import { TokenBudgetStrategy } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: TokenBudgetStrategy = 'fifo'; -``` - diff --git a/content/docs/references/ai/conversation/TokenUsageStats.mdx b/content/docs/references/ai/conversation/TokenUsageStats.mdx deleted file mode 100644 index 3147eb6b7..000000000 --- a/content/docs/references/ai/conversation/TokenUsageStats.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TokenUsageStats -description: TokenUsageStats Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **promptTokens** | `integer` | optional | | -| **completionTokens** | `integer` | optional | | -| **totalTokens** | `integer` | optional | | -| **budgetLimit** | `integer` | ✅ | | -| **budgetUsed** | `integer` | optional | | -| **budgetRemaining** | `integer` | ✅ | | -| **budgetPercentage** | `number` | ✅ | Usage as percentage of budget | -| **messageCount** | `integer` | optional | | -| **prunedMessageCount** | `integer` | optional | | -| **summarizedMessageCount** | `integer` | optional | | - -## TypeScript Usage - -```typescript -import { TokenUsageStatsSchema } from '@objectstack/spec/ai'; -import type { TokenUsageStats } from '@objectstack/spec/ai'; - -// Validate data -const result = TokenUsageStatsSchema.parse(data); - -// Type-safe usage -const myTokenUsageStats: TokenUsageStats = { - budgetLimit: null, - budgetRemaining: null, - budgetPercentage: 0 -}; -``` - diff --git a/content/docs/references/ai/conversation/ToolCall.mdx b/content/docs/references/ai/conversation/ToolCall.mdx deleted file mode 100644 index e5a6f1d5a..000000000 --- a/content/docs/references/ai/conversation/ToolCall.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ToolCall -description: ToolCall Schema Reference -category: ai -zodFile: conversation ---- - - - -**Source:** `packages/spec/src/ai/conversation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Tool call ID | -| **type** | `Enum<'function'>` | optional | | -| **function** | `object` | ✅ | | - -## TypeScript Usage - -```typescript -import { ToolCallSchema } from '@objectstack/spec/ai'; -import type { ToolCall } from '@objectstack/spec/ai'; - -// Validate data -const result = ToolCallSchema.parse(data); - -// Type-safe usage -const myToolCall: ToolCall = { - id: 'example', - function: {} -}; -``` - diff --git a/content/docs/references/ai/conversation/meta.json b/content/docs/references/ai/conversation/meta.json deleted file mode 100644 index 6a8728d4b..000000000 --- a/content/docs/references/ai/conversation/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Conversation" -} \ No newline at end of file diff --git a/content/docs/references/ai/cost.mdx b/content/docs/references/ai/cost.mdx new file mode 100644 index 000000000..bd3c0ce29 --- /dev/null +++ b/content/docs/references/ai/cost.mdx @@ -0,0 +1,321 @@ +--- +title: Cost +description: Cost protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Cost + + +**Source:** `packages/spec/src/ai/cost.zod.ts` + + +## TypeScript Usage + +```typescript +import { BillingPeriodSchema, BudgetLimitSchema, BudgetStatusSchema, BudgetTypeSchema, CostAlertSchema, CostAlertTypeSchema, CostAnalyticsSchema, CostBreakdownDimensionSchema, CostBreakdownEntrySchema, CostEntrySchema, CostMetricTypeSchema, CostOptimizationRecommendationSchema, CostQueryFiltersSchema, CostReportSchema } from '@objectstack/spec/ai'; +import type { BillingPeriod, BudgetLimit, BudgetStatus, BudgetType, CostAlert, CostAlertType, CostAnalytics, CostBreakdownDimension, CostBreakdownEntry, CostEntry, CostMetricType, CostOptimizationRecommendation, CostQueryFilters, CostReport } from '@objectstack/spec/ai'; + +// Validate data +const result = BillingPeriodSchema.parse(data); +``` + +--- + +## BillingPeriod + +### Allowed Values + +* `hourly` +* `daily` +* `weekly` +* `monthly` +* `quarterly` +* `yearly` +* `custom` + +--- + +## BudgetLimit + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'global' \| 'user' \| 'agent' \| 'object' \| 'project' \| 'department'>` | ✅ | | +| **scope** | `string` | optional | Scope identifier (userId, agentId, etc.) | +| **maxCost** | `number` | ✅ | Maximum cost limit | +| **currency** | `string` | optional | | +| **period** | `Enum<'hourly' \| 'daily' \| 'weekly' \| 'monthly' \| 'quarterly' \| 'yearly' \| 'custom'>` | ✅ | | +| **customPeriodDays** | `integer` | optional | Custom period in days | +| **softLimit** | `number` | optional | Soft limit for warnings | +| **warnThresholds** | `number[]` | optional | Warning thresholds (e.g., [0.5, 0.8, 0.95]) | +| **enforced** | `boolean` | optional | Block requests when exceeded | +| **gracePeriodSeconds** | `integer` | optional | Grace period after limit exceeded | +| **allowRollover** | `boolean` | optional | Allow unused budget to rollover | +| **maxRolloverPercentage** | `number` | optional | Max rollover as % of limit | +| **name** | `string` | optional | Budget name | +| **description** | `string` | optional | | +| **active** | `boolean` | optional | | +| **tags** | `string[]` | optional | | + +--- + +## BudgetStatus + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **budgetId** | `string` | ✅ | | +| **type** | `Enum<'global' \| 'user' \| 'agent' \| 'object' \| 'project' \| 'department'>` | ✅ | | +| **scope** | `string` | optional | | +| **periodStart** | `string` | ✅ | ISO 8601 timestamp | +| **periodEnd** | `string` | ✅ | ISO 8601 timestamp | +| **currentCost** | `number` | optional | | +| **maxCost** | `number` | ✅ | | +| **currency** | `string` | optional | | +| **percentageUsed** | `number` | ✅ | Usage as percentage (can exceed 1.0 if over budget) | +| **remainingCost** | `number` | ✅ | Remaining budget (can be negative if exceeded) | +| **isExceeded** | `boolean` | optional | | +| **isWarning** | `boolean` | optional | | +| **projectedCost** | `number` | optional | Projected cost for period | +| **projectedOverage** | `number` | optional | Projected overage | +| **lastUpdated** | `string` | ✅ | ISO 8601 timestamp | + +--- + +## BudgetType + +### Allowed Values + +* `global` +* `user` +* `agent` +* `object` +* `project` +* `department` + +--- + +## CostAlert + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | | +| **timestamp** | `string` | ✅ | ISO 8601 timestamp | +| **type** | `Enum<'threshold_warning' \| 'threshold_critical' \| 'limit_exceeded' \| 'anomaly_detected' \| 'projection_exceeded'>` | ✅ | | +| **severity** | `Enum<'info' \| 'warning' \| 'critical'>` | ✅ | | +| **budgetId** | `string` | optional | | +| **budgetType** | `Enum<'global' \| 'user' \| 'agent' \| 'object' \| 'project' \| 'department'>` | optional | | +| **scope** | `string` | optional | | +| **message** | `string` | ✅ | Alert message | +| **currentCost** | `number` | ✅ | | +| **maxCost** | `number` | optional | | +| **threshold** | `number` | optional | | +| **currency** | `string` | optional | | +| **recommendations** | `string[]` | optional | | +| **acknowledged** | `boolean` | optional | | +| **acknowledgedBy** | `string` | optional | | +| **acknowledgedAt** | `string` | optional | | +| **resolved** | `boolean` | optional | | +| **metadata** | `Record` | optional | | + +--- + +## CostAlertType + +### Allowed Values + +* `threshold_warning` +* `threshold_critical` +* `limit_exceeded` +* `anomaly_detected` +* `projection_exceeded` + +--- + +## CostAnalytics + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **periodStart** | `string` | ✅ | ISO 8601 timestamp | +| **periodEnd** | `string` | ✅ | ISO 8601 timestamp | +| **totalCost** | `number` | ✅ | | +| **totalRequests** | `integer` | ✅ | | +| **totalTokens** | `integer` | optional | | +| **currency** | `string` | optional | | +| **averageCostPerRequest** | `number` | ✅ | | +| **averageCostPerToken** | `number` | optional | | +| **averageRequestsPerDay** | `number` | ✅ | | +| **costTrend** | `Enum<'increasing' \| 'decreasing' \| 'stable'>` | optional | | +| **trendPercentage** | `number` | optional | % change vs previous period | +| **byModel** | `object[]` | optional | | +| **byProvider** | `object[]` | optional | | +| **byUser** | `object[]` | optional | | +| **byAgent** | `object[]` | optional | | +| **byOperation** | `object[]` | optional | | +| **byDate** | `object[]` | optional | | +| **topModels** | `object[]` | optional | | +| **topUsers** | `object[]` | optional | | +| **topAgents** | `object[]` | optional | | +| **tokensPerDollar** | `number` | optional | | +| **requestsPerDollar** | `number` | optional | | + +--- + +## CostBreakdownDimension + +### Allowed Values + +* `model` +* `provider` +* `user` +* `agent` +* `object` +* `operation` +* `date` +* `hour` +* `tag` + +--- + +## CostBreakdownEntry + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **dimension** | `Enum<'model' \| 'provider' \| 'user' \| 'agent' \| 'object' \| 'operation' \| 'date' \| 'hour' \| 'tag'>` | ✅ | | +| **value** | `string` | ✅ | Dimension value (e.g., model ID, user ID) | +| **totalCost** | `number` | ✅ | | +| **requestCount** | `integer` | ✅ | | +| **totalTokens** | `integer` | optional | | +| **percentageOfTotal** | `number` | ✅ | | +| **periodStart** | `string` | optional | | +| **periodEnd** | `string` | optional | | + +--- + +## CostEntry + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique cost entry ID | +| **timestamp** | `string` | ✅ | ISO 8601 timestamp | +| **modelId** | `string` | ✅ | AI model used | +| **provider** | `string` | ✅ | AI provider (e.g., "openai", "anthropic") | +| **operation** | `string` | ✅ | Operation type (e.g., "chat_completion", "embedding") | +| **promptTokens** | `integer` | optional | | +| **completionTokens** | `integer` | optional | | +| **totalTokens** | `integer` | optional | | +| **requestCount** | `integer` | optional | | +| **promptCost** | `number` | optional | Cost of prompt tokens | +| **completionCost** | `number` | optional | Cost of completion tokens | +| **totalCost** | `number` | ✅ | Total cost in base currency | +| **currency** | `string` | optional | | +| **sessionId** | `string` | optional | Conversation session ID | +| **userId** | `string` | optional | User who triggered the request | +| **agentId** | `string` | optional | AI agent ID | +| **object** | `string` | optional | Related object (e.g., "case", "project") | +| **recordId** | `string` | optional | Related record ID | +| **tags** | `string[]` | optional | | +| **metadata** | `Record` | optional | | + +--- + +## CostMetricType + +### Allowed Values + +* `token` +* `request` +* `character` +* `second` +* `image` +* `embedding` + +--- + +## CostOptimizationRecommendation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | | +| **type** | `Enum<'switch_model' \| 'reduce_tokens' \| 'batch_requests' \| 'cache_results' \| 'adjust_parameters' \| 'limit_usage'>` | ✅ | | +| **title** | `string` | ✅ | | +| **description** | `string` | ✅ | | +| **estimatedSavings** | `number` | optional | | +| **savingsPercentage** | `number` | optional | | +| **priority** | `Enum<'low' \| 'medium' \| 'high'>` | ✅ | | +| **effort** | `Enum<'low' \| 'medium' \| 'high'>` | ✅ | | +| **actionable** | `boolean` | optional | | +| **actionSteps** | `string[]` | optional | | +| **targetModel** | `string` | optional | | +| **alternativeModel** | `string` | optional | | +| **affectedUsers** | `string[]` | optional | | +| **status** | `Enum<'pending' \| 'accepted' \| 'rejected' \| 'implemented'>` | optional | | +| **implementedAt** | `string` | optional | | + +--- + +## CostQueryFilters + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **startDate** | `string` | optional | ISO 8601 timestamp | +| **endDate** | `string` | optional | ISO 8601 timestamp | +| **modelIds** | `string[]` | optional | | +| **providers** | `string[]` | optional | | +| **userIds** | `string[]` | optional | | +| **agentIds** | `string[]` | optional | | +| **operations** | `string[]` | optional | | +| **sessionIds** | `string[]` | optional | | +| **minCost** | `number` | optional | | +| **maxCost** | `number` | optional | | +| **tags** | `string[]` | optional | | +| **groupBy** | `Enum<'model' \| 'provider' \| 'user' \| 'agent' \| 'object' \| 'operation' \| 'date' \| 'hour' \| 'tag'>[]` | optional | | +| **orderBy** | `Enum<'timestamp' \| 'cost' \| 'tokens'>` | optional | | +| **orderDirection** | `Enum<'asc' \| 'desc'>` | optional | | +| **limit** | `integer` | optional | | +| **offset** | `integer` | optional | | + +--- + +## CostReport + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | | +| **name** | `string` | ✅ | | +| **generatedAt** | `string` | ✅ | ISO 8601 timestamp | +| **periodStart** | `string` | ✅ | ISO 8601 timestamp | +| **periodEnd** | `string` | ✅ | ISO 8601 timestamp | +| **period** | `Enum<'hourly' \| 'daily' \| 'weekly' \| 'monthly' \| 'quarterly' \| 'yearly' \| 'custom'>` | ✅ | | +| **analytics** | `object` | ✅ | | +| **budgets** | `object[]` | optional | | +| **alerts** | `object[]` | optional | | +| **activeAlertCount** | `integer` | optional | | +| **recommendations** | `object[]` | optional | | +| **previousPeriodCost** | `number` | optional | | +| **costChange** | `number` | optional | Change vs previous period | +| **costChangePercentage** | `number` | optional | | +| **forecastedCost** | `number` | optional | | +| **forecastedBudgetStatus** | `Enum<'under' \| 'at' \| 'over'>` | optional | | +| **format** | `Enum<'summary' \| 'detailed' \| 'executive'>` | optional | | +| **currency** | `string` | optional | | + diff --git a/content/docs/references/ai/cost/BillingPeriod.mdx b/content/docs/references/ai/cost/BillingPeriod.mdx deleted file mode 100644 index 79edfd7ac..000000000 --- a/content/docs/references/ai/cost/BillingPeriod.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: BillingPeriod -description: BillingPeriod Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Allowed Values - -* `hourly` -* `daily` -* `weekly` -* `monthly` -* `quarterly` -* `yearly` -* `custom` - -## TypeScript Usage - -```typescript -import { BillingPeriod } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: BillingPeriod = 'hourly'; -``` - diff --git a/content/docs/references/ai/cost/BudgetLimit.mdx b/content/docs/references/ai/cost/BudgetLimit.mdx deleted file mode 100644 index 4b5cee994..000000000 --- a/content/docs/references/ai/cost/BudgetLimit.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: BudgetLimit -description: BudgetLimit Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'global' \| 'user' \| 'agent' \| 'object' \| 'project' \| 'department'>` | ✅ | | -| **scope** | `string` | optional | Scope identifier (userId, agentId, etc.) | -| **maxCost** | `number` | ✅ | Maximum cost limit | -| **currency** | `string` | optional | | -| **period** | `Enum<'hourly' \| 'daily' \| 'weekly' \| 'monthly' \| 'quarterly' \| 'yearly' \| 'custom'>` | ✅ | | -| **customPeriodDays** | `integer` | optional | Custom period in days | -| **softLimit** | `number` | optional | Soft limit for warnings | -| **warnThresholds** | `number[]` | optional | Warning thresholds (e.g., [0.5, 0.8, 0.95]) | -| **enforced** | `boolean` | optional | Block requests when exceeded | -| **gracePeriodSeconds** | `integer` | optional | Grace period after limit exceeded | -| **allowRollover** | `boolean` | optional | Allow unused budget to rollover | -| **maxRolloverPercentage** | `number` | optional | Max rollover as % of limit | -| **name** | `string` | optional | Budget name | -| **description** | `string` | optional | | -| **active** | `boolean` | optional | | -| **tags** | `string[]` | optional | | - -## TypeScript Usage - -```typescript -import { BudgetLimitSchema } from '@objectstack/spec/ai'; -import type { BudgetLimit } from '@objectstack/spec/ai'; - -// Validate data -const result = BudgetLimitSchema.parse(data); - -// Type-safe usage -const myBudgetLimit: BudgetLimit = { - type: 'global', - maxCost: 0, - period: 'hourly' -}; -``` - diff --git a/content/docs/references/ai/cost/BudgetStatus.mdx b/content/docs/references/ai/cost/BudgetStatus.mdx deleted file mode 100644 index a164bd95c..000000000 --- a/content/docs/references/ai/cost/BudgetStatus.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: BudgetStatus -description: BudgetStatus Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **budgetId** | `string` | ✅ | | -| **type** | `Enum<'global' \| 'user' \| 'agent' \| 'object' \| 'project' \| 'department'>` | ✅ | | -| **scope** | `string` | optional | | -| **periodStart** | `string` | ✅ | ISO 8601 timestamp | -| **periodEnd** | `string` | ✅ | ISO 8601 timestamp | -| **currentCost** | `number` | optional | | -| **maxCost** | `number` | ✅ | | -| **currency** | `string` | optional | | -| **percentageUsed** | `number` | ✅ | Usage as percentage (can exceed 1.0 if over budget) | -| **remainingCost** | `number` | ✅ | Remaining budget (can be negative if exceeded) | -| **isExceeded** | `boolean` | optional | | -| **isWarning** | `boolean` | optional | | -| **projectedCost** | `number` | optional | Projected cost for period | -| **projectedOverage** | `number` | optional | Projected overage | -| **lastUpdated** | `string` | ✅ | ISO 8601 timestamp | - -## TypeScript Usage - -```typescript -import { BudgetStatusSchema } from '@objectstack/spec/ai'; -import type { BudgetStatus } from '@objectstack/spec/ai'; - -// Validate data -const result = BudgetStatusSchema.parse(data); - -// Type-safe usage -const myBudgetStatus: BudgetStatus = { - budgetId: 'example', - type: 'global', - periodStart: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/BudgetType.mdx b/content/docs/references/ai/cost/BudgetType.mdx deleted file mode 100644 index cef8cc7e6..000000000 --- a/content/docs/references/ai/cost/BudgetType.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: BudgetType -description: BudgetType Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Allowed Values - -* `global` -* `user` -* `agent` -* `object` -* `project` -* `department` - -## TypeScript Usage - -```typescript -import { BudgetType } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: BudgetType = 'global'; -``` - diff --git a/content/docs/references/ai/cost/CostAlert.mdx b/content/docs/references/ai/cost/CostAlert.mdx deleted file mode 100644 index 731ad848f..000000000 --- a/content/docs/references/ai/cost/CostAlert.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CostAlert -description: CostAlert Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | | -| **timestamp** | `string` | ✅ | ISO 8601 timestamp | -| **type** | `Enum<'threshold_warning' \| 'threshold_critical' \| 'limit_exceeded' \| 'anomaly_detected' \| 'projection_exceeded'>` | ✅ | | -| **severity** | `Enum<'info' \| 'warning' \| 'critical'>` | ✅ | | -| **budgetId** | `string` | optional | | -| **budgetType** | `Enum<'global' \| 'user' \| 'agent' \| 'object' \| 'project' \| 'department'>` | optional | | -| **scope** | `string` | optional | | -| **message** | `string` | ✅ | Alert message | -| **currentCost** | `number` | ✅ | | -| **maxCost** | `number` | optional | | -| **threshold** | `number` | optional | | -| **currency** | `string` | optional | | -| **recommendations** | `string[]` | optional | | -| **acknowledged** | `boolean` | optional | | -| **acknowledgedBy** | `string` | optional | | -| **acknowledgedAt** | `string` | optional | | -| **resolved** | `boolean` | optional | | -| **metadata** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { CostAlertSchema } from '@objectstack/spec/ai'; -import type { CostAlert } from '@objectstack/spec/ai'; - -// Validate data -const result = CostAlertSchema.parse(data); - -// Type-safe usage -const myCostAlert: CostAlert = { - id: 'example', - timestamp: 'example', - type: 'threshold_warning', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/CostAlertType.mdx b/content/docs/references/ai/cost/CostAlertType.mdx deleted file mode 100644 index f05486f6c..000000000 --- a/content/docs/references/ai/cost/CostAlertType.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: CostAlertType -description: CostAlertType Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Allowed Values - -* `threshold_warning` -* `threshold_critical` -* `limit_exceeded` -* `anomaly_detected` -* `projection_exceeded` - -## TypeScript Usage - -```typescript -import { CostAlertType } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: CostAlertType = 'threshold_warning'; -``` - diff --git a/content/docs/references/ai/cost/CostAnalytics.mdx b/content/docs/references/ai/cost/CostAnalytics.mdx deleted file mode 100644 index 496116f51..000000000 --- a/content/docs/references/ai/cost/CostAnalytics.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: CostAnalytics -description: CostAnalytics Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **periodStart** | `string` | ✅ | ISO 8601 timestamp | -| **periodEnd** | `string` | ✅ | ISO 8601 timestamp | -| **totalCost** | `number` | ✅ | | -| **totalRequests** | `integer` | ✅ | | -| **totalTokens** | `integer` | optional | | -| **currency** | `string` | optional | | -| **averageCostPerRequest** | `number` | ✅ | | -| **averageCostPerToken** | `number` | optional | | -| **averageRequestsPerDay** | `number` | ✅ | | -| **costTrend** | `Enum<'increasing' \| 'decreasing' \| 'stable'>` | optional | | -| **trendPercentage** | `number` | optional | % change vs previous period | -| **byModel** | `object[]` | optional | | -| **byProvider** | `object[]` | optional | | -| **byUser** | `object[]` | optional | | -| **byAgent** | `object[]` | optional | | -| **byOperation** | `object[]` | optional | | -| **byDate** | `object[]` | optional | | -| **topModels** | `object[]` | optional | | -| **topUsers** | `object[]` | optional | | -| **topAgents** | `object[]` | optional | | -| **tokensPerDollar** | `number` | optional | | -| **requestsPerDollar** | `number` | optional | | - -## TypeScript Usage - -```typescript -import { CostAnalyticsSchema } from '@objectstack/spec/ai'; -import type { CostAnalytics } from '@objectstack/spec/ai'; - -// Validate data -const result = CostAnalyticsSchema.parse(data); - -// Type-safe usage -const myCostAnalytics: CostAnalytics = { - periodStart: 'example', - periodEnd: 'example', - totalCost: 0, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/CostBreakdownDimension.mdx b/content/docs/references/ai/cost/CostBreakdownDimension.mdx deleted file mode 100644 index 279ee1ec5..000000000 --- a/content/docs/references/ai/cost/CostBreakdownDimension.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: CostBreakdownDimension -description: CostBreakdownDimension Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Allowed Values - -* `model` -* `provider` -* `user` -* `agent` -* `object` -* `operation` -* `date` -* `hour` -* `tag` - -## TypeScript Usage - -```typescript -import { CostBreakdownDimension } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: CostBreakdownDimension = 'model'; -``` - diff --git a/content/docs/references/ai/cost/CostBreakdownEntry.mdx b/content/docs/references/ai/cost/CostBreakdownEntry.mdx deleted file mode 100644 index 66eeae0f1..000000000 --- a/content/docs/references/ai/cost/CostBreakdownEntry.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CostBreakdownEntry -description: CostBreakdownEntry Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **dimension** | `Enum<'model' \| 'provider' \| 'user' \| 'agent' \| 'object' \| 'operation' \| 'date' \| 'hour' \| 'tag'>` | ✅ | | -| **value** | `string` | ✅ | Dimension value (e.g., model ID, user ID) | -| **totalCost** | `number` | ✅ | | -| **requestCount** | `integer` | ✅ | | -| **totalTokens** | `integer` | optional | | -| **percentageOfTotal** | `number` | ✅ | | -| **periodStart** | `string` | optional | | -| **periodEnd** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { CostBreakdownEntrySchema } from '@objectstack/spec/ai'; -import type { CostBreakdownEntry } from '@objectstack/spec/ai'; - -// Validate data -const result = CostBreakdownEntrySchema.parse(data); - -// Type-safe usage -const myCostBreakdownEntry: CostBreakdownEntry = { - dimension: 'model', - value: 'example', - totalCost: 0, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/CostEntry.mdx b/content/docs/references/ai/cost/CostEntry.mdx deleted file mode 100644 index 952087b64..000000000 --- a/content/docs/references/ai/cost/CostEntry.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CostEntry -description: CostEntry Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique cost entry ID | -| **timestamp** | `string` | ✅ | ISO 8601 timestamp | -| **modelId** | `string` | ✅ | AI model used | -| **provider** | `string` | ✅ | AI provider (e.g., "openai", "anthropic") | -| **operation** | `string` | ✅ | Operation type (e.g., "chat_completion", "embedding") | -| **promptTokens** | `integer` | optional | | -| **completionTokens** | `integer` | optional | | -| **totalTokens** | `integer` | optional | | -| **requestCount** | `integer` | optional | | -| **promptCost** | `number` | optional | Cost of prompt tokens | -| **completionCost** | `number` | optional | Cost of completion tokens | -| **totalCost** | `number` | ✅ | Total cost in base currency | -| **currency** | `string` | optional | | -| **sessionId** | `string` | optional | Conversation session ID | -| **userId** | `string` | optional | User who triggered the request | -| **agentId** | `string` | optional | AI agent ID | -| **object** | `string` | optional | Related object (e.g., "case", "project") | -| **recordId** | `string` | optional | Related record ID | -| **tags** | `string[]` | optional | | -| **metadata** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { CostEntrySchema } from '@objectstack/spec/ai'; -import type { CostEntry } from '@objectstack/spec/ai'; - -// Validate data -const result = CostEntrySchema.parse(data); - -// Type-safe usage -const myCostEntry: CostEntry = { - id: 'example', - timestamp: 'example', - modelId: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/CostMetricType.mdx b/content/docs/references/ai/cost/CostMetricType.mdx deleted file mode 100644 index 91f0baf81..000000000 --- a/content/docs/references/ai/cost/CostMetricType.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: CostMetricType -description: CostMetricType Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Allowed Values - -* `token` -* `request` -* `character` -* `second` -* `image` -* `embedding` - -## TypeScript Usage - -```typescript -import { CostMetricType } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: CostMetricType = 'token'; -``` - diff --git a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx b/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx deleted file mode 100644 index a5d1156f9..000000000 --- a/content/docs/references/ai/cost/CostOptimizationRecommendation.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CostOptimizationRecommendation -description: CostOptimizationRecommendation Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | | -| **type** | `Enum<'switch_model' \| 'reduce_tokens' \| 'batch_requests' \| 'cache_results' \| 'adjust_parameters' \| 'limit_usage'>` | ✅ | | -| **title** | `string` | ✅ | | -| **description** | `string` | ✅ | | -| **estimatedSavings** | `number` | optional | | -| **savingsPercentage** | `number` | optional | | -| **priority** | `Enum<'low' \| 'medium' \| 'high'>` | ✅ | | -| **effort** | `Enum<'low' \| 'medium' \| 'high'>` | ✅ | | -| **actionable** | `boolean` | optional | | -| **actionSteps** | `string[]` | optional | | -| **targetModel** | `string` | optional | | -| **alternativeModel** | `string` | optional | | -| **affectedUsers** | `string[]` | optional | | -| **status** | `Enum<'pending' \| 'accepted' \| 'rejected' \| 'implemented'>` | optional | | -| **implementedAt** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { CostOptimizationRecommendationSchema } from '@objectstack/spec/ai'; -import type { CostOptimizationRecommendation } from '@objectstack/spec/ai'; - -// Validate data -const result = CostOptimizationRecommendationSchema.parse(data); - -// Type-safe usage -const myCostOptimizationRecommendation: CostOptimizationRecommendation = { - id: 'example', - type: 'switch_model', - title: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/CostQueryFilters.mdx b/content/docs/references/ai/cost/CostQueryFilters.mdx deleted file mode 100644 index 248a489c4..000000000 --- a/content/docs/references/ai/cost/CostQueryFilters.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: CostQueryFilters -description: CostQueryFilters Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **startDate** | `string` | optional | ISO 8601 timestamp | -| **endDate** | `string` | optional | ISO 8601 timestamp | -| **modelIds** | `string[]` | optional | | -| **providers** | `string[]` | optional | | -| **userIds** | `string[]` | optional | | -| **agentIds** | `string[]` | optional | | -| **operations** | `string[]` | optional | | -| **sessionIds** | `string[]` | optional | | -| **minCost** | `number` | optional | | -| **maxCost** | `number` | optional | | -| **tags** | `string[]` | optional | | -| **groupBy** | `Enum<'model' \| 'provider' \| 'user' \| 'agent' \| 'object' \| 'operation' \| 'date' \| 'hour' \| 'tag'>[]` | optional | | -| **orderBy** | `Enum<'timestamp' \| 'cost' \| 'tokens'>` | optional | | -| **orderDirection** | `Enum<'asc' \| 'desc'>` | optional | | -| **limit** | `integer` | optional | | -| **offset** | `integer` | optional | | - -## TypeScript Usage - -```typescript -import { CostQueryFiltersSchema } from '@objectstack/spec/ai'; -import type { CostQueryFilters } from '@objectstack/spec/ai'; - -// Validate data -const result = CostQueryFiltersSchema.parse(data); - -// Type-safe usage -const myCostQueryFilters: CostQueryFilters = { -}; -``` - diff --git a/content/docs/references/ai/cost/CostReport.mdx b/content/docs/references/ai/cost/CostReport.mdx deleted file mode 100644 index 984a63f5c..000000000 --- a/content/docs/references/ai/cost/CostReport.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CostReport -description: CostReport Schema Reference -category: ai -zodFile: cost ---- - - - -**Source:** `packages/spec/src/ai/cost.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | | -| **name** | `string` | ✅ | | -| **generatedAt** | `string` | ✅ | ISO 8601 timestamp | -| **periodStart** | `string` | ✅ | ISO 8601 timestamp | -| **periodEnd** | `string` | ✅ | ISO 8601 timestamp | -| **period** | `Enum<'hourly' \| 'daily' \| 'weekly' \| 'monthly' \| 'quarterly' \| 'yearly' \| 'custom'>` | ✅ | | -| **analytics** | `object` | ✅ | | -| **budgets** | `object[]` | optional | | -| **alerts** | `object[]` | optional | | -| **activeAlertCount** | `integer` | optional | | -| **recommendations** | `object[]` | optional | | -| **previousPeriodCost** | `number` | optional | | -| **costChange** | `number` | optional | Change vs previous period | -| **costChangePercentage** | `number` | optional | | -| **forecastedCost** | `number` | optional | | -| **forecastedBudgetStatus** | `Enum<'under' \| 'at' \| 'over'>` | optional | | -| **format** | `Enum<'summary' \| 'detailed' \| 'executive'>` | optional | | -| **currency** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { CostReportSchema } from '@objectstack/spec/ai'; -import type { CostReport } from '@objectstack/spec/ai'; - -// Validate data -const result = CostReportSchema.parse(data); - -// Type-safe usage -const myCostReport: CostReport = { - id: 'example', - name: 'name', - generatedAt: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/cost/meta.json b/content/docs/references/ai/cost/meta.json deleted file mode 100644 index e2969ca4b..000000000 --- a/content/docs/references/ai/cost/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Cost" -} \ No newline at end of file diff --git a/content/docs/references/ai/index.mdx b/content/docs/references/ai/index.mdx index 2d8212b89..fcdea1448 100644 --- a/content/docs/references/ai/index.mdx +++ b/content/docs/references/ai/index.mdx @@ -3,150 +3,20 @@ title: AI Protocol Overview description: Complete reference for all ai protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # AI Protocol This section contains all protocol schemas for the ai layer of ObjectStack. -## Agent - -Source: `packages/spec/src/ai/agent.zod.ts` - - - - - - - - -## Conversation - -Source: `packages/spec/src/ai/conversation.zod.ts` - - - - - - - - - - - - - - - - - - -## Cost - -Source: `packages/spec/src/ai/cost.zod.ts` - - - - - - - - - - - - - - - - - - -## Model Registry - -Source: `packages/spec/src/ai/model-registry.zod.ts` - - - - - - - - - - - - - - -## Nlq - -Source: `packages/spec/src/ai/nlq.zod.ts` - - - - - - - - - - - - - - - - - -## Orchestration - -Source: `packages/spec/src/ai/orchestration.zod.ts` - - - - - - - - - - - - - -## Predictive - -Source: `packages/spec/src/ai/predictive.zod.ts` - - - - - - - - - - - - - -## Rag Pipeline - -Source: `packages/spec/src/ai/rag-pipeline.zod.ts` - - - - - - - - - - - - - - + + + + + + + + diff --git a/content/docs/references/ai/model-registry.mdx b/content/docs/references/ai/model-registry.mdx new file mode 100644 index 000000000..15e1541e9 --- /dev/null +++ b/content/docs/references/ai/model-registry.mdx @@ -0,0 +1,190 @@ +--- +title: Model Registry +description: Model Registry protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Model Registry + + +**Source:** `packages/spec/src/ai/model-registry.zod.ts` + + +## TypeScript Usage + +```typescript +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 = ModelCapabilitySchema.parse(data); +``` + +--- + +## ModelCapability + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **textGeneration** | `boolean` | optional | Supports text generation | +| **textEmbedding** | `boolean` | optional | Supports text embedding | +| **imageGeneration** | `boolean` | optional | Supports image generation | +| **imageUnderstanding** | `boolean` | optional | Supports image understanding | +| **functionCalling** | `boolean` | optional | Supports function calling | +| **codeGeneration** | `boolean` | optional | Supports code generation | +| **reasoning** | `boolean` | optional | Supports advanced reasoning | + +--- + +## ModelConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique model identifier | +| **name** | `string` | ✅ | Model display name | +| **version** | `string` | ✅ | Model version (e.g., "gpt-4-turbo-2024-04-09") | +| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'google' \| 'cohere' \| 'huggingface' \| 'local' \| 'custom'>` | ✅ | | +| **capabilities** | `object` | ✅ | | +| **limits** | `object` | ✅ | | +| **pricing** | `object` | optional | | +| **endpoint** | `string` | optional | Custom API endpoint | +| **apiKey** | `string` | optional | API key or reference to secret | +| **region** | `string` | optional | Deployment region (e.g., "us-east-1") | +| **description** | `string` | optional | | +| **tags** | `string[]` | optional | Tags for categorization | +| **deprecated** | `boolean` | optional | | +| **recommendedFor** | `string[]` | optional | Use case recommendations | + +--- + +## ModelLimits + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **maxTokens** | `integer` | ✅ | Maximum tokens per request | +| **contextWindow** | `integer` | ✅ | Context window size | +| **maxOutputTokens** | `integer` | optional | Maximum output tokens | +| **rateLimit** | `object` | optional | | + +--- + +## ModelPricing + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **currency** | `string` | optional | | +| **inputCostPer1kTokens** | `number` | optional | Cost per 1K input tokens | +| **outputCostPer1kTokens** | `number` | optional | Cost per 1K output tokens | +| **embeddingCostPer1kTokens** | `number` | optional | Cost per 1K embedding tokens | + +--- + +## ModelProvider + +### Allowed Values + +* `openai` +* `azure_openai` +* `anthropic` +* `google` +* `cohere` +* `huggingface` +* `local` +* `custom` + +--- + +## ModelRegistry + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Registry name | +| **models** | `Record` | ✅ | Model entries by ID | +| **promptTemplates** | `Record` | optional | Prompt templates by name | +| **defaultModel** | `string` | optional | Default model ID | +| **enableAutoFallback** | `boolean` | optional | Auto-fallback on errors | + +--- + +## ModelRegistryEntry + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **model** | `object` | ✅ | | +| **status** | `Enum<'active' \| 'deprecated' \| 'experimental' \| 'disabled'>` | optional | | +| **priority** | `integer` | optional | Priority for model selection | +| **fallbackModels** | `string[]` | optional | Fallback model IDs | +| **healthCheck** | `object` | optional | | + +--- + +## ModelSelectionCriteria + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **capabilities** | `string[]` | optional | Required capabilities | +| **maxCostPer1kTokens** | `number` | optional | Maximum acceptable cost | +| **minContextWindow** | `number` | optional | Minimum context window size | +| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'google' \| 'cohere' \| 'huggingface' \| 'local' \| 'custom'>` | optional | | +| **tags** | `string[]` | optional | | +| **excludeDeprecated** | `boolean` | optional | | + +--- + +## PromptTemplate + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique template identifier | +| **name** | `string` | ✅ | Template name (snake_case) | +| **label** | `string` | ✅ | Display name | +| **system** | `string` | optional | System prompt | +| **user** | `string` | ✅ | User prompt template with variables | +| **assistant** | `string` | optional | Assistant message prefix | +| **variables** | `object[]` | optional | Template variables | +| **modelId** | `string` | optional | Recommended model ID | +| **temperature** | `number` | optional | | +| **maxTokens** | `number` | optional | | +| **topP** | `number` | optional | | +| **frequencyPenalty** | `number` | optional | | +| **presencePenalty** | `number` | optional | | +| **stopSequences** | `string[]` | optional | | +| **version** | `string` | optional | | +| **description** | `string` | optional | | +| **category** | `string` | optional | Template category (e.g., "code_generation", "support") | +| **tags** | `string[]` | optional | | +| **examples** | `object[]` | optional | | + +--- + +## PromptVariable + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Variable name (e.g., "user_name", "context") | +| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'object' \| 'array'>` | optional | | +| **required** | `boolean` | optional | | +| **defaultValue** | `any` | optional | | +| **description** | `string` | optional | | +| **validation** | `object` | optional | | + diff --git a/content/docs/references/ai/model-registry/ModelCapability.mdx b/content/docs/references/ai/model-registry/ModelCapability.mdx deleted file mode 100644 index e5a65992c..000000000 --- a/content/docs/references/ai/model-registry/ModelCapability.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ModelCapability -description: ModelCapability Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **textGeneration** | `boolean` | optional | Supports text generation | -| **textEmbedding** | `boolean` | optional | Supports text embedding | -| **imageGeneration** | `boolean` | optional | Supports image generation | -| **imageUnderstanding** | `boolean` | optional | Supports image understanding | -| **functionCalling** | `boolean` | optional | Supports function calling | -| **codeGeneration** | `boolean` | optional | Supports code generation | -| **reasoning** | `boolean` | optional | Supports advanced reasoning | - -## TypeScript Usage - -```typescript -import { ModelCapabilitySchema } from '@objectstack/spec/ai'; -import type { ModelCapability } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelCapabilitySchema.parse(data); - -// Type-safe usage -const myModelCapability: ModelCapability = { -}; -``` - diff --git a/content/docs/references/ai/model-registry/ModelConfig.mdx b/content/docs/references/ai/model-registry/ModelConfig.mdx deleted file mode 100644 index 759c80fcc..000000000 --- a/content/docs/references/ai/model-registry/ModelConfig.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ModelConfig -description: ModelConfig Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique model identifier | -| **name** | `string` | ✅ | Model display name | -| **version** | `string` | ✅ | Model version (e.g., "gpt-4-turbo-2024-04-09") | -| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'google' \| 'cohere' \| 'huggingface' \| 'local' \| 'custom'>` | ✅ | | -| **capabilities** | `object` | ✅ | | -| **limits** | `object` | ✅ | | -| **pricing** | `object` | optional | | -| **endpoint** | `string` | optional | Custom API endpoint | -| **apiKey** | `string` | optional | API key or reference to secret | -| **region** | `string` | optional | Deployment region (e.g., "us-east-1") | -| **description** | `string` | optional | | -| **tags** | `string[]` | optional | Tags for categorization | -| **deprecated** | `boolean` | optional | | -| **recommendedFor** | `string[]` | optional | Use case recommendations | - -## TypeScript Usage - -```typescript -import { ModelConfigSchema } from '@objectstack/spec/ai'; -import type { ModelConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelConfigSchema.parse(data); - -// Type-safe usage -const myModelConfig: ModelConfig = { - id: 'example', - name: 'name', - version: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/model-registry/ModelLimits.mdx b/content/docs/references/ai/model-registry/ModelLimits.mdx deleted file mode 100644 index 98ac6c2c6..000000000 --- a/content/docs/references/ai/model-registry/ModelLimits.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ModelLimits -description: ModelLimits Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **maxTokens** | `integer` | ✅ | Maximum tokens per request | -| **contextWindow** | `integer` | ✅ | Context window size | -| **maxOutputTokens** | `integer` | optional | Maximum output tokens | -| **rateLimit** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { ModelLimitsSchema } from '@objectstack/spec/ai'; -import type { ModelLimits } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelLimitsSchema.parse(data); - -// Type-safe usage -const myModelLimits: ModelLimits = { - maxTokens: null, - contextWindow: null -}; -``` - diff --git a/content/docs/references/ai/model-registry/ModelPricing.mdx b/content/docs/references/ai/model-registry/ModelPricing.mdx deleted file mode 100644 index 2ce149c42..000000000 --- a/content/docs/references/ai/model-registry/ModelPricing.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ModelPricing -description: ModelPricing Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **currency** | `string` | optional | | -| **inputCostPer1kTokens** | `number` | optional | Cost per 1K input tokens | -| **outputCostPer1kTokens** | `number` | optional | Cost per 1K output tokens | -| **embeddingCostPer1kTokens** | `number` | optional | Cost per 1K embedding tokens | - -## TypeScript Usage - -```typescript -import { ModelPricingSchema } from '@objectstack/spec/ai'; -import type { ModelPricing } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelPricingSchema.parse(data); - -// Type-safe usage -const myModelPricing: ModelPricing = { -}; -``` - diff --git a/content/docs/references/ai/model-registry/ModelProvider.mdx b/content/docs/references/ai/model-registry/ModelProvider.mdx deleted file mode 100644 index 754b21236..000000000 --- a/content/docs/references/ai/model-registry/ModelProvider.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ModelProvider -description: ModelProvider Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Allowed Values - -* `openai` -* `azure_openai` -* `anthropic` -* `google` -* `cohere` -* `huggingface` -* `local` -* `custom` - -## TypeScript Usage - -```typescript -import { ModelProvider } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: ModelProvider = 'openai'; -``` - diff --git a/content/docs/references/ai/model-registry/ModelRegistry.mdx b/content/docs/references/ai/model-registry/ModelRegistry.mdx deleted file mode 100644 index d927741c8..000000000 --- a/content/docs/references/ai/model-registry/ModelRegistry.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ModelRegistry -description: ModelRegistry Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Registry name | -| **models** | `Record` | ✅ | Model entries by ID | -| **promptTemplates** | `Record` | optional | Prompt templates by name | -| **defaultModel** | `string` | optional | Default model ID | -| **enableAutoFallback** | `boolean` | optional | Auto-fallback on errors | - -## TypeScript Usage - -```typescript -import { ModelRegistrySchema } from '@objectstack/spec/ai'; -import type { ModelRegistry } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelRegistrySchema.parse(data); - -// Type-safe usage -const myModelRegistry: ModelRegistry = { - name: 'name', - models: {} -}; -``` - diff --git a/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx b/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx deleted file mode 100644 index a33563e0e..000000000 --- a/content/docs/references/ai/model-registry/ModelRegistryEntry.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ModelRegistryEntry -description: ModelRegistryEntry Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **model** | `object` | ✅ | | -| **status** | `Enum<'active' \| 'deprecated' \| 'experimental' \| 'disabled'>` | optional | | -| **priority** | `integer` | optional | Priority for model selection | -| **fallbackModels** | `string[]` | optional | Fallback model IDs | -| **healthCheck** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { ModelRegistryEntrySchema } from '@objectstack/spec/ai'; -import type { ModelRegistryEntry } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelRegistryEntrySchema.parse(data); - -// Type-safe usage -const myModelRegistryEntry: ModelRegistryEntry = { - model: {} -}; -``` - diff --git a/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx b/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx deleted file mode 100644 index 8d9352eeb..000000000 --- a/content/docs/references/ai/model-registry/ModelSelectionCriteria.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ModelSelectionCriteria -description: ModelSelectionCriteria Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **capabilities** | `string[]` | optional | Required capabilities | -| **maxCostPer1kTokens** | `number` | optional | Maximum acceptable cost | -| **minContextWindow** | `number` | optional | Minimum context window size | -| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'google' \| 'cohere' \| 'huggingface' \| 'local' \| 'custom'>` | optional | | -| **tags** | `string[]` | optional | | -| **excludeDeprecated** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { ModelSelectionCriteriaSchema } from '@objectstack/spec/ai'; -import type { ModelSelectionCriteria } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelSelectionCriteriaSchema.parse(data); - -// Type-safe usage -const myModelSelectionCriteria: ModelSelectionCriteria = { -}; -``` - diff --git a/content/docs/references/ai/model-registry/PromptTemplate.mdx b/content/docs/references/ai/model-registry/PromptTemplate.mdx deleted file mode 100644 index b723a8d94..000000000 --- a/content/docs/references/ai/model-registry/PromptTemplate.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: PromptTemplate -description: PromptTemplate Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique template identifier | -| **name** | `string` | ✅ | Template name (snake_case) | -| **label** | `string` | ✅ | Display name | -| **system** | `string` | optional | System prompt | -| **user** | `string` | ✅ | User prompt template with variables | -| **assistant** | `string` | optional | Assistant message prefix | -| **variables** | `object[]` | optional | Template variables | -| **modelId** | `string` | optional | Recommended model ID | -| **temperature** | `number` | optional | | -| **maxTokens** | `number` | optional | | -| **topP** | `number` | optional | | -| **frequencyPenalty** | `number` | optional | | -| **presencePenalty** | `number` | optional | | -| **stopSequences** | `string[]` | optional | | -| **version** | `string` | optional | | -| **description** | `string` | optional | | -| **category** | `string` | optional | Template category (e.g., "code_generation", "support") | -| **tags** | `string[]` | optional | | -| **examples** | `object[]` | optional | | - -## TypeScript Usage - -```typescript -import { PromptTemplateSchema } from '@objectstack/spec/ai'; -import type { PromptTemplate } from '@objectstack/spec/ai'; - -// Validate data -const result = PromptTemplateSchema.parse(data); - -// Type-safe usage -const myPromptTemplate: PromptTemplate = { - id: 'example', - name: 'name', - label: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/model-registry/PromptVariable.mdx b/content/docs/references/ai/model-registry/PromptVariable.mdx deleted file mode 100644 index c281ed0a1..000000000 --- a/content/docs/references/ai/model-registry/PromptVariable.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PromptVariable -description: PromptVariable Schema Reference -category: ai -zodFile: model-registry ---- - - - -**Source:** `packages/spec/src/ai/model-registry.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Variable name (e.g., "user_name", "context") | -| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'object' \| 'array'>` | optional | | -| **required** | `boolean` | optional | | -| **defaultValue** | `any` | optional | | -| **description** | `string` | optional | | -| **validation** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { PromptVariableSchema } from '@objectstack/spec/ai'; -import type { PromptVariable } from '@objectstack/spec/ai'; - -// Validate data -const result = PromptVariableSchema.parse(data); - -// Type-safe usage -const myPromptVariable: PromptVariable = { - name: 'name' -}; -``` - diff --git a/content/docs/references/ai/model-registry/meta.json b/content/docs/references/ai/model-registry/meta.json deleted file mode 100644 index 189c7565d..000000000 --- a/content/docs/references/ai/model-registry/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Model Registry" -} \ No newline at end of file diff --git a/content/docs/references/ai/nlq.mdx b/content/docs/references/ai/nlq.mdx new file mode 100644 index 000000000..079f071a3 --- /dev/null +++ b/content/docs/references/ai/nlq.mdx @@ -0,0 +1,242 @@ +--- +title: Nlq +description: Nlq protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Nlq + + +**Source:** `packages/spec/src/ai/nlq.zod.ts` + + +## TypeScript Usage + +```typescript +import { EntitySchema, FieldSynonymConfigSchema, NLQAnalyticsSchema, NLQFieldMappingSchema, NLQModelConfigSchema, NLQParseResultSchema, NLQRequestSchema, NLQResponseSchema, NLQTrainingExampleSchema, QueryContextSchema, QueryIntentSchema, QueryTemplateSchema, TimeframeSchema } from '@objectstack/spec/ai'; +import type { Entity, FieldSynonymConfig, NLQAnalytics, NLQFieldMapping, NLQModelConfig, NLQParseResult, NLQRequest, NLQResponse, NLQTrainingExample, QueryContext, QueryIntent, QueryTemplate, Timeframe } from '@objectstack/spec/ai'; + +// Validate data +const result = EntitySchema.parse(data); +``` + +--- + +## Entity + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'object' \| 'field' \| 'value' \| 'operator' \| 'function' \| 'timeframe'>` | ✅ | | +| **text** | `string` | ✅ | Original text from query | +| **value** | `any` | optional | Normalized value | +| **confidence** | `number` | ✅ | Confidence score | +| **span** | `any[]` | optional | Character span in query | + +--- + +## FieldSynonymConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **object** | `string` | ✅ | Object name | +| **field** | `string` | ✅ | Field name | +| **synonyms** | `string[]` | ✅ | Natural language synonyms | +| **examples** | `string[]` | optional | Example queries using synonyms | + +--- + +## NLQAnalytics + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **totalQueries** | `integer` | ✅ | | +| **successfulQueries** | `integer` | ✅ | | +| **failedQueries** | `integer` | ✅ | | +| **averageConfidence** | `number` | ✅ | | +| **intentDistribution** | `Record` | ✅ | Count by intent type | +| **topQueries** | `object[]` | ✅ | | +| **averageParseTime** | `number` | ✅ | Average parse time in milliseconds | +| **averageExecutionTime** | `number` | optional | | +| **lowConfidenceQueries** | `object[]` | ✅ | | +| **startDate** | `string` | ✅ | ISO timestamp | +| **endDate** | `string` | ✅ | ISO timestamp | + +--- + +## NLQFieldMapping + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **naturalLanguage** | `string` | ✅ | NL field name (e.g., "customer name") | +| **objectField** | `string` | ✅ | Actual field name (e.g., "account.name") | +| **object** | `string` | ✅ | Object name | +| **field** | `string` | ✅ | Field name | +| **confidence** | `number` | ✅ | | + +--- + +## NLQModelConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **modelId** | `string` | ✅ | Model from registry | +| **systemPrompt** | `string` | optional | System prompt override | +| **includeSchema** | `boolean` | optional | Include object schema in prompt | +| **includeExamples** | `boolean` | optional | Include examples in prompt | +| **enableIntentDetection** | `boolean` | optional | | +| **intentThreshold** | `number` | optional | | +| **enableEntityRecognition** | `boolean` | optional | | +| **entityRecognitionModel** | `string` | optional | | +| **enableFuzzyMatching** | `boolean` | optional | Fuzzy match field names | +| **fuzzyMatchThreshold** | `number` | optional | | +| **enableTimeframeDetection** | `boolean` | optional | | +| **defaultTimeframe** | `string` | optional | Default timeframe if not specified | +| **enableCaching** | `boolean` | optional | | +| **cacheTTL** | `integer` | optional | Cache TTL in seconds | + +--- + +## NLQParseResult + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **originalQuery** | `string` | ✅ | | +| **intent** | `Enum<'select' \| 'aggregate' \| 'filter' \| 'sort' \| 'compare' \| 'trend' \| 'insight' \| 'create' \| 'update' \| 'delete'>` | ✅ | | +| **intentConfidence** | `number` | ✅ | | +| **entities** | `object[]` | ✅ | | +| **targetObject** | `string` | optional | Primary object to query | +| **fields** | `object[]` | optional | | +| **timeframe** | `object` | optional | | +| **ast** | `any` | optional | Generated ObjectQL AST | +| **confidence** | `number` | ✅ | Overall confidence | +| **ambiguities** | `object[]` | optional | Detected ambiguities requiring clarification | +| **alternatives** | `object[]` | optional | | + +--- + +## NLQRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **query** | `string` | ✅ | Natural language query | +| **context** | `object` | optional | | +| **includeAlternatives** | `boolean` | optional | Include alternative interpretations | +| **maxAlternatives** | `integer` | optional | | +| **minConfidence** | `number` | optional | Minimum confidence threshold | +| **executeQuery** | `boolean` | optional | Execute query and return results | +| **maxResults** | `integer` | optional | Maximum results to return | + +--- + +## NLQResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **parseResult** | `object` | ✅ | | +| **results** | `Record[]` | optional | Query results | +| **totalCount** | `integer` | optional | | +| **executionTime** | `number` | optional | Execution time in milliseconds | +| **needsClarification** | `boolean` | ✅ | Whether query needs clarification | +| **suggestions** | `string[]` | optional | Query refinement suggestions | + +--- + +## NLQTrainingExample + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **query** | `string` | ✅ | Natural language query | +| **context** | `object` | optional | | +| **expectedIntent** | `Enum<'select' \| 'aggregate' \| 'filter' \| 'sort' \| 'compare' \| 'trend' \| 'insight' \| 'create' \| 'update' \| 'delete'>` | ✅ | | +| **expectedObject** | `string` | optional | | +| **expectedAST** | `any` | optional | Expected ObjectQL AST | +| **category** | `string` | optional | Example category | +| **tags** | `string[]` | optional | | +| **notes** | `string` | optional | | + +--- + +## QueryContext + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **userId** | `string` | optional | | +| **userRole** | `string` | optional | | +| **currentObject** | `string` | optional | Current object being viewed | +| **currentRecordId** | `string` | optional | Current record ID | +| **conversationHistory** | `object[]` | optional | | +| **defaultLimit** | `integer` | optional | | +| **timezone** | `string` | optional | | +| **locale** | `string` | optional | | + +--- + +## QueryIntent + +### Allowed Values + +* `select` +* `aggregate` +* `filter` +* `sort` +* `compare` +* `trend` +* `insight` +* `create` +* `update` +* `delete` + +--- + +## QueryTemplate + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | | +| **name** | `string` | ✅ | Template name (snake_case) | +| **label** | `string` | ✅ | | +| **pattern** | `string` | ✅ | Query pattern with placeholders | +| **variables** | `object[]` | ✅ | | +| **astTemplate** | `any` | optional | AST template with variable placeholders | +| **category** | `string` | optional | | +| **examples** | `string[]` | optional | | +| **tags** | `string[]` | optional | | + +--- + +## Timeframe + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'absolute' \| 'relative'>` | ✅ | | +| **start** | `string` | optional | Start date (ISO format) | +| **end** | `string` | optional | End date (ISO format) | +| **relative** | `object` | optional | | +| **text** | `string` | ✅ | Original timeframe text | + diff --git a/content/docs/references/ai/nlq/Entity.mdx b/content/docs/references/ai/nlq/Entity.mdx deleted file mode 100644 index f4ff57734..000000000 --- a/content/docs/references/ai/nlq/Entity.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Entity -description: Entity Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'object' \| 'field' \| 'value' \| 'operator' \| 'function' \| 'timeframe'>` | ✅ | | -| **text** | `string` | ✅ | Original text from query | -| **value** | `any` | optional | Normalized value | -| **confidence** | `number` | ✅ | Confidence score | -| **span** | `any[]` | optional | Character span in query | - -## TypeScript Usage - -```typescript -import { EntitySchema } from '@objectstack/spec/ai'; -import type { Entity } from '@objectstack/spec/ai'; - -// Validate data -const result = EntitySchema.parse(data); - -// Type-safe usage -const myEntity: Entity = { - type: 'object', - text: 'example', - confidence: 0 -}; -``` - diff --git a/content/docs/references/ai/nlq/FieldSynonymConfig.mdx b/content/docs/references/ai/nlq/FieldSynonymConfig.mdx deleted file mode 100644 index d5ac00d58..000000000 --- a/content/docs/references/ai/nlq/FieldSynonymConfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: FieldSynonymConfig -description: FieldSynonymConfig Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **object** | `string` | ✅ | Object name | -| **field** | `string` | ✅ | Field name | -| **synonyms** | `string[]` | ✅ | Natural language synonyms | -| **examples** | `string[]` | optional | Example queries using synonyms | - -## TypeScript Usage - -```typescript -import { FieldSynonymConfigSchema } from '@objectstack/spec/ai'; -import type { FieldSynonymConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = FieldSynonymConfigSchema.parse(data); - -// Type-safe usage -const myFieldSynonymConfig: FieldSynonymConfig = { - object: 'example', - field: 'example', - synonyms: [] -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQAnalytics.mdx b/content/docs/references/ai/nlq/NLQAnalytics.mdx deleted file mode 100644 index d1c75443b..000000000 --- a/content/docs/references/ai/nlq/NLQAnalytics.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: NLQAnalytics -description: NLQAnalytics Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **totalQueries** | `integer` | ✅ | | -| **successfulQueries** | `integer` | ✅ | | -| **failedQueries** | `integer` | ✅ | | -| **averageConfidence** | `number` | ✅ | | -| **intentDistribution** | `Record` | ✅ | Count by intent type | -| **topQueries** | `object[]` | ✅ | | -| **averageParseTime** | `number` | ✅ | Average parse time in milliseconds | -| **averageExecutionTime** | `number` | optional | | -| **lowConfidenceQueries** | `object[]` | ✅ | | -| **startDate** | `string` | ✅ | ISO timestamp | -| **endDate** | `string` | ✅ | ISO timestamp | - -## TypeScript Usage - -```typescript -import { NLQAnalyticsSchema } from '@objectstack/spec/ai'; -import type { NLQAnalytics } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQAnalyticsSchema.parse(data); - -// Type-safe usage -const myNLQAnalytics: NLQAnalytics = { - totalQueries: null, - successfulQueries: null, - failedQueries: null, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQFieldMapping.mdx b/content/docs/references/ai/nlq/NLQFieldMapping.mdx deleted file mode 100644 index 21433ce35..000000000 --- a/content/docs/references/ai/nlq/NLQFieldMapping.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: NLQFieldMapping -description: NLQFieldMapping Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **naturalLanguage** | `string` | ✅ | NL field name (e.g., "customer name") | -| **objectField** | `string` | ✅ | Actual field name (e.g., "account.name") | -| **object** | `string` | ✅ | Object name | -| **field** | `string` | ✅ | Field name | -| **confidence** | `number` | ✅ | | - -## TypeScript Usage - -```typescript -import { NLQFieldMappingSchema } from '@objectstack/spec/ai'; -import type { NLQFieldMapping } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQFieldMappingSchema.parse(data); - -// Type-safe usage -const myNLQFieldMapping: NLQFieldMapping = { - naturalLanguage: 'example', - objectField: 'example', - object: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQModelConfig.mdx b/content/docs/references/ai/nlq/NLQModelConfig.mdx deleted file mode 100644 index e041a9c19..000000000 --- a/content/docs/references/ai/nlq/NLQModelConfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: NLQModelConfig -description: NLQModelConfig Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **modelId** | `string` | ✅ | Model from registry | -| **systemPrompt** | `string` | optional | System prompt override | -| **includeSchema** | `boolean` | optional | Include object schema in prompt | -| **includeExamples** | `boolean` | optional | Include examples in prompt | -| **enableIntentDetection** | `boolean` | optional | | -| **intentThreshold** | `number` | optional | | -| **enableEntityRecognition** | `boolean` | optional | | -| **entityRecognitionModel** | `string` | optional | | -| **enableFuzzyMatching** | `boolean` | optional | Fuzzy match field names | -| **fuzzyMatchThreshold** | `number` | optional | | -| **enableTimeframeDetection** | `boolean` | optional | | -| **defaultTimeframe** | `string` | optional | Default timeframe if not specified | -| **enableCaching** | `boolean` | optional | | -| **cacheTTL** | `integer` | optional | Cache TTL in seconds | - -## TypeScript Usage - -```typescript -import { NLQModelConfigSchema } from '@objectstack/spec/ai'; -import type { NLQModelConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQModelConfigSchema.parse(data); - -// Type-safe usage -const myNLQModelConfig: NLQModelConfig = { - modelId: 'example' -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQParseResult.mdx b/content/docs/references/ai/nlq/NLQParseResult.mdx deleted file mode 100644 index 28f8ddef6..000000000 --- a/content/docs/references/ai/nlq/NLQParseResult.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: NLQParseResult -description: NLQParseResult Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **originalQuery** | `string` | ✅ | | -| **intent** | `Enum<'select' \| 'aggregate' \| 'filter' \| 'sort' \| 'compare' \| 'trend' \| 'insight' \| 'create' \| 'update' \| 'delete'>` | ✅ | | -| **intentConfidence** | `number` | ✅ | | -| **entities** | `object[]` | ✅ | | -| **targetObject** | `string` | optional | Primary object to query | -| **fields** | `object[]` | optional | | -| **timeframe** | `object` | optional | | -| **ast** | `any` | optional | Generated ObjectQL AST | -| **confidence** | `number` | ✅ | Overall confidence | -| **ambiguities** | `object[]` | optional | Detected ambiguities requiring clarification | -| **alternatives** | `object[]` | optional | | - -## TypeScript Usage - -```typescript -import { NLQParseResultSchema } from '@objectstack/spec/ai'; -import type { NLQParseResult } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQParseResultSchema.parse(data); - -// Type-safe usage -const myNLQParseResult: NLQParseResult = { - originalQuery: 'example', - intent: 'select', - intentConfidence: 0, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQRequest.mdx b/content/docs/references/ai/nlq/NLQRequest.mdx deleted file mode 100644 index bb7f4d97f..000000000 --- a/content/docs/references/ai/nlq/NLQRequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: NLQRequest -description: NLQRequest Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **query** | `string` | ✅ | Natural language query | -| **context** | `object` | optional | | -| **includeAlternatives** | `boolean` | optional | Include alternative interpretations | -| **maxAlternatives** | `integer` | optional | | -| **minConfidence** | `number` | optional | Minimum confidence threshold | -| **executeQuery** | `boolean` | optional | Execute query and return results | -| **maxResults** | `integer` | optional | Maximum results to return | - -## TypeScript Usage - -```typescript -import { NLQRequestSchema } from '@objectstack/spec/ai'; -import type { NLQRequest } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQRequestSchema.parse(data); - -// Type-safe usage -const myNLQRequest: NLQRequest = { - query: 'example' -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQResponse.mdx b/content/docs/references/ai/nlq/NLQResponse.mdx deleted file mode 100644 index 3997880fe..000000000 --- a/content/docs/references/ai/nlq/NLQResponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: NLQResponse -description: NLQResponse Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **parseResult** | `object` | ✅ | | -| **results** | `Record[]` | optional | Query results | -| **totalCount** | `integer` | optional | | -| **executionTime** | `number` | optional | Execution time in milliseconds | -| **needsClarification** | `boolean` | ✅ | Whether query needs clarification | -| **suggestions** | `string[]` | optional | Query refinement suggestions | - -## TypeScript Usage - -```typescript -import { NLQResponseSchema } from '@objectstack/spec/ai'; -import type { NLQResponse } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQResponseSchema.parse(data); - -// Type-safe usage -const myNLQResponse: NLQResponse = { - parseResult: {}, - needsClarification: false -}; -``` - diff --git a/content/docs/references/ai/nlq/NLQTrainingExample.mdx b/content/docs/references/ai/nlq/NLQTrainingExample.mdx deleted file mode 100644 index 83861737e..000000000 --- a/content/docs/references/ai/nlq/NLQTrainingExample.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: NLQTrainingExample -description: NLQTrainingExample Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **query** | `string` | ✅ | Natural language query | -| **context** | `object` | optional | | -| **expectedIntent** | `Enum<'select' \| 'aggregate' \| 'filter' \| 'sort' \| 'compare' \| 'trend' \| 'insight' \| 'create' \| 'update' \| 'delete'>` | ✅ | | -| **expectedObject** | `string` | optional | | -| **expectedAST** | `any` | optional | Expected ObjectQL AST | -| **category** | `string` | optional | Example category | -| **tags** | `string[]` | optional | | -| **notes** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { NLQTrainingExampleSchema } from '@objectstack/spec/ai'; -import type { NLQTrainingExample } from '@objectstack/spec/ai'; - -// Validate data -const result = NLQTrainingExampleSchema.parse(data); - -// Type-safe usage -const myNLQTrainingExample: NLQTrainingExample = { - query: 'example', - expectedIntent: 'select' -}; -``` - diff --git a/content/docs/references/ai/nlq/QueryContext.mdx b/content/docs/references/ai/nlq/QueryContext.mdx deleted file mode 100644 index 0216cdebb..000000000 --- a/content/docs/references/ai/nlq/QueryContext.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: QueryContext -description: QueryContext Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **userId** | `string` | optional | | -| **userRole** | `string` | optional | | -| **currentObject** | `string` | optional | Current object being viewed | -| **currentRecordId** | `string` | optional | Current record ID | -| **conversationHistory** | `object[]` | optional | | -| **defaultLimit** | `integer` | optional | | -| **timezone** | `string` | optional | | -| **locale** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { QueryContextSchema } from '@objectstack/spec/ai'; -import type { QueryContext } from '@objectstack/spec/ai'; - -// Validate data -const result = QueryContextSchema.parse(data); - -// Type-safe usage -const myQueryContext: QueryContext = { -}; -``` - diff --git a/content/docs/references/ai/nlq/QueryIntent.mdx b/content/docs/references/ai/nlq/QueryIntent.mdx deleted file mode 100644 index a99eb4724..000000000 --- a/content/docs/references/ai/nlq/QueryIntent.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: QueryIntent -description: QueryIntent Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Allowed Values - -* `select` -* `aggregate` -* `filter` -* `sort` -* `compare` -* `trend` -* `insight` -* `create` -* `update` -* `delete` - -## TypeScript Usage - -```typescript -import { QueryIntent } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: QueryIntent = 'select'; -``` - diff --git a/content/docs/references/ai/nlq/QueryTemplate.mdx b/content/docs/references/ai/nlq/QueryTemplate.mdx deleted file mode 100644 index 3ab57de06..000000000 --- a/content/docs/references/ai/nlq/QueryTemplate.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: QueryTemplate -description: QueryTemplate Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | | -| **name** | `string` | ✅ | Template name (snake_case) | -| **label** | `string` | ✅ | | -| **pattern** | `string` | ✅ | Query pattern with placeholders | -| **variables** | `object[]` | ✅ | | -| **astTemplate** | `any` | optional | AST template with variable placeholders | -| **category** | `string` | optional | | -| **examples** | `string[]` | optional | | -| **tags** | `string[]` | optional | | - -## TypeScript Usage - -```typescript -import { QueryTemplateSchema } from '@objectstack/spec/ai'; -import type { QueryTemplate } from '@objectstack/spec/ai'; - -// Validate data -const result = QueryTemplateSchema.parse(data); - -// Type-safe usage -const myQueryTemplate: QueryTemplate = { - id: 'example', - name: 'name', - label: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/nlq/Timeframe.mdx b/content/docs/references/ai/nlq/Timeframe.mdx deleted file mode 100644 index 0a24d4b74..000000000 --- a/content/docs/references/ai/nlq/Timeframe.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Timeframe -description: Timeframe Schema Reference -category: ai -zodFile: nlq ---- - - - -**Source:** `packages/spec/src/ai/nlq.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'absolute' \| 'relative'>` | ✅ | | -| **start** | `string` | optional | Start date (ISO format) | -| **end** | `string` | optional | End date (ISO format) | -| **relative** | `object` | optional | | -| **text** | `string` | ✅ | Original timeframe text | - -## TypeScript Usage - -```typescript -import { TimeframeSchema } from '@objectstack/spec/ai'; -import type { Timeframe } from '@objectstack/spec/ai'; - -// Validate data -const result = TimeframeSchema.parse(data); - -// Type-safe usage -const myTimeframe: Timeframe = { - type: 'absolute', - text: 'example' -}; -``` - diff --git a/content/docs/references/ai/nlq/meta.json b/content/docs/references/ai/nlq/meta.json deleted file mode 100644 index da4c491bf..000000000 --- a/content/docs/references/ai/nlq/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Nlq" -} \ No newline at end of file diff --git a/content/docs/references/ai/orchestration.mdx b/content/docs/references/ai/orchestration.mdx new file mode 100644 index 000000000..f520fcc4f --- /dev/null +++ b/content/docs/references/ai/orchestration.mdx @@ -0,0 +1,192 @@ +--- +title: Orchestration +description: Orchestration protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Orchestration + + +**Source:** `packages/spec/src/ai/orchestration.zod.ts` + + +## TypeScript Usage + +```typescript +import { AIOrchestrationSchema, AIOrchestrationExecutionResultSchema, AIOrchestrationTriggerSchema, AITaskSchema, AITaskTypeSchema, BatchAIOrchestrationExecutionSchema, PostProcessingActionSchema, WorkflowFieldConditionSchema, WorkflowScheduleSchema } from '@objectstack/spec/ai'; +import type { AIOrchestration, AIOrchestrationExecutionResult, AIOrchestrationTrigger, AITask, AITaskType, BatchAIOrchestrationExecution, PostProcessingAction, WorkflowFieldCondition, WorkflowSchedule } from '@objectstack/spec/ai'; + +// Validate data +const result = AIOrchestrationSchema.parse(data); +``` + +--- + +## AIOrchestration + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Orchestration unique identifier (snake_case) | +| **label** | `string` | ✅ | Display name | +| **description** | `string` | optional | | +| **objectName** | `string` | ✅ | Target object for this orchestration | +| **trigger** | `Enum<'record_created' \| 'record_updated' \| 'field_changed' \| 'scheduled' \| 'manual' \| 'webhook' \| 'batch'>` | ✅ | | +| **fieldConditions** | `object[]` | optional | Fields to monitor (for field_changed trigger) | +| **schedule** | `object` | optional | Schedule configuration (for scheduled trigger) | +| **webhookConfig** | `object` | optional | Webhook configuration (for webhook trigger) | +| **entryCriteria** | `string` | optional | Formula condition - workflow only runs if TRUE | +| **aiTasks** | `object[]` | ✅ | AI tasks to execute in sequence | +| **postActions** | `object[]` | optional | Actions after AI tasks complete | +| **executionMode** | `Enum<'sequential' \| 'parallel'>` | optional | How to execute multiple AI tasks | +| **stopOnError** | `boolean` | optional | Stop workflow if any task fails | +| **timeout** | `number` | optional | Maximum execution time in seconds | +| **priority** | `Enum<'low' \| 'normal' \| 'high' \| 'critical'>` | optional | | +| **enableLogging** | `boolean` | optional | | +| **enableMetrics** | `boolean` | optional | | +| **notifyOnFailure** | `string[]` | optional | User IDs to notify on failure | +| **active** | `boolean` | optional | | +| **version** | `string` | optional | | +| **tags** | `string[]` | optional | | +| **category** | `string` | optional | Workflow category (e.g., "support", "sales", "hr") | +| **owner** | `string` | optional | User ID of workflow owner | +| **createdAt** | `string` | optional | ISO timestamp | +| **updatedAt** | `string` | optional | ISO timestamp | + +--- + +## AIOrchestrationExecutionResult + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **workflowName** | `string` | ✅ | | +| **recordId** | `string` | ✅ | | +| **status** | `Enum<'success' \| 'partial_success' \| 'failed' \| 'skipped'>` | ✅ | | +| **executionTime** | `number` | ✅ | Execution time in milliseconds | +| **tasksExecuted** | `integer` | ✅ | Number of tasks executed | +| **tasksSucceeded** | `integer` | ✅ | Number of tasks succeeded | +| **tasksFailed** | `integer` | ✅ | Number of tasks failed | +| **taskResults** | `object[]` | optional | | +| **error** | `string` | optional | | +| **startedAt** | `string` | ✅ | ISO timestamp | +| **completedAt** | `string` | optional | ISO timestamp | + +--- + +## AIOrchestrationTrigger + +### Allowed Values + +* `record_created` +* `record_updated` +* `field_changed` +* `scheduled` +* `manual` +* `webhook` +* `batch` + +--- + +## AITask + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | optional | Optional task ID for referencing | +| **name** | `string` | ✅ | Human-readable task name | +| **type** | `Enum<'classify' \| 'extract' \| 'summarize' \| 'generate' \| 'predict' \| 'translate' \| 'sentiment' \| 'entity_recognition' \| 'anomaly_detection' \| 'recommendation'>` | ✅ | | +| **model** | `string` | optional | Model ID from registry (uses default if not specified) | +| **promptTemplate** | `string` | optional | Prompt template ID for this task | +| **inputFields** | `string[]` | ✅ | Source fields to process (e.g., ["description", "comments"]) | +| **inputContext** | `Record` | optional | Additional context for the AI model | +| **outputField** | `string` | ✅ | Target field to store the result | +| **outputFormat** | `Enum<'text' \| 'json' \| 'number' \| 'boolean' \| 'array'>` | optional | | +| **classes** | `string[]` | optional | Valid classes for classification tasks | +| **multiClass** | `boolean` | optional | Allow multiple classes to be selected | +| **extractionSchema** | `Record` | optional | JSON schema for structured extraction | +| **maxLength** | `number` | optional | Maximum length for generated content | +| **temperature** | `number` | optional | Model temperature override | +| **fallbackValue** | `any` | optional | Fallback value if AI task fails | +| **retryAttempts** | `integer` | optional | | +| **condition** | `string` | optional | Formula condition - task only runs if TRUE | +| **description** | `string` | optional | | +| **active** | `boolean` | optional | | + +--- + +## AITaskType + +### Allowed Values + +* `classify` +* `extract` +* `summarize` +* `generate` +* `predict` +* `translate` +* `sentiment` +* `entity_recognition` +* `anomaly_detection` +* `recommendation` + +--- + +## BatchAIOrchestrationExecution + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **workflowName** | `string` | ✅ | Orchestration to execute | +| **recordIds** | `string[]` | ✅ | Records to process | +| **batchSize** | `integer` | optional | | +| **parallelism** | `integer` | optional | | +| **priority** | `Enum<'low' \| 'normal' \| 'high'>` | optional | | + +--- + +## PostProcessingAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'field_update' \| 'send_email' \| 'create_record' \| 'update_related' \| 'trigger_flow' \| 'webhook'>` | ✅ | | +| **name** | `string` | ✅ | Action name | +| **config** | `Record` | ✅ | Action-specific configuration | +| **condition** | `string` | optional | Execute only if condition is TRUE | + +--- + +## WorkflowFieldCondition + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | Field name to monitor | +| **operator** | `Enum<'changed' \| 'changed_to' \| 'changed_from' \| 'is' \| 'is_not'>` | optional | | +| **value** | `any` | optional | Value to compare against (for changed_to/changed_from/is/is_not) | + +--- + +## WorkflowSchedule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'cron' \| 'interval' \| 'daily' \| 'weekly' \| 'monthly'>` | optional | | +| **cron** | `string` | optional | Cron expression (required if type is "cron") | +| **interval** | `number` | optional | Interval in minutes (required if type is "interval") | +| **time** | `string` | optional | Time of day for daily schedules (HH:MM format) | +| **dayOfWeek** | `integer` | optional | Day of week for weekly (0=Sunday) | +| **dayOfMonth** | `integer` | optional | Day of month for monthly | +| **timezone** | `string` | optional | | + diff --git a/content/docs/references/ai/orchestration/AIOrchestration.mdx b/content/docs/references/ai/orchestration/AIOrchestration.mdx deleted file mode 100644 index 2c713123d..000000000 --- a/content/docs/references/ai/orchestration/AIOrchestration.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: AIOrchestration -description: AIOrchestration Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Orchestration unique identifier (snake_case) | -| **label** | `string` | ✅ | Display name | -| **description** | `string` | optional | | -| **objectName** | `string` | ✅ | Target object for this orchestration | -| **trigger** | `Enum<'record_created' \| 'record_updated' \| 'field_changed' \| 'scheduled' \| 'manual' \| 'webhook' \| 'batch'>` | ✅ | | -| **fieldConditions** | `object[]` | optional | Fields to monitor (for field_changed trigger) | -| **schedule** | `object` | optional | Schedule configuration (for scheduled trigger) | -| **webhookConfig** | `object` | optional | Webhook configuration (for webhook trigger) | -| **entryCriteria** | `string` | optional | Formula condition - workflow only runs if TRUE | -| **aiTasks** | `object[]` | ✅ | AI tasks to execute in sequence | -| **postActions** | `object[]` | optional | Actions after AI tasks complete | -| **executionMode** | `Enum<'sequential' \| 'parallel'>` | optional | How to execute multiple AI tasks | -| **stopOnError** | `boolean` | optional | Stop workflow if any task fails | -| **timeout** | `number` | optional | Maximum execution time in seconds | -| **priority** | `Enum<'low' \| 'normal' \| 'high' \| 'critical'>` | optional | | -| **enableLogging** | `boolean` | optional | | -| **enableMetrics** | `boolean` | optional | | -| **notifyOnFailure** | `string[]` | optional | User IDs to notify on failure | -| **active** | `boolean` | optional | | -| **version** | `string` | optional | | -| **tags** | `string[]` | optional | | -| **category** | `string` | optional | Workflow category (e.g., "support", "sales", "hr") | -| **owner** | `string` | optional | User ID of workflow owner | -| **createdAt** | `string` | optional | ISO timestamp | -| **updatedAt** | `string` | optional | ISO timestamp | - -## TypeScript Usage - -```typescript -import { AIOrchestrationSchema } from '@objectstack/spec/ai'; -import type { AIOrchestration } from '@objectstack/spec/ai'; - -// Validate data -const result = AIOrchestrationSchema.parse(data); - -// Type-safe usage -const myAIOrchestration: AIOrchestration = { - name: 'name', - label: 'example', - objectName: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx b/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx deleted file mode 100644 index 7592d50c7..000000000 --- a/content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AIOrchestrationExecutionResult -description: AIOrchestrationExecutionResult Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **workflowName** | `string` | ✅ | | -| **recordId** | `string` | ✅ | | -| **status** | `Enum<'success' \| 'partial_success' \| 'failed' \| 'skipped'>` | ✅ | | -| **executionTime** | `number` | ✅ | Execution time in milliseconds | -| **tasksExecuted** | `integer` | ✅ | Number of tasks executed | -| **tasksSucceeded** | `integer` | ✅ | Number of tasks succeeded | -| **tasksFailed** | `integer` | ✅ | Number of tasks failed | -| **taskResults** | `object[]` | optional | | -| **error** | `string` | optional | | -| **startedAt** | `string` | ✅ | ISO timestamp | -| **completedAt** | `string` | optional | ISO timestamp | - -## TypeScript Usage - -```typescript -import { AIOrchestrationExecutionResultSchema } from '@objectstack/spec/ai'; -import type { AIOrchestrationExecutionResult } from '@objectstack/spec/ai'; - -// Validate data -const result = AIOrchestrationExecutionResultSchema.parse(data); - -// Type-safe usage -const myAIOrchestrationExecutionResult: AIOrchestrationExecutionResult = { - workflowName: 'example', - recordId: 'example', - status: 'success', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx b/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx deleted file mode 100644 index c98afdb58..000000000 --- a/content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: AIOrchestrationTrigger -description: AIOrchestrationTrigger Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Allowed Values - -* `record_created` -* `record_updated` -* `field_changed` -* `scheduled` -* `manual` -* `webhook` -* `batch` - -## TypeScript Usage - -```typescript -import { AIOrchestrationTrigger } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: AIOrchestrationTrigger = 'record_created'; -``` - diff --git a/content/docs/references/ai/orchestration/AITask.mdx b/content/docs/references/ai/orchestration/AITask.mdx deleted file mode 100644 index ac7ad8eff..000000000 --- a/content/docs/references/ai/orchestration/AITask.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AITask -description: AITask Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | optional | Optional task ID for referencing | -| **name** | `string` | ✅ | Human-readable task name | -| **type** | `Enum<'classify' \| 'extract' \| 'summarize' \| 'generate' \| 'predict' \| 'translate' \| 'sentiment' \| 'entity_recognition' \| 'anomaly_detection' \| 'recommendation'>` | ✅ | | -| **model** | `string` | optional | Model ID from registry (uses default if not specified) | -| **promptTemplate** | `string` | optional | Prompt template ID for this task | -| **inputFields** | `string[]` | ✅ | Source fields to process (e.g., ["description", "comments"]) | -| **inputContext** | `Record` | optional | Additional context for the AI model | -| **outputField** | `string` | ✅ | Target field to store the result | -| **outputFormat** | `Enum<'text' \| 'json' \| 'number' \| 'boolean' \| 'array'>` | optional | | -| **classes** | `string[]` | optional | Valid classes for classification tasks | -| **multiClass** | `boolean` | optional | Allow multiple classes to be selected | -| **extractionSchema** | `Record` | optional | JSON schema for structured extraction | -| **maxLength** | `number` | optional | Maximum length for generated content | -| **temperature** | `number` | optional | Model temperature override | -| **fallbackValue** | `any` | optional | Fallback value if AI task fails | -| **retryAttempts** | `integer` | optional | | -| **condition** | `string` | optional | Formula condition - task only runs if TRUE | -| **description** | `string` | optional | | -| **active** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { AITaskSchema } from '@objectstack/spec/ai'; -import type { AITask } from '@objectstack/spec/ai'; - -// Validate data -const result = AITaskSchema.parse(data); - -// Type-safe usage -const myAITask: AITask = { - name: 'name', - type: 'classify', - inputFields: [], - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/orchestration/AITaskType.mdx b/content/docs/references/ai/orchestration/AITaskType.mdx deleted file mode 100644 index 608cbb409..000000000 --- a/content/docs/references/ai/orchestration/AITaskType.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AITaskType -description: AITaskType Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Allowed Values - -* `classify` -* `extract` -* `summarize` -* `generate` -* `predict` -* `translate` -* `sentiment` -* `entity_recognition` -* `anomaly_detection` -* `recommendation` - -## TypeScript Usage - -```typescript -import { AITaskType } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: AITaskType = 'classify'; -``` - diff --git a/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx b/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx deleted file mode 100644 index a96c359c8..000000000 --- a/content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BatchAIOrchestrationExecution -description: BatchAIOrchestrationExecution Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **workflowName** | `string` | ✅ | Orchestration to execute | -| **recordIds** | `string[]` | ✅ | Records to process | -| **batchSize** | `integer` | optional | | -| **parallelism** | `integer` | optional | | -| **priority** | `Enum<'low' \| 'normal' \| 'high'>` | optional | | - -## TypeScript Usage - -```typescript -import { BatchAIOrchestrationExecutionSchema } from '@objectstack/spec/ai'; -import type { BatchAIOrchestrationExecution } from '@objectstack/spec/ai'; - -// Validate data -const result = BatchAIOrchestrationExecutionSchema.parse(data); - -// Type-safe usage -const myBatchAIOrchestrationExecution: BatchAIOrchestrationExecution = { - workflowName: 'example', - recordIds: [] -}; -``` - diff --git a/content/docs/references/ai/orchestration/PostProcessingAction.mdx b/content/docs/references/ai/orchestration/PostProcessingAction.mdx deleted file mode 100644 index d1aa65973..000000000 --- a/content/docs/references/ai/orchestration/PostProcessingAction.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PostProcessingAction -description: PostProcessingAction Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'field_update' \| 'send_email' \| 'create_record' \| 'update_related' \| 'trigger_flow' \| 'webhook'>` | ✅ | | -| **name** | `string` | ✅ | Action name | -| **config** | `Record` | ✅ | Action-specific configuration | -| **condition** | `string` | optional | Execute only if condition is TRUE | - -## TypeScript Usage - -```typescript -import { PostProcessingActionSchema } from '@objectstack/spec/ai'; -import type { PostProcessingAction } from '@objectstack/spec/ai'; - -// Validate data -const result = PostProcessingActionSchema.parse(data); - -// Type-safe usage -const myPostProcessingAction: PostProcessingAction = { - type: 'field_update', - name: 'name', - config: {} -}; -``` - diff --git a/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx b/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx deleted file mode 100644 index 992f27998..000000000 --- a/content/docs/references/ai/orchestration/WorkflowFieldCondition.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: WorkflowFieldCondition -description: WorkflowFieldCondition Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | Field name to monitor | -| **operator** | `Enum<'changed' \| 'changed_to' \| 'changed_from' \| 'is' \| 'is_not'>` | optional | | -| **value** | `any` | optional | Value to compare against (for changed_to/changed_from/is/is_not) | - -## TypeScript Usage - -```typescript -import { WorkflowFieldConditionSchema } from '@objectstack/spec/ai'; -import type { WorkflowFieldCondition } from '@objectstack/spec/ai'; - -// Validate data -const result = WorkflowFieldConditionSchema.parse(data); - -// Type-safe usage -const myWorkflowFieldCondition: WorkflowFieldCondition = { - field: 'example' -}; -``` - diff --git a/content/docs/references/ai/orchestration/WorkflowSchedule.mdx b/content/docs/references/ai/orchestration/WorkflowSchedule.mdx deleted file mode 100644 index e51403547..000000000 --- a/content/docs/references/ai/orchestration/WorkflowSchedule.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: WorkflowSchedule -description: WorkflowSchedule Schema Reference -category: ai -zodFile: orchestration ---- - - - -**Source:** `packages/spec/src/ai/orchestration.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'cron' \| 'interval' \| 'daily' \| 'weekly' \| 'monthly'>` | optional | | -| **cron** | `string` | optional | Cron expression (required if type is "cron") | -| **interval** | `number` | optional | Interval in minutes (required if type is "interval") | -| **time** | `string` | optional | Time of day for daily schedules (HH:MM format) | -| **dayOfWeek** | `integer` | optional | Day of week for weekly (0=Sunday) | -| **dayOfMonth** | `integer` | optional | Day of month for monthly | -| **timezone** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { WorkflowScheduleSchema } from '@objectstack/spec/ai'; -import type { WorkflowSchedule } from '@objectstack/spec/ai'; - -// Validate data -const result = WorkflowScheduleSchema.parse(data); - -// Type-safe usage -const myWorkflowSchedule: WorkflowSchedule = { -}; -``` - diff --git a/content/docs/references/ai/orchestration/meta.json b/content/docs/references/ai/orchestration/meta.json deleted file mode 100644 index 76144ea5b..000000000 --- a/content/docs/references/ai/orchestration/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Orchestration" -} \ No newline at end of file diff --git a/content/docs/references/ai/predictive.mdx b/content/docs/references/ai/predictive.mdx new file mode 100644 index 000000000..6fff86bae --- /dev/null +++ b/content/docs/references/ai/predictive.mdx @@ -0,0 +1,215 @@ +--- +title: Predictive +description: Predictive protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Predictive + + +**Source:** `packages/spec/src/ai/predictive.zod.ts` + + +## TypeScript Usage + +```typescript +import { EvaluationMetricsSchema, HyperparametersSchema, ModelDriftSchema, ModelFeatureSchema, PredictionRequestSchema, PredictionResultSchema, PredictiveModelSchema, PredictiveModelTypeSchema, TrainingConfigSchema } from '@objectstack/spec/ai'; +import type { EvaluationMetrics, Hyperparameters, ModelDrift, ModelFeature, PredictionRequest, PredictionResult, PredictiveModel, PredictiveModelType, TrainingConfig } from '@objectstack/spec/ai'; + +// Validate data +const result = EvaluationMetricsSchema.parse(data); +``` + +--- + +## EvaluationMetrics + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **accuracy** | `number` | optional | | +| **precision** | `number` | optional | | +| **recall** | `number` | optional | | +| **f1Score** | `number` | optional | | +| **auc** | `number` | optional | Area Under ROC Curve | +| **mse** | `number` | optional | Mean Squared Error | +| **rmse** | `number` | optional | Root Mean Squared Error | +| **mae** | `number` | optional | Mean Absolute Error | +| **r2Score** | `number` | optional | R-squared score | +| **silhouetteScore** | `number` | optional | | +| **daviesBouldinIndex** | `number` | optional | | +| **mape** | `number` | optional | Mean Absolute Percentage Error | +| **smape** | `number` | optional | Symmetric MAPE | +| **custom** | `Record` | optional | | + +--- + +## Hyperparameters + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **learningRate** | `number` | optional | Learning rate for training | +| **epochs** | `integer` | optional | Number of training epochs | +| **batchSize** | `integer` | optional | Training batch size | +| **maxDepth** | `integer` | optional | Maximum tree depth | +| **numTrees** | `integer` | optional | Number of trees in ensemble | +| **minSamplesSplit** | `integer` | optional | Minimum samples to split node | +| **minSamplesLeaf** | `integer` | optional | Minimum samples in leaf node | +| **hiddenLayers** | `integer[]` | optional | Hidden layer sizes | +| **activation** | `string` | optional | Activation function | +| **dropout** | `number` | optional | Dropout rate | +| **l1Regularization** | `number` | optional | L1 regularization strength | +| **l2Regularization** | `number` | optional | L2 regularization strength | +| **numClusters** | `integer` | optional | Number of clusters (k-means, etc.) | +| **seasonalPeriod** | `integer` | optional | Seasonal period for time series | +| **forecastHorizon** | `integer` | optional | Number of periods to forecast | +| **custom** | `Record` | optional | Algorithm-specific parameters | + +--- + +## ModelDrift + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **modelName** | `string` | ✅ | | +| **driftType** | `Enum<'feature_drift' \| 'prediction_drift' \| 'performance_drift'>` | ✅ | | +| **severity** | `Enum<'low' \| 'medium' \| 'high' \| 'critical'>` | ✅ | | +| **detectedAt** | `string` | ✅ | ISO timestamp | +| **metrics** | `object` | ✅ | | +| **recommendation** | `string` | optional | | +| **autoRetrainTriggered** | `boolean` | optional | | + +--- + +## ModelFeature + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Feature name (snake_case) | +| **label** | `string` | optional | Human-readable label | +| **field** | `string` | ✅ | Source field name | +| **object** | `string` | optional | Source object (if different from target) | +| **dataType** | `Enum<'numeric' \| 'categorical' \| 'text' \| 'datetime' \| 'boolean'>` | ✅ | Feature data type | +| **transformation** | `Enum<'none' \| 'normalize' \| 'standardize' \| 'one_hot_encode' \| 'label_encode' \| 'log_transform' \| 'binning' \| 'embedding'>` | optional | | +| **required** | `boolean` | optional | | +| **defaultValue** | `any` | optional | | +| **description** | `string` | optional | | +| **importance** | `number` | optional | Feature importance score (0-1) | + +--- + +## PredictionRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **modelName** | `string` | ✅ | Model to use for prediction | +| **recordIds** | `string[]` | optional | Specific records to predict (if not provided, uses all) | +| **inputData** | `Record` | optional | Direct input data (alternative to recordIds) | +| **returnConfidence** | `boolean` | optional | | +| **returnExplanation** | `boolean` | optional | | + +--- + +## PredictionResult + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **modelName** | `string` | ✅ | | +| **modelVersion** | `string` | ✅ | | +| **recordId** | `string` | optional | | +| **prediction** | `any` | optional | The predicted value | +| **confidence** | `number` | optional | Confidence score (0-1) | +| **probabilities** | `Record` | optional | Class probabilities (for classification) | +| **explanation** | `object` | optional | | +| **metadata** | `object` | optional | | + +--- + +## PredictiveModel + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Model unique identifier (snake_case) | +| **label** | `string` | ✅ | Model display name | +| **description** | `string` | optional | | +| **type** | `Enum<'classification' \| 'regression' \| 'clustering' \| 'forecasting' \| 'anomaly_detection' \| 'recommendation' \| 'ranking'>` | ✅ | | +| **algorithm** | `string` | optional | Specific algorithm (e.g., "random_forest", "xgboost", "lstm") | +| **objectName** | `string` | ✅ | Target object for predictions | +| **target** | `string` | ✅ | Target field to predict | +| **targetType** | `Enum<'numeric' \| 'categorical' \| 'binary'>` | optional | Target field type | +| **features** | `object[]` | ✅ | Input features for the model | +| **hyperparameters** | `object` | optional | | +| **training** | `object` | optional | | +| **metrics** | `object` | optional | Evaluation metrics from last training | +| **deploymentStatus** | `Enum<'draft' \| 'training' \| 'trained' \| 'deployed' \| 'deprecated'>` | optional | | +| **version** | `string` | optional | | +| **predictionField** | `string` | optional | Field to store predictions | +| **confidenceField** | `string` | optional | Field to store confidence scores | +| **updateTrigger** | `Enum<'on_create' \| 'on_update' \| 'manual' \| 'scheduled'>` | optional | | +| **autoRetrain** | `boolean` | optional | | +| **retrainSchedule** | `string` | optional | Cron expression for auto-retraining | +| **retrainThreshold** | `number` | optional | Performance threshold to trigger retraining | +| **enableExplainability** | `boolean` | optional | Generate feature importance & explanations | +| **enableMonitoring** | `boolean` | optional | | +| **alertOnDrift** | `boolean` | optional | Alert when model drift is detected | +| **active** | `boolean` | optional | | +| **owner** | `string` | optional | User ID of model owner | +| **permissions** | `string[]` | optional | User/group IDs with access | +| **tags** | `string[]` | optional | | +| **category** | `string` | optional | Model category (e.g., "sales", "marketing", "operations") | +| **lastTrainedAt** | `string` | optional | ISO timestamp | +| **createdAt** | `string` | optional | ISO timestamp | +| **updatedAt** | `string` | optional | ISO timestamp | + +--- + +## PredictiveModelType + +### Allowed Values + +* `classification` +* `regression` +* `clustering` +* `forecasting` +* `anomaly_detection` +* `recommendation` +* `ranking` + +--- + +## TrainingConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **trainingDataRatio** | `number` | optional | Proportion of data for training | +| **validationDataRatio** | `number` | optional | Proportion for validation | +| **testDataRatio** | `number` | optional | Proportion for testing | +| **dataFilter** | `string` | optional | Formula to filter training data | +| **minRecords** | `integer` | optional | Minimum records required | +| **maxRecords** | `integer` | optional | Maximum records to use | +| **strategy** | `Enum<'full' \| 'incremental' \| 'online' \| 'transfer_learning'>` | optional | | +| **crossValidation** | `boolean` | optional | | +| **folds** | `integer` | optional | Cross-validation folds | +| **earlyStoppingEnabled** | `boolean` | optional | | +| **earlyStoppingPatience** | `integer` | optional | Epochs without improvement before stopping | +| **maxTrainingTime** | `number` | optional | Maximum training time in seconds | +| **gpuEnabled** | `boolean` | optional | | +| **randomSeed** | `integer` | optional | Random seed for reproducibility | + diff --git a/content/docs/references/ai/predictive/EvaluationMetrics.mdx b/content/docs/references/ai/predictive/EvaluationMetrics.mdx deleted file mode 100644 index 9d05509d0..000000000 --- a/content/docs/references/ai/predictive/EvaluationMetrics.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: EvaluationMetrics -description: EvaluationMetrics Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **accuracy** | `number` | optional | | -| **precision** | `number` | optional | | -| **recall** | `number` | optional | | -| **f1Score** | `number` | optional | | -| **auc** | `number` | optional | Area Under ROC Curve | -| **mse** | `number` | optional | Mean Squared Error | -| **rmse** | `number` | optional | Root Mean Squared Error | -| **mae** | `number` | optional | Mean Absolute Error | -| **r2Score** | `number` | optional | R-squared score | -| **silhouetteScore** | `number` | optional | | -| **daviesBouldinIndex** | `number` | optional | | -| **mape** | `number` | optional | Mean Absolute Percentage Error | -| **smape** | `number` | optional | Symmetric MAPE | -| **custom** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { EvaluationMetricsSchema } from '@objectstack/spec/ai'; -import type { EvaluationMetrics } from '@objectstack/spec/ai'; - -// Validate data -const result = EvaluationMetricsSchema.parse(data); - -// Type-safe usage -const myEvaluationMetrics: EvaluationMetrics = { -}; -``` - diff --git a/content/docs/references/ai/predictive/Hyperparameters.mdx b/content/docs/references/ai/predictive/Hyperparameters.mdx deleted file mode 100644 index 03ad72791..000000000 --- a/content/docs/references/ai/predictive/Hyperparameters.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Hyperparameters -description: Hyperparameters Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **learningRate** | `number` | optional | Learning rate for training | -| **epochs** | `integer` | optional | Number of training epochs | -| **batchSize** | `integer` | optional | Training batch size | -| **maxDepth** | `integer` | optional | Maximum tree depth | -| **numTrees** | `integer` | optional | Number of trees in ensemble | -| **minSamplesSplit** | `integer` | optional | Minimum samples to split node | -| **minSamplesLeaf** | `integer` | optional | Minimum samples in leaf node | -| **hiddenLayers** | `integer[]` | optional | Hidden layer sizes | -| **activation** | `string` | optional | Activation function | -| **dropout** | `number` | optional | Dropout rate | -| **l1Regularization** | `number` | optional | L1 regularization strength | -| **l2Regularization** | `number` | optional | L2 regularization strength | -| **numClusters** | `integer` | optional | Number of clusters (k-means, etc.) | -| **seasonalPeriod** | `integer` | optional | Seasonal period for time series | -| **forecastHorizon** | `integer` | optional | Number of periods to forecast | -| **custom** | `Record` | optional | Algorithm-specific parameters | - -## TypeScript Usage - -```typescript -import { HyperparametersSchema } from '@objectstack/spec/ai'; -import type { Hyperparameters } from '@objectstack/spec/ai'; - -// Validate data -const result = HyperparametersSchema.parse(data); - -// Type-safe usage -const myHyperparameters: Hyperparameters = { -}; -``` - diff --git a/content/docs/references/ai/predictive/ModelDrift.mdx b/content/docs/references/ai/predictive/ModelDrift.mdx deleted file mode 100644 index 873c109e1..000000000 --- a/content/docs/references/ai/predictive/ModelDrift.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ModelDrift -description: ModelDrift Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **modelName** | `string` | ✅ | | -| **driftType** | `Enum<'feature_drift' \| 'prediction_drift' \| 'performance_drift'>` | ✅ | | -| **severity** | `Enum<'low' \| 'medium' \| 'high' \| 'critical'>` | ✅ | | -| **detectedAt** | `string` | ✅ | ISO timestamp | -| **metrics** | `object` | ✅ | | -| **recommendation** | `string` | optional | | -| **autoRetrainTriggered** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { ModelDriftSchema } from '@objectstack/spec/ai'; -import type { ModelDrift } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelDriftSchema.parse(data); - -// Type-safe usage -const myModelDrift: ModelDrift = { - modelName: 'example', - driftType: 'feature_drift', - severity: 'low', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/predictive/ModelFeature.mdx b/content/docs/references/ai/predictive/ModelFeature.mdx deleted file mode 100644 index e7640e6f7..000000000 --- a/content/docs/references/ai/predictive/ModelFeature.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ModelFeature -description: ModelFeature Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Feature name (snake_case) | -| **label** | `string` | optional | Human-readable label | -| **field** | `string` | ✅ | Source field name | -| **object** | `string` | optional | Source object (if different from target) | -| **dataType** | `Enum<'numeric' \| 'categorical' \| 'text' \| 'datetime' \| 'boolean'>` | ✅ | Feature data type | -| **transformation** | `Enum<'none' \| 'normalize' \| 'standardize' \| 'one_hot_encode' \| 'label_encode' \| 'log_transform' \| 'binning' \| 'embedding'>` | optional | | -| **required** | `boolean` | optional | | -| **defaultValue** | `any` | optional | | -| **description** | `string` | optional | | -| **importance** | `number` | optional | Feature importance score (0-1) | - -## TypeScript Usage - -```typescript -import { ModelFeatureSchema } from '@objectstack/spec/ai'; -import type { ModelFeature } from '@objectstack/spec/ai'; - -// Validate data -const result = ModelFeatureSchema.parse(data); - -// Type-safe usage -const myModelFeature: ModelFeature = { - name: 'name', - field: 'example', - dataType: 'numeric' -}; -``` - diff --git a/content/docs/references/ai/predictive/PredictionRequest.mdx b/content/docs/references/ai/predictive/PredictionRequest.mdx deleted file mode 100644 index c8065d43a..000000000 --- a/content/docs/references/ai/predictive/PredictionRequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PredictionRequest -description: PredictionRequest Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **modelName** | `string` | ✅ | Model to use for prediction | -| **recordIds** | `string[]` | optional | Specific records to predict (if not provided, uses all) | -| **inputData** | `Record` | optional | Direct input data (alternative to recordIds) | -| **returnConfidence** | `boolean` | optional | | -| **returnExplanation** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { PredictionRequestSchema } from '@objectstack/spec/ai'; -import type { PredictionRequest } from '@objectstack/spec/ai'; - -// Validate data -const result = PredictionRequestSchema.parse(data); - -// Type-safe usage -const myPredictionRequest: PredictionRequest = { - modelName: 'example' -}; -``` - diff --git a/content/docs/references/ai/predictive/PredictionResult.mdx b/content/docs/references/ai/predictive/PredictionResult.mdx deleted file mode 100644 index 3be121497..000000000 --- a/content/docs/references/ai/predictive/PredictionResult.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: PredictionResult -description: PredictionResult Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **modelName** | `string` | ✅ | | -| **modelVersion** | `string` | ✅ | | -| **recordId** | `string` | optional | | -| **prediction** | `any` | optional | The predicted value | -| **confidence** | `number` | optional | Confidence score (0-1) | -| **probabilities** | `Record` | optional | Class probabilities (for classification) | -| **explanation** | `object` | optional | | -| **metadata** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { PredictionResultSchema } from '@objectstack/spec/ai'; -import type { PredictionResult } from '@objectstack/spec/ai'; - -// Validate data -const result = PredictionResultSchema.parse(data); - -// Type-safe usage -const myPredictionResult: PredictionResult = { - modelName: 'example', - modelVersion: 'example' -}; -``` - diff --git a/content/docs/references/ai/predictive/PredictiveModel.mdx b/content/docs/references/ai/predictive/PredictiveModel.mdx deleted file mode 100644 index fbe2ccfca..000000000 --- a/content/docs/references/ai/predictive/PredictiveModel.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: PredictiveModel -description: PredictiveModel Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Model unique identifier (snake_case) | -| **label** | `string` | ✅ | Model display name | -| **description** | `string` | optional | | -| **type** | `Enum<'classification' \| 'regression' \| 'clustering' \| 'forecasting' \| 'anomaly_detection' \| 'recommendation' \| 'ranking'>` | ✅ | | -| **algorithm** | `string` | optional | Specific algorithm (e.g., "random_forest", "xgboost", "lstm") | -| **objectName** | `string` | ✅ | Target object for predictions | -| **target** | `string` | ✅ | Target field to predict | -| **targetType** | `Enum<'numeric' \| 'categorical' \| 'binary'>` | optional | Target field type | -| **features** | `object[]` | ✅ | Input features for the model | -| **hyperparameters** | `object` | optional | | -| **training** | `object` | optional | | -| **metrics** | `object` | optional | Evaluation metrics from last training | -| **deploymentStatus** | `Enum<'draft' \| 'training' \| 'trained' \| 'deployed' \| 'deprecated'>` | optional | | -| **version** | `string` | optional | | -| **predictionField** | `string` | optional | Field to store predictions | -| **confidenceField** | `string` | optional | Field to store confidence scores | -| **updateTrigger** | `Enum<'on_create' \| 'on_update' \| 'manual' \| 'scheduled'>` | optional | | -| **autoRetrain** | `boolean` | optional | | -| **retrainSchedule** | `string` | optional | Cron expression for auto-retraining | -| **retrainThreshold** | `number` | optional | Performance threshold to trigger retraining | -| **enableExplainability** | `boolean` | optional | Generate feature importance & explanations | -| **enableMonitoring** | `boolean` | optional | | -| **alertOnDrift** | `boolean` | optional | Alert when model drift is detected | -| **active** | `boolean` | optional | | -| **owner** | `string` | optional | User ID of model owner | -| **permissions** | `string[]` | optional | User/group IDs with access | -| **tags** | `string[]` | optional | | -| **category** | `string` | optional | Model category (e.g., "sales", "marketing", "operations") | -| **lastTrainedAt** | `string` | optional | ISO timestamp | -| **createdAt** | `string` | optional | ISO timestamp | -| **updatedAt** | `string` | optional | ISO timestamp | - -## TypeScript Usage - -```typescript -import { PredictiveModelSchema } from '@objectstack/spec/ai'; -import type { PredictiveModel } from '@objectstack/spec/ai'; - -// Validate data -const result = PredictiveModelSchema.parse(data); - -// Type-safe usage -const myPredictiveModel: PredictiveModel = { - name: 'name', - label: 'example', - type: 'classification', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/predictive/PredictiveModelType.mdx b/content/docs/references/ai/predictive/PredictiveModelType.mdx deleted file mode 100644 index 285ecc8de..000000000 --- a/content/docs/references/ai/predictive/PredictiveModelType.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: PredictiveModelType -description: PredictiveModelType Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Allowed Values - -* `classification` -* `regression` -* `clustering` -* `forecasting` -* `anomaly_detection` -* `recommendation` -* `ranking` - -## TypeScript Usage - -```typescript -import { PredictiveModelType } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: PredictiveModelType = 'classification'; -``` - diff --git a/content/docs/references/ai/predictive/TrainingConfig.mdx b/content/docs/references/ai/predictive/TrainingConfig.mdx deleted file mode 100644 index 38a3df087..000000000 --- a/content/docs/references/ai/predictive/TrainingConfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: TrainingConfig -description: TrainingConfig Schema Reference -category: ai -zodFile: predictive ---- - - - -**Source:** `packages/spec/src/ai/predictive.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **trainingDataRatio** | `number` | optional | Proportion of data for training | -| **validationDataRatio** | `number` | optional | Proportion for validation | -| **testDataRatio** | `number` | optional | Proportion for testing | -| **dataFilter** | `string` | optional | Formula to filter training data | -| **minRecords** | `integer` | optional | Minimum records required | -| **maxRecords** | `integer` | optional | Maximum records to use | -| **strategy** | `Enum<'full' \| 'incremental' \| 'online' \| 'transfer_learning'>` | optional | | -| **crossValidation** | `boolean` | optional | | -| **folds** | `integer` | optional | Cross-validation folds | -| **earlyStoppingEnabled** | `boolean` | optional | | -| **earlyStoppingPatience** | `integer` | optional | Epochs without improvement before stopping | -| **maxTrainingTime** | `number` | optional | Maximum training time in seconds | -| **gpuEnabled** | `boolean` | optional | | -| **randomSeed** | `integer` | optional | Random seed for reproducibility | - -## TypeScript Usage - -```typescript -import { TrainingConfigSchema } from '@objectstack/spec/ai'; -import type { TrainingConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = TrainingConfigSchema.parse(data); - -// Type-safe usage -const myTrainingConfig: TrainingConfig = { -}; -``` - diff --git a/content/docs/references/ai/predictive/meta.json b/content/docs/references/ai/predictive/meta.json deleted file mode 100644 index 4a6c858c1..000000000 --- a/content/docs/references/ai/predictive/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Predictive" -} \ No newline at end of file diff --git a/content/docs/references/ai/rag-pipeline.mdx b/content/docs/references/ai/rag-pipeline.mdx new file mode 100644 index 000000000..6f778a22f --- /dev/null +++ b/content/docs/references/ai/rag-pipeline.mdx @@ -0,0 +1,219 @@ +--- +title: Rag Pipeline +description: Rag Pipeline protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Rag Pipeline + + +**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` + + +## TypeScript Usage + +```typescript +import { ChunkingStrategySchema, DocumentChunkSchema, DocumentLoaderConfigSchema, DocumentMetadataSchema, EmbeddingModelSchema, RAGPipelineConfigSchema, RAGPipelineStatusSchema, RAGQueryRequestSchema, RAGQueryResponseSchema, RerankingConfigSchema, RetrievalStrategySchema, VectorStoreConfigSchema, VectorStoreProviderSchema } from '@objectstack/spec/ai'; +import type { ChunkingStrategy, DocumentChunk, DocumentLoaderConfig, DocumentMetadata, EmbeddingModel, RAGPipelineConfig, RAGPipelineStatus, RAGQueryRequest, RAGQueryResponse, RerankingConfig, RetrievalStrategy, VectorStoreConfig, VectorStoreProvider } from '@objectstack/spec/ai'; + +// Validate data +const result = ChunkingStrategySchema.parse(data); +``` + +--- + +## ChunkingStrategy + +--- + +## DocumentChunk + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique chunk identifier | +| **content** | `string` | ✅ | Chunk text content | +| **embedding** | `number[]` | optional | Embedding vector | +| **metadata** | `object` | ✅ | | +| **chunkIndex** | `integer` | ✅ | Chunk position in document | +| **tokens** | `integer` | optional | Token count | + +--- + +## DocumentLoaderConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'file' \| 'directory' \| 'url' \| 'api' \| 'database' \| 'custom'>` | ✅ | | +| **source** | `string` | ✅ | Source path, URL, or identifier | +| **fileTypes** | `string[]` | optional | Accepted file extensions (e.g., [".pdf", ".md"]) | +| **recursive** | `boolean` | optional | Process directories recursively | +| **maxFileSize** | `integer` | optional | Maximum file size in bytes | +| **excludePatterns** | `string[]` | optional | Patterns to exclude | +| **extractImages** | `boolean` | optional | Extract text from images (OCR) | +| **extractTables** | `boolean` | optional | Extract and format tables | +| **loaderConfig** | `Record` | optional | Custom loader-specific config | + +--- + +## DocumentMetadata + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **source** | `string` | ✅ | Document source (file path, URL, etc.) | +| **sourceType** | `Enum<'file' \| 'url' \| 'api' \| 'database' \| 'custom'>` | optional | | +| **title** | `string` | optional | | +| **author** | `string` | optional | | +| **createdAt** | `string` | optional | ISO timestamp | +| **updatedAt** | `string` | optional | ISO timestamp | +| **tags** | `string[]` | optional | | +| **category** | `string` | optional | | +| **language** | `string` | optional | Document language (ISO 639-1 code) | +| **custom** | `Record` | optional | Custom metadata fields | + +--- + +## EmbeddingModel + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **provider** | `Enum<'openai' \| 'cohere' \| 'huggingface' \| 'azure_openai' \| 'local' \| 'custom'>` | ✅ | | +| **model** | `string` | ✅ | Model name (e.g., "text-embedding-3-large") | +| **dimensions** | `integer` | ✅ | Embedding vector dimensions | +| **maxTokens** | `integer` | optional | Maximum tokens per embedding | +| **batchSize** | `integer` | optional | Batch size for embedding | +| **endpoint** | `string` | optional | Custom endpoint URL | +| **apiKey** | `string` | optional | API key or reference to secret | + +--- + +## RAGPipelineConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Pipeline name (snake_case) | +| **label** | `string` | ✅ | Display name | +| **description** | `string` | optional | | +| **embedding** | `object` | ✅ | | +| **vectorStore** | `object` | ✅ | | +| **chunking** | `object \| object \| object \| object` | ✅ | | +| **retrieval** | `object \| object \| object \| object` | ✅ | | +| **reranking** | `object` | optional | | +| **loaders** | `object[]` | optional | Document loaders | +| **maxContextTokens** | `integer` | optional | Maximum tokens in context | +| **contextWindow** | `integer` | optional | LLM context window size | +| **metadataFilters** | `Record` | optional | Filters for retrieval (e.g., `{category: "docs", status: "published"}`) | +| **enableCache** | `boolean` | optional | | +| **cacheTTL** | `integer` | optional | Cache TTL in seconds | +| **cacheInvalidationStrategy** | `Enum<'time_based' \| 'manual' \| 'on_update'>` | optional | | + +--- + +## RAGPipelineStatus + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | | +| **status** | `Enum<'active' \| 'indexing' \| 'error' \| 'disabled'>` | ✅ | | +| **documentsIndexed** | `integer` | ✅ | | +| **lastIndexed** | `string` | optional | ISO timestamp | +| **errorMessage** | `string` | optional | | +| **health** | `object` | optional | | + +--- + +## RAGQueryRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **query** | `string` | ✅ | User query | +| **pipelineName** | `string` | ✅ | Pipeline to use | +| **topK** | `integer` | optional | | +| **metadataFilters** | `Record` | optional | | +| **conversationHistory** | `object[]` | optional | | +| **includeMetadata** | `boolean` | optional | | +| **includeSources** | `boolean` | optional | | + +--- + +## RAGQueryResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **query** | `string` | ✅ | | +| **results** | `object[]` | ✅ | | +| **context** | `string` | ✅ | Assembled context for LLM | +| **tokensUsed** | `integer` | optional | | +| **retrievalTime** | `number` | optional | Retrieval time in milliseconds | + +--- + +## RerankingConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **model** | `string` | optional | Reranking model name | +| **provider** | `Enum<'cohere' \| 'huggingface' \| 'custom'>` | optional | | +| **topK** | `integer` | optional | Final number of results after reranking | + +--- + +## RetrievalStrategy + +--- + +## VectorStoreConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **provider** | `Enum<'pinecone' \| 'weaviate' \| 'qdrant' \| 'milvus' \| 'chroma' \| 'pgvector' \| 'redis' \| 'opensearch' \| 'elasticsearch' \| 'custom'>` | ✅ | | +| **indexName** | `string` | ✅ | Index/collection name | +| **namespace** | `string` | optional | Namespace for multi-tenancy | +| **host** | `string` | optional | Vector store host | +| **port** | `integer` | optional | Vector store port | +| **apiKey** | `string` | optional | API key or reference to secret | +| **dimensions** | `integer` | ✅ | Vector dimensions | +| **metric** | `Enum<'cosine' \| 'euclidean' \| 'dotproduct'>` | optional | | +| **batchSize** | `integer` | optional | | +| **connectionPoolSize** | `integer` | optional | | +| **timeout** | `integer` | optional | Timeout in milliseconds | + +--- + +## VectorStoreProvider + +### Allowed Values + +* `pinecone` +* `weaviate` +* `qdrant` +* `milvus` +* `chroma` +* `pgvector` +* `redis` +* `opensearch` +* `elasticsearch` +* `custom` + diff --git a/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx b/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx deleted file mode 100644 index aa35e44af..000000000 --- a/content/docs/references/ai/rag-pipeline/ChunkingStrategy.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: ChunkingStrategy -description: ChunkingStrategy Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - diff --git a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx b/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx deleted file mode 100644 index effb3617e..000000000 --- a/content/docs/references/ai/rag-pipeline/DocumentChunk.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: DocumentChunk -description: DocumentChunk Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique chunk identifier | -| **content** | `string` | ✅ | Chunk text content | -| **embedding** | `number[]` | optional | Embedding vector | -| **metadata** | `object` | ✅ | | -| **chunkIndex** | `integer` | ✅ | Chunk position in document | -| **tokens** | `integer` | optional | Token count | - -## TypeScript Usage - -```typescript -import { DocumentChunkSchema } from '@objectstack/spec/ai'; -import type { DocumentChunk } from '@objectstack/spec/ai'; - -// Validate data -const result = DocumentChunkSchema.parse(data); - -// Type-safe usage -const myDocumentChunk: DocumentChunk = { - id: 'example', - content: 'example', - metadata: {}, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx b/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx deleted file mode 100644 index 713b601cb..000000000 --- a/content/docs/references/ai/rag-pipeline/DocumentLoaderConfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: DocumentLoaderConfig -description: DocumentLoaderConfig Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'file' \| 'directory' \| 'url' \| 'api' \| 'database' \| 'custom'>` | ✅ | | -| **source** | `string` | ✅ | Source path, URL, or identifier | -| **fileTypes** | `string[]` | optional | Accepted file extensions (e.g., [".pdf", ".md"]) | -| **recursive** | `boolean` | optional | Process directories recursively | -| **maxFileSize** | `integer` | optional | Maximum file size in bytes | -| **excludePatterns** | `string[]` | optional | Patterns to exclude | -| **extractImages** | `boolean` | optional | Extract text from images (OCR) | -| **extractTables** | `boolean` | optional | Extract and format tables | -| **loaderConfig** | `Record` | optional | Custom loader-specific config | - -## TypeScript Usage - -```typescript -import { DocumentLoaderConfigSchema } from '@objectstack/spec/ai'; -import type { DocumentLoaderConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = DocumentLoaderConfigSchema.parse(data); - -// Type-safe usage -const myDocumentLoaderConfig: DocumentLoaderConfig = { - type: 'file', - source: 'example' -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx b/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx deleted file mode 100644 index 778eaae6b..000000000 --- a/content/docs/references/ai/rag-pipeline/DocumentMetadata.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: DocumentMetadata -description: DocumentMetadata Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **source** | `string` | ✅ | Document source (file path, URL, etc.) | -| **sourceType** | `Enum<'file' \| 'url' \| 'api' \| 'database' \| 'custom'>` | optional | | -| **title** | `string` | optional | | -| **author** | `string` | optional | | -| **createdAt** | `string` | optional | ISO timestamp | -| **updatedAt** | `string` | optional | ISO timestamp | -| **tags** | `string[]` | optional | | -| **category** | `string` | optional | | -| **language** | `string` | optional | Document language (ISO 639-1 code) | -| **custom** | `Record` | optional | Custom metadata fields | - -## TypeScript Usage - -```typescript -import { DocumentMetadataSchema } from '@objectstack/spec/ai'; -import type { DocumentMetadata } from '@objectstack/spec/ai'; - -// Validate data -const result = DocumentMetadataSchema.parse(data); - -// Type-safe usage -const myDocumentMetadata: DocumentMetadata = { - source: 'example' -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx b/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx deleted file mode 100644 index 17de427b0..000000000 --- a/content/docs/references/ai/rag-pipeline/EmbeddingModel.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: EmbeddingModel -description: EmbeddingModel Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **provider** | `Enum<'openai' \| 'cohere' \| 'huggingface' \| 'azure_openai' \| 'local' \| 'custom'>` | ✅ | | -| **model** | `string` | ✅ | Model name (e.g., "text-embedding-3-large") | -| **dimensions** | `integer` | ✅ | Embedding vector dimensions | -| **maxTokens** | `integer` | optional | Maximum tokens per embedding | -| **batchSize** | `integer` | optional | Batch size for embedding | -| **endpoint** | `string` | optional | Custom endpoint URL | -| **apiKey** | `string` | optional | API key or reference to secret | - -## TypeScript Usage - -```typescript -import { EmbeddingModelSchema } from '@objectstack/spec/ai'; -import type { EmbeddingModel } from '@objectstack/spec/ai'; - -// Validate data -const result = EmbeddingModelSchema.parse(data); - -// Type-safe usage -const myEmbeddingModel: EmbeddingModel = { - provider: 'openai', - model: 'example', - dimensions: null -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx deleted file mode 100644 index eddcfc3a3..000000000 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineConfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: RAGPipelineConfig -description: RAGPipelineConfig Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Pipeline name (snake_case) | -| **label** | `string` | ✅ | Display name | -| **description** | `string` | optional | | -| **embedding** | `object` | ✅ | | -| **vectorStore** | `object` | ✅ | | -| **chunking** | `object \| object \| object \| object` | ✅ | | -| **retrieval** | `object \| object \| object \| object` | ✅ | | -| **reranking** | `object` | optional | | -| **loaders** | `object[]` | optional | Document loaders | -| **maxContextTokens** | `integer` | optional | Maximum tokens in context | -| **contextWindow** | `integer` | optional | LLM context window size | -| **metadataFilters** | `Record` | optional | Filters for retrieval (e.g., `{category: "docs", status: "published"}`) | -| **enableCache** | `boolean` | optional | | -| **cacheTTL** | `integer` | optional | Cache TTL in seconds | -| **cacheInvalidationStrategy** | `Enum<'time_based' \| 'manual' \| 'on_update'>` | optional | | - -## TypeScript Usage - -```typescript -import { RAGPipelineConfigSchema } from '@objectstack/spec/ai'; -import type { RAGPipelineConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = RAGPipelineConfigSchema.parse(data); - -// Type-safe usage -const myRAGPipelineConfig: RAGPipelineConfig = { - name: 'name', - label: 'example', - embedding: {}, - // ... other required fields -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx b/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx deleted file mode 100644 index 7eec63404..000000000 --- a/content/docs/references/ai/rag-pipeline/RAGPipelineStatus.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: RAGPipelineStatus -description: RAGPipelineStatus Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | | -| **status** | `Enum<'active' \| 'indexing' \| 'error' \| 'disabled'>` | ✅ | | -| **documentsIndexed** | `integer` | ✅ | | -| **lastIndexed** | `string` | optional | ISO timestamp | -| **errorMessage** | `string` | optional | | -| **health** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { RAGPipelineStatusSchema } from '@objectstack/spec/ai'; -import type { RAGPipelineStatus } from '@objectstack/spec/ai'; - -// Validate data -const result = RAGPipelineStatusSchema.parse(data); - -// Type-safe usage -const myRAGPipelineStatus: RAGPipelineStatus = { - name: 'name', - status: 'active', - documentsIndexed: null -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx b/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx deleted file mode 100644 index 0415441c0..000000000 --- a/content/docs/references/ai/rag-pipeline/RAGQueryRequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: RAGQueryRequest -description: RAGQueryRequest Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **query** | `string` | ✅ | User query | -| **pipelineName** | `string` | ✅ | Pipeline to use | -| **topK** | `integer` | optional | | -| **metadataFilters** | `Record` | optional | | -| **conversationHistory** | `object[]` | optional | | -| **includeMetadata** | `boolean` | optional | | -| **includeSources** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { RAGQueryRequestSchema } from '@objectstack/spec/ai'; -import type { RAGQueryRequest } from '@objectstack/spec/ai'; - -// Validate data -const result = RAGQueryRequestSchema.parse(data); - -// Type-safe usage -const myRAGQueryRequest: RAGQueryRequest = { - query: 'example', - pipelineName: 'example' -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx b/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx deleted file mode 100644 index 8f7a06bb9..000000000 --- a/content/docs/references/ai/rag-pipeline/RAGQueryResponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: RAGQueryResponse -description: RAGQueryResponse Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **query** | `string` | ✅ | | -| **results** | `object[]` | ✅ | | -| **context** | `string` | ✅ | Assembled context for LLM | -| **tokensUsed** | `integer` | optional | | -| **retrievalTime** | `number` | optional | Retrieval time in milliseconds | - -## TypeScript Usage - -```typescript -import { RAGQueryResponseSchema } from '@objectstack/spec/ai'; -import type { RAGQueryResponse } from '@objectstack/spec/ai'; - -// Validate data -const result = RAGQueryResponseSchema.parse(data); - -// Type-safe usage -const myRAGQueryResponse: RAGQueryResponse = { - query: 'example', - results: [], - context: 'example' -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx b/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx deleted file mode 100644 index 13f2c94c8..000000000 --- a/content/docs/references/ai/rag-pipeline/RerankingConfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RerankingConfig -description: RerankingConfig Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **model** | `string` | optional | Reranking model name | -| **provider** | `Enum<'cohere' \| 'huggingface' \| 'custom'>` | optional | | -| **topK** | `integer` | optional | Final number of results after reranking | - -## TypeScript Usage - -```typescript -import { RerankingConfigSchema } from '@objectstack/spec/ai'; -import type { RerankingConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = RerankingConfigSchema.parse(data); - -// Type-safe usage -const myRerankingConfig: RerankingConfig = { -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx b/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx deleted file mode 100644 index 4368653dd..000000000 --- a/content/docs/references/ai/rag-pipeline/RetrievalStrategy.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: RetrievalStrategy -description: RetrievalStrategy Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - diff --git a/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx b/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx deleted file mode 100644 index 824af54c4..000000000 --- a/content/docs/references/ai/rag-pipeline/VectorStoreConfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: VectorStoreConfig -description: VectorStoreConfig Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **provider** | `Enum<'pinecone' \| 'weaviate' \| 'qdrant' \| 'milvus' \| 'chroma' \| 'pgvector' \| 'redis' \| 'opensearch' \| 'elasticsearch' \| 'custom'>` | ✅ | | -| **indexName** | `string` | ✅ | Index/collection name | -| **namespace** | `string` | optional | Namespace for multi-tenancy | -| **host** | `string` | optional | Vector store host | -| **port** | `integer` | optional | Vector store port | -| **apiKey** | `string` | optional | API key or reference to secret | -| **dimensions** | `integer` | ✅ | Vector dimensions | -| **metric** | `Enum<'cosine' \| 'euclidean' \| 'dotproduct'>` | optional | | -| **batchSize** | `integer` | optional | | -| **connectionPoolSize** | `integer` | optional | | -| **timeout** | `integer` | optional | Timeout in milliseconds | - -## TypeScript Usage - -```typescript -import { VectorStoreConfigSchema } from '@objectstack/spec/ai'; -import type { VectorStoreConfig } from '@objectstack/spec/ai'; - -// Validate data -const result = VectorStoreConfigSchema.parse(data); - -// Type-safe usage -const myVectorStoreConfig: VectorStoreConfig = { - provider: 'pinecone', - indexName: 'example', - dimensions: null -}; -``` - diff --git a/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx b/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx deleted file mode 100644 index 2d456310c..000000000 --- a/content/docs/references/ai/rag-pipeline/VectorStoreProvider.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: VectorStoreProvider -description: VectorStoreProvider Schema Reference -category: ai -zodFile: rag-pipeline ---- - - - -**Source:** `packages/spec/src/ai/rag-pipeline.zod.ts` - - -## Allowed Values - -* `pinecone` -* `weaviate` -* `qdrant` -* `milvus` -* `chroma` -* `pgvector` -* `redis` -* `opensearch` -* `elasticsearch` -* `custom` - -## TypeScript Usage - -```typescript -import { VectorStoreProvider } from '@objectstack/spec/ai'; - -// Type-safe enum value -const value: VectorStoreProvider = 'pinecone'; -``` - diff --git a/content/docs/references/ai/rag-pipeline/meta.json b/content/docs/references/ai/rag-pipeline/meta.json deleted file mode 100644 index b6a1c7267..000000000 --- a/content/docs/references/ai/rag-pipeline/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Rag Pipeline" -} \ No newline at end of file diff --git a/content/docs/references/api/contract.mdx b/content/docs/references/api/contract.mdx new file mode 100644 index 000000000..324b2bf2a --- /dev/null +++ b/content/docs/references/api/contract.mdx @@ -0,0 +1,173 @@ +--- +title: Contract +description: Contract protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Contract + + +**Source:** `packages/spec/src/api/contract.zod.ts` + + +## TypeScript Usage + +```typescript +import { ApiErrorSchema, BaseResponseSchema, BulkRequestSchema, BulkResponseSchema, CreateRequestSchema, DeleteResponseSchema, ExportRequestSchema, ListRecordResponseSchema, ModificationResultSchema, RecordDataSchema, SingleRecordResponseSchema, UpdateRequestSchema } from '@objectstack/spec/api'; +import type { ApiError, BaseResponse, BulkRequest, BulkResponse, CreateRequest, DeleteResponse, ExportRequest, ListRecordResponse, ModificationResult, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api'; + +// Validate data +const result = ApiErrorSchema.parse(data); +``` + +--- + +## ApiError + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **code** | `string` | ✅ | Error code (e.g. validation_error) | +| **message** | `string` | ✅ | Readable error message | +| **details** | `any` | optional | Additional error context (e.g. field validation errors) | + +--- + +## BaseResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **success** | `boolean` | ✅ | Operation success status | +| **error** | `object` | optional | Error details if success is false | +| **meta** | `object` | optional | Response metadata | + +--- + +## BulkRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **records** | `Record[]` | ✅ | Array of records to process | +| **allOrNone** | `boolean` | optional | If true, rollback entire transaction on any failure | + +--- + +## BulkResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **success** | `boolean` | ✅ | Operation success status | +| **error** | `object` | optional | Error details if success is false | +| **meta** | `object` | optional | Response metadata | +| **data** | `object[]` | ✅ | Results for each item in the batch | + +--- + +## CreateRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **data** | `Record` | ✅ | Record data to insert | + +--- + +## DeleteResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **success** | `boolean` | ✅ | Operation success status | +| **error** | `object` | optional | Error details if success is false | +| **meta** | `object` | optional | Response metadata | +| **id** | `string` | ✅ | ID of the deleted record | + +--- + +## ExportRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **object** | `string` | ✅ | Object name (e.g. account) | +| **fields** | `string \| object[]` | optional | Fields to retrieve | +| **where** | `any` | optional | Filtering criteria (WHERE) | +| **orderBy** | `object[]` | optional | Sorting instructions (ORDER BY) | +| **limit** | `number` | optional | Max records to return (LIMIT) | +| **offset** | `number` | optional | Records to skip (OFFSET) | +| **cursor** | `Record` | optional | Cursor for keyset pagination | +| **joins** | `object[]` | optional | Explicit Table Joins | +| **aggregations** | `object[]` | optional | Aggregation functions | +| **groupBy** | `string[]` | optional | GROUP BY fields | +| **having** | `any` | optional | HAVING clause for aggregation filtering | +| **windowFunctions** | `object[]` | optional | Window functions with OVER clause | +| **distinct** | `boolean` | optional | SELECT DISTINCT flag | +| **format** | `Enum<'csv' \| 'json' \| 'xlsx'>` | optional | | + +--- + +## ListRecordResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **success** | `boolean` | ✅ | Operation success status | +| **error** | `object` | optional | Error details if success is false | +| **meta** | `object` | optional | Response metadata | +| **data** | `Record[]` | ✅ | Array of matching records | +| **pagination** | `object` | ✅ | Pagination info | + +--- + +## ModificationResult + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | optional | Record ID if processed | +| **success** | `boolean` | ✅ | | +| **errors** | `object[]` | optional | | + +--- + +## RecordData + +Key-value map of record data + +--- + +## SingleRecordResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **success** | `boolean` | ✅ | Operation success status | +| **error** | `object` | optional | Error details if success is false | +| **meta** | `object` | optional | Response metadata | +| **data** | `Record` | ✅ | The requested or modified record | + +--- + +## UpdateRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **data** | `Record` | ✅ | Partial record data to update | + diff --git a/content/docs/references/api/contract/ApiError.mdx b/content/docs/references/api/contract/ApiError.mdx deleted file mode 100644 index 11ca539ed..000000000 --- a/content/docs/references/api/contract/ApiError.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ApiError -description: ApiError Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **code** | `string` | ✅ | Error code (e.g. validation_error) | -| **message** | `string` | ✅ | Readable error message | -| **details** | `any` | optional | Additional error context (e.g. field validation errors) | - -## TypeScript Usage - -```typescript -import { ApiErrorSchema } from '@objectstack/spec/api'; -import type { ApiError } from '@objectstack/spec/api'; - -// Validate data -const result = ApiErrorSchema.parse(data); - -// Type-safe usage -const myApiError: ApiError = { - code: 'example', - message: 'example' -}; -``` - diff --git a/content/docs/references/api/contract/BaseResponse.mdx b/content/docs/references/api/contract/BaseResponse.mdx deleted file mode 100644 index 18c99aacc..000000000 --- a/content/docs/references/api/contract/BaseResponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BaseResponse -description: BaseResponse Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **success** | `boolean` | ✅ | Operation success status | -| **error** | `object` | optional | Error details if success is false | -| **meta** | `object` | optional | Response metadata | - -## TypeScript Usage - -```typescript -import { BaseResponseSchema } from '@objectstack/spec/api'; -import type { BaseResponse } from '@objectstack/spec/api'; - -// Validate data -const result = BaseResponseSchema.parse(data); - -// Type-safe usage -const myBaseResponse: BaseResponse = { - success: false -}; -``` - diff --git a/content/docs/references/api/contract/BulkRequest.mdx b/content/docs/references/api/contract/BulkRequest.mdx deleted file mode 100644 index 9917c09f1..000000000 --- a/content/docs/references/api/contract/BulkRequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkRequest -description: BulkRequest Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **records** | `Record[]` | ✅ | Array of records to process | -| **allOrNone** | `boolean` | optional | If true, rollback entire transaction on any failure | - -## TypeScript Usage - -```typescript -import { BulkRequestSchema } from '@objectstack/spec/api'; -import type { BulkRequest } from '@objectstack/spec/api'; - -// Validate data -const result = BulkRequestSchema.parse(data); - -// Type-safe usage -const myBulkRequest: BulkRequest = { - records: [] -}; -``` - diff --git a/content/docs/references/api/contract/BulkResponse.mdx b/content/docs/references/api/contract/BulkResponse.mdx deleted file mode 100644 index 3c2a00ca6..000000000 --- a/content/docs/references/api/contract/BulkResponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: BulkResponse -description: BulkResponse Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **success** | `boolean` | ✅ | Operation success status | -| **error** | `object` | optional | Error details if success is false | -| **meta** | `object` | optional | Response metadata | -| **data** | `object[]` | ✅ | Results for each item in the batch | - -## TypeScript Usage - -```typescript -import { BulkResponseSchema } from '@objectstack/spec/api'; -import type { BulkResponse } from '@objectstack/spec/api'; - -// Validate data -const result = BulkResponseSchema.parse(data); - -// Type-safe usage -const myBulkResponse: BulkResponse = { - success: false, - data: [] -}; -``` - diff --git a/content/docs/references/api/contract/CreateRequest.mdx b/content/docs/references/api/contract/CreateRequest.mdx deleted file mode 100644 index 7ba9ed808..000000000 --- a/content/docs/references/api/contract/CreateRequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: CreateRequest -description: CreateRequest Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **data** | `Record` | ✅ | Record data to insert | - -## TypeScript Usage - -```typescript -import { CreateRequestSchema } from '@objectstack/spec/api'; -import type { CreateRequest } from '@objectstack/spec/api'; - -// Validate data -const result = CreateRequestSchema.parse(data); - -// Type-safe usage -const myCreateRequest: CreateRequest = { - data: {} -}; -``` - diff --git a/content/docs/references/api/contract/DeleteResponse.mdx b/content/docs/references/api/contract/DeleteResponse.mdx deleted file mode 100644 index b6f5b691a..000000000 --- a/content/docs/references/api/contract/DeleteResponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DeleteResponse -description: DeleteResponse Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **success** | `boolean` | ✅ | Operation success status | -| **error** | `object` | optional | Error details if success is false | -| **meta** | `object` | optional | Response metadata | -| **id** | `string` | ✅ | ID of the deleted record | - -## TypeScript Usage - -```typescript -import { DeleteResponseSchema } from '@objectstack/spec/api'; -import type { DeleteResponse } from '@objectstack/spec/api'; - -// Validate data -const result = DeleteResponseSchema.parse(data); - -// Type-safe usage -const myDeleteResponse: DeleteResponse = { - success: false, - id: 'example' -}; -``` - diff --git a/content/docs/references/api/contract/ExportRequest.mdx b/content/docs/references/api/contract/ExportRequest.mdx deleted file mode 100644 index 4b3d51b55..000000000 --- a/content/docs/references/api/contract/ExportRequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ExportRequest -description: ExportRequest Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **object** | `string` | ✅ | Object name (e.g. account) | -| **fields** | `string \| object[]` | optional | Fields to retrieve | -| **where** | `any` | optional | Filtering criteria (WHERE) | -| **orderBy** | `object[]` | optional | Sorting instructions (ORDER BY) | -| **limit** | `number` | optional | Max records to return (LIMIT) | -| **offset** | `number` | optional | Records to skip (OFFSET) | -| **cursor** | `Record` | optional | Cursor for keyset pagination | -| **joins** | `object[]` | optional | Explicit Table Joins | -| **aggregations** | `object[]` | optional | Aggregation functions | -| **groupBy** | `string[]` | optional | GROUP BY fields | -| **having** | `any` | optional | HAVING clause for aggregation filtering | -| **windowFunctions** | `object[]` | optional | Window functions with OVER clause | -| **distinct** | `boolean` | optional | SELECT DISTINCT flag | -| **format** | `Enum<'csv' \| 'json' \| 'xlsx'>` | optional | | - -## TypeScript Usage - -```typescript -import { ExportRequestSchema } from '@objectstack/spec/api'; -import type { ExportRequest } from '@objectstack/spec/api'; - -// Validate data -const result = ExportRequestSchema.parse(data); - -// Type-safe usage -const myExportRequest: ExportRequest = { - object: 'example' -}; -``` - diff --git a/content/docs/references/api/contract/ListRecordResponse.mdx b/content/docs/references/api/contract/ListRecordResponse.mdx deleted file mode 100644 index ccfa95b7c..000000000 --- a/content/docs/references/api/contract/ListRecordResponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListRecordResponse -description: ListRecordResponse Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **success** | `boolean` | ✅ | Operation success status | -| **error** | `object` | optional | Error details if success is false | -| **meta** | `object` | optional | Response metadata | -| **data** | `Record[]` | ✅ | Array of matching records | -| **pagination** | `object` | ✅ | Pagination info | - -## TypeScript Usage - -```typescript -import { ListRecordResponseSchema } from '@objectstack/spec/api'; -import type { ListRecordResponse } from '@objectstack/spec/api'; - -// Validate data -const result = ListRecordResponseSchema.parse(data); - -// Type-safe usage -const myListRecordResponse: ListRecordResponse = { - success: false, - data: [], - pagination: {} -}; -``` - diff --git a/content/docs/references/api/contract/ModificationResult.mdx b/content/docs/references/api/contract/ModificationResult.mdx deleted file mode 100644 index 24af2997b..000000000 --- a/content/docs/references/api/contract/ModificationResult.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ModificationResult -description: ModificationResult Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | optional | Record ID if processed | -| **success** | `boolean` | ✅ | | -| **errors** | `object[]` | optional | | - -## TypeScript Usage - -```typescript -import { ModificationResultSchema } from '@objectstack/spec/api'; -import type { ModificationResult } from '@objectstack/spec/api'; - -// Validate data -const result = ModificationResultSchema.parse(data); - -// Type-safe usage -const myModificationResult: ModificationResult = { - success: false -}; -``` - diff --git a/content/docs/references/api/contract/RecordData.mdx b/content/docs/references/api/contract/RecordData.mdx deleted file mode 100644 index 8d5c4150e..000000000 --- a/content/docs/references/api/contract/RecordData.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: RecordData -description: Key-value map of record data -category: api -zodFile: contract ---- - - -Key-value map of record data - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - diff --git a/content/docs/references/api/contract/SingleRecordResponse.mdx b/content/docs/references/api/contract/SingleRecordResponse.mdx deleted file mode 100644 index f12cbb503..000000000 --- a/content/docs/references/api/contract/SingleRecordResponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: SingleRecordResponse -description: SingleRecordResponse Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **success** | `boolean` | ✅ | Operation success status | -| **error** | `object` | optional | Error details if success is false | -| **meta** | `object` | optional | Response metadata | -| **data** | `Record` | ✅ | The requested or modified record | - -## TypeScript Usage - -```typescript -import { SingleRecordResponseSchema } from '@objectstack/spec/api'; -import type { SingleRecordResponse } from '@objectstack/spec/api'; - -// Validate data -const result = SingleRecordResponseSchema.parse(data); - -// Type-safe usage -const mySingleRecordResponse: SingleRecordResponse = { - success: false, - data: {} -}; -``` - diff --git a/content/docs/references/api/contract/UpdateRequest.mdx b/content/docs/references/api/contract/UpdateRequest.mdx deleted file mode 100644 index 3de9be142..000000000 --- a/content/docs/references/api/contract/UpdateRequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: UpdateRequest -description: UpdateRequest Schema Reference -category: api -zodFile: contract ---- - - - -**Source:** `packages/spec/src/api/contract.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **data** | `Record` | ✅ | Partial record data to update | - -## TypeScript Usage - -```typescript -import { UpdateRequestSchema } from '@objectstack/spec/api'; -import type { UpdateRequest } from '@objectstack/spec/api'; - -// Validate data -const result = UpdateRequestSchema.parse(data); - -// Type-safe usage -const myUpdateRequest: UpdateRequest = { - data: {} -}; -``` - diff --git a/content/docs/references/api/contract/meta.json b/content/docs/references/api/contract/meta.json deleted file mode 100644 index 4676f39a2..000000000 --- a/content/docs/references/api/contract/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Contract" -} \ No newline at end of file diff --git a/content/docs/references/api/discovery.mdx b/content/docs/references/api/discovery.mdx new file mode 100644 index 000000000..d9a1cbb07 --- /dev/null +++ b/content/docs/references/api/discovery.mdx @@ -0,0 +1,67 @@ +--- +title: Discovery +description: Discovery protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Discovery + + +**Source:** `packages/spec/src/api/discovery.zod.ts` + + +## TypeScript Usage + +```typescript +import { ApiCapabilitiesSchema, ApiRoutesSchema, DiscoverySchema } from '@objectstack/spec/api'; +import type { ApiCapabilities, ApiRoutes, Discovery } from '@objectstack/spec/api'; + +// Validate data +const result = ApiCapabilitiesSchema.parse(data); +``` + +--- + +## ApiCapabilities + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **graphql** | `boolean` | optional | | +| **search** | `boolean` | optional | | +| **websockets** | `boolean` | optional | | +| **files** | `boolean` | optional | | + +--- + +## ApiRoutes + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **data** | `string` | ✅ | e.g. /api/data | +| **metadata** | `string` | ✅ | e.g. /api/meta | +| **auth** | `string` | ✅ | e.g. /api/auth | +| **automation** | `string` | optional | e.g. /api/automation | +| **storage** | `string` | optional | e.g. /api/storage | +| **graphql** | `string` | optional | e.g. /graphql | + +--- + +## Discovery + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | | +| **version** | `string` | ✅ | | +| **environment** | `Enum<'production' \| 'sandbox' \| 'development'>` | ✅ | | +| **routes** | `object` | ✅ | | +| **features** | `object` | ✅ | | +| **locale** | `object` | ✅ | | + diff --git a/content/docs/references/api/discovery/ApiCapabilities.mdx b/content/docs/references/api/discovery/ApiCapabilities.mdx deleted file mode 100644 index ac92b5da9..000000000 --- a/content/docs/references/api/discovery/ApiCapabilities.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ApiCapabilities -description: ApiCapabilities Schema Reference -category: api -zodFile: discovery ---- - - - -**Source:** `packages/spec/src/api/discovery.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **graphql** | `boolean` | optional | | -| **search** | `boolean` | optional | | -| **websockets** | `boolean` | optional | | -| **files** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { ApiCapabilitiesSchema } from '@objectstack/spec/api'; -import type { ApiCapabilities } from '@objectstack/spec/api'; - -// Validate data -const result = ApiCapabilitiesSchema.parse(data); - -// Type-safe usage -const myApiCapabilities: ApiCapabilities = { -}; -``` - diff --git a/content/docs/references/api/discovery/ApiRoutes.mdx b/content/docs/references/api/discovery/ApiRoutes.mdx deleted file mode 100644 index 4452f67c7..000000000 --- a/content/docs/references/api/discovery/ApiRoutes.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApiRoutes -description: ApiRoutes Schema Reference -category: api -zodFile: discovery ---- - - - -**Source:** `packages/spec/src/api/discovery.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **data** | `string` | ✅ | e.g. /api/data | -| **metadata** | `string` | ✅ | e.g. /api/meta | -| **auth** | `string` | ✅ | e.g. /api/auth | -| **automation** | `string` | optional | e.g. /api/automation | -| **storage** | `string` | optional | e.g. /api/storage | -| **graphql** | `string` | optional | e.g. /graphql | - -## TypeScript Usage - -```typescript -import { ApiRoutesSchema } from '@objectstack/spec/api'; -import type { ApiRoutes } from '@objectstack/spec/api'; - -// Validate data -const result = ApiRoutesSchema.parse(data); - -// Type-safe usage -const myApiRoutes: ApiRoutes = { - data: 'example', - metadata: 'example', - auth: 'example' -}; -``` - diff --git a/content/docs/references/api/discovery/Discovery.mdx b/content/docs/references/api/discovery/Discovery.mdx deleted file mode 100644 index 78bf7bc75..000000000 --- a/content/docs/references/api/discovery/Discovery.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Discovery -description: Discovery Schema Reference -category: api -zodFile: discovery ---- - - - -**Source:** `packages/spec/src/api/discovery.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | | -| **version** | `string` | ✅ | | -| **environment** | `Enum<'production' \| 'sandbox' \| 'development'>` | ✅ | | -| **routes** | `object` | ✅ | | -| **features** | `object` | ✅ | | -| **locale** | `object` | ✅ | | - -## TypeScript Usage - -```typescript -import { DiscoverySchema } from '@objectstack/spec/api'; -import type { Discovery } from '@objectstack/spec/api'; - -// Validate data -const result = DiscoverySchema.parse(data); - -// Type-safe usage -const myDiscovery: Discovery = { - name: 'name', - version: 'example', - environment: 'production', - // ... other required fields -}; -``` - diff --git a/content/docs/references/api/discovery/meta.json b/content/docs/references/api/discovery/meta.json deleted file mode 100644 index dd5e6e9d5..000000000 --- a/content/docs/references/api/discovery/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Discovery" -} \ No newline at end of file diff --git a/content/docs/references/api/endpoint/ApiEndpoint.mdx b/content/docs/references/api/endpoint.mdx similarity index 55% rename from content/docs/references/api/endpoint/ApiEndpoint.mdx rename to content/docs/references/api/endpoint.mdx index 9d283de5a..92e9b6fb4 100644 --- a/content/docs/references/api/endpoint/ApiEndpoint.mdx +++ b/content/docs/references/api/endpoint.mdx @@ -1,16 +1,32 @@ --- -title: ApiEndpoint -description: ApiEndpoint Schema Reference -category: api -zodFile: endpoint +title: Endpoint +description: Endpoint protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Endpoint **Source:** `packages/spec/src/api/endpoint.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { ApiEndpointSchema, ApiMappingSchema, RateLimitSchema } from '@objectstack/spec/api'; +import type { ApiEndpoint, ApiMapping, RateLimit } from '@objectstack/spec/api'; + +// Validate data +const result = ApiEndpointSchema.parse(data); +``` + +--- + +## ApiEndpoint + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -28,21 +44,27 @@ zodFile: endpoint | **rateLimit** | `object` | optional | Rate limiting policy | | **cacheTtl** | `number` | optional | Response cache TTL in seconds | -## TypeScript Usage +--- -```typescript -import { ApiEndpointSchema } from '@objectstack/spec/api'; -import type { ApiEndpoint } from '@objectstack/spec/api'; +## ApiMapping -// Validate data -const result = ApiEndpointSchema.parse(data); +### Properties -// Type-safe usage -const myApiEndpoint: ApiEndpoint = { - name: 'name', - path: 'example', - method: 'GET', - // ... other required fields -}; -``` +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **source** | `string` | ✅ | Source field/path | +| **target** | `string` | ✅ | Target field/path | +| **transform** | `string` | optional | Transformation function name | + +--- + +## RateLimit + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **windowMs** | `number` | optional | Time window in milliseconds | +| **maxRequests** | `number` | optional | Max requests per window | diff --git a/content/docs/references/api/endpoint/ApiMapping.mdx b/content/docs/references/api/endpoint/ApiMapping.mdx deleted file mode 100644 index 5aa45328a..000000000 --- a/content/docs/references/api/endpoint/ApiMapping.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ApiMapping -description: ApiMapping Schema Reference -category: api -zodFile: endpoint ---- - - - -**Source:** `packages/spec/src/api/endpoint.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **source** | `string` | ✅ | Source field/path | -| **target** | `string` | ✅ | Target field/path | -| **transform** | `string` | optional | Transformation function name | - -## TypeScript Usage - -```typescript -import { ApiMappingSchema } from '@objectstack/spec/api'; -import type { ApiMapping } from '@objectstack/spec/api'; - -// Validate data -const result = ApiMappingSchema.parse(data); - -// Type-safe usage -const myApiMapping: ApiMapping = { - source: 'example', - target: 'example' -}; -``` - diff --git a/content/docs/references/api/endpoint/RateLimit.mdx b/content/docs/references/api/endpoint/RateLimit.mdx deleted file mode 100644 index 666c45f54..000000000 --- a/content/docs/references/api/endpoint/RateLimit.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RateLimit -description: RateLimit Schema Reference -category: api -zodFile: endpoint ---- - - - -**Source:** `packages/spec/src/api/endpoint.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **windowMs** | `number` | optional | Time window in milliseconds | -| **maxRequests** | `number` | optional | Max requests per window | - -## TypeScript Usage - -```typescript -import { RateLimitSchema } from '@objectstack/spec/api'; -import type { RateLimit } from '@objectstack/spec/api'; - -// Validate data -const result = RateLimitSchema.parse(data); - -// Type-safe usage -const myRateLimit: RateLimit = { -}; -``` - diff --git a/content/docs/references/api/endpoint/meta.json b/content/docs/references/api/endpoint/meta.json deleted file mode 100644 index 1a36a9f9c..000000000 --- a/content/docs/references/api/endpoint/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Endpoint" -} \ No newline at end of file diff --git a/content/docs/references/api/index.mdx b/content/docs/references/api/index.mdx index b62c9e521..f633a10bc 100644 --- a/content/docs/references/api/index.mdx +++ b/content/docs/references/api/index.mdx @@ -3,85 +3,18 @@ title: API Protocol Overview description: Complete reference for all api protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # API Protocol This section contains all protocol schemas for the api layer of ObjectStack. -## Contract - -Source: `packages/spec/src/api/contract.zod.ts` - - - - - - - - - - - - - - - - -## Discovery - -Source: `packages/spec/src/api/discovery.zod.ts` - - - - - - - -## Endpoint - -Source: `packages/spec/src/api/endpoint.zod.ts` - - - - - - - -## Odata - -Source: `packages/spec/src/api/odata.zod.ts` - - - - - - - - - - -## Realtime - -Source: `packages/spec/src/api/realtime.zod.ts` - - - - - - - - - - - - -## Router - -Source: `packages/spec/src/api/router.zod.ts` - - - - + + + + + + diff --git a/content/docs/references/api/odata.mdx b/content/docs/references/api/odata.mdx new file mode 100644 index 000000000..2fc63d7be --- /dev/null +++ b/content/docs/references/api/odata.mdx @@ -0,0 +1,133 @@ +--- +title: Odata +description: Odata protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Odata + + +**Source:** `packages/spec/src/api/odata.zod.ts` + + +## TypeScript Usage + +```typescript +import { ODataErrorSchema, ODataFilterFunctionSchema, ODataFilterOperatorSchema, ODataMetadataSchema, ODataQuerySchema, ODataResponseSchema } from '@objectstack/spec/api'; +import type { ODataError, ODataFilterFunction, ODataFilterOperator, ODataMetadata, ODataQuery, ODataResponse } from '@objectstack/spec/api'; + +// Validate data +const result = ODataErrorSchema.parse(data); +``` + +--- + +## ODataError + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **error** | `object` | ✅ | | + +--- + +## ODataFilterFunction + +### Allowed Values + +* `contains` +* `startswith` +* `endswith` +* `length` +* `indexof` +* `substring` +* `tolower` +* `toupper` +* `trim` +* `concat` +* `year` +* `month` +* `day` +* `hour` +* `minute` +* `second` +* `date` +* `time` +* `now` +* `maxdatetime` +* `mindatetime` +* `round` +* `floor` +* `ceiling` +* `cast` +* `isof` +* `any` +* `all` + +--- + +## ODataFilterOperator + +### Allowed Values + +* `eq` +* `ne` +* `lt` +* `le` +* `gt` +* `ge` +* `and` +* `or` +* `not` +* `(` +* `)` +* `in` +* `has` + +--- + +## ODataMetadata + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **namespace** | `string` | ✅ | Service namespace | +| **entityTypes** | `object[]` | ✅ | Entity types | +| **entitySets** | `object[]` | ✅ | Entity sets | + +--- + +## ODataQuery + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$select** | `string \| string[]` | optional | Fields to select | +| **$filter** | `string` | optional | Filter expression (OData filter syntax) | +| **$orderby** | `string \| string[]` | optional | Sort order | +| **$top** | `integer` | optional | Max results to return | +| **$skip** | `integer` | optional | Results to skip | +| **$expand** | `string \| string[]` | optional | Navigation properties to expand | +| **$count** | `boolean` | optional | Include total count | +| **$search** | `string` | optional | Search expression | +| **$format** | `Enum<'json' \| 'xml' \| 'atom'>` | optional | Response format | +| **$apply** | `string` | optional | Aggregation expression | + +--- + +## ODataResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **@odata.context** | `string` | optional | Metadata context URL | +| **@odata.count** | `integer` | optional | Total results count | +| **@odata.nextLink** | `string` | optional | Next page URL | +| **value** | `Record[]` | ✅ | Results array | + diff --git a/content/docs/references/api/odata/ODataError.mdx b/content/docs/references/api/odata/ODataError.mdx deleted file mode 100644 index cc814f826..000000000 --- a/content/docs/references/api/odata/ODataError.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ODataError -description: ODataError Schema Reference -category: api -zodFile: odata ---- - - - -**Source:** `packages/spec/src/api/odata.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **error** | `object` | ✅ | | - -## TypeScript Usage - -```typescript -import { ODataErrorSchema } from '@objectstack/spec/api'; -import type { ODataError } from '@objectstack/spec/api'; - -// Validate data -const result = ODataErrorSchema.parse(data); - -// Type-safe usage -const myODataError: ODataError = { - error: {} -}; -``` - diff --git a/content/docs/references/api/odata/ODataFilterFunction.mdx b/content/docs/references/api/odata/ODataFilterFunction.mdx deleted file mode 100644 index 4d67ed223..000000000 --- a/content/docs/references/api/odata/ODataFilterFunction.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ODataFilterFunction -description: ODataFilterFunction Schema Reference -category: api -zodFile: odata ---- - - - -**Source:** `packages/spec/src/api/odata.zod.ts` - - -## Allowed Values - -* `contains` -* `startswith` -* `endswith` -* `length` -* `indexof` -* `substring` -* `tolower` -* `toupper` -* `trim` -* `concat` -* `year` -* `month` -* `day` -* `hour` -* `minute` -* `second` -* `date` -* `time` -* `now` -* `maxdatetime` -* `mindatetime` -* `round` -* `floor` -* `ceiling` -* `cast` -* `isof` -* `any` -* `all` - -## TypeScript Usage - -```typescript -import { ODataFilterFunction } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: ODataFilterFunction = 'contains'; -``` - diff --git a/content/docs/references/api/odata/ODataFilterOperator.mdx b/content/docs/references/api/odata/ODataFilterOperator.mdx deleted file mode 100644 index 869831ae7..000000000 --- a/content/docs/references/api/odata/ODataFilterOperator.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ODataFilterOperator -description: ODataFilterOperator Schema Reference -category: api -zodFile: odata ---- - - - -**Source:** `packages/spec/src/api/odata.zod.ts` - - -## Allowed Values - -* `eq` -* `ne` -* `lt` -* `le` -* `gt` -* `ge` -* `and` -* `or` -* `not` -* `(` -* `)` -* `in` -* `has` - -## TypeScript Usage - -```typescript -import { ODataFilterOperator } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: ODataFilterOperator = 'eq'; -``` - diff --git a/content/docs/references/api/odata/ODataMetadata.mdx b/content/docs/references/api/odata/ODataMetadata.mdx deleted file mode 100644 index 071895b9e..000000000 --- a/content/docs/references/api/odata/ODataMetadata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ODataMetadata -description: ODataMetadata Schema Reference -category: api -zodFile: odata ---- - - - -**Source:** `packages/spec/src/api/odata.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **namespace** | `string` | ✅ | Service namespace | -| **entityTypes** | `object[]` | ✅ | Entity types | -| **entitySets** | `object[]` | ✅ | Entity sets | - -## TypeScript Usage - -```typescript -import { ODataMetadataSchema } from '@objectstack/spec/api'; -import type { ODataMetadata } from '@objectstack/spec/api'; - -// Validate data -const result = ODataMetadataSchema.parse(data); - -// Type-safe usage -const myODataMetadata: ODataMetadata = { - namespace: 'namespace', - entityTypes: [], - entitySets: [] -}; -``` - diff --git a/content/docs/references/api/odata/ODataQuery.mdx b/content/docs/references/api/odata/ODataQuery.mdx deleted file mode 100644 index 47d7aa01a..000000000 --- a/content/docs/references/api/odata/ODataQuery.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ODataQuery -description: ODataQuery Schema Reference -category: api -zodFile: odata ---- - - - -**Source:** `packages/spec/src/api/odata.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$select** | `string \| string[]` | optional | Fields to select | -| **$filter** | `string` | optional | Filter expression (OData filter syntax) | -| **$orderby** | `string \| string[]` | optional | Sort order | -| **$top** | `integer` | optional | Max results to return | -| **$skip** | `integer` | optional | Results to skip | -| **$expand** | `string \| string[]` | optional | Navigation properties to expand | -| **$count** | `boolean` | optional | Include total count | -| **$search** | `string` | optional | Search expression | -| **$format** | `Enum<'json' \| 'xml' \| 'atom'>` | optional | Response format | -| **$apply** | `string` | optional | Aggregation expression | - -## TypeScript Usage - -```typescript -import { ODataQuerySchema } from '@objectstack/spec/api'; -import type { ODataQuery } from '@objectstack/spec/api'; - -// Validate data -const result = ODataQuerySchema.parse(data); - -// Type-safe usage -const myODataQuery: ODataQuery = { -}; -``` - diff --git a/content/docs/references/api/odata/ODataResponse.mdx b/content/docs/references/api/odata/ODataResponse.mdx deleted file mode 100644 index ed59f747e..000000000 --- a/content/docs/references/api/odata/ODataResponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ODataResponse -description: ODataResponse Schema Reference -category: api -zodFile: odata ---- - - - -**Source:** `packages/spec/src/api/odata.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **@odata.context** | `string` | optional | Metadata context URL | -| **@odata.count** | `integer` | optional | Total results count | -| **@odata.nextLink** | `string` | optional | Next page URL | -| **value** | `Record[]` | ✅ | Results array | - -## TypeScript Usage - -```typescript -import { ODataResponseSchema } from '@objectstack/spec/api'; -import type { ODataResponse } from '@objectstack/spec/api'; - -// Validate data -const result = ODataResponseSchema.parse(data); - -// Type-safe usage -const myODataResponse: ODataResponse = { - value: [] -}; -``` - diff --git a/content/docs/references/api/odata/meta.json b/content/docs/references/api/odata/meta.json deleted file mode 100644 index e030c4de3..000000000 --- a/content/docs/references/api/odata/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Odata" -} \ No newline at end of file diff --git a/content/docs/references/api/realtime.mdx b/content/docs/references/api/realtime.mdx new file mode 100644 index 000000000..d517558de --- /dev/null +++ b/content/docs/references/api/realtime.mdx @@ -0,0 +1,119 @@ +--- +title: Realtime +description: Realtime protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Realtime + + +**Source:** `packages/spec/src/api/realtime.zod.ts` + + +## TypeScript Usage + +```typescript +import { PresenceSchema, PresenceStatusSchema, RealtimeActionSchema, RealtimeEventSchema, RealtimeEventTypeSchema, SubscriptionSchema, SubscriptionEventSchema, TransportProtocolSchema } from '@objectstack/spec/api'; +import type { Presence, PresenceStatus, RealtimeAction, RealtimeEvent, RealtimeEventType, Subscription, SubscriptionEvent, TransportProtocol } from '@objectstack/spec/api'; + +// Validate data +const result = PresenceSchema.parse(data); +``` + +--- + +## Presence + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **userId** | `string` | ✅ | User identifier | +| **status** | `Enum<'online' \| 'away' \| 'offline'>` | ✅ | Current presence status | +| **lastSeen** | `string` | ✅ | ISO 8601 datetime of last activity | +| **metadata** | `Record` | optional | Custom presence data (e.g., current page, custom status) | + +--- + +## PresenceStatus + +### Allowed Values + +* `online` +* `away` +* `offline` + +--- + +## RealtimeAction + +### Allowed Values + +* `created` +* `updated` +* `deleted` + +--- + +## RealtimeEvent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique event identifier | +| **type** | `string` | ✅ | Event type (e.g., record.created, record.updated) | +| **object** | `string` | optional | Object name the event relates to | +| **action** | `Enum<'created' \| 'updated' \| 'deleted'>` | optional | Action performed | +| **payload** | `any` | optional | Event payload data | +| **timestamp** | `string` | ✅ | ISO 8601 datetime when event occurred | +| **userId** | `string` | optional | User who triggered the event | + +--- + +## RealtimeEventType + +### Allowed Values + +* `record.created` +* `record.updated` +* `record.deleted` +* `field.changed` + +--- + +## Subscription + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique subscription identifier | +| **events** | `object[]` | ✅ | Array of events to subscribe to | +| **transport** | `Enum<'websocket' \| 'sse' \| 'polling'>` | ✅ | Transport protocol to use | +| **channel** | `string` | optional | Optional channel name for grouping subscriptions | + +--- + +## SubscriptionEvent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'record.created' \| 'record.updated' \| 'record.deleted' \| 'field.changed'>` | ✅ | Type of event to subscribe to | +| **object** | `string` | optional | Object name to subscribe to | +| **filters** | `any` | optional | Filter conditions | + +--- + +## TransportProtocol + +### Allowed Values + +* `websocket` +* `sse` +* `polling` + diff --git a/content/docs/references/api/realtime/Presence.mdx b/content/docs/references/api/realtime/Presence.mdx deleted file mode 100644 index 9664a28c8..000000000 --- a/content/docs/references/api/realtime/Presence.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Presence -description: Presence Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **userId** | `string` | ✅ | User identifier | -| **status** | `Enum<'online' \| 'away' \| 'offline'>` | ✅ | Current presence status | -| **lastSeen** | `string` | ✅ | ISO 8601 datetime of last activity | -| **metadata** | `Record` | optional | Custom presence data (e.g., current page, custom status) | - -## TypeScript Usage - -```typescript -import { PresenceSchema } from '@objectstack/spec/api'; -import type { Presence } from '@objectstack/spec/api'; - -// Validate data -const result = PresenceSchema.parse(data); - -// Type-safe usage -const myPresence: Presence = { - userId: 'example', - status: 'online', - lastSeen: 'example' -}; -``` - diff --git a/content/docs/references/api/realtime/PresenceStatus.mdx b/content/docs/references/api/realtime/PresenceStatus.mdx deleted file mode 100644 index 9dd97e3f7..000000000 --- a/content/docs/references/api/realtime/PresenceStatus.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: PresenceStatus -description: PresenceStatus Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Allowed Values - -* `online` -* `away` -* `offline` - -## TypeScript Usage - -```typescript -import { PresenceStatus } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: PresenceStatus = 'online'; -``` - diff --git a/content/docs/references/api/realtime/RealtimeAction.mdx b/content/docs/references/api/realtime/RealtimeAction.mdx deleted file mode 100644 index 62ab17dc5..000000000 --- a/content/docs/references/api/realtime/RealtimeAction.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: RealtimeAction -description: RealtimeAction Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Allowed Values - -* `created` -* `updated` -* `deleted` - -## TypeScript Usage - -```typescript -import { RealtimeAction } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: RealtimeAction = 'created'; -``` - diff --git a/content/docs/references/api/realtime/RealtimeEvent.mdx b/content/docs/references/api/realtime/RealtimeEvent.mdx deleted file mode 100644 index 47a600bb0..000000000 --- a/content/docs/references/api/realtime/RealtimeEvent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: RealtimeEvent -description: RealtimeEvent Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique event identifier | -| **type** | `string` | ✅ | Event type (e.g., record.created, record.updated) | -| **object** | `string` | optional | Object name the event relates to | -| **action** | `Enum<'created' \| 'updated' \| 'deleted'>` | optional | Action performed | -| **payload** | `any` | optional | Event payload data | -| **timestamp** | `string` | ✅ | ISO 8601 datetime when event occurred | -| **userId** | `string` | optional | User who triggered the event | - -## TypeScript Usage - -```typescript -import { RealtimeEventSchema } from '@objectstack/spec/api'; -import type { RealtimeEvent } from '@objectstack/spec/api'; - -// Validate data -const result = RealtimeEventSchema.parse(data); - -// Type-safe usage -const myRealtimeEvent: RealtimeEvent = { - id: 'example', - type: 'example', - timestamp: 'example' -}; -``` - diff --git a/content/docs/references/api/realtime/RealtimeEventType.mdx b/content/docs/references/api/realtime/RealtimeEventType.mdx deleted file mode 100644 index 68ee1f2f3..000000000 --- a/content/docs/references/api/realtime/RealtimeEventType.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: RealtimeEventType -description: RealtimeEventType Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Allowed Values - -* `record.created` -* `record.updated` -* `record.deleted` -* `field.changed` - -## TypeScript Usage - -```typescript -import { RealtimeEventType } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: RealtimeEventType = 'record.created'; -``` - diff --git a/content/docs/references/api/realtime/Subscription.mdx b/content/docs/references/api/realtime/Subscription.mdx deleted file mode 100644 index d27617976..000000000 --- a/content/docs/references/api/realtime/Subscription.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Subscription -description: Subscription Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique subscription identifier | -| **events** | `object[]` | ✅ | Array of events to subscribe to | -| **transport** | `Enum<'websocket' \| 'sse' \| 'polling'>` | ✅ | Transport protocol to use | -| **channel** | `string` | optional | Optional channel name for grouping subscriptions | - -## TypeScript Usage - -```typescript -import { SubscriptionSchema } from '@objectstack/spec/api'; -import type { Subscription } from '@objectstack/spec/api'; - -// Validate data -const result = SubscriptionSchema.parse(data); - -// Type-safe usage -const mySubscription: Subscription = { - id: 'example', - events: [], - transport: 'websocket' -}; -``` - diff --git a/content/docs/references/api/realtime/SubscriptionEvent.mdx b/content/docs/references/api/realtime/SubscriptionEvent.mdx deleted file mode 100644 index e15fe9757..000000000 --- a/content/docs/references/api/realtime/SubscriptionEvent.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SubscriptionEvent -description: SubscriptionEvent Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'record.created' \| 'record.updated' \| 'record.deleted' \| 'field.changed'>` | ✅ | Type of event to subscribe to | -| **object** | `string` | optional | Object name to subscribe to | -| **filters** | `any` | optional | Filter conditions | - -## TypeScript Usage - -```typescript -import { SubscriptionEventSchema } from '@objectstack/spec/api'; -import type { SubscriptionEvent } from '@objectstack/spec/api'; - -// Validate data -const result = SubscriptionEventSchema.parse(data); - -// Type-safe usage -const mySubscriptionEvent: SubscriptionEvent = { - type: 'record.created' -}; -``` - diff --git a/content/docs/references/api/realtime/TransportProtocol.mdx b/content/docs/references/api/realtime/TransportProtocol.mdx deleted file mode 100644 index 253172acf..000000000 --- a/content/docs/references/api/realtime/TransportProtocol.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TransportProtocol -description: TransportProtocol Schema Reference -category: api -zodFile: realtime ---- - - - -**Source:** `packages/spec/src/api/realtime.zod.ts` - - -## Allowed Values - -* `websocket` -* `sse` -* `polling` - -## TypeScript Usage - -```typescript -import { TransportProtocol } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: TransportProtocol = 'websocket'; -``` - diff --git a/content/docs/references/api/realtime/meta.json b/content/docs/references/api/realtime/meta.json deleted file mode 100644 index f9c14dee9..000000000 --- a/content/docs/references/api/realtime/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Realtime" -} \ No newline at end of file diff --git a/content/docs/references/api/router/RouteDefinition.mdx b/content/docs/references/api/router.mdx similarity index 51% rename from content/docs/references/api/router/RouteDefinition.mdx rename to content/docs/references/api/router.mdx index 64cb75549..11e46eb67 100644 --- a/content/docs/references/api/router/RouteDefinition.mdx +++ b/content/docs/references/api/router.mdx @@ -1,16 +1,45 @@ --- -title: RouteDefinition -description: RouteDefinition Schema Reference -category: api -zodFile: router +title: Router +description: Router protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Router **Source:** `packages/spec/src/api/router.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { RouteCategorySchema, RouteDefinitionSchema, RouterConfigSchema } from '@objectstack/spec/api'; +import type { RouteCategory, RouteDefinition, RouterConfig } from '@objectstack/spec/api'; + +// Validate data +const result = RouteCategorySchema.parse(data); +``` + +--- + +## RouteCategory + +### Allowed Values + +* `system` +* `api` +* `auth` +* `static` +* `webhook` +* `plugin` + +--- + +## RouteDefinition + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -25,20 +54,16 @@ zodFile: router | **timeout** | `integer` | optional | Execution timeout in ms | | **rateLimit** | `string` | optional | Rate limit policy name | -## TypeScript Usage +--- -```typescript -import { RouteDefinitionSchema } from '@objectstack/spec/api'; -import type { RouteDefinition } from '@objectstack/spec/api'; +## RouterConfig -// Validate data -const result = RouteDefinitionSchema.parse(data); - -// Type-safe usage -const myRouteDefinition: RouteDefinition = { - method: 'GET', - path: 'example', - handler: 'example' -}; -``` +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **basePath** | `string` | optional | Global API prefix | +| **mounts** | `object` | optional | | +| **cors** | `object` | optional | | +| **staticMounts** | `object[]` | optional | | diff --git a/content/docs/references/api/router/RouteCategory.mdx b/content/docs/references/api/router/RouteCategory.mdx deleted file mode 100644 index 3adaf9991..000000000 --- a/content/docs/references/api/router/RouteCategory.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: RouteCategory -description: RouteCategory Schema Reference -category: api -zodFile: router ---- - - - -**Source:** `packages/spec/src/api/router.zod.ts` - - -## Allowed Values - -* `system` -* `api` -* `auth` -* `static` -* `webhook` -* `plugin` - -## TypeScript Usage - -```typescript -import { RouteCategory } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: RouteCategory = 'system'; -``` - diff --git a/content/docs/references/api/router/RouterConfig.mdx b/content/docs/references/api/router/RouterConfig.mdx deleted file mode 100644 index deec8b457..000000000 --- a/content/docs/references/api/router/RouterConfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RouterConfig -description: RouterConfig Schema Reference -category: api -zodFile: router ---- - - - -**Source:** `packages/spec/src/api/router.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **basePath** | `string` | optional | Global API prefix | -| **mounts** | `object` | optional | | -| **cors** | `object` | optional | | -| **staticMounts** | `object[]` | optional | | - -## TypeScript Usage - -```typescript -import { RouterConfigSchema } from '@objectstack/spec/api'; -import type { RouterConfig } from '@objectstack/spec/api'; - -// Validate data -const result = RouterConfigSchema.parse(data); - -// Type-safe usage -const myRouterConfig: RouterConfig = { -}; -``` - diff --git a/content/docs/references/api/router/meta.json b/content/docs/references/api/router/meta.json deleted file mode 100644 index ca23566ad..000000000 --- a/content/docs/references/api/router/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Router" -} \ No newline at end of file diff --git a/content/docs/references/api/view.mdx b/content/docs/references/api/view.mdx new file mode 100644 index 000000000..9b55e8f5a --- /dev/null +++ b/content/docs/references/api/view.mdx @@ -0,0 +1,38 @@ +--- +title: View +description: View protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# View + + +**Source:** `packages/spec/src/api/view.zod.ts` + + +## TypeScript Usage + +```typescript +import { HttpMethodSchema } from '@objectstack/spec/api'; +import type { HttpMethod } from '@objectstack/spec/api'; + +// Validate data +const result = HttpMethodSchema.parse(data); +``` + +--- + +## HttpMethod + +### Allowed Values + +* `GET` +* `POST` +* `PUT` +* `DELETE` +* `PATCH` +* `HEAD` +* `OPTIONS` + diff --git a/content/docs/references/api/view/HttpMethod.mdx b/content/docs/references/api/view/HttpMethod.mdx deleted file mode 100644 index 2186f8a97..000000000 --- a/content/docs/references/api/view/HttpMethod.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: HttpMethod -description: HttpMethod Schema Reference -category: api -zodFile: view ---- - - - -**Source:** `packages/spec/src/api/view.zod.ts` - - -## Allowed Values - -* `GET` -* `POST` -* `PUT` -* `DELETE` -* `PATCH` -* `HEAD` -* `OPTIONS` - -## TypeScript Usage - -```typescript -import { HttpMethod } from '@objectstack/spec/api'; - -// Type-safe enum value -const value: HttpMethod = 'GET'; -``` - diff --git a/content/docs/references/auth/config.mdx b/content/docs/references/auth/config.mdx new file mode 100644 index 000000000..76c0dd922 --- /dev/null +++ b/content/docs/references/auth/config.mdx @@ -0,0 +1,329 @@ +--- +title: Config +description: Config protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Config + + +**Source:** `packages/spec/src/auth/config.zod.ts` + + +## TypeScript Usage + +```typescript +import { AccountLinkingConfigSchema, AuthConfigSchema, AuthPluginConfigSchema, AuthStrategySchema, CSRFConfigSchema, DatabaseAdapterSchema, DatabaseMappingSchema, EmailPasswordConfigSchema, EnterpriseAuthConfigSchema, LDAPConfigSchema, MagicLinkConfigSchema, OAuthProviderSchema, OIDCConfigSchema, PasskeyConfigSchema, RateLimitConfigSchema, SAMLConfigSchema, SessionConfigSchema, StandardAuthProviderSchema, TwoFactorConfigSchema, UserFieldMappingSchema } from '@objectstack/spec/auth'; +import type { AccountLinkingConfig, AuthConfig, AuthPluginConfig, AuthStrategy, CSRFConfig, DatabaseAdapter, DatabaseMapping, EmailPasswordConfig, EnterpriseAuthConfig, LDAPConfig, MagicLinkConfig, OAuthProvider, OIDCConfig, PasskeyConfig, RateLimitConfig, SAMLConfig, SessionConfig, StandardAuthProvider, TwoFactorConfig, UserFieldMapping } from '@objectstack/spec/auth'; + +// Validate data +const result = AccountLinkingConfigSchema.parse(data); +``` + +--- + +## AccountLinkingConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | Allow account linking | +| **autoLink** | `boolean` | optional | Automatically link accounts with same email | +| **requireVerification** | `boolean` | optional | Require email verification before linking | + +--- + +## AuthConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Configuration name (snake_case) | +| **label** | `string` | ✅ | Display label | +| **driver** | `string` | optional | The underlying authentication implementation driver | +| **strategies** | `Enum<'email_password' \| 'magic_link' \| 'oauth' \| 'passkey' \| 'otp' \| 'anonymous'>[]` | ✅ | Enabled authentication strategies | +| **baseUrl** | `string` | ✅ | Application base URL | +| **secret** | `string` | ✅ | Secret key for signing (min 32 chars) | +| **emailPassword** | `object` | optional | | +| **magicLink** | `object` | optional | | +| **passkey** | `object` | optional | | +| **oauth** | `object` | optional | | +| **session** | `object` | optional | | +| **rateLimit** | `object` | optional | | +| **csrf** | `object` | optional | | +| **accountLinking** | `object` | optional | | +| **twoFactor** | `object` | optional | | +| **organization** | `object` | optional | Organization/multi-tenant configuration | +| **enterprise** | `object` | optional | | +| **userFieldMapping** | `object` | optional | | +| **database** | `object` | optional | | +| **mapping** | `object` | optional | | +| **plugins** | `object[]` | optional | | +| **hooks** | `object` | optional | Authentication lifecycle hooks | +| **security** | `object` | optional | Advanced security settings | +| **email** | `object` | optional | Email configuration | +| **ui** | `object` | optional | UI customization | +| **active** | `boolean` | optional | Whether this provider is active | +| **allowRegistration** | `boolean` | optional | Allow new user registration | + +--- + +## AuthPluginConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Plugin name | +| **enabled** | `boolean` | optional | | +| **options** | `Record` | optional | Plugin-specific options | + +--- + +## AuthStrategy + +### Allowed Values + +* `email_password` +* `magic_link` +* `oauth` +* `passkey` +* `otp` +* `anonymous` + +--- + +## CSRFConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **tokenLength** | `number` | optional | CSRF token length | +| **cookieName** | `string` | optional | CSRF cookie name | +| **headerName** | `string` | optional | CSRF header name | + +--- + +## DatabaseAdapter + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'prisma' \| 'drizzle' \| 'kysely' \| 'custom'>` | ✅ | Database adapter type | +| **connectionString** | `string` | optional | Database connection string | +| **tablePrefix** | `string` | optional | Prefix for auth tables | +| **schema** | `string` | optional | Database schema name | + +--- + +## DatabaseMapping + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **user** | `Record` | optional | User field mapping (e.g., `{ "emailVerified": "email_verified" }`) | +| **session** | `Record` | optional | Session field mapping | +| **account** | `Record` | optional | Account field mapping | +| **verificationToken** | `Record` | optional | VerificationToken field mapping | + +--- + +## EmailPasswordConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **requireEmailVerification** | `boolean` | optional | Require email verification before login | +| **minPasswordLength** | `number` | optional | Minimum password length | +| **requirePasswordComplexity** | `boolean` | optional | Require uppercase, lowercase, numbers, symbols | +| **allowPasswordReset** | `boolean` | optional | Enable password reset functionality | +| **passwordResetExpiry** | `number` | optional | Password reset token expiry in seconds | + +--- + +## EnterpriseAuthConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **oidc** | `object` | optional | OpenID Connect configuration | +| **saml** | `object` | optional | SAML 2.0 configuration | +| **ldap** | `object` | optional | LDAP/Active Directory configuration | + +--- + +## LDAPConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **url** | `string` | ✅ | LDAP Server URL (ldap:// or ldaps://) | +| **bindDn** | `string` | ✅ | Bind DN for LDAP authentication | +| **bindCredentials** | `string` | ✅ | Bind credentials | +| **searchBase** | `string` | ✅ | Search base DN | +| **searchFilter** | `string` | ✅ | Search filter | +| **groupSearchBase** | `string` | optional | Group search base DN | +| **displayName** | `string` | optional | Display name for the provider button | +| **icon** | `string` | optional | Icon URL or identifier | + +--- + +## MagicLinkConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **expiryTime** | `number` | optional | Magic link expiry time in seconds (default 15 min) | + +--- + +## OAuthProvider + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **provider** | `Enum<'google' \| 'github' \| 'facebook' \| 'twitter' \| 'linkedin' \| 'microsoft' \| 'apple' \| 'discord' \| 'gitlab' \| 'custom'>` | ✅ | OAuth provider type | +| **clientId** | `string` | ✅ | OAuth client ID | +| **clientSecret** | `string` | ✅ | OAuth client secret (typically from ENV) | +| **scopes** | `string[]` | optional | Requested OAuth scopes | +| **redirectUri** | `string` | optional | OAuth callback URL | +| **enabled** | `boolean` | optional | Whether this provider is enabled | +| **displayName** | `string` | optional | Display name for the provider button | +| **icon** | `string` | optional | Icon URL or identifier | + +--- + +## OIDCConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **issuer** | `string` | ✅ | OIDC Issuer URL (.well-known/openid-configuration) | +| **clientId** | `string` | ✅ | OIDC client ID | +| **clientSecret** | `string` | ✅ | OIDC client secret | +| **scopes** | `string[]` | optional | OIDC scopes | +| **attributeMapping** | `Record` | optional | Map IdP claims to User fields | +| **displayName** | `string` | optional | Display name for the provider button | +| **icon** | `string` | optional | Icon URL or identifier | + +--- + +## PasskeyConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **rpName** | `string` | ✅ | Relying Party name | +| **rpId** | `string` | optional | Relying Party ID (defaults to domain) | +| **allowedOrigins** | `string[]` | optional | Allowed origins for WebAuthn | +| **userVerification** | `Enum<'required' \| 'preferred' \| 'discouraged'>` | optional | | +| **attestation** | `Enum<'none' \| 'indirect' \| 'direct' \| 'enterprise'>` | optional | | + +--- + +## RateLimitConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **maxAttempts** | `number` | optional | Maximum login attempts | +| **windowMs** | `number` | optional | Time window in milliseconds (default 15 min) | +| **blockDuration** | `number` | optional | Block duration after max attempts in ms | +| **skipSuccessfulRequests** | `boolean` | optional | Only count failed requests | + +--- + +## SAMLConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **entryPoint** | `string` | ✅ | IdP SSO URL | +| **cert** | `string` | ✅ | IdP Public Certificate (PEM format) | +| **issuer** | `string` | ✅ | Entity ID of the IdP | +| **signatureAlgorithm** | `Enum<'sha256' \| 'sha512'>` | optional | Signature algorithm | +| **attributeMapping** | `Record` | optional | Map SAML attributes to User fields | +| **displayName** | `string` | optional | Display name for the provider button | +| **icon** | `string` | optional | Icon URL or identifier | + +--- + +## SessionConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **expiresIn** | `number` | optional | Session expiry in seconds (default 7 days) | +| **updateAge** | `number` | optional | Session update interval in seconds (default 1 day) | +| **cookieName** | `string` | optional | Session cookie name | +| **cookieSecure** | `boolean` | optional | Use secure cookies (HTTPS only) | +| **cookieSameSite** | `Enum<'strict' \| 'lax' \| 'none'>` | optional | SameSite cookie attribute | +| **cookieDomain** | `string` | optional | Cookie domain | +| **cookiePath** | `string` | optional | Cookie path | +| **cookieHttpOnly** | `boolean` | optional | HttpOnly cookie attribute | + +--- + +## StandardAuthProvider + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `string` | ✅ | Provider type identifier | +| **config** | `object` | ✅ | Standard authentication configuration | + +--- + +## TwoFactorConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | | +| **issuer** | `string` | optional | TOTP issuer name | +| **qrCodeSize** | `number` | optional | QR code size in pixels | +| **backupCodes** | `object` | optional | | + +--- + +## UserFieldMapping + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | optional | User ID field | +| **email** | `string` | optional | Email field | +| **name** | `string` | optional | Name field | +| **image** | `string` | optional | Profile image field | +| **emailVerified** | `string` | optional | Email verification status field | +| **createdAt** | `string` | optional | Created timestamp field | +| **updatedAt** | `string` | optional | Updated timestamp field | + diff --git a/content/docs/references/auth/config/AccountLinkingConfig.mdx b/content/docs/references/auth/config/AccountLinkingConfig.mdx deleted file mode 100644 index c431d2968..000000000 --- a/content/docs/references/auth/config/AccountLinkingConfig.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AccountLinkingConfig -description: AccountLinkingConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | Allow account linking | -| **autoLink** | `boolean` | optional | Automatically link accounts with same email | -| **requireVerification** | `boolean` | optional | Require email verification before linking | - -## TypeScript Usage - -```typescript -import { AccountLinkingConfigSchema } from '@objectstack/spec/auth'; -import type { AccountLinkingConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = AccountLinkingConfigSchema.parse(data); - -// Type-safe usage -const myAccountLinkingConfig: AccountLinkingConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/AuthConfig.mdx b/content/docs/references/auth/config/AuthConfig.mdx deleted file mode 100644 index 510214882..000000000 --- a/content/docs/references/auth/config/AuthConfig.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: AuthConfig -description: AuthConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Configuration name (snake_case) | -| **label** | `string` | ✅ | Display label | -| **driver** | `string` | optional | The underlying authentication implementation driver | -| **strategies** | `Enum<'email_password' \| 'magic_link' \| 'oauth' \| 'passkey' \| 'otp' \| 'anonymous'>[]` | ✅ | Enabled authentication strategies | -| **baseUrl** | `string` | ✅ | Application base URL | -| **secret** | `string` | ✅ | Secret key for signing (min 32 chars) | -| **emailPassword** | `object` | optional | | -| **magicLink** | `object` | optional | | -| **passkey** | `object` | optional | | -| **oauth** | `object` | optional | | -| **session** | `object` | optional | | -| **rateLimit** | `object` | optional | | -| **csrf** | `object` | optional | | -| **accountLinking** | `object` | optional | | -| **twoFactor** | `object` | optional | | -| **organization** | `object` | optional | Organization/multi-tenant configuration | -| **enterprise** | `object` | optional | | -| **userFieldMapping** | `object` | optional | | -| **database** | `object` | optional | | -| **mapping** | `object` | optional | | -| **plugins** | `object[]` | optional | | -| **hooks** | `object` | optional | Authentication lifecycle hooks | -| **security** | `object` | optional | Advanced security settings | -| **email** | `object` | optional | Email configuration | -| **ui** | `object` | optional | UI customization | -| **active** | `boolean` | optional | Whether this provider is active | -| **allowRegistration** | `boolean` | optional | Allow new user registration | - -## TypeScript Usage - -```typescript -import { AuthConfigSchema } from '@objectstack/spec/auth'; -import type { AuthConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = AuthConfigSchema.parse(data); - -// Type-safe usage -const myAuthConfig: AuthConfig = { - name: 'name', - label: 'example', - strategies: [], - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/config/AuthPluginConfig.mdx b/content/docs/references/auth/config/AuthPluginConfig.mdx deleted file mode 100644 index a729ab68d..000000000 --- a/content/docs/references/auth/config/AuthPluginConfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AuthPluginConfig -description: AuthPluginConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Plugin name | -| **enabled** | `boolean` | optional | | -| **options** | `Record` | optional | Plugin-specific options | - -## TypeScript Usage - -```typescript -import { AuthPluginConfigSchema } from '@objectstack/spec/auth'; -import type { AuthPluginConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = AuthPluginConfigSchema.parse(data); - -// Type-safe usage -const myAuthPluginConfig: AuthPluginConfig = { - name: 'name' -}; -``` - diff --git a/content/docs/references/auth/config/AuthStrategy.mdx b/content/docs/references/auth/config/AuthStrategy.mdx deleted file mode 100644 index c0fd8a890..000000000 --- a/content/docs/references/auth/config/AuthStrategy.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: AuthStrategy -description: AuthStrategy Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Allowed Values - -* `email_password` -* `magic_link` -* `oauth` -* `passkey` -* `otp` -* `anonymous` - -## TypeScript Usage - -```typescript -import { AuthStrategy } from '@objectstack/spec/auth'; - -// Type-safe enum value -const value: AuthStrategy = 'email_password'; -``` - diff --git a/content/docs/references/auth/config/CSRFConfig.mdx b/content/docs/references/auth/config/CSRFConfig.mdx deleted file mode 100644 index a6aef30f1..000000000 --- a/content/docs/references/auth/config/CSRFConfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CSRFConfig -description: CSRFConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **tokenLength** | `number` | optional | CSRF token length | -| **cookieName** | `string` | optional | CSRF cookie name | -| **headerName** | `string` | optional | CSRF header name | - -## TypeScript Usage - -```typescript -import { CSRFConfigSchema } from '@objectstack/spec/auth'; -import type { CSRFConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = CSRFConfigSchema.parse(data); - -// Type-safe usage -const myCSRFConfig: CSRFConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/DatabaseAdapter.mdx b/content/docs/references/auth/config/DatabaseAdapter.mdx deleted file mode 100644 index 4f81ffd88..000000000 --- a/content/docs/references/auth/config/DatabaseAdapter.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DatabaseAdapter -description: DatabaseAdapter Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'prisma' \| 'drizzle' \| 'kysely' \| 'custom'>` | ✅ | Database adapter type | -| **connectionString** | `string` | optional | Database connection string | -| **tablePrefix** | `string` | optional | Prefix for auth tables | -| **schema** | `string` | optional | Database schema name | - -## TypeScript Usage - -```typescript -import { DatabaseAdapterSchema } from '@objectstack/spec/auth'; -import type { DatabaseAdapter } from '@objectstack/spec/auth'; - -// Validate data -const result = DatabaseAdapterSchema.parse(data); - -// Type-safe usage -const myDatabaseAdapter: DatabaseAdapter = { - type: 'prisma' -}; -``` - diff --git a/content/docs/references/auth/config/DatabaseMapping.mdx b/content/docs/references/auth/config/DatabaseMapping.mdx deleted file mode 100644 index f16f39a76..000000000 --- a/content/docs/references/auth/config/DatabaseMapping.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: DatabaseMapping -description: DatabaseMapping Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **user** | `Record` | optional | User field mapping (e.g., `{ "emailVerified": "email_verified" }`) | -| **session** | `Record` | optional | Session field mapping | -| **account** | `Record` | optional | Account field mapping | -| **verificationToken** | `Record` | optional | VerificationToken field mapping | - -## TypeScript Usage - -```typescript -import { DatabaseMappingSchema } from '@objectstack/spec/auth'; -import type { DatabaseMapping } from '@objectstack/spec/auth'; - -// Validate data -const result = DatabaseMappingSchema.parse(data); - -// Type-safe usage -const myDatabaseMapping: DatabaseMapping = { -}; -``` - diff --git a/content/docs/references/auth/config/EmailPasswordConfig.mdx b/content/docs/references/auth/config/EmailPasswordConfig.mdx deleted file mode 100644 index eb3ecc3fc..000000000 --- a/content/docs/references/auth/config/EmailPasswordConfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EmailPasswordConfig -description: EmailPasswordConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **requireEmailVerification** | `boolean` | optional | Require email verification before login | -| **minPasswordLength** | `number` | optional | Minimum password length | -| **requirePasswordComplexity** | `boolean` | optional | Require uppercase, lowercase, numbers, symbols | -| **allowPasswordReset** | `boolean` | optional | Enable password reset functionality | -| **passwordResetExpiry** | `number` | optional | Password reset token expiry in seconds | - -## TypeScript Usage - -```typescript -import { EmailPasswordConfigSchema } from '@objectstack/spec/auth'; -import type { EmailPasswordConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = EmailPasswordConfigSchema.parse(data); - -// Type-safe usage -const myEmailPasswordConfig: EmailPasswordConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/EnterpriseAuthConfig.mdx b/content/docs/references/auth/config/EnterpriseAuthConfig.mdx deleted file mode 100644 index f0c1b663c..000000000 --- a/content/docs/references/auth/config/EnterpriseAuthConfig.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EnterpriseAuthConfig -description: EnterpriseAuthConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **oidc** | `object` | optional | OpenID Connect configuration | -| **saml** | `object` | optional | SAML 2.0 configuration | -| **ldap** | `object` | optional | LDAP/Active Directory configuration | - -## TypeScript Usage - -```typescript -import { EnterpriseAuthConfigSchema } from '@objectstack/spec/auth'; -import type { EnterpriseAuthConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = EnterpriseAuthConfigSchema.parse(data); - -// Type-safe usage -const myEnterpriseAuthConfig: EnterpriseAuthConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/LDAPConfig.mdx b/content/docs/references/auth/config/LDAPConfig.mdx deleted file mode 100644 index 5ff023035..000000000 --- a/content/docs/references/auth/config/LDAPConfig.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: LDAPConfig -description: LDAPConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **url** | `string` | ✅ | LDAP Server URL (ldap:// or ldaps://) | -| **bindDn** | `string` | ✅ | Bind DN for LDAP authentication | -| **bindCredentials** | `string` | ✅ | Bind credentials | -| **searchBase** | `string` | ✅ | Search base DN | -| **searchFilter** | `string` | ✅ | Search filter | -| **groupSearchBase** | `string` | optional | Group search base DN | -| **displayName** | `string` | optional | Display name for the provider button | -| **icon** | `string` | optional | Icon URL or identifier | - -## TypeScript Usage - -```typescript -import { LDAPConfigSchema } from '@objectstack/spec/auth'; -import type { LDAPConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = LDAPConfigSchema.parse(data); - -// Type-safe usage -const myLDAPConfig: LDAPConfig = { - url: 'https://example.com', - bindDn: 'example', - bindCredentials: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/config/MagicLinkConfig.mdx b/content/docs/references/auth/config/MagicLinkConfig.mdx deleted file mode 100644 index 464388ad1..000000000 --- a/content/docs/references/auth/config/MagicLinkConfig.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: MagicLinkConfig -description: MagicLinkConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **expiryTime** | `number` | optional | Magic link expiry time in seconds (default 15 min) | - -## TypeScript Usage - -```typescript -import { MagicLinkConfigSchema } from '@objectstack/spec/auth'; -import type { MagicLinkConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = MagicLinkConfigSchema.parse(data); - -// Type-safe usage -const myMagicLinkConfig: MagicLinkConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/OAuthProvider.mdx b/content/docs/references/auth/config/OAuthProvider.mdx deleted file mode 100644 index fc8508014..000000000 --- a/content/docs/references/auth/config/OAuthProvider.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OAuthProvider -description: OAuthProvider Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **provider** | `Enum<'google' \| 'github' \| 'facebook' \| 'twitter' \| 'linkedin' \| 'microsoft' \| 'apple' \| 'discord' \| 'gitlab' \| 'custom'>` | ✅ | OAuth provider type | -| **clientId** | `string` | ✅ | OAuth client ID | -| **clientSecret** | `string` | ✅ | OAuth client secret (typically from ENV) | -| **scopes** | `string[]` | optional | Requested OAuth scopes | -| **redirectUri** | `string` | optional | OAuth callback URL | -| **enabled** | `boolean` | optional | Whether this provider is enabled | -| **displayName** | `string` | optional | Display name for the provider button | -| **icon** | `string` | optional | Icon URL or identifier | - -## TypeScript Usage - -```typescript -import { OAuthProviderSchema } from '@objectstack/spec/auth'; -import type { OAuthProvider } from '@objectstack/spec/auth'; - -// Validate data -const result = OAuthProviderSchema.parse(data); - -// Type-safe usage -const myOAuthProvider: OAuthProvider = { - provider: 'google', - clientId: 'example', - clientSecret: 'example' -}; -``` - diff --git a/content/docs/references/auth/config/OIDCConfig.mdx b/content/docs/references/auth/config/OIDCConfig.mdx deleted file mode 100644 index feddb5d98..000000000 --- a/content/docs/references/auth/config/OIDCConfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OIDCConfig -description: OIDCConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **issuer** | `string` | ✅ | OIDC Issuer URL (.well-known/openid-configuration) | -| **clientId** | `string` | ✅ | OIDC client ID | -| **clientSecret** | `string` | ✅ | OIDC client secret | -| **scopes** | `string[]` | optional | OIDC scopes | -| **attributeMapping** | `Record` | optional | Map IdP claims to User fields | -| **displayName** | `string` | optional | Display name for the provider button | -| **icon** | `string` | optional | Icon URL or identifier | - -## TypeScript Usage - -```typescript -import { OIDCConfigSchema } from '@objectstack/spec/auth'; -import type { OIDCConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = OIDCConfigSchema.parse(data); - -// Type-safe usage -const myOIDCConfig: OIDCConfig = { - issuer: 'example', - clientId: 'example', - clientSecret: 'example' -}; -``` - diff --git a/content/docs/references/auth/config/PasskeyConfig.mdx b/content/docs/references/auth/config/PasskeyConfig.mdx deleted file mode 100644 index 21672d0dc..000000000 --- a/content/docs/references/auth/config/PasskeyConfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PasskeyConfig -description: PasskeyConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **rpName** | `string` | ✅ | Relying Party name | -| **rpId** | `string` | optional | Relying Party ID (defaults to domain) | -| **allowedOrigins** | `string[]` | optional | Allowed origins for WebAuthn | -| **userVerification** | `Enum<'required' \| 'preferred' \| 'discouraged'>` | optional | | -| **attestation** | `Enum<'none' \| 'indirect' \| 'direct' \| 'enterprise'>` | optional | | - -## TypeScript Usage - -```typescript -import { PasskeyConfigSchema } from '@objectstack/spec/auth'; -import type { PasskeyConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = PasskeyConfigSchema.parse(data); - -// Type-safe usage -const myPasskeyConfig: PasskeyConfig = { - rpName: 'example' -}; -``` - diff --git a/content/docs/references/auth/config/RateLimitConfig.mdx b/content/docs/references/auth/config/RateLimitConfig.mdx deleted file mode 100644 index 52b27b3f5..000000000 --- a/content/docs/references/auth/config/RateLimitConfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: RateLimitConfig -description: RateLimitConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **maxAttempts** | `number` | optional | Maximum login attempts | -| **windowMs** | `number` | optional | Time window in milliseconds (default 15 min) | -| **blockDuration** | `number` | optional | Block duration after max attempts in ms | -| **skipSuccessfulRequests** | `boolean` | optional | Only count failed requests | - -## TypeScript Usage - -```typescript -import { RateLimitConfigSchema } from '@objectstack/spec/auth'; -import type { RateLimitConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = RateLimitConfigSchema.parse(data); - -// Type-safe usage -const myRateLimitConfig: RateLimitConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/SAMLConfig.mdx b/content/docs/references/auth/config/SAMLConfig.mdx deleted file mode 100644 index 6316e74d4..000000000 --- a/content/docs/references/auth/config/SAMLConfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: SAMLConfig -description: SAMLConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **entryPoint** | `string` | ✅ | IdP SSO URL | -| **cert** | `string` | ✅ | IdP Public Certificate (PEM format) | -| **issuer** | `string` | ✅ | Entity ID of the IdP | -| **signatureAlgorithm** | `Enum<'sha256' \| 'sha512'>` | optional | Signature algorithm | -| **attributeMapping** | `Record` | optional | Map SAML attributes to User fields | -| **displayName** | `string` | optional | Display name for the provider button | -| **icon** | `string` | optional | Icon URL or identifier | - -## TypeScript Usage - -```typescript -import { SAMLConfigSchema } from '@objectstack/spec/auth'; -import type { SAMLConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = SAMLConfigSchema.parse(data); - -// Type-safe usage -const mySAMLConfig: SAMLConfig = { - entryPoint: 'example', - cert: 'example', - issuer: 'example' -}; -``` - diff --git a/content/docs/references/auth/config/SessionConfig.mdx b/content/docs/references/auth/config/SessionConfig.mdx deleted file mode 100644 index bd9f18c5e..000000000 --- a/content/docs/references/auth/config/SessionConfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: SessionConfig -description: SessionConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **expiresIn** | `number` | optional | Session expiry in seconds (default 7 days) | -| **updateAge** | `number` | optional | Session update interval in seconds (default 1 day) | -| **cookieName** | `string` | optional | Session cookie name | -| **cookieSecure** | `boolean` | optional | Use secure cookies (HTTPS only) | -| **cookieSameSite** | `Enum<'strict' \| 'lax' \| 'none'>` | optional | SameSite cookie attribute | -| **cookieDomain** | `string` | optional | Cookie domain | -| **cookiePath** | `string` | optional | Cookie path | -| **cookieHttpOnly** | `boolean` | optional | HttpOnly cookie attribute | - -## TypeScript Usage - -```typescript -import { SessionConfigSchema } from '@objectstack/spec/auth'; -import type { SessionConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = SessionConfigSchema.parse(data); - -// Type-safe usage -const mySessionConfig: SessionConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/StandardAuthProvider.mdx b/content/docs/references/auth/config/StandardAuthProvider.mdx deleted file mode 100644 index c47fa9be8..000000000 --- a/content/docs/references/auth/config/StandardAuthProvider.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: StandardAuthProvider -description: StandardAuthProvider Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `string` | ✅ | Provider type identifier | -| **config** | `object` | ✅ | Standard authentication configuration | - -## TypeScript Usage - -```typescript -import { StandardAuthProviderSchema } from '@objectstack/spec/auth'; -import type { StandardAuthProvider } from '@objectstack/spec/auth'; - -// Validate data -const result = StandardAuthProviderSchema.parse(data); - -// Type-safe usage -const myStandardAuthProvider: StandardAuthProvider = { - type: 'example', - config: {} -}; -``` - diff --git a/content/docs/references/auth/config/TwoFactorConfig.mdx b/content/docs/references/auth/config/TwoFactorConfig.mdx deleted file mode 100644 index c7024652e..000000000 --- a/content/docs/references/auth/config/TwoFactorConfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: TwoFactorConfig -description: TwoFactorConfig Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | | -| **issuer** | `string` | optional | TOTP issuer name | -| **qrCodeSize** | `number` | optional | QR code size in pixels | -| **backupCodes** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { TwoFactorConfigSchema } from '@objectstack/spec/auth'; -import type { TwoFactorConfig } from '@objectstack/spec/auth'; - -// Validate data -const result = TwoFactorConfigSchema.parse(data); - -// Type-safe usage -const myTwoFactorConfig: TwoFactorConfig = { -}; -``` - diff --git a/content/docs/references/auth/config/UserFieldMapping.mdx b/content/docs/references/auth/config/UserFieldMapping.mdx deleted file mode 100644 index 3f1d8151e..000000000 --- a/content/docs/references/auth/config/UserFieldMapping.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UserFieldMapping -description: UserFieldMapping Schema Reference -category: auth -zodFile: config ---- - - - -**Source:** `packages/spec/src/auth/config.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | optional | User ID field | -| **email** | `string` | optional | Email field | -| **name** | `string` | optional | Name field | -| **image** | `string` | optional | Profile image field | -| **emailVerified** | `string` | optional | Email verification status field | -| **createdAt** | `string` | optional | Created timestamp field | -| **updatedAt** | `string` | optional | Updated timestamp field | - -## TypeScript Usage - -```typescript -import { UserFieldMappingSchema } from '@objectstack/spec/auth'; -import type { UserFieldMapping } from '@objectstack/spec/auth'; - -// Validate data -const result = UserFieldMappingSchema.parse(data); - -// Type-safe usage -const myUserFieldMapping: UserFieldMapping = { -}; -``` - diff --git a/content/docs/references/auth/config/meta.json b/content/docs/references/auth/config/meta.json deleted file mode 100644 index 84de464eb..000000000 --- a/content/docs/references/auth/config/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Config" -} \ No newline at end of file diff --git a/content/docs/references/auth/identity.mdx b/content/docs/references/auth/identity.mdx new file mode 100644 index 000000000..4ffe2f73c --- /dev/null +++ b/content/docs/references/auth/identity.mdx @@ -0,0 +1,95 @@ +--- +title: Identity +description: Identity protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Identity + + +**Source:** `packages/spec/src/auth/identity.zod.ts` + + +## TypeScript Usage + +```typescript +import { AccountSchema, SessionSchema, UserSchema, VerificationTokenSchema } from '@objectstack/spec/auth'; +import type { Account, Session, User, VerificationToken } from '@objectstack/spec/auth'; + +// Validate data +const result = AccountSchema.parse(data); +``` + +--- + +## Account + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique account identifier | +| **userId** | `string` | ✅ | Associated user ID | +| **type** | `Enum<'oauth' \| 'oidc' \| 'email' \| 'credentials' \| 'saml' \| 'ldap'>` | ✅ | Account type | +| **provider** | `string` | ✅ | Provider name | +| **providerAccountId** | `string` | ✅ | Provider account ID | +| **refreshToken** | `string` | optional | OAuth refresh token | +| **accessToken** | `string` | optional | OAuth access token | +| **expiresAt** | `number` | optional | Token expiry timestamp (Unix) | +| **tokenType** | `string` | optional | OAuth token type | +| **scope** | `string` | optional | OAuth scope | +| **idToken** | `string` | optional | OAuth ID token | +| **sessionState** | `string` | optional | Session state | +| **createdAt** | `string` | ✅ | Account creation timestamp | +| **updatedAt** | `string` | ✅ | Last update timestamp | + +--- + +## Session + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique session identifier | +| **sessionToken** | `string` | ✅ | Session token | +| **userId** | `string` | ✅ | Associated user ID | +| **activeOrganizationId** | `string` | optional | Active organization ID for context switching | +| **expires** | `string` | ✅ | Session expiry timestamp | +| **createdAt** | `string` | ✅ | Session creation timestamp | +| **updatedAt** | `string` | ✅ | Last update timestamp | +| **ipAddress** | `string` | optional | IP address | +| **userAgent** | `string` | optional | User agent string | +| **fingerprint** | `string` | optional | Device fingerprint | + +--- + +## User + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique user identifier | +| **email** | `string` | ✅ | User email address | +| **emailVerified** | `boolean` | optional | Whether email is verified | +| **name** | `string` | optional | User display name | +| **image** | `string` | optional | Profile image URL | +| **createdAt** | `string` | ✅ | Account creation timestamp | +| **updatedAt** | `string` | ✅ | Last update timestamp | + +--- + +## VerificationToken + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **identifier** | `string` | ✅ | Token identifier (email or phone) | +| **token** | `string` | ✅ | Verification token | +| **expires** | `string` | ✅ | Token expiry timestamp | +| **createdAt** | `string` | ✅ | Token creation timestamp | + diff --git a/content/docs/references/auth/identity/Account.mdx b/content/docs/references/auth/identity/Account.mdx deleted file mode 100644 index 3057fbdbd..000000000 --- a/content/docs/references/auth/identity/Account.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Account -description: Account Schema Reference -category: auth -zodFile: identity ---- - - - -**Source:** `packages/spec/src/auth/identity.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique account identifier | -| **userId** | `string` | ✅ | Associated user ID | -| **type** | `Enum<'oauth' \| 'oidc' \| 'email' \| 'credentials' \| 'saml' \| 'ldap'>` | ✅ | Account type | -| **provider** | `string` | ✅ | Provider name | -| **providerAccountId** | `string` | ✅ | Provider account ID | -| **refreshToken** | `string` | optional | OAuth refresh token | -| **accessToken** | `string` | optional | OAuth access token | -| **expiresAt** | `number` | optional | Token expiry timestamp (Unix) | -| **tokenType** | `string` | optional | OAuth token type | -| **scope** | `string` | optional | OAuth scope | -| **idToken** | `string` | optional | OAuth ID token | -| **sessionState** | `string` | optional | Session state | -| **createdAt** | `string` | ✅ | Account creation timestamp | -| **updatedAt** | `string` | ✅ | Last update timestamp | - -## TypeScript Usage - -```typescript -import { AccountSchema } from '@objectstack/spec/auth'; -import type { Account } from '@objectstack/spec/auth'; - -// Validate data -const result = AccountSchema.parse(data); - -// Type-safe usage -const myAccount: Account = { - id: 'example', - userId: 'example', - type: 'oauth', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/identity/Session.mdx b/content/docs/references/auth/identity/Session.mdx deleted file mode 100644 index 995c8fd20..000000000 --- a/content/docs/references/auth/identity/Session.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Session -description: Session Schema Reference -category: auth -zodFile: identity ---- - - - -**Source:** `packages/spec/src/auth/identity.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique session identifier | -| **sessionToken** | `string` | ✅ | Session token | -| **userId** | `string` | ✅ | Associated user ID | -| **activeOrganizationId** | `string` | optional | Active organization ID for context switching | -| **expires** | `string` | ✅ | Session expiry timestamp | -| **createdAt** | `string` | ✅ | Session creation timestamp | -| **updatedAt** | `string` | ✅ | Last update timestamp | -| **ipAddress** | `string` | optional | IP address | -| **userAgent** | `string` | optional | User agent string | -| **fingerprint** | `string` | optional | Device fingerprint | - -## TypeScript Usage - -```typescript -import { SessionSchema } from '@objectstack/spec/auth'; -import type { Session } from '@objectstack/spec/auth'; - -// Validate data -const result = SessionSchema.parse(data); - -// Type-safe usage -const mySession: Session = { - id: 'example', - sessionToken: 'example', - userId: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/identity/User.mdx b/content/docs/references/auth/identity/User.mdx deleted file mode 100644 index 89fb56d9c..000000000 --- a/content/docs/references/auth/identity/User.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: User -description: User Schema Reference -category: auth -zodFile: identity ---- - - - -**Source:** `packages/spec/src/auth/identity.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique user identifier | -| **email** | `string` | ✅ | User email address | -| **emailVerified** | `boolean` | optional | Whether email is verified | -| **name** | `string` | optional | User display name | -| **image** | `string` | optional | Profile image URL | -| **createdAt** | `string` | ✅ | Account creation timestamp | -| **updatedAt** | `string` | ✅ | Last update timestamp | - -## TypeScript Usage - -```typescript -import { UserSchema } from '@objectstack/spec/auth'; -import type { User } from '@objectstack/spec/auth'; - -// Validate data -const result = UserSchema.parse(data); - -// Type-safe usage -const myUser: User = { - id: 'example', - email: 'user@example.com', - createdAt: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/identity/VerificationToken.mdx b/content/docs/references/auth/identity/VerificationToken.mdx deleted file mode 100644 index 940de43fd..000000000 --- a/content/docs/references/auth/identity/VerificationToken.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: VerificationToken -description: VerificationToken Schema Reference -category: auth -zodFile: identity ---- - - - -**Source:** `packages/spec/src/auth/identity.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **identifier** | `string` | ✅ | Token identifier (email or phone) | -| **token** | `string` | ✅ | Verification token | -| **expires** | `string` | ✅ | Token expiry timestamp | -| **createdAt** | `string` | ✅ | Token creation timestamp | - -## TypeScript Usage - -```typescript -import { VerificationTokenSchema } from '@objectstack/spec/auth'; -import type { VerificationToken } from '@objectstack/spec/auth'; - -// Validate data -const result = VerificationTokenSchema.parse(data); - -// Type-safe usage -const myVerificationToken: VerificationToken = { - identifier: 'example', - token: 'example', - expires: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/identity/meta.json b/content/docs/references/auth/identity/meta.json deleted file mode 100644 index 97df7cd95..000000000 --- a/content/docs/references/auth/identity/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Identity" -} \ No newline at end of file diff --git a/content/docs/references/auth/index.mdx b/content/docs/references/auth/index.mdx index d8f4aa59b..49316c982 100644 --- a/content/docs/references/auth/index.mdx +++ b/content/docs/references/auth/index.mdx @@ -3,98 +3,18 @@ title: Auth Protocol Overview description: Complete reference for all auth protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # Auth Protocol This section contains all protocol schemas for the auth layer of ObjectStack. -## Config - -Source: `packages/spec/src/auth/config.zod.ts` - - - - - - - - - - - - - - - - - - - - - - - - -## Identity - -Source: `packages/spec/src/auth/identity.zod.ts` - - - - - - - - -## Organization - -Source: `packages/spec/src/auth/organization.zod.ts` - - - - - - - - -## Policy - -Source: `packages/spec/src/auth/policy.zod.ts` - - - - - - - - - -## Role - -Source: `packages/spec/src/auth/role.zod.ts` - - - - - -## Scim - -Source: `packages/spec/src/auth/scim.zod.ts` - - - - - - - - - - - - - - - + + + + + + diff --git a/content/docs/references/auth/organization.mdx b/content/docs/references/auth/organization.mdx new file mode 100644 index 000000000..f908c273b --- /dev/null +++ b/content/docs/references/auth/organization.mdx @@ -0,0 +1,84 @@ +--- +title: Organization +description: Organization protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Organization + + +**Source:** `packages/spec/src/auth/organization.zod.ts` + + +## TypeScript Usage + +```typescript +import { InvitationSchema, InvitationStatusSchema, MemberSchema, OrganizationSchema } from '@objectstack/spec/auth'; +import type { Invitation, InvitationStatus, Member, Organization } from '@objectstack/spec/auth'; + +// Validate data +const result = InvitationSchema.parse(data); +``` + +--- + +## Invitation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique invitation identifier | +| **organizationId** | `string` | ✅ | Organization ID | +| **email** | `string` | ✅ | Invitee email address | +| **role** | `string` | ✅ | Role to assign upon acceptance | +| **status** | `Enum<'pending' \| 'accepted' \| 'rejected' \| 'expired'>` | optional | Invitation status | +| **expiresAt** | `string` | ✅ | Invitation expiry timestamp | +| **inviterId** | `string` | ✅ | User ID of the inviter | +| **createdAt** | `string` | ✅ | Invitation creation timestamp | +| **updatedAt** | `string` | ✅ | Last update timestamp | + +--- + +## InvitationStatus + +### Allowed Values + +* `pending` +* `accepted` +* `rejected` +* `expired` + +--- + +## Member + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique member identifier | +| **organizationId** | `string` | ✅ | Organization ID | +| **userId** | `string` | ✅ | User ID | +| **role** | `string` | ✅ | Member role (e.g., owner, admin, member, guest) | +| **createdAt** | `string` | ✅ | Member creation timestamp | +| **updatedAt** | `string` | ✅ | Last update timestamp | + +--- + +## Organization + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique organization identifier | +| **name** | `string` | ✅ | Organization display name | +| **slug** | `string` | ✅ | Unique URL-friendly slug (lowercase alphanumeric, hyphens, underscores) | +| **logo** | `string` | optional | Organization logo URL | +| **metadata** | `Record` | optional | Custom metadata | +| **createdAt** | `string` | ✅ | Organization creation timestamp | +| **updatedAt** | `string` | ✅ | Last update timestamp | + diff --git a/content/docs/references/auth/organization/Invitation.mdx b/content/docs/references/auth/organization/Invitation.mdx deleted file mode 100644 index ae5ff8ea9..000000000 --- a/content/docs/references/auth/organization/Invitation.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Invitation -description: Invitation Schema Reference -category: auth -zodFile: organization ---- - - - -**Source:** `packages/spec/src/auth/organization.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique invitation identifier | -| **organizationId** | `string` | ✅ | Organization ID | -| **email** | `string` | ✅ | Invitee email address | -| **role** | `string` | ✅ | Role to assign upon acceptance | -| **status** | `Enum<'pending' \| 'accepted' \| 'rejected' \| 'expired'>` | optional | Invitation status | -| **expiresAt** | `string` | ✅ | Invitation expiry timestamp | -| **inviterId** | `string` | ✅ | User ID of the inviter | -| **createdAt** | `string` | ✅ | Invitation creation timestamp | -| **updatedAt** | `string` | ✅ | Last update timestamp | - -## TypeScript Usage - -```typescript -import { InvitationSchema } from '@objectstack/spec/auth'; -import type { Invitation } from '@objectstack/spec/auth'; - -// Validate data -const result = InvitationSchema.parse(data); - -// Type-safe usage -const myInvitation: Invitation = { - id: 'example', - organizationId: 'example', - email: 'user@example.com', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/organization/InvitationStatus.mdx b/content/docs/references/auth/organization/InvitationStatus.mdx deleted file mode 100644 index ad23c1320..000000000 --- a/content/docs/references/auth/organization/InvitationStatus.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: InvitationStatus -description: InvitationStatus Schema Reference -category: auth -zodFile: organization ---- - - - -**Source:** `packages/spec/src/auth/organization.zod.ts` - - -## Allowed Values - -* `pending` -* `accepted` -* `rejected` -* `expired` - -## TypeScript Usage - -```typescript -import { InvitationStatus } from '@objectstack/spec/auth'; - -// Type-safe enum value -const value: InvitationStatus = 'pending'; -``` - diff --git a/content/docs/references/auth/organization/Member.mdx b/content/docs/references/auth/organization/Member.mdx deleted file mode 100644 index dcf7ccc30..000000000 --- a/content/docs/references/auth/organization/Member.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Member -description: Member Schema Reference -category: auth -zodFile: organization ---- - - - -**Source:** `packages/spec/src/auth/organization.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique member identifier | -| **organizationId** | `string` | ✅ | Organization ID | -| **userId** | `string` | ✅ | User ID | -| **role** | `string` | ✅ | Member role (e.g., owner, admin, member, guest) | -| **createdAt** | `string` | ✅ | Member creation timestamp | -| **updatedAt** | `string` | ✅ | Last update timestamp | - -## TypeScript Usage - -```typescript -import { MemberSchema } from '@objectstack/spec/auth'; -import type { Member } from '@objectstack/spec/auth'; - -// Validate data -const result = MemberSchema.parse(data); - -// Type-safe usage -const myMember: Member = { - id: 'example', - organizationId: 'example', - userId: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/organization/Organization.mdx b/content/docs/references/auth/organization/Organization.mdx deleted file mode 100644 index 8e2092ade..000000000 --- a/content/docs/references/auth/organization/Organization.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Organization -description: Organization Schema Reference -category: auth -zodFile: organization ---- - - - -**Source:** `packages/spec/src/auth/organization.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique organization identifier | -| **name** | `string` | ✅ | Organization display name | -| **slug** | `string` | ✅ | Unique URL-friendly slug (lowercase alphanumeric, hyphens, underscores) | -| **logo** | `string` | optional | Organization logo URL | -| **metadata** | `Record` | optional | Custom metadata | -| **createdAt** | `string` | ✅ | Organization creation timestamp | -| **updatedAt** | `string` | ✅ | Last update timestamp | - -## TypeScript Usage - -```typescript -import { OrganizationSchema } from '@objectstack/spec/auth'; -import type { Organization } from '@objectstack/spec/auth'; - -// Validate data -const result = OrganizationSchema.parse(data); - -// Type-safe usage -const myOrganization: Organization = { - id: 'example', - name: 'name', - slug: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/auth/organization/meta.json b/content/docs/references/auth/organization/meta.json deleted file mode 100644 index 7d2b5f26a..000000000 --- a/content/docs/references/auth/organization/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Organization" -} \ No newline at end of file diff --git a/content/docs/references/auth/policy.mdx b/content/docs/references/auth/policy.mdx new file mode 100644 index 000000000..ceccc86e2 --- /dev/null +++ b/content/docs/references/auth/policy.mdx @@ -0,0 +1,92 @@ +--- +title: Policy +description: Policy protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Policy + + +**Source:** `packages/spec/src/auth/policy.zod.ts` + + +## TypeScript Usage + +```typescript +import { AuditPolicySchema, NetworkPolicySchema, PasswordPolicySchema, PolicySchema, SessionPolicySchema } from '@objectstack/spec/auth'; +import type { AuditPolicy, NetworkPolicy, PasswordPolicy, Policy, SessionPolicy } from '@objectstack/spec/auth'; + +// Validate data +const result = AuditPolicySchema.parse(data); +``` + +--- + +## AuditPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **logRetentionDays** | `number` | optional | | +| **sensitiveFields** | `string[]` | ✅ | Fields to redact in logs (e.g. password, ssn) | +| **captureRead** | `boolean` | optional | Log read access (High volume!) | + +--- + +## NetworkPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **trustedRanges** | `string[]` | ✅ | CIDR ranges allowed to access (e.g. 10.0.0.0/8) | +| **blockUnknown** | `boolean` | optional | Block all IPs not in trusted ranges | +| **vpnRequired** | `boolean` | optional | | + +--- + +## PasswordPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **minLength** | `number` | optional | | +| **requireUppercase** | `boolean` | optional | | +| **requireLowercase** | `boolean` | optional | | +| **requireNumbers** | `boolean` | optional | | +| **requireSymbols** | `boolean` | optional | | +| **expirationDays** | `number` | optional | Force password change every X days | +| **historyCount** | `number` | optional | Prevent reusing last X passwords | + +--- + +## Policy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Policy Name | +| **password** | `object` | optional | | +| **network** | `object` | optional | | +| **session** | `object` | optional | | +| **audit** | `object` | optional | | +| **isDefault** | `boolean` | optional | Apply to all users by default | +| **assignedProfiles** | `string[]` | optional | Apply to specific profiles | + +--- + +## SessionPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **idleTimeout** | `number` | optional | Minutes before idle session logout | +| **absoluteTimeout** | `number` | optional | Max session duration (minutes) | +| **forceMfa** | `boolean` | optional | Require 2FA for all users | + diff --git a/content/docs/references/auth/policy/AuditPolicy.mdx b/content/docs/references/auth/policy/AuditPolicy.mdx deleted file mode 100644 index 1aacc509b..000000000 --- a/content/docs/references/auth/policy/AuditPolicy.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AuditPolicy -description: AuditPolicy Schema Reference -category: auth -zodFile: policy ---- - - - -**Source:** `packages/spec/src/auth/policy.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **logRetentionDays** | `number` | optional | | -| **sensitiveFields** | `string[]` | ✅ | Fields to redact in logs (e.g. password, ssn) | -| **captureRead** | `boolean` | optional | Log read access (High volume!) | - -## TypeScript Usage - -```typescript -import { AuditPolicySchema } from '@objectstack/spec/auth'; -import type { AuditPolicy } from '@objectstack/spec/auth'; - -// Validate data -const result = AuditPolicySchema.parse(data); - -// Type-safe usage -const myAuditPolicy: AuditPolicy = { - sensitiveFields: [] -}; -``` - diff --git a/content/docs/references/auth/policy/NetworkPolicy.mdx b/content/docs/references/auth/policy/NetworkPolicy.mdx deleted file mode 100644 index b1bb472b5..000000000 --- a/content/docs/references/auth/policy/NetworkPolicy.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: NetworkPolicy -description: NetworkPolicy Schema Reference -category: auth -zodFile: policy ---- - - - -**Source:** `packages/spec/src/auth/policy.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **trustedRanges** | `string[]` | ✅ | CIDR ranges allowed to access (e.g. 10.0.0.0/8) | -| **blockUnknown** | `boolean` | optional | Block all IPs not in trusted ranges | -| **vpnRequired** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { NetworkPolicySchema } from '@objectstack/spec/auth'; -import type { NetworkPolicy } from '@objectstack/spec/auth'; - -// Validate data -const result = NetworkPolicySchema.parse(data); - -// Type-safe usage -const myNetworkPolicy: NetworkPolicy = { - trustedRanges: [] -}; -``` - diff --git a/content/docs/references/auth/policy/PasswordPolicy.mdx b/content/docs/references/auth/policy/PasswordPolicy.mdx deleted file mode 100644 index 938071c2a..000000000 --- a/content/docs/references/auth/policy/PasswordPolicy.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PasswordPolicy -description: PasswordPolicy Schema Reference -category: auth -zodFile: policy ---- - - - -**Source:** `packages/spec/src/auth/policy.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **minLength** | `number` | optional | | -| **requireUppercase** | `boolean` | optional | | -| **requireLowercase** | `boolean` | optional | | -| **requireNumbers** | `boolean` | optional | | -| **requireSymbols** | `boolean` | optional | | -| **expirationDays** | `number` | optional | Force password change every X days | -| **historyCount** | `number` | optional | Prevent reusing last X passwords | - -## TypeScript Usage - -```typescript -import { PasswordPolicySchema } from '@objectstack/spec/auth'; -import type { PasswordPolicy } from '@objectstack/spec/auth'; - -// Validate data -const result = PasswordPolicySchema.parse(data); - -// Type-safe usage -const myPasswordPolicy: PasswordPolicy = { -}; -``` - diff --git a/content/docs/references/auth/policy/Policy.mdx b/content/docs/references/auth/policy/Policy.mdx deleted file mode 100644 index 1dae0c678..000000000 --- a/content/docs/references/auth/policy/Policy.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Policy -description: Policy Schema Reference -category: auth -zodFile: policy ---- - - - -**Source:** `packages/spec/src/auth/policy.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Policy Name | -| **password** | `object` | optional | | -| **network** | `object` | optional | | -| **session** | `object` | optional | | -| **audit** | `object` | optional | | -| **isDefault** | `boolean` | optional | Apply to all users by default | -| **assignedProfiles** | `string[]` | optional | Apply to specific profiles | - -## TypeScript Usage - -```typescript -import { PolicySchema } from '@objectstack/spec/auth'; -import type { Policy } from '@objectstack/spec/auth'; - -// Validate data -const result = PolicySchema.parse(data); - -// Type-safe usage -const myPolicy: Policy = { - name: 'name' -}; -``` - diff --git a/content/docs/references/auth/policy/SessionPolicy.mdx b/content/docs/references/auth/policy/SessionPolicy.mdx deleted file mode 100644 index c403f7416..000000000 --- a/content/docs/references/auth/policy/SessionPolicy.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SessionPolicy -description: SessionPolicy Schema Reference -category: auth -zodFile: policy ---- - - - -**Source:** `packages/spec/src/auth/policy.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **idleTimeout** | `number` | optional | Minutes before idle session logout | -| **absoluteTimeout** | `number` | optional | Max session duration (minutes) | -| **forceMfa** | `boolean` | optional | Require 2FA for all users | - -## TypeScript Usage - -```typescript -import { SessionPolicySchema } from '@objectstack/spec/auth'; -import type { SessionPolicy } from '@objectstack/spec/auth'; - -// Validate data -const result = SessionPolicySchema.parse(data); - -// Type-safe usage -const mySessionPolicy: SessionPolicy = { -}; -``` - diff --git a/content/docs/references/auth/policy/meta.json b/content/docs/references/auth/policy/meta.json deleted file mode 100644 index 3f7527ca1..000000000 --- a/content/docs/references/auth/policy/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Policy" -} \ No newline at end of file diff --git a/content/docs/references/auth/role/Role.mdx b/content/docs/references/auth/role.mdx similarity index 77% rename from content/docs/references/auth/role/Role.mdx rename to content/docs/references/auth/role.mdx index 90b6bccc8..12fb1f615 100644 --- a/content/docs/references/auth/role/Role.mdx +++ b/content/docs/references/auth/role.mdx @@ -1,24 +1,17 @@ --- title: Role -description: Role Schema Reference -category: auth -zodFile: role +description: Role protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Role **Source:** `packages/spec/src/auth/role.zod.ts` -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique role name (lowercase snake_case) | -| **label** | `string` | ✅ | Display label (e.g. VP of Sales) | -| **parent** | `string` | optional | Parent Role ID (Reports To) | -| **description** | `string` | optional | | - ## TypeScript Usage ```typescript @@ -27,11 +20,18 @@ import type { Role } from '@objectstack/spec/auth'; // Validate data const result = RoleSchema.parse(data); - -// Type-safe usage -const myRole: Role = { - name: 'name', - label: 'example' -}; ``` +--- + +## Role + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique role name (lowercase snake_case) | +| **label** | `string` | ✅ | Display label (e.g. VP of Sales) | +| **parent** | `string` | optional | Parent Role ID (Reports To) | +| **description** | `string` | optional | | + diff --git a/content/docs/references/auth/role/meta.json b/content/docs/references/auth/role/meta.json deleted file mode 100644 index 548168cd6..000000000 --- a/content/docs/references/auth/role/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Role" -} \ No newline at end of file diff --git a/content/docs/references/auth/scim.mdx b/content/docs/references/auth/scim.mdx new file mode 100644 index 000000000..2c8a027d1 --- /dev/null +++ b/content/docs/references/auth/scim.mdx @@ -0,0 +1,237 @@ +--- +title: Scim +description: Scim protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Scim + + +**Source:** `packages/spec/src/auth/scim.zod.ts` + + +## TypeScript Usage + +```typescript +import { SCIMAddressSchema, SCIMEmailSchema, SCIMEnterpriseUserSchema, SCIMErrorSchema, SCIMGroupSchema, SCIMGroupReferenceSchema, SCIMListResponseSchema, SCIMMemberReferenceSchema, SCIMMetaSchema, SCIMNameSchema, SCIMPatchOperationSchema, SCIMPatchRequestSchema, SCIMPhoneNumberSchema, SCIMUserSchema } from '@objectstack/spec/auth'; +import type { SCIMAddress, SCIMEmail, SCIMEnterpriseUser, SCIMError, SCIMGroup, SCIMGroupReference, SCIMListResponse, SCIMMemberReference, SCIMMeta, SCIMName, SCIMPatchOperation, SCIMPatchRequest, SCIMPhoneNumber, SCIMUser } from '@objectstack/spec/auth'; + +// Validate data +const result = SCIMAddressSchema.parse(data); +``` + +--- + +## SCIMAddress + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **formatted** | `string` | optional | Formatted address | +| **streetAddress** | `string` | optional | Street address | +| **locality** | `string` | optional | City/Locality | +| **region** | `string` | optional | State/Region | +| **postalCode** | `string` | optional | Postal code | +| **country** | `string` | optional | Country | +| **type** | `Enum<'work' \| 'home' \| 'other'>` | optional | Address type | +| **primary** | `boolean` | optional | Primary address indicator | + +--- + +## SCIMEmail + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **value** | `string` | ✅ | Email address | +| **type** | `Enum<'work' \| 'home' \| 'other'>` | optional | Email type | +| **display** | `string` | optional | Display label | +| **primary** | `boolean` | optional | Primary email indicator | + +--- + +## SCIMEnterpriseUser + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **employeeNumber** | `string` | optional | Employee number | +| **costCenter** | `string` | optional | Cost center | +| **organization** | `string` | optional | Organization | +| **division** | `string` | optional | Division | +| **department** | `string` | optional | Department | +| **manager** | `object` | optional | Manager reference | + +--- + +## SCIMError + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **schemas** | `string[]` | optional | SCIM schema URIs | +| **status** | `integer` | ✅ | HTTP status code | +| **scimType** | `Enum<'invalidFilter' \| 'tooMany' \| 'uniqueness' \| 'mutability' \| 'invalidSyntax' \| 'invalidPath' \| 'noTarget' \| 'invalidValue' \| 'invalidVers' \| 'sensitive'>` | optional | SCIM error type | +| **detail** | `string` | optional | Error detail message | + +--- + +## SCIMGroup + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **schemas** | `string[]` | optional | SCIM schema URIs (must include Group schema) | +| **id** | `string` | optional | Unique resource identifier | +| **externalId** | `string` | optional | External identifier from client system | +| **displayName** | `string` | ✅ | Group display name (REQUIRED) | +| **members** | `object[]` | optional | Group members | +| **meta** | `object` | optional | Resource metadata | + +--- + +## SCIMGroupReference + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **value** | `string` | ✅ | Group ID | +| **$ref** | `string` | optional | URI reference to the group | +| **display** | `string` | optional | Group display name | +| **type** | `Enum<'direct' \| 'indirect'>` | optional | Membership type | + +--- + +## SCIMListResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **schemas** | `string[]` | optional | SCIM schema URIs | +| **totalResults** | `integer` | ✅ | Total results count | +| **Resources** | `object \| object \| Record[]` | ✅ | Resources array (Users, Groups, or custom resources) | +| **startIndex** | `integer` | optional | Start index (1-based) | +| **itemsPerPage** | `integer` | optional | Items per page | + +--- + +## SCIMMemberReference + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **value** | `string` | ✅ | Member ID | +| **$ref** | `string` | optional | URI reference to the member | +| **type** | `Enum<'User' \| 'Group'>` | optional | Member type | +| **display** | `string` | optional | Member display name | + +--- + +## SCIMMeta + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **resourceType** | `string` | optional | Resource type | +| **created** | `string` | optional | Creation timestamp | +| **lastModified** | `string` | optional | Last modification timestamp | +| **location** | `string` | optional | Resource location URI | +| **version** | `string` | optional | Entity tag (ETag) for concurrency control | + +--- + +## SCIMName + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **formatted** | `string` | optional | Formatted full name | +| **familyName** | `string` | optional | Family name (last name) | +| **givenName** | `string` | optional | Given name (first name) | +| **middleName** | `string` | optional | Middle name | +| **honorificPrefix** | `string` | optional | Honorific prefix (Mr., Ms., Dr.) | +| **honorificSuffix** | `string` | optional | Honorific suffix (Jr., Sr.) | + +--- + +## SCIMPatchOperation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **op** | `Enum<'add' \| 'remove' \| 'replace'>` | ✅ | Operation type | +| **path** | `string` | optional | Attribute path (optional for add) | +| **value** | `any` | optional | Value to set | + +--- + +## SCIMPatchRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **schemas** | `string[]` | optional | SCIM schema URIs | +| **Operations** | `object[]` | ✅ | Patch operations | + +--- + +## SCIMPhoneNumber + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **value** | `string` | ✅ | Phone number | +| **type** | `Enum<'work' \| 'home' \| 'mobile' \| 'fax' \| 'pager' \| 'other'>` | optional | Phone number type | +| **display** | `string` | optional | Display label | +| **primary** | `boolean` | optional | Primary phone indicator | + +--- + +## SCIMUser + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **schemas** | `string[]` | optional | SCIM schema URIs (must include User schema) | +| **id** | `string` | optional | Unique resource identifier | +| **externalId** | `string` | optional | External identifier from client system | +| **userName** | `string` | ✅ | Unique username (REQUIRED) | +| **name** | `object` | optional | Structured name components | +| **displayName** | `string` | optional | Display name for UI | +| **nickName** | `string` | optional | Nickname | +| **profileUrl** | `string` | optional | Profile page URL | +| **title** | `string` | optional | Job title | +| **userType** | `string` | optional | User type (employee, contractor) | +| **preferredLanguage** | `string` | optional | Preferred language (ISO 639-1) | +| **locale** | `string` | optional | Locale (e.g., en-US) | +| **timezone** | `string` | optional | Timezone | +| **active** | `boolean` | optional | Account active status | +| **password** | `string` | optional | Password (write-only) | +| **emails** | `object[]` | optional | Email addresses | +| **phoneNumbers** | `object[]` | optional | Phone numbers | +| **ims** | `object[]` | optional | IM addresses | +| **photos** | `object[]` | optional | Photo URLs | +| **addresses** | `object[]` | optional | Physical addresses | +| **groups** | `object[]` | optional | Group memberships | +| **entitlements** | `object[]` | optional | Entitlements | +| **roles** | `object[]` | optional | Roles | +| **x509Certificates** | `object[]` | optional | X509 certificates | +| **meta** | `object` | optional | Resource metadata | +| **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** | `object` | optional | Enterprise user attributes | + diff --git a/content/docs/references/auth/scim/SCIMAddress.mdx b/content/docs/references/auth/scim/SCIMAddress.mdx deleted file mode 100644 index 1aba33b77..000000000 --- a/content/docs/references/auth/scim/SCIMAddress.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: SCIMAddress -description: SCIMAddress Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **formatted** | `string` | optional | Formatted address | -| **streetAddress** | `string` | optional | Street address | -| **locality** | `string` | optional | City/Locality | -| **region** | `string` | optional | State/Region | -| **postalCode** | `string` | optional | Postal code | -| **country** | `string` | optional | Country | -| **type** | `Enum<'work' \| 'home' \| 'other'>` | optional | Address type | -| **primary** | `boolean` | optional | Primary address indicator | - -## TypeScript Usage - -```typescript -import { SCIMAddressSchema } from '@objectstack/spec/auth'; -import type { SCIMAddress } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMAddressSchema.parse(data); - -// Type-safe usage -const mySCIMAddress: SCIMAddress = { -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMEmail.mdx b/content/docs/references/auth/scim/SCIMEmail.mdx deleted file mode 100644 index d81cd2134..000000000 --- a/content/docs/references/auth/scim/SCIMEmail.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SCIMEmail -description: SCIMEmail Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **value** | `string` | ✅ | Email address | -| **type** | `Enum<'work' \| 'home' \| 'other'>` | optional | Email type | -| **display** | `string` | optional | Display label | -| **primary** | `boolean` | optional | Primary email indicator | - -## TypeScript Usage - -```typescript -import { SCIMEmailSchema } from '@objectstack/spec/auth'; -import type { SCIMEmail } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMEmailSchema.parse(data); - -// Type-safe usage -const mySCIMEmail: SCIMEmail = { - value: 'example' -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx b/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx deleted file mode 100644 index a2779fee3..000000000 --- a/content/docs/references/auth/scim/SCIMEnterpriseUser.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: SCIMEnterpriseUser -description: SCIMEnterpriseUser Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **employeeNumber** | `string` | optional | Employee number | -| **costCenter** | `string` | optional | Cost center | -| **organization** | `string` | optional | Organization | -| **division** | `string` | optional | Division | -| **department** | `string` | optional | Department | -| **manager** | `object` | optional | Manager reference | - -## TypeScript Usage - -```typescript -import { SCIMEnterpriseUserSchema } from '@objectstack/spec/auth'; -import type { SCIMEnterpriseUser } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMEnterpriseUserSchema.parse(data); - -// Type-safe usage -const mySCIMEnterpriseUser: SCIMEnterpriseUser = { -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMError.mdx b/content/docs/references/auth/scim/SCIMError.mdx deleted file mode 100644 index fc4510f52..000000000 --- a/content/docs/references/auth/scim/SCIMError.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SCIMError -description: SCIMError Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **schemas** | `string[]` | optional | SCIM schema URIs | -| **status** | `integer` | ✅ | HTTP status code | -| **scimType** | `Enum<'invalidFilter' \| 'tooMany' \| 'uniqueness' \| 'mutability' \| 'invalidSyntax' \| 'invalidPath' \| 'noTarget' \| 'invalidValue' \| 'invalidVers' \| 'sensitive'>` | optional | SCIM error type | -| **detail** | `string` | optional | Error detail message | - -## TypeScript Usage - -```typescript -import { SCIMErrorSchema } from '@objectstack/spec/auth'; -import type { SCIMError } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMErrorSchema.parse(data); - -// Type-safe usage -const mySCIMError: SCIMError = { - status: null -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMGroup.mdx b/content/docs/references/auth/scim/SCIMGroup.mdx deleted file mode 100644 index 69856a6e6..000000000 --- a/content/docs/references/auth/scim/SCIMGroup.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: SCIMGroup -description: SCIMGroup Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **schemas** | `string[]` | optional | SCIM schema URIs (must include Group schema) | -| **id** | `string` | optional | Unique resource identifier | -| **externalId** | `string` | optional | External identifier from client system | -| **displayName** | `string` | ✅ | Group display name (REQUIRED) | -| **members** | `object[]` | optional | Group members | -| **meta** | `object` | optional | Resource metadata | - -## TypeScript Usage - -```typescript -import { SCIMGroupSchema } from '@objectstack/spec/auth'; -import type { SCIMGroup } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMGroupSchema.parse(data); - -// Type-safe usage -const mySCIMGroup: SCIMGroup = { - displayName: 'example' -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMGroupReference.mdx b/content/docs/references/auth/scim/SCIMGroupReference.mdx deleted file mode 100644 index 7117fe0cc..000000000 --- a/content/docs/references/auth/scim/SCIMGroupReference.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SCIMGroupReference -description: SCIMGroupReference Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **value** | `string` | ✅ | Group ID | -| **$ref** | `string` | optional | URI reference to the group | -| **display** | `string` | optional | Group display name | -| **type** | `Enum<'direct' \| 'indirect'>` | optional | Membership type | - -## TypeScript Usage - -```typescript -import { SCIMGroupReferenceSchema } from '@objectstack/spec/auth'; -import type { SCIMGroupReference } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMGroupReferenceSchema.parse(data); - -// Type-safe usage -const mySCIMGroupReference: SCIMGroupReference = { - value: 'example' -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMListResponse.mdx b/content/docs/references/auth/scim/SCIMListResponse.mdx deleted file mode 100644 index 3ef786de9..000000000 --- a/content/docs/references/auth/scim/SCIMListResponse.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: SCIMListResponse -description: SCIMListResponse Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **schemas** | `string[]` | optional | SCIM schema URIs | -| **totalResults** | `integer` | ✅ | Total results count | -| **Resources** | `object \| object \| Record[]` | ✅ | Resources array (Users, Groups, or custom resources) | -| **startIndex** | `integer` | optional | Start index (1-based) | -| **itemsPerPage** | `integer` | optional | Items per page | - -## TypeScript Usage - -```typescript -import { SCIMListResponseSchema } from '@objectstack/spec/auth'; -import type { SCIMListResponse } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMListResponseSchema.parse(data); - -// Type-safe usage -const mySCIMListResponse: SCIMListResponse = { - totalResults: null, - Resources: [] -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMMemberReference.mdx b/content/docs/references/auth/scim/SCIMMemberReference.mdx deleted file mode 100644 index ce4d108a7..000000000 --- a/content/docs/references/auth/scim/SCIMMemberReference.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SCIMMemberReference -description: SCIMMemberReference Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **value** | `string` | ✅ | Member ID | -| **$ref** | `string` | optional | URI reference to the member | -| **type** | `Enum<'User' \| 'Group'>` | optional | Member type | -| **display** | `string` | optional | Member display name | - -## TypeScript Usage - -```typescript -import { SCIMMemberReferenceSchema } from '@objectstack/spec/auth'; -import type { SCIMMemberReference } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMMemberReferenceSchema.parse(data); - -// Type-safe usage -const mySCIMMemberReference: SCIMMemberReference = { - value: 'example' -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMMeta.mdx b/content/docs/references/auth/scim/SCIMMeta.mdx deleted file mode 100644 index fbe94c544..000000000 --- a/content/docs/references/auth/scim/SCIMMeta.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SCIMMeta -description: SCIMMeta Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **resourceType** | `string` | optional | Resource type | -| **created** | `string` | optional | Creation timestamp | -| **lastModified** | `string` | optional | Last modification timestamp | -| **location** | `string` | optional | Resource location URI | -| **version** | `string` | optional | Entity tag (ETag) for concurrency control | - -## TypeScript Usage - -```typescript -import { SCIMMetaSchema } from '@objectstack/spec/auth'; -import type { SCIMMeta } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMMetaSchema.parse(data); - -// Type-safe usage -const mySCIMMeta: SCIMMeta = { -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMName.mdx b/content/docs/references/auth/scim/SCIMName.mdx deleted file mode 100644 index 776c9cb0c..000000000 --- a/content/docs/references/auth/scim/SCIMName.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: SCIMName -description: SCIMName Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **formatted** | `string` | optional | Formatted full name | -| **familyName** | `string` | optional | Family name (last name) | -| **givenName** | `string` | optional | Given name (first name) | -| **middleName** | `string` | optional | Middle name | -| **honorificPrefix** | `string` | optional | Honorific prefix (Mr., Ms., Dr.) | -| **honorificSuffix** | `string` | optional | Honorific suffix (Jr., Sr.) | - -## TypeScript Usage - -```typescript -import { SCIMNameSchema } from '@objectstack/spec/auth'; -import type { SCIMName } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMNameSchema.parse(data); - -// Type-safe usage -const mySCIMName: SCIMName = { -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMPatchOperation.mdx b/content/docs/references/auth/scim/SCIMPatchOperation.mdx deleted file mode 100644 index 25b935ca8..000000000 --- a/content/docs/references/auth/scim/SCIMPatchOperation.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SCIMPatchOperation -description: SCIMPatchOperation Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **op** | `Enum<'add' \| 'remove' \| 'replace'>` | ✅ | Operation type | -| **path** | `string` | optional | Attribute path (optional for add) | -| **value** | `any` | optional | Value to set | - -## TypeScript Usage - -```typescript -import { SCIMPatchOperationSchema } from '@objectstack/spec/auth'; -import type { SCIMPatchOperation } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMPatchOperationSchema.parse(data); - -// Type-safe usage -const mySCIMPatchOperation: SCIMPatchOperation = { - op: 'add' -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMPatchRequest.mdx b/content/docs/references/auth/scim/SCIMPatchRequest.mdx deleted file mode 100644 index 285cc3283..000000000 --- a/content/docs/references/auth/scim/SCIMPatchRequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SCIMPatchRequest -description: SCIMPatchRequest Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **schemas** | `string[]` | optional | SCIM schema URIs | -| **Operations** | `object[]` | ✅ | Patch operations | - -## TypeScript Usage - -```typescript -import { SCIMPatchRequestSchema } from '@objectstack/spec/auth'; -import type { SCIMPatchRequest } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMPatchRequestSchema.parse(data); - -// Type-safe usage -const mySCIMPatchRequest: SCIMPatchRequest = { - Operations: [] -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMPhoneNumber.mdx b/content/docs/references/auth/scim/SCIMPhoneNumber.mdx deleted file mode 100644 index 671d1a91e..000000000 --- a/content/docs/references/auth/scim/SCIMPhoneNumber.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SCIMPhoneNumber -description: SCIMPhoneNumber Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **value** | `string` | ✅ | Phone number | -| **type** | `Enum<'work' \| 'home' \| 'mobile' \| 'fax' \| 'pager' \| 'other'>` | optional | Phone number type | -| **display** | `string` | optional | Display label | -| **primary** | `boolean` | optional | Primary phone indicator | - -## TypeScript Usage - -```typescript -import { SCIMPhoneNumberSchema } from '@objectstack/spec/auth'; -import type { SCIMPhoneNumber } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMPhoneNumberSchema.parse(data); - -// Type-safe usage -const mySCIMPhoneNumber: SCIMPhoneNumber = { - value: 'example' -}; -``` - diff --git a/content/docs/references/auth/scim/SCIMUser.mdx b/content/docs/references/auth/scim/SCIMUser.mdx deleted file mode 100644 index 76560413a..000000000 --- a/content/docs/references/auth/scim/SCIMUser.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: SCIMUser -description: SCIMUser Schema Reference -category: auth -zodFile: scim ---- - - - -**Source:** `packages/spec/src/auth/scim.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **schemas** | `string[]` | optional | SCIM schema URIs (must include User schema) | -| **id** | `string` | optional | Unique resource identifier | -| **externalId** | `string` | optional | External identifier from client system | -| **userName** | `string` | ✅ | Unique username (REQUIRED) | -| **name** | `object` | optional | Structured name components | -| **displayName** | `string` | optional | Display name for UI | -| **nickName** | `string` | optional | Nickname | -| **profileUrl** | `string` | optional | Profile page URL | -| **title** | `string` | optional | Job title | -| **userType** | `string` | optional | User type (employee, contractor) | -| **preferredLanguage** | `string` | optional | Preferred language (ISO 639-1) | -| **locale** | `string` | optional | Locale (e.g., en-US) | -| **timezone** | `string` | optional | Timezone | -| **active** | `boolean` | optional | Account active status | -| **password** | `string` | optional | Password (write-only) | -| **emails** | `object[]` | optional | Email addresses | -| **phoneNumbers** | `object[]` | optional | Phone numbers | -| **ims** | `object[]` | optional | IM addresses | -| **photos** | `object[]` | optional | Photo URLs | -| **addresses** | `object[]` | optional | Physical addresses | -| **groups** | `object[]` | optional | Group memberships | -| **entitlements** | `object[]` | optional | Entitlements | -| **roles** | `object[]` | optional | Roles | -| **x509Certificates** | `object[]` | optional | X509 certificates | -| **meta** | `object` | optional | Resource metadata | -| **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** | `object` | optional | Enterprise user attributes | - -## TypeScript Usage - -```typescript -import { SCIMUserSchema } from '@objectstack/spec/auth'; -import type { SCIMUser } from '@objectstack/spec/auth'; - -// Validate data -const result = SCIMUserSchema.parse(data); - -// Type-safe usage -const mySCIMUser: SCIMUser = { - userName: 'example' -}; -``` - diff --git a/content/docs/references/auth/scim/meta.json b/content/docs/references/auth/scim/meta.json deleted file mode 100644 index 71b5a3eaf..000000000 --- a/content/docs/references/auth/scim/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Scim" -} \ No newline at end of file diff --git a/content/docs/references/automation/approval.mdx b/content/docs/references/automation/approval.mdx new file mode 100644 index 000000000..e989b8ded --- /dev/null +++ b/content/docs/references/automation/approval.mdx @@ -0,0 +1,98 @@ +--- +title: Approval +description: Approval protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Approval + + +**Source:** `packages/spec/src/automation/approval.zod.ts` + + +## TypeScript Usage + +```typescript +import { ApprovalActionSchema, ApprovalActionTypeSchema, ApprovalProcessSchema, ApprovalStepSchema, ApproverTypeSchema } from '@objectstack/spec/automation'; +import type { ApprovalAction, ApprovalActionType, ApprovalProcess, ApprovalStep, ApproverType } from '@objectstack/spec/automation'; + +// Validate data +const result = ApprovalActionSchema.parse(data); +``` + +--- + +## ApprovalAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'field_update' \| 'email_alert' \| 'webhook' \| 'script'>` | ✅ | | +| **name** | `string` | ✅ | Action name | +| **config** | `Record` | ✅ | Action configuration | + +--- + +## ApprovalActionType + +### Allowed Values + +* `field_update` +* `email_alert` +* `webhook` +* `script` + +--- + +## ApprovalProcess + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique process name | +| **label** | `string` | ✅ | Human readable label | +| **object** | `string` | ✅ | Target Object Name | +| **active** | `boolean` | optional | | +| **description** | `string` | optional | | +| **entryCriteria** | `string` | optional | Formula to allow submission | +| **lockRecord** | `boolean` | optional | Lock record from editing during approval | +| **steps** | `object[]` | ✅ | Sequence of approval steps | +| **onSubmit** | `object[]` | optional | Actions on initial submission | +| **onFinalApprove** | `object[]` | optional | Actions on final approval | +| **onFinalReject** | `object[]` | optional | Actions on final rejection | +| **onRecall** | `object[]` | optional | Actions on recall | + +--- + +## ApprovalStep + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Step machine name | +| **label** | `string` | ✅ | Step display label | +| **description** | `string` | optional | | +| **entryCriteria** | `string` | optional | Formula expression to enter this step | +| **approvers** | `object[]` | ✅ | List of allowed approvers | +| **behavior** | `Enum<'first_response' \| 'unanimous'>` | optional | How to handle multiple approvers | +| **rejectionBehavior** | `Enum<'reject_process' \| 'back_to_previous'>` | optional | What happens if rejected | +| **onApprove** | `object[]` | optional | Actions on step approval | +| **onReject** | `object[]` | optional | Actions on step rejection | + +--- + +## ApproverType + +### Allowed Values + +* `user` +* `role` +* `manager` +* `field` +* `queue` + diff --git a/content/docs/references/automation/approval/ApprovalAction.mdx b/content/docs/references/automation/approval/ApprovalAction.mdx deleted file mode 100644 index 56f7abda1..000000000 --- a/content/docs/references/automation/approval/ApprovalAction.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ApprovalAction -description: ApprovalAction Schema Reference -category: automation -zodFile: approval ---- - - - -**Source:** `packages/spec/src/automation/approval.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'field_update' \| 'email_alert' \| 'webhook' \| 'script'>` | ✅ | | -| **name** | `string` | ✅ | Action name | -| **config** | `Record` | ✅ | Action configuration | - -## TypeScript Usage - -```typescript -import { ApprovalActionSchema } from '@objectstack/spec/automation'; -import type { ApprovalAction } from '@objectstack/spec/automation'; - -// Validate data -const result = ApprovalActionSchema.parse(data); - -// Type-safe usage -const myApprovalAction: ApprovalAction = { - type: 'field_update', - name: 'name', - config: {} -}; -``` - diff --git a/content/docs/references/automation/approval/ApprovalActionType.mdx b/content/docs/references/automation/approval/ApprovalActionType.mdx deleted file mode 100644 index 6a38c9aa1..000000000 --- a/content/docs/references/automation/approval/ApprovalActionType.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: ApprovalActionType -description: ApprovalActionType Schema Reference -category: automation -zodFile: approval ---- - - - -**Source:** `packages/spec/src/automation/approval.zod.ts` - - -## Allowed Values - -* `field_update` -* `email_alert` -* `webhook` -* `script` - -## TypeScript Usage - -```typescript -import { ApprovalActionType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ApprovalActionType = 'field_update'; -``` - diff --git a/content/docs/references/automation/approval/ApprovalProcess.mdx b/content/docs/references/automation/approval/ApprovalProcess.mdx deleted file mode 100644 index a0534cd2d..000000000 --- a/content/docs/references/automation/approval/ApprovalProcess.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ApprovalProcess -description: ApprovalProcess Schema Reference -category: automation -zodFile: approval ---- - - - -**Source:** `packages/spec/src/automation/approval.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique process name | -| **label** | `string` | ✅ | Human readable label | -| **object** | `string` | ✅ | Target Object Name | -| **active** | `boolean` | optional | | -| **description** | `string` | optional | | -| **entryCriteria** | `string` | optional | Formula to allow submission | -| **lockRecord** | `boolean` | optional | Lock record from editing during approval | -| **steps** | `object[]` | ✅ | Sequence of approval steps | -| **onSubmit** | `object[]` | optional | Actions on initial submission | -| **onFinalApprove** | `object[]` | optional | Actions on final approval | -| **onFinalReject** | `object[]` | optional | Actions on final rejection | -| **onRecall** | `object[]` | optional | Actions on recall | - -## TypeScript Usage - -```typescript -import { ApprovalProcessSchema } from '@objectstack/spec/automation'; -import type { ApprovalProcess } from '@objectstack/spec/automation'; - -// Validate data -const result = ApprovalProcessSchema.parse(data); - -// Type-safe usage -const myApprovalProcess: ApprovalProcess = { - name: 'name', - label: 'example', - object: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/approval/ApprovalStep.mdx b/content/docs/references/automation/approval/ApprovalStep.mdx deleted file mode 100644 index 4b7220934..000000000 --- a/content/docs/references/automation/approval/ApprovalStep.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ApprovalStep -description: ApprovalStep Schema Reference -category: automation -zodFile: approval ---- - - - -**Source:** `packages/spec/src/automation/approval.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Step machine name | -| **label** | `string` | ✅ | Step display label | -| **description** | `string` | optional | | -| **entryCriteria** | `string` | optional | Formula expression to enter this step | -| **approvers** | `object[]` | ✅ | List of allowed approvers | -| **behavior** | `Enum<'first_response' \| 'unanimous'>` | optional | How to handle multiple approvers | -| **rejectionBehavior** | `Enum<'reject_process' \| 'back_to_previous'>` | optional | What happens if rejected | -| **onApprove** | `object[]` | optional | Actions on step approval | -| **onReject** | `object[]` | optional | Actions on step rejection | - -## TypeScript Usage - -```typescript -import { ApprovalStepSchema } from '@objectstack/spec/automation'; -import type { ApprovalStep } from '@objectstack/spec/automation'; - -// Validate data -const result = ApprovalStepSchema.parse(data); - -// Type-safe usage -const myApprovalStep: ApprovalStep = { - name: 'name', - label: 'example', - approvers: [] -}; -``` - diff --git a/content/docs/references/automation/approval/ApproverType.mdx b/content/docs/references/automation/approval/ApproverType.mdx deleted file mode 100644 index 303ce3c9f..000000000 --- a/content/docs/references/automation/approval/ApproverType.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: ApproverType -description: ApproverType Schema Reference -category: automation -zodFile: approval ---- - - - -**Source:** `packages/spec/src/automation/approval.zod.ts` - - -## Allowed Values - -* `user` -* `role` -* `manager` -* `field` -* `queue` - -## TypeScript Usage - -```typescript -import { ApproverType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ApproverType = 'user'; -``` - diff --git a/content/docs/references/automation/approval/meta.json b/content/docs/references/automation/approval/meta.json deleted file mode 100644 index 4b3e80736..000000000 --- a/content/docs/references/automation/approval/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Approval" -} \ No newline at end of file diff --git a/content/docs/references/automation/connector.mdx b/content/docs/references/automation/connector.mdx new file mode 100644 index 000000000..52e775af9 --- /dev/null +++ b/content/docs/references/automation/connector.mdx @@ -0,0 +1,214 @@ +--- +title: Connector +description: Connector protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Connector + + +**Source:** `packages/spec/src/automation/connector.zod.ts` + + +## TypeScript Usage + +```typescript +import { AuthFieldSchema, AuthenticationSchema, AuthenticationTypeSchema, ConnectorSchema, ConnectorCategorySchema, ConnectorInstanceSchema, ConnectorOperationSchema, ConnectorTriggerSchema, OAuth2ConfigSchema, OperationParameterSchema, OperationTypeSchema } from '@objectstack/spec/automation'; +import type { AuthField, Authentication, AuthenticationType, Connector, ConnectorCategory, ConnectorInstance, ConnectorOperation, ConnectorTrigger, OAuth2Config, OperationParameter, OperationType } from '@objectstack/spec/automation'; + +// Validate data +const result = AuthFieldSchema.parse(data); +``` + +--- + +## AuthField + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Field name (snake_case) | +| **label** | `string` | ✅ | Field label | +| **type** | `Enum<'text' \| 'password' \| 'url' \| 'select'>` | optional | Field type | +| **description** | `string` | optional | Field description | +| **required** | `boolean` | optional | Required field | +| **default** | `string` | optional | Default value | +| **options** | `object[]` | optional | Select field options | +| **placeholder** | `string` | optional | Placeholder text | + +--- + +## Authentication + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'none' \| 'apiKey' \| 'basic' \| 'bearer' \| 'oauth1' \| 'oauth2' \| 'custom'>` | ✅ | Authentication type | +| **fields** | `object[]` | optional | Authentication fields | +| **oauth2** | `object` | optional | OAuth 2.0 configuration | +| **test** | `object` | optional | Authentication test configuration | + +--- + +## AuthenticationType + +### Allowed Values + +* `none` +* `apiKey` +* `basic` +* `bearer` +* `oauth1` +* `oauth2` +* `custom` + +--- + +## Connector + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Connector ID (snake_case) | +| **name** | `string` | ✅ | Connector name | +| **description** | `string` | optional | Connector description | +| **version** | `string` | optional | Connector version | +| **icon** | `string` | optional | Connector icon | +| **category** | `Enum<'crm' \| 'payment' \| 'communication' \| 'storage' \| 'analytics' \| 'database' \| 'marketing' \| 'accounting' \| 'hr' \| 'productivity' \| 'ecommerce' \| 'support' \| 'devtools' \| 'social' \| 'other'>` | ✅ | Connector category | +| **baseUrl** | `string` | optional | API base URL | +| **authentication** | `object` | ✅ | Authentication config | +| **operations** | `object[]` | optional | Connector operations | +| **triggers** | `object[]` | optional | Connector triggers | +| **rateLimit** | `object` | optional | Rate limiting | +| **author** | `string` | optional | Connector author | +| **documentation** | `string` | optional | Documentation URL | +| **homepage** | `string` | optional | Homepage URL | +| **license** | `string` | optional | License (SPDX identifier) | +| **tags** | `string[]` | optional | Connector tags | +| **verified** | `boolean` | optional | Verified connector | +| **metadata** | `Record` | optional | Custom metadata | + +--- + +## ConnectorCategory + +### Allowed Values + +* `crm` +* `payment` +* `communication` +* `storage` +* `analytics` +* `database` +* `marketing` +* `accounting` +* `hr` +* `productivity` +* `ecommerce` +* `support` +* `devtools` +* `social` +* `other` + +--- + +## ConnectorInstance + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Instance ID | +| **connectorId** | `string` | ✅ | Connector ID | +| **name** | `string` | ✅ | Instance name | +| **description** | `string` | optional | Instance description | +| **credentials** | `Record` | ✅ | Encrypted credentials | +| **config** | `Record` | optional | Additional config | +| **active** | `boolean` | optional | Instance active status | +| **createdAt** | `string` | optional | Creation time | +| **lastTestedAt** | `string` | optional | Last test time | +| **testStatus** | `Enum<'unknown' \| 'success' \| 'failed'>` | optional | Connection test status | + +--- + +## ConnectorOperation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Operation ID (snake_case) | +| **name** | `string` | ✅ | Operation name | +| **description** | `string` | optional | Operation description | +| **type** | `Enum<'read' \| 'write' \| 'delete' \| 'search' \| 'trigger' \| 'action'>` | ✅ | Operation type | +| **inputSchema** | `object[]` | optional | Input parameters | +| **outputSchema** | `Record` | optional | Output schema | +| **sampleOutput** | `any` | optional | Sample output | +| **supportsPagination** | `boolean` | optional | Supports pagination | +| **supportsFiltering** | `boolean` | optional | Supports filtering | + +--- + +## ConnectorTrigger + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Trigger ID (snake_case) | +| **name** | `string` | ✅ | Trigger name | +| **description** | `string` | optional | Trigger description | +| **type** | `Enum<'webhook' \| 'polling' \| 'stream'>` | ✅ | Trigger mechanism | +| **config** | `Record` | optional | Trigger configuration | +| **outputSchema** | `Record` | optional | Event payload schema | +| **pollingIntervalMs** | `integer` | optional | Polling interval in ms | + +--- + +## OAuth2Config + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **authorizationUrl** | `string` | ✅ | Authorization endpoint URL | +| **tokenUrl** | `string` | ✅ | Token endpoint URL | +| **scopes** | `string[]` | optional | OAuth scopes | +| **clientIdField** | `string` | optional | Client ID field name | +| **clientSecretField** | `string` | optional | Client secret field name | + +--- + +## OperationParameter + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Parameter name | +| **label** | `string` | ✅ | Parameter label | +| **description** | `string` | optional | Parameter description | +| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'array' \| 'object' \| 'date' \| 'file'>` | ✅ | Parameter type | +| **required** | `boolean` | optional | Required parameter | +| **default** | `any` | optional | Default value | +| **validation** | `Record` | optional | Validation rules | +| **dynamicOptions** | `string` | optional | Function to load dynamic options | + +--- + +## OperationType + +### Allowed Values + +* `read` +* `write` +* `delete` +* `search` +* `trigger` +* `action` + diff --git a/content/docs/references/automation/connector/AuthField.mdx b/content/docs/references/automation/connector/AuthField.mdx deleted file mode 100644 index 3c6689c60..000000000 --- a/content/docs/references/automation/connector/AuthField.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: AuthField -description: AuthField Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Field name (snake_case) | -| **label** | `string` | ✅ | Field label | -| **type** | `Enum<'text' \| 'password' \| 'url' \| 'select'>` | optional | Field type | -| **description** | `string` | optional | Field description | -| **required** | `boolean` | optional | Required field | -| **default** | `string` | optional | Default value | -| **options** | `object[]` | optional | Select field options | -| **placeholder** | `string` | optional | Placeholder text | - -## TypeScript Usage - -```typescript -import { AuthFieldSchema } from '@objectstack/spec/automation'; -import type { AuthField } from '@objectstack/spec/automation'; - -// Validate data -const result = AuthFieldSchema.parse(data); - -// Type-safe usage -const myAuthField: AuthField = { - name: 'name', - label: 'example' -}; -``` - diff --git a/content/docs/references/automation/connector/Authentication.mdx b/content/docs/references/automation/connector/Authentication.mdx deleted file mode 100644 index 3e7412f09..000000000 --- a/content/docs/references/automation/connector/Authentication.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Authentication -description: Authentication Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'none' \| 'apiKey' \| 'basic' \| 'bearer' \| 'oauth1' \| 'oauth2' \| 'custom'>` | ✅ | Authentication type | -| **fields** | `object[]` | optional | Authentication fields | -| **oauth2** | `object` | optional | OAuth 2.0 configuration | -| **test** | `object` | optional | Authentication test configuration | - -## TypeScript Usage - -```typescript -import { AuthenticationSchema } from '@objectstack/spec/automation'; -import type { Authentication } from '@objectstack/spec/automation'; - -// Validate data -const result = AuthenticationSchema.parse(data); - -// Type-safe usage -const myAuthentication: Authentication = { - type: 'none' -}; -``` - diff --git a/content/docs/references/automation/connector/AuthenticationType.mdx b/content/docs/references/automation/connector/AuthenticationType.mdx deleted file mode 100644 index 6574f44fe..000000000 --- a/content/docs/references/automation/connector/AuthenticationType.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: AuthenticationType -description: AuthenticationType Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Allowed Values - -* `none` -* `apiKey` -* `basic` -* `bearer` -* `oauth1` -* `oauth2` -* `custom` - -## TypeScript Usage - -```typescript -import { AuthenticationType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: AuthenticationType = 'none'; -``` - diff --git a/content/docs/references/automation/connector/Connector.mdx b/content/docs/references/automation/connector/Connector.mdx deleted file mode 100644 index 3e1b5ed30..000000000 --- a/content/docs/references/automation/connector/Connector.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Connector -description: Connector Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Connector ID (snake_case) | -| **name** | `string` | ✅ | Connector name | -| **description** | `string` | optional | Connector description | -| **version** | `string` | optional | Connector version | -| **icon** | `string` | optional | Connector icon | -| **category** | `Enum<'crm' \| 'payment' \| 'communication' \| 'storage' \| 'analytics' \| 'database' \| 'marketing' \| 'accounting' \| 'hr' \| 'productivity' \| 'ecommerce' \| 'support' \| 'devtools' \| 'social' \| 'other'>` | ✅ | Connector category | -| **baseUrl** | `string` | optional | API base URL | -| **authentication** | `object` | ✅ | Authentication config | -| **operations** | `object[]` | optional | Connector operations | -| **triggers** | `object[]` | optional | Connector triggers | -| **rateLimit** | `object` | optional | Rate limiting | -| **author** | `string` | optional | Connector author | -| **documentation** | `string` | optional | Documentation URL | -| **homepage** | `string` | optional | Homepage URL | -| **license** | `string` | optional | License (SPDX identifier) | -| **tags** | `string[]` | optional | Connector tags | -| **verified** | `boolean` | optional | Verified connector | -| **metadata** | `Record` | optional | Custom metadata | - -## TypeScript Usage - -```typescript -import { ConnectorSchema } from '@objectstack/spec/automation'; -import type { Connector } from '@objectstack/spec/automation'; - -// Validate data -const result = ConnectorSchema.parse(data); - -// Type-safe usage -const myConnector: Connector = { - id: 'example', - name: 'name', - category: 'crm', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/connector/ConnectorCategory.mdx b/content/docs/references/automation/connector/ConnectorCategory.mdx deleted file mode 100644 index 279568e96..000000000 --- a/content/docs/references/automation/connector/ConnectorCategory.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ConnectorCategory -description: ConnectorCategory Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Allowed Values - -* `crm` -* `payment` -* `communication` -* `storage` -* `analytics` -* `database` -* `marketing` -* `accounting` -* `hr` -* `productivity` -* `ecommerce` -* `support` -* `devtools` -* `social` -* `other` - -## TypeScript Usage - -```typescript -import { ConnectorCategory } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ConnectorCategory = 'crm'; -``` - diff --git a/content/docs/references/automation/connector/ConnectorInstance.mdx b/content/docs/references/automation/connector/ConnectorInstance.mdx deleted file mode 100644 index 5f007d11c..000000000 --- a/content/docs/references/automation/connector/ConnectorInstance.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ConnectorInstance -description: ConnectorInstance Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Instance ID | -| **connectorId** | `string` | ✅ | Connector ID | -| **name** | `string` | ✅ | Instance name | -| **description** | `string` | optional | Instance description | -| **credentials** | `Record` | ✅ | Encrypted credentials | -| **config** | `Record` | optional | Additional config | -| **active** | `boolean` | optional | Instance active status | -| **createdAt** | `string` | optional | Creation time | -| **lastTestedAt** | `string` | optional | Last test time | -| **testStatus** | `Enum<'unknown' \| 'success' \| 'failed'>` | optional | Connection test status | - -## TypeScript Usage - -```typescript -import { ConnectorInstanceSchema } from '@objectstack/spec/automation'; -import type { ConnectorInstance } from '@objectstack/spec/automation'; - -// Validate data -const result = ConnectorInstanceSchema.parse(data); - -// Type-safe usage -const myConnectorInstance: ConnectorInstance = { - id: 'example', - connectorId: 'example', - name: 'name', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/connector/ConnectorOperation.mdx b/content/docs/references/automation/connector/ConnectorOperation.mdx deleted file mode 100644 index 6fc0ef549..000000000 --- a/content/docs/references/automation/connector/ConnectorOperation.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ConnectorOperation -description: ConnectorOperation Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Operation ID (snake_case) | -| **name** | `string` | ✅ | Operation name | -| **description** | `string` | optional | Operation description | -| **type** | `Enum<'read' \| 'write' \| 'delete' \| 'search' \| 'trigger' \| 'action'>` | ✅ | Operation type | -| **inputSchema** | `object[]` | optional | Input parameters | -| **outputSchema** | `Record` | optional | Output schema | -| **sampleOutput** | `any` | optional | Sample output | -| **supportsPagination** | `boolean` | optional | Supports pagination | -| **supportsFiltering** | `boolean` | optional | Supports filtering | - -## TypeScript Usage - -```typescript -import { ConnectorOperationSchema } from '@objectstack/spec/automation'; -import type { ConnectorOperation } from '@objectstack/spec/automation'; - -// Validate data -const result = ConnectorOperationSchema.parse(data); - -// Type-safe usage -const myConnectorOperation: ConnectorOperation = { - id: 'example', - name: 'name', - type: 'read' -}; -``` - diff --git a/content/docs/references/automation/connector/ConnectorTrigger.mdx b/content/docs/references/automation/connector/ConnectorTrigger.mdx deleted file mode 100644 index 400118062..000000000 --- a/content/docs/references/automation/connector/ConnectorTrigger.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ConnectorTrigger -description: ConnectorTrigger Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Trigger ID (snake_case) | -| **name** | `string` | ✅ | Trigger name | -| **description** | `string` | optional | Trigger description | -| **type** | `Enum<'webhook' \| 'polling' \| 'stream'>` | ✅ | Trigger mechanism | -| **config** | `Record` | optional | Trigger configuration | -| **outputSchema** | `Record` | optional | Event payload schema | -| **pollingIntervalMs** | `integer` | optional | Polling interval in ms | - -## TypeScript Usage - -```typescript -import { ConnectorTriggerSchema } from '@objectstack/spec/automation'; -import type { ConnectorTrigger } from '@objectstack/spec/automation'; - -// Validate data -const result = ConnectorTriggerSchema.parse(data); - -// Type-safe usage -const myConnectorTrigger: ConnectorTrigger = { - id: 'example', - name: 'name', - type: 'webhook' -}; -``` - diff --git a/content/docs/references/automation/connector/OAuth2Config.mdx b/content/docs/references/automation/connector/OAuth2Config.mdx deleted file mode 100644 index 37314decd..000000000 --- a/content/docs/references/automation/connector/OAuth2Config.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OAuth2Config -description: OAuth2Config Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **authorizationUrl** | `string` | ✅ | Authorization endpoint URL | -| **tokenUrl** | `string` | ✅ | Token endpoint URL | -| **scopes** | `string[]` | optional | OAuth scopes | -| **clientIdField** | `string` | optional | Client ID field name | -| **clientSecretField** | `string` | optional | Client secret field name | - -## TypeScript Usage - -```typescript -import { OAuth2ConfigSchema } from '@objectstack/spec/automation'; -import type { OAuth2Config } from '@objectstack/spec/automation'; - -// Validate data -const result = OAuth2ConfigSchema.parse(data); - -// Type-safe usage -const myOAuth2Config: OAuth2Config = { - authorizationUrl: 'example', - tokenUrl: 'example' -}; -``` - diff --git a/content/docs/references/automation/connector/OperationParameter.mdx b/content/docs/references/automation/connector/OperationParameter.mdx deleted file mode 100644 index 363aff6e6..000000000 --- a/content/docs/references/automation/connector/OperationParameter.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OperationParameter -description: OperationParameter Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Parameter name | -| **label** | `string` | ✅ | Parameter label | -| **description** | `string` | optional | Parameter description | -| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'array' \| 'object' \| 'date' \| 'file'>` | ✅ | Parameter type | -| **required** | `boolean` | optional | Required parameter | -| **default** | `any` | optional | Default value | -| **validation** | `Record` | optional | Validation rules | -| **dynamicOptions** | `string` | optional | Function to load dynamic options | - -## TypeScript Usage - -```typescript -import { OperationParameterSchema } from '@objectstack/spec/automation'; -import type { OperationParameter } from '@objectstack/spec/automation'; - -// Validate data -const result = OperationParameterSchema.parse(data); - -// Type-safe usage -const myOperationParameter: OperationParameter = { - name: 'name', - label: 'example', - type: 'string' -}; -``` - diff --git a/content/docs/references/automation/connector/OperationType.mdx b/content/docs/references/automation/connector/OperationType.mdx deleted file mode 100644 index 40aeeba1d..000000000 --- a/content/docs/references/automation/connector/OperationType.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: OperationType -description: OperationType Schema Reference -category: automation -zodFile: connector ---- - - - -**Source:** `packages/spec/src/automation/connector.zod.ts` - - -## Allowed Values - -* `read` -* `write` -* `delete` -* `search` -* `trigger` -* `action` - -## TypeScript Usage - -```typescript -import { OperationType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: OperationType = 'read'; -``` - diff --git a/content/docs/references/automation/connector/meta.json b/content/docs/references/automation/connector/meta.json deleted file mode 100644 index b89ecdbeb..000000000 --- a/content/docs/references/automation/connector/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Connector" -} \ No newline at end of file diff --git a/content/docs/references/automation/etl.mdx b/content/docs/references/automation/etl.mdx new file mode 100644 index 000000000..037795b52 --- /dev/null +++ b/content/docs/references/automation/etl.mdx @@ -0,0 +1,159 @@ +--- +title: Etl +description: Etl protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Etl + + +**Source:** `packages/spec/src/automation/etl.zod.ts` + + +## TypeScript Usage + +```typescript +import { ETLDestinationSchema, ETLEndpointTypeSchema, ETLPipelineSchema, ETLPipelineRunSchema, ETLRunStatusSchema, ETLSourceSchema, ETLSyncModeSchema, ETLTransformationSchema, ETLTransformationTypeSchema } from '@objectstack/spec/automation'; +import type { ETLDestination, ETLEndpointType, ETLPipeline, ETLPipelineRun, ETLRunStatus, ETLSource, ETLSyncMode, ETLTransformation, ETLTransformationType } from '@objectstack/spec/automation'; + +// Validate data +const result = ETLDestinationSchema.parse(data); +``` + +--- + +## ETLDestination + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'database' \| 'api' \| 'file' \| 'stream' \| 'object' \| 'warehouse' \| 'storage' \| 'spreadsheet'>` | ✅ | Destination type | +| **connector** | `string` | optional | Connector ID | +| **config** | `Record` | ✅ | Destination configuration | +| **writeMode** | `Enum<'append' \| 'overwrite' \| 'upsert' \| 'merge'>` | optional | How to write data | +| **primaryKey** | `string[]` | optional | Primary key fields | + +--- + +## ETLEndpointType + +### Allowed Values + +* `database` +* `api` +* `file` +* `stream` +* `object` +* `warehouse` +* `storage` +* `spreadsheet` + +--- + +## ETLPipeline + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Pipeline identifier (snake_case) | +| **label** | `string` | optional | Pipeline display name | +| **description** | `string` | optional | Pipeline description | +| **source** | `object` | ✅ | Data source | +| **destination** | `object` | ✅ | Data destination | +| **transformations** | `object[]` | optional | Transformation pipeline | +| **syncMode** | `Enum<'full' \| 'incremental' \| 'cdc'>` | optional | Sync mode | +| **schedule** | `string` | optional | Cron schedule expression | +| **enabled** | `boolean` | optional | Pipeline enabled status | +| **retry** | `object` | optional | Retry configuration | +| **notifications** | `object` | optional | Notification settings | +| **tags** | `string[]` | optional | Pipeline tags | +| **metadata** | `Record` | optional | Custom metadata | + +--- + +## ETLPipelineRun + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Run identifier | +| **pipelineName** | `string` | ✅ | Pipeline name | +| **status** | `Enum<'pending' \| 'running' \| 'succeeded' \| 'failed' \| 'cancelled' \| 'timeout'>` | ✅ | Run status | +| **startedAt** | `string` | ✅ | Start time | +| **completedAt** | `string` | optional | Completion time | +| **durationMs** | `number` | optional | Duration in ms | +| **stats** | `object` | optional | Run statistics | +| **error** | `object` | optional | Error information | +| **logs** | `string[]` | optional | Execution logs | + +--- + +## ETLRunStatus + +### Allowed Values + +* `pending` +* `running` +* `succeeded` +* `failed` +* `cancelled` +* `timeout` + +--- + +## ETLSource + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'database' \| 'api' \| 'file' \| 'stream' \| 'object' \| 'warehouse' \| 'storage' \| 'spreadsheet'>` | ✅ | Source type | +| **connector** | `string` | optional | Connector ID | +| **config** | `Record` | ✅ | Source configuration | +| **incremental** | `object` | optional | Incremental extraction config | + +--- + +## ETLSyncMode + +### Allowed Values + +* `full` +* `incremental` +* `cdc` + +--- + +## ETLTransformation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | optional | Transformation name | +| **type** | `Enum<'map' \| 'filter' \| 'aggregate' \| 'join' \| 'script' \| 'lookup' \| 'split' \| 'merge' \| 'normalize' \| 'deduplicate'>` | ✅ | Transformation type | +| **config** | `Record` | ✅ | Transformation config | +| **continueOnError** | `boolean` | optional | Continue on error | + +--- + +## ETLTransformationType + +### Allowed Values + +* `map` +* `filter` +* `aggregate` +* `join` +* `script` +* `lookup` +* `split` +* `merge` +* `normalize` +* `deduplicate` + diff --git a/content/docs/references/automation/etl/ETLDestination.mdx b/content/docs/references/automation/etl/ETLDestination.mdx deleted file mode 100644 index f5bbe0797..000000000 --- a/content/docs/references/automation/etl/ETLDestination.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ETLDestination -description: ETLDestination Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'database' \| 'api' \| 'file' \| 'stream' \| 'object' \| 'warehouse' \| 'storage' \| 'spreadsheet'>` | ✅ | Destination type | -| **connector** | `string` | optional | Connector ID | -| **config** | `Record` | ✅ | Destination configuration | -| **writeMode** | `Enum<'append' \| 'overwrite' \| 'upsert' \| 'merge'>` | optional | How to write data | -| **primaryKey** | `string[]` | optional | Primary key fields | - -## TypeScript Usage - -```typescript -import { ETLDestinationSchema } from '@objectstack/spec/automation'; -import type { ETLDestination } from '@objectstack/spec/automation'; - -// Validate data -const result = ETLDestinationSchema.parse(data); - -// Type-safe usage -const myETLDestination: ETLDestination = { - type: 'database', - config: {} -}; -``` - diff --git a/content/docs/references/automation/etl/ETLEndpointType.mdx b/content/docs/references/automation/etl/ETLEndpointType.mdx deleted file mode 100644 index e2a9e913c..000000000 --- a/content/docs/references/automation/etl/ETLEndpointType.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ETLEndpointType -description: ETLEndpointType Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Allowed Values - -* `database` -* `api` -* `file` -* `stream` -* `object` -* `warehouse` -* `storage` -* `spreadsheet` - -## TypeScript Usage - -```typescript -import { ETLEndpointType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ETLEndpointType = 'database'; -``` - diff --git a/content/docs/references/automation/etl/ETLPipeline.mdx b/content/docs/references/automation/etl/ETLPipeline.mdx deleted file mode 100644 index 3c53a71b8..000000000 --- a/content/docs/references/automation/etl/ETLPipeline.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ETLPipeline -description: ETLPipeline Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Pipeline identifier (snake_case) | -| **label** | `string` | optional | Pipeline display name | -| **description** | `string` | optional | Pipeline description | -| **source** | `object` | ✅ | Data source | -| **destination** | `object` | ✅ | Data destination | -| **transformations** | `object[]` | optional | Transformation pipeline | -| **syncMode** | `Enum<'full' \| 'incremental' \| 'cdc'>` | optional | Sync mode | -| **schedule** | `string` | optional | Cron schedule expression | -| **enabled** | `boolean` | optional | Pipeline enabled status | -| **retry** | `object` | optional | Retry configuration | -| **notifications** | `object` | optional | Notification settings | -| **tags** | `string[]` | optional | Pipeline tags | -| **metadata** | `Record` | optional | Custom metadata | - -## TypeScript Usage - -```typescript -import { ETLPipelineSchema } from '@objectstack/spec/automation'; -import type { ETLPipeline } from '@objectstack/spec/automation'; - -// Validate data -const result = ETLPipelineSchema.parse(data); - -// Type-safe usage -const myETLPipeline: ETLPipeline = { - name: 'name', - source: {}, - destination: {} -}; -``` - diff --git a/content/docs/references/automation/etl/ETLPipelineRun.mdx b/content/docs/references/automation/etl/ETLPipelineRun.mdx deleted file mode 100644 index d9f7d94df..000000000 --- a/content/docs/references/automation/etl/ETLPipelineRun.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ETLPipelineRun -description: ETLPipelineRun Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Run identifier | -| **pipelineName** | `string` | ✅ | Pipeline name | -| **status** | `Enum<'pending' \| 'running' \| 'succeeded' \| 'failed' \| 'cancelled' \| 'timeout'>` | ✅ | Run status | -| **startedAt** | `string` | ✅ | Start time | -| **completedAt** | `string` | optional | Completion time | -| **durationMs** | `number` | optional | Duration in ms | -| **stats** | `object` | optional | Run statistics | -| **error** | `object` | optional | Error information | -| **logs** | `string[]` | optional | Execution logs | - -## TypeScript Usage - -```typescript -import { ETLPipelineRunSchema } from '@objectstack/spec/automation'; -import type { ETLPipelineRun } from '@objectstack/spec/automation'; - -// Validate data -const result = ETLPipelineRunSchema.parse(data); - -// Type-safe usage -const myETLPipelineRun: ETLPipelineRun = { - id: 'example', - pipelineName: 'example', - status: 'pending', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/etl/ETLRunStatus.mdx b/content/docs/references/automation/etl/ETLRunStatus.mdx deleted file mode 100644 index 29bdfd298..000000000 --- a/content/docs/references/automation/etl/ETLRunStatus.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: ETLRunStatus -description: ETLRunStatus Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Allowed Values - -* `pending` -* `running` -* `succeeded` -* `failed` -* `cancelled` -* `timeout` - -## TypeScript Usage - -```typescript -import { ETLRunStatus } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ETLRunStatus = 'pending'; -``` - diff --git a/content/docs/references/automation/etl/ETLSource.mdx b/content/docs/references/automation/etl/ETLSource.mdx deleted file mode 100644 index d62b45530..000000000 --- a/content/docs/references/automation/etl/ETLSource.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ETLSource -description: ETLSource Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'database' \| 'api' \| 'file' \| 'stream' \| 'object' \| 'warehouse' \| 'storage' \| 'spreadsheet'>` | ✅ | Source type | -| **connector** | `string` | optional | Connector ID | -| **config** | `Record` | ✅ | Source configuration | -| **incremental** | `object` | optional | Incremental extraction config | - -## TypeScript Usage - -```typescript -import { ETLSourceSchema } from '@objectstack/spec/automation'; -import type { ETLSource } from '@objectstack/spec/automation'; - -// Validate data -const result = ETLSourceSchema.parse(data); - -// Type-safe usage -const myETLSource: ETLSource = { - type: 'database', - config: {} -}; -``` - diff --git a/content/docs/references/automation/etl/ETLSyncMode.mdx b/content/docs/references/automation/etl/ETLSyncMode.mdx deleted file mode 100644 index 072c82052..000000000 --- a/content/docs/references/automation/etl/ETLSyncMode.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: ETLSyncMode -description: ETLSyncMode Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Allowed Values - -* `full` -* `incremental` -* `cdc` - -## TypeScript Usage - -```typescript -import { ETLSyncMode } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ETLSyncMode = 'full'; -``` - diff --git a/content/docs/references/automation/etl/ETLTransformation.mdx b/content/docs/references/automation/etl/ETLTransformation.mdx deleted file mode 100644 index d3a070f2c..000000000 --- a/content/docs/references/automation/etl/ETLTransformation.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ETLTransformation -description: ETLTransformation Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | optional | Transformation name | -| **type** | `Enum<'map' \| 'filter' \| 'aggregate' \| 'join' \| 'script' \| 'lookup' \| 'split' \| 'merge' \| 'normalize' \| 'deduplicate'>` | ✅ | Transformation type | -| **config** | `Record` | ✅ | Transformation config | -| **continueOnError** | `boolean` | optional | Continue on error | - -## TypeScript Usage - -```typescript -import { ETLTransformationSchema } from '@objectstack/spec/automation'; -import type { ETLTransformation } from '@objectstack/spec/automation'; - -// Validate data -const result = ETLTransformationSchema.parse(data); - -// Type-safe usage -const myETLTransformation: ETLTransformation = { - type: 'map', - config: {} -}; -``` - diff --git a/content/docs/references/automation/etl/ETLTransformationType.mdx b/content/docs/references/automation/etl/ETLTransformationType.mdx deleted file mode 100644 index 3cce6ed20..000000000 --- a/content/docs/references/automation/etl/ETLTransformationType.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ETLTransformationType -description: ETLTransformationType Schema Reference -category: automation -zodFile: etl ---- - - - -**Source:** `packages/spec/src/automation/etl.zod.ts` - - -## Allowed Values - -* `map` -* `filter` -* `aggregate` -* `join` -* `script` -* `lookup` -* `split` -* `merge` -* `normalize` -* `deduplicate` - -## TypeScript Usage - -```typescript -import { ETLTransformationType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ETLTransformationType = 'map'; -``` - diff --git a/content/docs/references/automation/etl/meta.json b/content/docs/references/automation/etl/meta.json deleted file mode 100644 index d3fd031f1..000000000 --- a/content/docs/references/automation/etl/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Etl" -} \ No newline at end of file diff --git a/content/docs/references/automation/flow.mdx b/content/docs/references/automation/flow.mdx new file mode 100644 index 000000000..243e52364 --- /dev/null +++ b/content/docs/references/automation/flow.mdx @@ -0,0 +1,107 @@ +--- +title: Flow +description: Flow protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Flow + + +**Source:** `packages/spec/src/automation/flow.zod.ts` + + +## TypeScript Usage + +```typescript +import { FlowSchema, FlowEdgeSchema, FlowNodeSchema, FlowNodeActionSchema, FlowVariableSchema } from '@objectstack/spec/automation'; +import type { Flow, FlowEdge, FlowNode, FlowNodeAction, FlowVariable } from '@objectstack/spec/automation'; + +// Validate data +const result = FlowSchema.parse(data); +``` + +--- + +## Flow + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Machine name | +| **label** | `string` | ✅ | Flow label | +| **description** | `string` | optional | | +| **version** | `integer` | optional | Version number | +| **status** | `Enum<'draft' \| 'active' \| 'obsolete' \| 'invalid'>` | optional | Deployment status | +| **template** | `boolean` | optional | Is logic template (Subflow) | +| **type** | `Enum<'autolaunched' \| 'record_change' \| 'schedule' \| 'screen' \| 'api'>` | ✅ | Flow type | +| **variables** | `object[]` | optional | Flow variables | +| **nodes** | `object[]` | ✅ | Flow nodes | +| **edges** | `object[]` | ✅ | Flow connections | +| **active** | `boolean` | optional | Is active (Deprecated: use status) | +| **runAs** | `Enum<'system' \| 'user'>` | optional | Execution context | + +--- + +## FlowEdge + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Edge unique ID | +| **source** | `string` | ✅ | Source Node ID | +| **target** | `string` | ✅ | Target Node ID | +| **condition** | `string` | optional | Expression returning boolean used for branching | +| **type** | `Enum<'default' \| 'fault'>` | optional | Connection type: Standard (Success) or Fault (Error) path | +| **label** | `string` | optional | Label on the connector | + +--- + +## FlowNode + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Node unique ID | +| **type** | `Enum<'start' \| 'end' \| 'decision' \| 'assignment' \| 'loop' \| 'create_record' \| 'update_record' \| 'delete_record' \| 'get_record' \| 'http_request' \| 'script' \| 'wait' \| 'subflow'>` | ✅ | Action type | +| **label** | `string` | ✅ | Node label | +| **config** | `Record` | optional | Node configuration | +| **position** | `object` | optional | | + +--- + +## FlowNodeAction + +### Allowed Values + +* `start` +* `end` +* `decision` +* `assignment` +* `loop` +* `create_record` +* `update_record` +* `delete_record` +* `get_record` +* `http_request` +* `script` +* `wait` +* `subflow` + +--- + +## FlowVariable + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Variable name | +| **type** | `string` | ✅ | Data type (text, number, boolean, object, list) | +| **isInput** | `boolean` | optional | Is input parameter | +| **isOutput** | `boolean` | optional | Is output parameter | + diff --git a/content/docs/references/automation/flow/Flow.mdx b/content/docs/references/automation/flow/Flow.mdx deleted file mode 100644 index c6ca01803..000000000 --- a/content/docs/references/automation/flow/Flow.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Flow -description: Flow Schema Reference -category: automation -zodFile: flow ---- - - - -**Source:** `packages/spec/src/automation/flow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Machine name | -| **label** | `string` | ✅ | Flow label | -| **description** | `string` | optional | | -| **version** | `integer` | optional | Version number | -| **status** | `Enum<'draft' \| 'active' \| 'obsolete' \| 'invalid'>` | optional | Deployment status | -| **template** | `boolean` | optional | Is logic template (Subflow) | -| **type** | `Enum<'autolaunched' \| 'record_change' \| 'schedule' \| 'screen' \| 'api'>` | ✅ | Flow type | -| **variables** | `object[]` | optional | Flow variables | -| **nodes** | `object[]` | ✅ | Flow nodes | -| **edges** | `object[]` | ✅ | Flow connections | -| **active** | `boolean` | optional | Is active (Deprecated: use status) | -| **runAs** | `Enum<'system' \| 'user'>` | optional | Execution context | - -## TypeScript Usage - -```typescript -import { FlowSchema } from '@objectstack/spec/automation'; -import type { Flow } from '@objectstack/spec/automation'; - -// Validate data -const result = FlowSchema.parse(data); - -// Type-safe usage -const myFlow: Flow = { - name: 'name', - label: 'example', - type: 'autolaunched', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/flow/FlowEdge.mdx b/content/docs/references/automation/flow/FlowEdge.mdx deleted file mode 100644 index 3d9f369ee..000000000 --- a/content/docs/references/automation/flow/FlowEdge.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FlowEdge -description: FlowEdge Schema Reference -category: automation -zodFile: flow ---- - - - -**Source:** `packages/spec/src/automation/flow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Edge unique ID | -| **source** | `string` | ✅ | Source Node ID | -| **target** | `string` | ✅ | Target Node ID | -| **condition** | `string` | optional | Expression returning boolean used for branching | -| **type** | `Enum<'default' \| 'fault'>` | optional | Connection type: Standard (Success) or Fault (Error) path | -| **label** | `string` | optional | Label on the connector | - -## TypeScript Usage - -```typescript -import { FlowEdgeSchema } from '@objectstack/spec/automation'; -import type { FlowEdge } from '@objectstack/spec/automation'; - -// Validate data -const result = FlowEdgeSchema.parse(data); - -// Type-safe usage -const myFlowEdge: FlowEdge = { - id: 'example', - source: 'example', - target: 'example' -}; -``` - diff --git a/content/docs/references/automation/flow/FlowNode.mdx b/content/docs/references/automation/flow/FlowNode.mdx deleted file mode 100644 index 26a0d2804..000000000 --- a/content/docs/references/automation/flow/FlowNode.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: FlowNode -description: FlowNode Schema Reference -category: automation -zodFile: flow ---- - - - -**Source:** `packages/spec/src/automation/flow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Node unique ID | -| **type** | `Enum<'start' \| 'end' \| 'decision' \| 'assignment' \| 'loop' \| 'create_record' \| 'update_record' \| 'delete_record' \| 'get_record' \| 'http_request' \| 'script' \| 'wait' \| 'subflow'>` | ✅ | Action type | -| **label** | `string` | ✅ | Node label | -| **config** | `Record` | optional | Node configuration | -| **position** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { FlowNodeSchema } from '@objectstack/spec/automation'; -import type { FlowNode } from '@objectstack/spec/automation'; - -// Validate data -const result = FlowNodeSchema.parse(data); - -// Type-safe usage -const myFlowNode: FlowNode = { - id: 'example', - type: 'start', - label: 'example' -}; -``` - diff --git a/content/docs/references/automation/flow/FlowNodeAction.mdx b/content/docs/references/automation/flow/FlowNodeAction.mdx deleted file mode 100644 index 7f77857b6..000000000 --- a/content/docs/references/automation/flow/FlowNodeAction.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FlowNodeAction -description: FlowNodeAction Schema Reference -category: automation -zodFile: flow ---- - - - -**Source:** `packages/spec/src/automation/flow.zod.ts` - - -## Allowed Values - -* `start` -* `end` -* `decision` -* `assignment` -* `loop` -* `create_record` -* `update_record` -* `delete_record` -* `get_record` -* `http_request` -* `script` -* `wait` -* `subflow` - -## TypeScript Usage - -```typescript -import { FlowNodeAction } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: FlowNodeAction = 'start'; -``` - diff --git a/content/docs/references/automation/flow/FlowVariable.mdx b/content/docs/references/automation/flow/FlowVariable.mdx deleted file mode 100644 index 19ef35205..000000000 --- a/content/docs/references/automation/flow/FlowVariable.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FlowVariable -description: FlowVariable Schema Reference -category: automation -zodFile: flow ---- - - - -**Source:** `packages/spec/src/automation/flow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Variable name | -| **type** | `string` | ✅ | Data type (text, number, boolean, object, list) | -| **isInput** | `boolean` | optional | Is input parameter | -| **isOutput** | `boolean` | optional | Is output parameter | - -## TypeScript Usage - -```typescript -import { FlowVariableSchema } from '@objectstack/spec/automation'; -import type { FlowVariable } from '@objectstack/spec/automation'; - -// Validate data -const result = FlowVariableSchema.parse(data); - -// Type-safe usage -const myFlowVariable: FlowVariable = { - name: 'name', - type: 'example' -}; -``` - diff --git a/content/docs/references/automation/flow/meta.json b/content/docs/references/automation/flow/meta.json deleted file mode 100644 index 51349f2a7..000000000 --- a/content/docs/references/automation/flow/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Flow" -} \ No newline at end of file diff --git a/content/docs/references/automation/index.mdx b/content/docs/references/automation/index.mdx index 413461bf2..157a61322 100644 --- a/content/docs/references/automation/index.mdx +++ b/content/docs/references/automation/index.mdx @@ -3,112 +3,19 @@ title: Automation Protocol Overview description: Complete reference for all automation protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # Automation Protocol This section contains all protocol schemas for the automation layer of ObjectStack. -## Approval - -Source: `packages/spec/src/automation/approval.zod.ts` - - - - - - - - - -## Connector - -Source: `packages/spec/src/automation/connector.zod.ts` - - - - - - - - - - - - - - - -## Etl - -Source: `packages/spec/src/automation/etl.zod.ts` - - - - - - - - - - - - - -## Flow - -Source: `packages/spec/src/automation/flow.zod.ts` - - - - - - - - - -## Sync - -Source: `packages/spec/src/automation/sync.zod.ts` - - - - - - - - - - - - -## Webhook - -Source: `packages/spec/src/automation/webhook.zod.ts` - - - - - - - -## Workflow - -Source: `packages/spec/src/automation/workflow.zod.ts` - - - - - - - - - - - - - - - + + + + + + + diff --git a/content/docs/references/automation/mapping/FieldMapping.mdx b/content/docs/references/automation/mapping.mdx similarity index 75% rename from content/docs/references/automation/mapping/FieldMapping.mdx rename to content/docs/references/automation/mapping.mdx index 686ee1a3c..45581e06b 100644 --- a/content/docs/references/automation/mapping/FieldMapping.mdx +++ b/content/docs/references/automation/mapping.mdx @@ -1,25 +1,17 @@ --- -title: FieldMapping -description: FieldMapping Schema Reference -category: automation -zodFile: mapping +title: Mapping +description: Mapping protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Mapping **Source:** `packages/spec/src/automation/mapping.zod.ts` -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **sourceField** | `string` | ✅ | Source field name | -| **destinationField** | `string` | ✅ | Destination field name | -| **transform** | `string` | optional | Transformation formula | -| **default** | `any` | optional | Default value | -| **syncNull** | `boolean` | optional | Sync null values | - ## TypeScript Usage ```typescript @@ -28,11 +20,19 @@ import type { FieldMapping } from '@objectstack/spec/automation'; // Validate data const result = FieldMappingSchema.parse(data); - -// Type-safe usage -const myFieldMapping: FieldMapping = { - sourceField: 'example', - destinationField: 'example' -}; ``` +--- + +## FieldMapping + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **sourceField** | `string` | ✅ | Source field name | +| **destinationField** | `string` | ✅ | Destination field name | +| **transform** | `string` | optional | Transformation formula | +| **default** | `any` | optional | Default value | +| **syncNull** | `boolean` | optional | Sync null values | + diff --git a/content/docs/references/automation/sync.mdx b/content/docs/references/automation/sync.mdx new file mode 100644 index 000000000..cf7af8ae7 --- /dev/null +++ b/content/docs/references/automation/sync.mdx @@ -0,0 +1,144 @@ +--- +title: Sync +description: Sync protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Sync + + +**Source:** `packages/spec/src/automation/sync.zod.ts` + + +## TypeScript Usage + +```typescript +import { ConflictResolutionSchema, DataDestinationConfigSchema, DataSourceConfigSchema, DataSyncConfigSchema, SyncDirectionSchema, SyncExecutionResultSchema, SyncExecutionStatusSchema, SyncModeSchema } from '@objectstack/spec/automation'; +import type { ConflictResolution, DataDestinationConfig, DataSourceConfig, DataSyncConfig, SyncDirection, SyncExecutionResult, SyncExecutionStatus, SyncMode } from '@objectstack/spec/automation'; + +// Validate data +const result = ConflictResolutionSchema.parse(data); +``` + +--- + +## ConflictResolution + +### Allowed Values + +* `source_wins` +* `destination_wins` +* `latest_wins` +* `manual` +* `merge` + +--- + +## DataDestinationConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **object** | `string` | optional | ObjectStack object name | +| **connectorInstanceId** | `string` | optional | Connector instance ID | +| **operation** | `Enum<'insert' \| 'update' \| 'upsert' \| 'delete' \| 'sync'>` | ✅ | Sync operation | +| **mapping** | `Record \| object[]` | optional | Field mappings | +| **externalResource** | `string` | optional | External resource ID | +| **matchKey** | `string[]` | optional | Match key fields | + +--- + +## DataSourceConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **object** | `string` | optional | ObjectStack object name | +| **filters** | `any` | optional | Filter conditions | +| **fields** | `string[]` | optional | Fields to sync | +| **connectorInstanceId** | `string` | optional | Connector instance ID | +| **externalResource** | `string` | optional | External resource ID | + +--- + +## DataSyncConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Sync configuration name (snake_case) | +| **label** | `string` | optional | Sync display name | +| **description** | `string` | optional | Sync description | +| **source** | `object` | ✅ | Data source | +| **destination** | `object` | ✅ | Data destination | +| **direction** | `Enum<'push' \| 'pull' \| 'bidirectional'>` | optional | Sync direction | +| **syncMode** | `Enum<'full' \| 'incremental' \| 'realtime'>` | optional | Sync mode | +| **conflictResolution** | `Enum<'source_wins' \| 'destination_wins' \| 'latest_wins' \| 'manual' \| 'merge'>` | optional | Conflict resolution | +| **schedule** | `string` | optional | Cron schedule | +| **enabled** | `boolean` | optional | Sync enabled | +| **changeTrackingField** | `string` | optional | Field for change tracking | +| **batchSize** | `integer` | optional | Batch size for processing | +| **retry** | `object` | optional | Retry configuration | +| **validation** | `object` | optional | Validation rules | +| **errorHandling** | `object` | optional | Error handling | +| **optimization** | `object` | optional | Performance optimization | +| **audit** | `object` | optional | Audit configuration | +| **tags** | `string[]` | optional | Sync tags | +| **metadata** | `Record` | optional | Custom metadata | + +--- + +## SyncDirection + +### Allowed Values + +* `push` +* `pull` +* `bidirectional` + +--- + +## SyncExecutionResult + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Execution ID | +| **syncName** | `string` | ✅ | Sync name | +| **status** | `Enum<'pending' \| 'running' \| 'completed' \| 'partial' \| 'failed' \| 'cancelled'>` | ✅ | Execution status | +| **startedAt** | `string` | ✅ | Start time | +| **completedAt** | `string` | optional | Completion time | +| **durationMs** | `number` | optional | Duration in ms | +| **stats** | `object` | optional | Execution statistics | +| **errors** | `object[]` | optional | Errors | +| **logs** | `string[]` | optional | Execution logs | + +--- + +## SyncExecutionStatus + +### Allowed Values + +* `pending` +* `running` +* `completed` +* `partial` +* `failed` +* `cancelled` + +--- + +## SyncMode + +### Allowed Values + +* `full` +* `incremental` +* `realtime` + diff --git a/content/docs/references/automation/sync/ConflictResolution.mdx b/content/docs/references/automation/sync/ConflictResolution.mdx deleted file mode 100644 index b24c576ab..000000000 --- a/content/docs/references/automation/sync/ConflictResolution.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: ConflictResolution -description: ConflictResolution Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Allowed Values - -* `source_wins` -* `destination_wins` -* `latest_wins` -* `manual` -* `merge` - -## TypeScript Usage - -```typescript -import { ConflictResolution } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: ConflictResolution = 'source_wins'; -``` - diff --git a/content/docs/references/automation/sync/DataDestinationConfig.mdx b/content/docs/references/automation/sync/DataDestinationConfig.mdx deleted file mode 100644 index e01f377dc..000000000 --- a/content/docs/references/automation/sync/DataDestinationConfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: DataDestinationConfig -description: DataDestinationConfig Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **object** | `string` | optional | ObjectStack object name | -| **connectorInstanceId** | `string` | optional | Connector instance ID | -| **operation** | `Enum<'insert' \| 'update' \| 'upsert' \| 'delete' \| 'sync'>` | ✅ | Sync operation | -| **mapping** | `Record \| object[]` | optional | Field mappings | -| **externalResource** | `string` | optional | External resource ID | -| **matchKey** | `string[]` | optional | Match key fields | - -## TypeScript Usage - -```typescript -import { DataDestinationConfigSchema } from '@objectstack/spec/automation'; -import type { DataDestinationConfig } from '@objectstack/spec/automation'; - -// Validate data -const result = DataDestinationConfigSchema.parse(data); - -// Type-safe usage -const myDataDestinationConfig: DataDestinationConfig = { - operation: 'insert' -}; -``` - diff --git a/content/docs/references/automation/sync/DataSourceConfig.mdx b/content/docs/references/automation/sync/DataSourceConfig.mdx deleted file mode 100644 index 4edb3f698..000000000 --- a/content/docs/references/automation/sync/DataSourceConfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DataSourceConfig -description: DataSourceConfig Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **object** | `string` | optional | ObjectStack object name | -| **filters** | `any` | optional | Filter conditions | -| **fields** | `string[]` | optional | Fields to sync | -| **connectorInstanceId** | `string` | optional | Connector instance ID | -| **externalResource** | `string` | optional | External resource ID | - -## TypeScript Usage - -```typescript -import { DataSourceConfigSchema } from '@objectstack/spec/automation'; -import type { DataSourceConfig } from '@objectstack/spec/automation'; - -// Validate data -const result = DataSourceConfigSchema.parse(data); - -// Type-safe usage -const myDataSourceConfig: DataSourceConfig = { -}; -``` - diff --git a/content/docs/references/automation/sync/DataSyncConfig.mdx b/content/docs/references/automation/sync/DataSyncConfig.mdx deleted file mode 100644 index 5aa8cdbc6..000000000 --- a/content/docs/references/automation/sync/DataSyncConfig.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: DataSyncConfig -description: DataSyncConfig Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Sync configuration name (snake_case) | -| **label** | `string` | optional | Sync display name | -| **description** | `string` | optional | Sync description | -| **source** | `object` | ✅ | Data source | -| **destination** | `object` | ✅ | Data destination | -| **direction** | `Enum<'push' \| 'pull' \| 'bidirectional'>` | optional | Sync direction | -| **syncMode** | `Enum<'full' \| 'incremental' \| 'realtime'>` | optional | Sync mode | -| **conflictResolution** | `Enum<'source_wins' \| 'destination_wins' \| 'latest_wins' \| 'manual' \| 'merge'>` | optional | Conflict resolution | -| **schedule** | `string` | optional | Cron schedule | -| **enabled** | `boolean` | optional | Sync enabled | -| **changeTrackingField** | `string` | optional | Field for change tracking | -| **batchSize** | `integer` | optional | Batch size for processing | -| **retry** | `object` | optional | Retry configuration | -| **validation** | `object` | optional | Validation rules | -| **errorHandling** | `object` | optional | Error handling | -| **optimization** | `object` | optional | Performance optimization | -| **audit** | `object` | optional | Audit configuration | -| **tags** | `string[]` | optional | Sync tags | -| **metadata** | `Record` | optional | Custom metadata | - -## TypeScript Usage - -```typescript -import { DataSyncConfigSchema } from '@objectstack/spec/automation'; -import type { DataSyncConfig } from '@objectstack/spec/automation'; - -// Validate data -const result = DataSyncConfigSchema.parse(data); - -// Type-safe usage -const myDataSyncConfig: DataSyncConfig = { - name: 'name', - source: {}, - destination: {} -}; -``` - diff --git a/content/docs/references/automation/sync/SyncDirection.mdx b/content/docs/references/automation/sync/SyncDirection.mdx deleted file mode 100644 index 6c2ab3cbb..000000000 --- a/content/docs/references/automation/sync/SyncDirection.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: SyncDirection -description: SyncDirection Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Allowed Values - -* `push` -* `pull` -* `bidirectional` - -## TypeScript Usage - -```typescript -import { SyncDirection } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: SyncDirection = 'push'; -``` - diff --git a/content/docs/references/automation/sync/SyncExecutionResult.mdx b/content/docs/references/automation/sync/SyncExecutionResult.mdx deleted file mode 100644 index 01b2c96d8..000000000 --- a/content/docs/references/automation/sync/SyncExecutionResult.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SyncExecutionResult -description: SyncExecutionResult Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Execution ID | -| **syncName** | `string` | ✅ | Sync name | -| **status** | `Enum<'pending' \| 'running' \| 'completed' \| 'partial' \| 'failed' \| 'cancelled'>` | ✅ | Execution status | -| **startedAt** | `string` | ✅ | Start time | -| **completedAt** | `string` | optional | Completion time | -| **durationMs** | `number` | optional | Duration in ms | -| **stats** | `object` | optional | Execution statistics | -| **errors** | `object[]` | optional | Errors | -| **logs** | `string[]` | optional | Execution logs | - -## TypeScript Usage - -```typescript -import { SyncExecutionResultSchema } from '@objectstack/spec/automation'; -import type { SyncExecutionResult } from '@objectstack/spec/automation'; - -// Validate data -const result = SyncExecutionResultSchema.parse(data); - -// Type-safe usage -const mySyncExecutionResult: SyncExecutionResult = { - id: 'example', - syncName: 'example', - status: 'pending', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/sync/SyncExecutionStatus.mdx b/content/docs/references/automation/sync/SyncExecutionStatus.mdx deleted file mode 100644 index d2624a80b..000000000 --- a/content/docs/references/automation/sync/SyncExecutionStatus.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: SyncExecutionStatus -description: SyncExecutionStatus Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Allowed Values - -* `pending` -* `running` -* `completed` -* `partial` -* `failed` -* `cancelled` - -## TypeScript Usage - -```typescript -import { SyncExecutionStatus } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: SyncExecutionStatus = 'pending'; -``` - diff --git a/content/docs/references/automation/sync/SyncMode.mdx b/content/docs/references/automation/sync/SyncMode.mdx deleted file mode 100644 index 2cbc9db1e..000000000 --- a/content/docs/references/automation/sync/SyncMode.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: SyncMode -description: SyncMode Schema Reference -category: automation -zodFile: sync ---- - - - -**Source:** `packages/spec/src/automation/sync.zod.ts` - - -## Allowed Values - -* `full` -* `incremental` -* `realtime` - -## TypeScript Usage - -```typescript -import { SyncMode } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: SyncMode = 'full'; -``` - diff --git a/content/docs/references/automation/sync/meta.json b/content/docs/references/automation/sync/meta.json deleted file mode 100644 index 770697c20..000000000 --- a/content/docs/references/automation/sync/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Sync" -} \ No newline at end of file diff --git a/content/docs/references/automation/webhook/Webhook.mdx b/content/docs/references/automation/webhook.mdx similarity index 50% rename from content/docs/references/automation/webhook/Webhook.mdx rename to content/docs/references/automation/webhook.mdx index 7b3931e30..982a8dcc7 100644 --- a/content/docs/references/automation/webhook/Webhook.mdx +++ b/content/docs/references/automation/webhook.mdx @@ -1,16 +1,32 @@ --- title: Webhook -description: Webhook Schema Reference -category: automation -zodFile: webhook +description: Webhook protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Webhook **Source:** `packages/spec/src/automation/webhook.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { WebhookSchema, WebhookReceiverSchema, WebhookTriggerTypeSchema } from '@objectstack/spec/automation'; +import type { Webhook, WebhookReceiver, WebhookTriggerType } from '@objectstack/spec/automation'; + +// Validate data +const result = WebhookSchema.parse(data); +``` + +--- + +## Webhook + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -27,21 +43,30 @@ zodFile: webhook | **retryCount** | `number` | optional | | | **isActive** | `boolean` | optional | | -## TypeScript Usage +--- -```typescript -import { WebhookSchema } from '@objectstack/spec/automation'; -import type { Webhook } from '@objectstack/spec/automation'; +## WebhookReceiver -// Validate data -const result = WebhookSchema.parse(data); +### Properties -// Type-safe usage -const myWebhook: Webhook = { - name: 'name', - object: 'example', - triggers: [], - // ... other required fields -}; -``` +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Webhook receiver unique name (lowercase snake_case) | +| **path** | `string` | ✅ | URL Path (e.g. /webhooks/stripe) | +| **verificationType** | `Enum<'none' \| 'header_token' \| 'hmac' \| 'ip_whitelist'>` | optional | | +| **verificationParams** | `object` | optional | | +| **action** | `Enum<'trigger_flow' \| 'script' \| 'upsert_record'>` | optional | | +| **target** | `string` | ✅ | Flow ID or Script name | + +--- + +## WebhookTriggerType + +### Allowed Values + +* `create` +* `update` +* `delete` +* `undelete` +* `api` diff --git a/content/docs/references/automation/webhook/WebhookReceiver.mdx b/content/docs/references/automation/webhook/WebhookReceiver.mdx deleted file mode 100644 index 7a290fea1..000000000 --- a/content/docs/references/automation/webhook/WebhookReceiver.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebhookReceiver -description: WebhookReceiver Schema Reference -category: automation -zodFile: webhook ---- - - - -**Source:** `packages/spec/src/automation/webhook.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Webhook receiver unique name (lowercase snake_case) | -| **path** | `string` | ✅ | URL Path (e.g. /webhooks/stripe) | -| **verificationType** | `Enum<'none' \| 'header_token' \| 'hmac' \| 'ip_whitelist'>` | optional | | -| **verificationParams** | `object` | optional | | -| **action** | `Enum<'trigger_flow' \| 'script' \| 'upsert_record'>` | optional | | -| **target** | `string` | ✅ | Flow ID or Script name | - -## TypeScript Usage - -```typescript -import { WebhookReceiverSchema } from '@objectstack/spec/automation'; -import type { WebhookReceiver } from '@objectstack/spec/automation'; - -// Validate data -const result = WebhookReceiverSchema.parse(data); - -// Type-safe usage -const myWebhookReceiver: WebhookReceiver = { - name: 'name', - path: 'example', - target: 'example' -}; -``` - diff --git a/content/docs/references/automation/webhook/WebhookTriggerType.mdx b/content/docs/references/automation/webhook/WebhookTriggerType.mdx deleted file mode 100644 index 74d5f9efe..000000000 --- a/content/docs/references/automation/webhook/WebhookTriggerType.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: WebhookTriggerType -description: WebhookTriggerType Schema Reference -category: automation -zodFile: webhook ---- - - - -**Source:** `packages/spec/src/automation/webhook.zod.ts` - - -## Allowed Values - -* `create` -* `update` -* `delete` -* `undelete` -* `api` - -## TypeScript Usage - -```typescript -import { WebhookTriggerType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: WebhookTriggerType = 'create'; -``` - diff --git a/content/docs/references/automation/webhook/meta.json b/content/docs/references/automation/webhook/meta.json deleted file mode 100644 index 790fdad82..000000000 --- a/content/docs/references/automation/webhook/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Webhook" -} \ No newline at end of file diff --git a/content/docs/references/automation/workflow.mdx b/content/docs/references/automation/workflow.mdx new file mode 100644 index 000000000..4713b8040 --- /dev/null +++ b/content/docs/references/automation/workflow.mdx @@ -0,0 +1,230 @@ +--- +title: Workflow +description: Workflow protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Workflow + + +**Source:** `packages/spec/src/automation/workflow.zod.ts` + + +## TypeScript Usage + +```typescript +import { CustomScriptActionSchema, EmailAlertActionSchema, FieldUpdateActionSchema, HttpCallActionSchema, PushNotificationActionSchema, SlackMessageActionSchema, SmsNotificationActionSchema, TaskCreationActionSchema, TeamsMessageActionSchema, TimeTriggerSchema, WebhookTriggerActionSchema, WorkflowActionSchema, WorkflowRuleSchema, WorkflowTriggerTypeSchema } from '@objectstack/spec/automation'; +import type { CustomScriptAction, EmailAlertAction, FieldUpdateAction, HttpCallAction, PushNotificationAction, SlackMessageAction, SmsNotificationAction, TaskCreationAction, TeamsMessageAction, TimeTrigger, WebhookTriggerAction, WorkflowAction, WorkflowRule, WorkflowTriggerType } from '@objectstack/spec/automation'; + +// Validate data +const result = CustomScriptActionSchema.parse(data); +``` + +--- + +## CustomScriptAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **language** | `Enum<'javascript' \| 'typescript' \| 'python'>` | optional | Script language | +| **code** | `string` | ✅ | Script code to execute | +| **timeout** | `number` | optional | Execution timeout in milliseconds | +| **context** | `Record` | optional | Additional context variables | + +--- + +## EmailAlertAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **template** | `string` | ✅ | Email template ID/DevName | +| **recipients** | `string[]` | ✅ | List of recipient emails or user IDs | + +--- + +## FieldUpdateAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **field** | `string` | ✅ | Field to update | +| **value** | `any` | optional | Value or Formula to set | + +--- + +## HttpCallAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **url** | `string` | ✅ | Target URL | +| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'>` | ✅ | HTTP method | +| **headers** | `Record` | optional | Request headers | +| **body** | `any` | optional | Request body (object/string) | +| **authentication** | `object` | optional | Authentication configuration | +| **timeout** | `number` | optional | Request timeout in milliseconds | + +--- + +## PushNotificationAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **title** | `string` | ✅ | Notification title | +| **body** | `string` | ✅ | Notification body text | +| **recipients** | `string[]` | ✅ | User IDs or device tokens | +| **data** | `Record` | optional | Additional data payload | +| **badge** | `number` | optional | Badge count (iOS) | +| **sound** | `string` | optional | Notification sound | +| **clickAction** | `string` | optional | Action/URL when notification is clicked | + +--- + +## SlackMessageAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **channel** | `string` | ✅ | Slack channel ID or name (#channel) | +| **message** | `string` | ✅ | Message text with optional markdown | +| **mentions** | `string[]` | optional | User IDs or @username to mention | +| **threadId** | `string` | optional | Thread ID for replies | + +--- + +## SmsNotificationAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **provider** | `Enum<'twilio' \| 'vonage'>` | ✅ | SMS provider | +| **recipients** | `string[]` | ✅ | List of phone numbers or user field references | +| **message** | `string` | ✅ | SMS message text or template | +| **fromNumber** | `string` | optional | Sender phone number (provider-specific) | + +--- + +## TaskCreationAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **taskObject** | `string` | ✅ | Task object name (e.g., "task", "project_task") | +| **subject** | `string` | ✅ | Task subject/title | +| **description** | `string` | optional | Task description | +| **assignedTo** | `string` | optional | User ID or field reference for assignee | +| **dueDate** | `string` | optional | Due date (ISO string or formula) | +| **priority** | `string` | optional | Task priority | +| **relatedTo** | `string` | optional | Related record ID or field reference | +| **additionalFields** | `Record` | optional | Additional custom fields | + +--- + +## TeamsMessageAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **channel** | `string` | ✅ | Teams channel ID | +| **message** | `string` | ✅ | Message text with optional markdown | +| **mentions** | `string[]` | optional | User IDs to mention | +| **teamId** | `string` | optional | Team ID (if not in default team) | + +--- + +## TimeTrigger + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | optional | Unique identifier | +| **timeLength** | `integer` | ✅ | Duration amount (e.g. 1, 30) | +| **timeUnit** | `Enum<'minutes' \| 'hours' \| 'days'>` | ✅ | Unit of time | +| **offsetDirection** | `Enum<'before' \| 'after'>` | ✅ | Before or After the reference date | +| **offsetFrom** | `Enum<'trigger_date' \| 'date_field'>` | ✅ | Basis for calculation | +| **dateField** | `string` | optional | Date field to calculate from (required if offsetFrom is date_field) | +| **actions** | `object \| object \| object \| object \| object \| object \| object \| object \| object \| object[]` | ✅ | Actions to execute at the scheduled time | + +--- + +## WebhookTriggerAction + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Action name | +| **type** | `string` | ✅ | | +| **url** | `string` | ✅ | Webhook URL to call | +| **method** | `Enum<'POST' \| 'PUT'>` | optional | HTTP method | +| **headers** | `Record` | optional | Custom headers | +| **payload** | `any` | optional | Webhook payload (uses record data if not specified) | +| **retryOnFailure** | `boolean` | optional | Retry if webhook fails | +| **maxRetries** | `number` | optional | Maximum retry attempts | + +--- + +## WorkflowAction + +--- + +## WorkflowRule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique workflow name (lowercase snake_case) | +| **objectName** | `string` | ✅ | Target Object | +| **triggerType** | `Enum<'on_create' \| 'on_update' \| 'on_create_or_update' \| 'on_delete' \| 'schedule'>` | ✅ | When to evaluate | +| **criteria** | `string` | optional | Formula condition. If TRUE, actions execute. | +| **actions** | `object \| object \| object \| object \| object \| object \| object \| object \| object \| object[]` | optional | Immediate actions | +| **timeTriggers** | `object[]` | optional | Scheduled actions relative to trigger or date field | +| **active** | `boolean` | optional | Whether this workflow is active | +| **reevaluateOnChange** | `boolean` | optional | Re-evaluate rule if field updates change the record validity | + +--- + +## WorkflowTriggerType + +### Allowed Values + +* `on_create` +* `on_update` +* `on_create_or_update` +* `on_delete` +* `schedule` + diff --git a/content/docs/references/automation/workflow/CustomScriptAction.mdx b/content/docs/references/automation/workflow/CustomScriptAction.mdx deleted file mode 100644 index 7d209732e..000000000 --- a/content/docs/references/automation/workflow/CustomScriptAction.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CustomScriptAction -description: CustomScriptAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **language** | `Enum<'javascript' \| 'typescript' \| 'python'>` | optional | Script language | -| **code** | `string` | ✅ | Script code to execute | -| **timeout** | `number` | optional | Execution timeout in milliseconds | -| **context** | `Record` | optional | Additional context variables | - -## TypeScript Usage - -```typescript -import { CustomScriptActionSchema } from '@objectstack/spec/automation'; -import type { CustomScriptAction } from '@objectstack/spec/automation'; - -// Validate data -const result = CustomScriptActionSchema.parse(data); - -// Type-safe usage -const myCustomScriptAction: CustomScriptAction = { - name: 'name', - type: 'example', - code: 'example' -}; -``` - diff --git a/content/docs/references/automation/workflow/EmailAlertAction.mdx b/content/docs/references/automation/workflow/EmailAlertAction.mdx deleted file mode 100644 index 389b147f5..000000000 --- a/content/docs/references/automation/workflow/EmailAlertAction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: EmailAlertAction -description: EmailAlertAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **template** | `string` | ✅ | Email template ID/DevName | -| **recipients** | `string[]` | ✅ | List of recipient emails or user IDs | - -## TypeScript Usage - -```typescript -import { EmailAlertActionSchema } from '@objectstack/spec/automation'; -import type { EmailAlertAction } from '@objectstack/spec/automation'; - -// Validate data -const result = EmailAlertActionSchema.parse(data); - -// Type-safe usage -const myEmailAlertAction: EmailAlertAction = { - name: 'name', - type: 'example', - template: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/FieldUpdateAction.mdx b/content/docs/references/automation/workflow/FieldUpdateAction.mdx deleted file mode 100644 index 7ab72492b..000000000 --- a/content/docs/references/automation/workflow/FieldUpdateAction.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: FieldUpdateAction -description: FieldUpdateAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **field** | `string` | ✅ | Field to update | -| **value** | `any` | optional | Value or Formula to set | - -## TypeScript Usage - -```typescript -import { FieldUpdateActionSchema } from '@objectstack/spec/automation'; -import type { FieldUpdateAction } from '@objectstack/spec/automation'; - -// Validate data -const result = FieldUpdateActionSchema.parse(data); - -// Type-safe usage -const myFieldUpdateAction: FieldUpdateAction = { - name: 'name', - type: 'example', - field: 'example' -}; -``` - diff --git a/content/docs/references/automation/workflow/HttpCallAction.mdx b/content/docs/references/automation/workflow/HttpCallAction.mdx deleted file mode 100644 index ec06fd80e..000000000 --- a/content/docs/references/automation/workflow/HttpCallAction.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: HttpCallAction -description: HttpCallAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **url** | `string` | ✅ | Target URL | -| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'>` | ✅ | HTTP method | -| **headers** | `Record` | optional | Request headers | -| **body** | `any` | optional | Request body (object/string) | -| **authentication** | `object` | optional | Authentication configuration | -| **timeout** | `number` | optional | Request timeout in milliseconds | - -## TypeScript Usage - -```typescript -import { HttpCallActionSchema } from '@objectstack/spec/automation'; -import type { HttpCallAction } from '@objectstack/spec/automation'; - -// Validate data -const result = HttpCallActionSchema.parse(data); - -// Type-safe usage -const myHttpCallAction: HttpCallAction = { - name: 'name', - type: 'example', - url: 'https://example.com', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/PushNotificationAction.mdx b/content/docs/references/automation/workflow/PushNotificationAction.mdx deleted file mode 100644 index 51e89933f..000000000 --- a/content/docs/references/automation/workflow/PushNotificationAction.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PushNotificationAction -description: PushNotificationAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **title** | `string` | ✅ | Notification title | -| **body** | `string` | ✅ | Notification body text | -| **recipients** | `string[]` | ✅ | User IDs or device tokens | -| **data** | `Record` | optional | Additional data payload | -| **badge** | `number` | optional | Badge count (iOS) | -| **sound** | `string` | optional | Notification sound | -| **clickAction** | `string` | optional | Action/URL when notification is clicked | - -## TypeScript Usage - -```typescript -import { PushNotificationActionSchema } from '@objectstack/spec/automation'; -import type { PushNotificationAction } from '@objectstack/spec/automation'; - -// Validate data -const result = PushNotificationActionSchema.parse(data); - -// Type-safe usage -const myPushNotificationAction: PushNotificationAction = { - name: 'name', - type: 'example', - title: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/SlackMessageAction.mdx b/content/docs/references/automation/workflow/SlackMessageAction.mdx deleted file mode 100644 index 7b179e10d..000000000 --- a/content/docs/references/automation/workflow/SlackMessageAction.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: SlackMessageAction -description: SlackMessageAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **channel** | `string` | ✅ | Slack channel ID or name (#channel) | -| **message** | `string` | ✅ | Message text with optional markdown | -| **mentions** | `string[]` | optional | User IDs or @username to mention | -| **threadId** | `string` | optional | Thread ID for replies | - -## TypeScript Usage - -```typescript -import { SlackMessageActionSchema } from '@objectstack/spec/automation'; -import type { SlackMessageAction } from '@objectstack/spec/automation'; - -// Validate data -const result = SlackMessageActionSchema.parse(data); - -// Type-safe usage -const mySlackMessageAction: SlackMessageAction = { - name: 'name', - type: 'example', - channel: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/SmsNotificationAction.mdx b/content/docs/references/automation/workflow/SmsNotificationAction.mdx deleted file mode 100644 index f81ba0979..000000000 --- a/content/docs/references/automation/workflow/SmsNotificationAction.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: SmsNotificationAction -description: SmsNotificationAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **provider** | `Enum<'twilio' \| 'vonage'>` | ✅ | SMS provider | -| **recipients** | `string[]` | ✅ | List of phone numbers or user field references | -| **message** | `string` | ✅ | SMS message text or template | -| **fromNumber** | `string` | optional | Sender phone number (provider-specific) | - -## TypeScript Usage - -```typescript -import { SmsNotificationActionSchema } from '@objectstack/spec/automation'; -import type { SmsNotificationAction } from '@objectstack/spec/automation'; - -// Validate data -const result = SmsNotificationActionSchema.parse(data); - -// Type-safe usage -const mySmsNotificationAction: SmsNotificationAction = { - name: 'name', - type: 'example', - provider: 'twilio', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/TaskCreationAction.mdx b/content/docs/references/automation/workflow/TaskCreationAction.mdx deleted file mode 100644 index 8793dc879..000000000 --- a/content/docs/references/automation/workflow/TaskCreationAction.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: TaskCreationAction -description: TaskCreationAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **taskObject** | `string` | ✅ | Task object name (e.g., "task", "project_task") | -| **subject** | `string` | ✅ | Task subject/title | -| **description** | `string` | optional | Task description | -| **assignedTo** | `string` | optional | User ID or field reference for assignee | -| **dueDate** | `string` | optional | Due date (ISO string or formula) | -| **priority** | `string` | optional | Task priority | -| **relatedTo** | `string` | optional | Related record ID or field reference | -| **additionalFields** | `Record` | optional | Additional custom fields | - -## TypeScript Usage - -```typescript -import { TaskCreationActionSchema } from '@objectstack/spec/automation'; -import type { TaskCreationAction } from '@objectstack/spec/automation'; - -// Validate data -const result = TaskCreationActionSchema.parse(data); - -// Type-safe usage -const myTaskCreationAction: TaskCreationAction = { - name: 'name', - type: 'example', - taskObject: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/TeamsMessageAction.mdx b/content/docs/references/automation/workflow/TeamsMessageAction.mdx deleted file mode 100644 index 4ce7803de..000000000 --- a/content/docs/references/automation/workflow/TeamsMessageAction.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TeamsMessageAction -description: TeamsMessageAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **channel** | `string` | ✅ | Teams channel ID | -| **message** | `string` | ✅ | Message text with optional markdown | -| **mentions** | `string[]` | optional | User IDs to mention | -| **teamId** | `string` | optional | Team ID (if not in default team) | - -## TypeScript Usage - -```typescript -import { TeamsMessageActionSchema } from '@objectstack/spec/automation'; -import type { TeamsMessageAction } from '@objectstack/spec/automation'; - -// Validate data -const result = TeamsMessageActionSchema.parse(data); - -// Type-safe usage -const myTeamsMessageAction: TeamsMessageAction = { - name: 'name', - type: 'example', - channel: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/TimeTrigger.mdx b/content/docs/references/automation/workflow/TimeTrigger.mdx deleted file mode 100644 index 6139951a1..000000000 --- a/content/docs/references/automation/workflow/TimeTrigger.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TimeTrigger -description: TimeTrigger Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | optional | Unique identifier | -| **timeLength** | `integer` | ✅ | Duration amount (e.g. 1, 30) | -| **timeUnit** | `Enum<'minutes' \| 'hours' \| 'days'>` | ✅ | Unit of time | -| **offsetDirection** | `Enum<'before' \| 'after'>` | ✅ | Before or After the reference date | -| **offsetFrom** | `Enum<'trigger_date' \| 'date_field'>` | ✅ | Basis for calculation | -| **dateField** | `string` | optional | Date field to calculate from (required if offsetFrom is date_field) | -| **actions** | `object \| object \| object \| object \| object \| object \| object \| object \| object \| object[]` | ✅ | Actions to execute at the scheduled time | - -## TypeScript Usage - -```typescript -import { TimeTriggerSchema } from '@objectstack/spec/automation'; -import type { TimeTrigger } from '@objectstack/spec/automation'; - -// Validate data -const result = TimeTriggerSchema.parse(data); - -// Type-safe usage -const myTimeTrigger: TimeTrigger = { - timeLength: null, - timeUnit: 'minutes', - offsetDirection: 'before', - // ... other required fields -}; -``` - diff --git a/content/docs/references/automation/workflow/WebhookTriggerAction.mdx b/content/docs/references/automation/workflow/WebhookTriggerAction.mdx deleted file mode 100644 index f8777e6d7..000000000 --- a/content/docs/references/automation/workflow/WebhookTriggerAction.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebhookTriggerAction -description: WebhookTriggerAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Action name | -| **type** | `string` | ✅ | | -| **url** | `string` | ✅ | Webhook URL to call | -| **method** | `Enum<'POST' \| 'PUT'>` | optional | HTTP method | -| **headers** | `Record` | optional | Custom headers | -| **payload** | `any` | optional | Webhook payload (uses record data if not specified) | -| **retryOnFailure** | `boolean` | optional | Retry if webhook fails | -| **maxRetries** | `number` | optional | Maximum retry attempts | - -## TypeScript Usage - -```typescript -import { WebhookTriggerActionSchema } from '@objectstack/spec/automation'; -import type { WebhookTriggerAction } from '@objectstack/spec/automation'; - -// Validate data -const result = WebhookTriggerActionSchema.parse(data); - -// Type-safe usage -const myWebhookTriggerAction: WebhookTriggerAction = { - name: 'name', - type: 'example', - url: 'https://example.com' -}; -``` - diff --git a/content/docs/references/automation/workflow/WorkflowAction.mdx b/content/docs/references/automation/workflow/WorkflowAction.mdx deleted file mode 100644 index 103a245df..000000000 --- a/content/docs/references/automation/workflow/WorkflowAction.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: WorkflowAction -description: WorkflowAction Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - diff --git a/content/docs/references/automation/workflow/WorkflowRule.mdx b/content/docs/references/automation/workflow/WorkflowRule.mdx deleted file mode 100644 index 31839fcb4..000000000 --- a/content/docs/references/automation/workflow/WorkflowRule.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WorkflowRule -description: WorkflowRule Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique workflow name (lowercase snake_case) | -| **objectName** | `string` | ✅ | Target Object | -| **triggerType** | `Enum<'on_create' \| 'on_update' \| 'on_create_or_update' \| 'on_delete' \| 'schedule'>` | ✅ | When to evaluate | -| **criteria** | `string` | optional | Formula condition. If TRUE, actions execute. | -| **actions** | `object \| object \| object \| object \| object \| object \| object \| object \| object \| object[]` | optional | Immediate actions | -| **timeTriggers** | `object[]` | optional | Scheduled actions relative to trigger or date field | -| **active** | `boolean` | optional | Whether this workflow is active | -| **reevaluateOnChange** | `boolean` | optional | Re-evaluate rule if field updates change the record validity | - -## TypeScript Usage - -```typescript -import { WorkflowRuleSchema } from '@objectstack/spec/automation'; -import type { WorkflowRule } from '@objectstack/spec/automation'; - -// Validate data -const result = WorkflowRuleSchema.parse(data); - -// Type-safe usage -const myWorkflowRule: WorkflowRule = { - name: 'name', - objectName: 'example', - triggerType: 'on_create' -}; -``` - diff --git a/content/docs/references/automation/workflow/WorkflowTriggerType.mdx b/content/docs/references/automation/workflow/WorkflowTriggerType.mdx deleted file mode 100644 index 48ee6aba2..000000000 --- a/content/docs/references/automation/workflow/WorkflowTriggerType.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: WorkflowTriggerType -description: WorkflowTriggerType Schema Reference -category: automation -zodFile: workflow ---- - - - -**Source:** `packages/spec/src/automation/workflow.zod.ts` - - -## Allowed Values - -* `on_create` -* `on_update` -* `on_create_or_update` -* `on_delete` -* `schedule` - -## TypeScript Usage - -```typescript -import { WorkflowTriggerType } from '@objectstack/spec/automation'; - -// Type-safe enum value -const value: WorkflowTriggerType = 'on_create'; -``` - diff --git a/content/docs/references/automation/workflow/meta.json b/content/docs/references/automation/workflow/meta.json deleted file mode 100644 index 01a9343dd..000000000 --- a/content/docs/references/automation/workflow/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Workflow" -} \ No newline at end of file diff --git a/content/docs/references/data/dataset/Dataset.mdx b/content/docs/references/data/dataset.mdx similarity index 61% rename from content/docs/references/data/dataset/Dataset.mdx rename to content/docs/references/data/dataset.mdx index be874e811..6d0a4a18e 100644 --- a/content/docs/references/data/dataset/Dataset.mdx +++ b/content/docs/references/data/dataset.mdx @@ -1,16 +1,32 @@ --- title: Dataset -description: Dataset Schema Reference -category: data -zodFile: dataset +description: Dataset protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Dataset **Source:** `packages/spec/src/data/dataset.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { DatasetSchema, DatasetModeSchema } from '@objectstack/spec/data'; +import type { Dataset, DatasetMode } from '@objectstack/spec/data'; + +// Validate data +const result = DatasetSchema.parse(data); +``` + +--- + +## Dataset + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -20,19 +36,15 @@ zodFile: dataset | **env** | `Enum<'prod' \| 'dev' \| 'test'>[]` | optional | Applicable environments | | **records** | `Record[]` | ✅ | Data records | -## TypeScript Usage +--- -```typescript -import { DatasetSchema } from '@objectstack/spec/data'; -import type { Dataset } from '@objectstack/spec/data'; +## DatasetMode -// Validate data -const result = DatasetSchema.parse(data); +### Allowed Values -// Type-safe usage -const myDataset: Dataset = { - object: 'example', - records: [] -}; -``` +* `insert` +* `update` +* `upsert` +* `replace` +* `ignore` diff --git a/content/docs/references/data/dataset/DatasetMode.mdx b/content/docs/references/data/dataset/DatasetMode.mdx deleted file mode 100644 index 85fbc46db..000000000 --- a/content/docs/references/data/dataset/DatasetMode.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: DatasetMode -description: DatasetMode Schema Reference -category: data -zodFile: dataset ---- - - - -**Source:** `packages/spec/src/data/dataset.zod.ts` - - -## Allowed Values - -* `insert` -* `update` -* `upsert` -* `replace` -* `ignore` - -## TypeScript Usage - -```typescript -import { DatasetMode } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: DatasetMode = 'insert'; -``` - diff --git a/content/docs/references/data/dataset/meta.json b/content/docs/references/data/dataset/meta.json deleted file mode 100644 index 6e8313b0f..000000000 --- a/content/docs/references/data/dataset/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Dataset" -} \ No newline at end of file diff --git a/content/docs/references/data/field/Field.mdx b/content/docs/references/data/field.mdx similarity index 55% rename from content/docs/references/data/field/Field.mdx rename to content/docs/references/data/field.mdx index 90dfa58dc..7789d5b43 100644 --- a/content/docs/references/data/field/Field.mdx +++ b/content/docs/references/data/field.mdx @@ -1,16 +1,71 @@ --- title: Field -description: Field Schema Reference -category: data -zodFile: field +description: Field protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Field **Source:** `packages/spec/src/data/field.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { AddressSchema, CurrencyConfigSchema, CurrencyValueSchema, FieldSchema, FieldTypeSchema, LocationCoordinatesSchema, SelectOptionSchema, VectorConfigSchema } from '@objectstack/spec/data'; +import type { Address, CurrencyConfig, CurrencyValue, Field, FieldType, LocationCoordinates, SelectOption, VectorConfig } from '@objectstack/spec/data'; + +// Validate data +const result = AddressSchema.parse(data); +``` + +--- + +## Address + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **street** | `string` | optional | Street address | +| **city** | `string` | optional | City name | +| **state** | `string` | optional | State/Province | +| **postalCode** | `string` | optional | Postal/ZIP code | +| **country** | `string` | optional | Country name or code | +| **countryCode** | `string` | optional | ISO country code (e.g., US, GB) | +| **formatted** | `string` | optional | Formatted address string | + +--- + +## CurrencyConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **precision** | `integer` | optional | Decimal precision (default: 2) | +| **currencyMode** | `Enum<'dynamic' \| 'fixed'>` | optional | Currency mode: dynamic (user selectable) or fixed (single currency) | +| **defaultCurrency** | `string` | optional | Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR) | + +--- + +## CurrencyValue + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **value** | `number` | ✅ | Monetary amount | +| **currency** | `string` | ✅ | Currency code (ISO 4217) | + +--- + +## Field + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -64,18 +119,94 @@ zodFile: field | **index** | `boolean` | optional | Create standard database index | | **externalId** | `boolean` | optional | Is external ID for upsert operations | -## TypeScript Usage +--- -```typescript -import { FieldSchema } from '@objectstack/spec/data'; -import type { Field } from '@objectstack/spec/data'; +## FieldType -// Validate data -const result = FieldSchema.parse(data); +### Allowed Values -// Type-safe usage -const myField: Field = { - type: 'text' -}; -``` +* `text` +* `textarea` +* `email` +* `url` +* `phone` +* `password` +* `markdown` +* `html` +* `richtext` +* `number` +* `currency` +* `percent` +* `date` +* `datetime` +* `time` +* `boolean` +* `toggle` +* `select` +* `multiselect` +* `radio` +* `checkboxes` +* `lookup` +* `master_detail` +* `tree` +* `image` +* `file` +* `avatar` +* `video` +* `audio` +* `formula` +* `summary` +* `autonumber` +* `location` +* `address` +* `code` +* `json` +* `color` +* `rating` +* `slider` +* `signature` +* `qrcode` +* `progress` +* `tags` +* `vector` + +--- + +## LocationCoordinates + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **latitude** | `number` | ✅ | Latitude coordinate | +| **longitude** | `number` | ✅ | Longitude coordinate | +| **altitude** | `number` | optional | Altitude in meters | +| **accuracy** | `number` | optional | Accuracy in meters | + +--- + +## SelectOption + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **label** | `string` | ✅ | Display label (human-readable, any case allowed) | +| **value** | `string` | ✅ | Stored value (lowercase machine identifier) | +| **color** | `string` | optional | Color code for badges/charts | +| **default** | `boolean` | optional | Is default option | + +--- + +## VectorConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **dimensions** | `integer` | ✅ | Vector dimensionality (e.g., 1536 for OpenAI embeddings) | +| **distanceMetric** | `Enum<'cosine' \| 'euclidean' \| 'dotProduct' \| 'manhattan'>` | optional | Distance/similarity metric for vector search | +| **normalized** | `boolean` | optional | Whether vectors are normalized (unit length) | +| **indexed** | `boolean` | optional | Whether to create a vector index for fast similarity search | +| **indexType** | `Enum<'hnsw' \| 'ivfflat' \| 'flat'>` | optional | Vector index algorithm (HNSW for high accuracy, IVFFlat for large datasets) | diff --git a/content/docs/references/data/field/Address.mdx b/content/docs/references/data/field/Address.mdx deleted file mode 100644 index bfa946dea..000000000 --- a/content/docs/references/data/field/Address.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Address -description: Address Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **street** | `string` | optional | Street address | -| **city** | `string` | optional | City name | -| **state** | `string` | optional | State/Province | -| **postalCode** | `string` | optional | Postal/ZIP code | -| **country** | `string` | optional | Country name or code | -| **countryCode** | `string` | optional | ISO country code (e.g., US, GB) | -| **formatted** | `string` | optional | Formatted address string | - -## TypeScript Usage - -```typescript -import { AddressSchema } from '@objectstack/spec/data'; -import type { Address } from '@objectstack/spec/data'; - -// Validate data -const result = AddressSchema.parse(data); - -// Type-safe usage -const myAddress: Address = { -}; -``` - diff --git a/content/docs/references/data/field/CurrencyConfig.mdx b/content/docs/references/data/field/CurrencyConfig.mdx deleted file mode 100644 index 65d56d06c..000000000 --- a/content/docs/references/data/field/CurrencyConfig.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CurrencyConfig -description: CurrencyConfig Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **precision** | `integer` | optional | Decimal precision (default: 2) | -| **currencyMode** | `Enum<'dynamic' \| 'fixed'>` | optional | Currency mode: dynamic (user selectable) or fixed (single currency) | -| **defaultCurrency** | `string` | optional | Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR) | - -## TypeScript Usage - -```typescript -import { CurrencyConfigSchema } from '@objectstack/spec/data'; -import type { CurrencyConfig } from '@objectstack/spec/data'; - -// Validate data -const result = CurrencyConfigSchema.parse(data); - -// Type-safe usage -const myCurrencyConfig: CurrencyConfig = { -}; -``` - diff --git a/content/docs/references/data/field/CurrencyValue.mdx b/content/docs/references/data/field/CurrencyValue.mdx deleted file mode 100644 index f0fa84bb4..000000000 --- a/content/docs/references/data/field/CurrencyValue.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CurrencyValue -description: CurrencyValue Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **value** | `number` | ✅ | Monetary amount | -| **currency** | `string` | ✅ | Currency code (ISO 4217) | - -## TypeScript Usage - -```typescript -import { CurrencyValueSchema } from '@objectstack/spec/data'; -import type { CurrencyValue } from '@objectstack/spec/data'; - -// Validate data -const result = CurrencyValueSchema.parse(data); - -// Type-safe usage -const myCurrencyValue: CurrencyValue = { - value: 0, - currency: 'example' -}; -``` - diff --git a/content/docs/references/data/field/FieldType.mdx b/content/docs/references/data/field/FieldType.mdx deleted file mode 100644 index c8aefebc0..000000000 --- a/content/docs/references/data/field/FieldType.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: FieldType -description: FieldType Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Allowed Values - -* `text` -* `textarea` -* `email` -* `url` -* `phone` -* `password` -* `markdown` -* `html` -* `richtext` -* `number` -* `currency` -* `percent` -* `date` -* `datetime` -* `time` -* `boolean` -* `toggle` -* `select` -* `multiselect` -* `radio` -* `checkboxes` -* `lookup` -* `master_detail` -* `tree` -* `image` -* `file` -* `avatar` -* `video` -* `audio` -* `formula` -* `summary` -* `autonumber` -* `location` -* `address` -* `code` -* `json` -* `color` -* `rating` -* `slider` -* `signature` -* `qrcode` -* `progress` -* `tags` -* `vector` - -## TypeScript Usage - -```typescript -import { FieldType } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: FieldType = 'text'; -``` - diff --git a/content/docs/references/data/field/LocationCoordinates.mdx b/content/docs/references/data/field/LocationCoordinates.mdx deleted file mode 100644 index e8a15457f..000000000 --- a/content/docs/references/data/field/LocationCoordinates.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: LocationCoordinates -description: LocationCoordinates Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **latitude** | `number` | ✅ | Latitude coordinate | -| **longitude** | `number` | ✅ | Longitude coordinate | -| **altitude** | `number` | optional | Altitude in meters | -| **accuracy** | `number` | optional | Accuracy in meters | - -## TypeScript Usage - -```typescript -import { LocationCoordinatesSchema } from '@objectstack/spec/data'; -import type { LocationCoordinates } from '@objectstack/spec/data'; - -// Validate data -const result = LocationCoordinatesSchema.parse(data); - -// Type-safe usage -const myLocationCoordinates: LocationCoordinates = { - latitude: 0, - longitude: 0 -}; -``` - diff --git a/content/docs/references/data/field/SelectOption.mdx b/content/docs/references/data/field/SelectOption.mdx deleted file mode 100644 index 23751b994..000000000 --- a/content/docs/references/data/field/SelectOption.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: SelectOption -description: SelectOption Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **label** | `string` | ✅ | Display label (human-readable, any case allowed) | -| **value** | `string` | ✅ | Stored value (lowercase machine identifier) | -| **color** | `string` | optional | Color code for badges/charts | -| **default** | `boolean` | optional | Is default option | - -## TypeScript Usage - -```typescript -import { SelectOptionSchema } from '@objectstack/spec/data'; -import type { SelectOption } from '@objectstack/spec/data'; - -// Validate data -const result = SelectOptionSchema.parse(data); - -// Type-safe usage -const mySelectOption: SelectOption = { - label: 'example', - value: 'example' -}; -``` - diff --git a/content/docs/references/data/field/VectorConfig.mdx b/content/docs/references/data/field/VectorConfig.mdx deleted file mode 100644 index 39f7f3bb0..000000000 --- a/content/docs/references/data/field/VectorConfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: VectorConfig -description: VectorConfig Schema Reference -category: data -zodFile: field ---- - - - -**Source:** `packages/spec/src/data/field.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **dimensions** | `integer` | ✅ | Vector dimensionality (e.g., 1536 for OpenAI embeddings) | -| **distanceMetric** | `Enum<'cosine' \| 'euclidean' \| 'dotProduct' \| 'manhattan'>` | optional | Distance/similarity metric for vector search | -| **normalized** | `boolean` | optional | Whether vectors are normalized (unit length) | -| **indexed** | `boolean` | optional | Whether to create a vector index for fast similarity search | -| **indexType** | `Enum<'hnsw' \| 'ivfflat' \| 'flat'>` | optional | Vector index algorithm (HNSW for high accuracy, IVFFlat for large datasets) | - -## TypeScript Usage - -```typescript -import { VectorConfigSchema } from '@objectstack/spec/data'; -import type { VectorConfig } from '@objectstack/spec/data'; - -// Validate data -const result = VectorConfigSchema.parse(data); - -// Type-safe usage -const myVectorConfig: VectorConfig = { - dimensions: null -}; -``` - diff --git a/content/docs/references/data/field/meta.json b/content/docs/references/data/field/meta.json deleted file mode 100644 index 6731230fb..000000000 --- a/content/docs/references/data/field/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Field" -} \ No newline at end of file diff --git a/content/docs/references/data/filter.mdx b/content/docs/references/data/filter.mdx new file mode 100644 index 000000000..dbdf337a6 --- /dev/null +++ b/content/docs/references/data/filter.mdx @@ -0,0 +1,151 @@ +--- +title: Filter +description: Filter protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Filter + + +**Source:** `packages/spec/src/data/filter.zod.ts` + + +## TypeScript Usage + +```typescript +import { ComparisonOperatorSchema, EqualityOperatorSchema, FieldOperatorsSchema, FieldReferenceSchema, FilterConditionSchema, NormalizedFilterSchema, QueryFilterSchema, RangeOperatorSchema, SetOperatorSchema, SpecialOperatorSchema, StringOperatorSchema } from '@objectstack/spec/data'; +import type { ComparisonOperator, EqualityOperator, FieldOperators, FieldReference, FilterCondition, NormalizedFilter, QueryFilter, RangeOperator, SetOperator, SpecialOperator, StringOperator } from '@objectstack/spec/data'; + +// Validate data +const result = ComparisonOperatorSchema.parse(data); +``` + +--- + +## ComparisonOperator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$gt** | `number \| string \| object` | optional | | +| **$gte** | `number \| string \| object` | optional | | +| **$lt** | `number \| string \| object` | optional | | +| **$lte** | `number \| string \| object` | optional | | + +--- + +## EqualityOperator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$eq** | `any` | optional | | +| **$ne** | `any` | optional | | + +--- + +## FieldOperators + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$eq** | `any` | optional | | +| **$ne** | `any` | optional | | +| **$gt** | `number \| string \| object` | optional | | +| **$gte** | `number \| string \| object` | optional | | +| **$lt** | `number \| string \| object` | optional | | +| **$lte** | `number \| string \| object` | optional | | +| **$in** | `any[]` | optional | | +| **$nin** | `any[]` | optional | | +| **$between** | `any[]` | optional | | +| **$contains** | `string` | optional | | +| **$startsWith** | `string` | optional | | +| **$endsWith** | `string` | optional | | +| **$null** | `boolean` | optional | | +| **$exist** | `boolean` | optional | | + +--- + +## FieldReference + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$field** | `string` | ✅ | Field Reference/Column Name | + +--- + +## FilterCondition + +--- + +## NormalizedFilter + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$and** | `Record \| any[]` | optional | | +| **$or** | `Record \| any[]` | optional | | +| **$not** | `Record \| any` | optional | | + +--- + +## QueryFilter + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **where** | `any` | optional | | + +--- + +## RangeOperator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$between** | `any[]` | optional | | + +--- + +## SetOperator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$in** | `any[]` | optional | | +| **$nin** | `any[]` | optional | | + +--- + +## SpecialOperator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$null** | `boolean` | optional | | +| **$exist** | `boolean` | optional | | + +--- + +## StringOperator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **$contains** | `string` | optional | | +| **$startsWith** | `string` | optional | | +| **$endsWith** | `string` | optional | | + diff --git a/content/docs/references/data/filter/ComparisonOperator.mdx b/content/docs/references/data/filter/ComparisonOperator.mdx deleted file mode 100644 index 6dbbeef2c..000000000 --- a/content/docs/references/data/filter/ComparisonOperator.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ComparisonOperator -description: ComparisonOperator Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$gt** | `number \| string \| object` | optional | | -| **$gte** | `number \| string \| object` | optional | | -| **$lt** | `number \| string \| object` | optional | | -| **$lte** | `number \| string \| object` | optional | | - -## TypeScript Usage - -```typescript -import { ComparisonOperatorSchema } from '@objectstack/spec/data'; -import type { ComparisonOperator } from '@objectstack/spec/data'; - -// Validate data -const result = ComparisonOperatorSchema.parse(data); - -// Type-safe usage -const myComparisonOperator: ComparisonOperator = { -}; -``` - diff --git a/content/docs/references/data/filter/EqualityOperator.mdx b/content/docs/references/data/filter/EqualityOperator.mdx deleted file mode 100644 index e97253bd8..000000000 --- a/content/docs/references/data/filter/EqualityOperator.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: EqualityOperator -description: EqualityOperator Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$eq** | `any` | optional | | -| **$ne** | `any` | optional | | - -## TypeScript Usage - -```typescript -import { EqualityOperatorSchema } from '@objectstack/spec/data'; -import type { EqualityOperator } from '@objectstack/spec/data'; - -// Validate data -const result = EqualityOperatorSchema.parse(data); - -// Type-safe usage -const myEqualityOperator: EqualityOperator = { -}; -``` - diff --git a/content/docs/references/data/filter/FieldOperators.mdx b/content/docs/references/data/filter/FieldOperators.mdx deleted file mode 100644 index 302b8ad3f..000000000 --- a/content/docs/references/data/filter/FieldOperators.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: FieldOperators -description: FieldOperators Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$eq** | `any` | optional | | -| **$ne** | `any` | optional | | -| **$gt** | `number \| string \| object` | optional | | -| **$gte** | `number \| string \| object` | optional | | -| **$lt** | `number \| string \| object` | optional | | -| **$lte** | `number \| string \| object` | optional | | -| **$in** | `any[]` | optional | | -| **$nin** | `any[]` | optional | | -| **$between** | `any[]` | optional | | -| **$contains** | `string` | optional | | -| **$startsWith** | `string` | optional | | -| **$endsWith** | `string` | optional | | -| **$null** | `boolean` | optional | | -| **$exist** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { FieldOperatorsSchema } from '@objectstack/spec/data'; -import type { FieldOperators } from '@objectstack/spec/data'; - -// Validate data -const result = FieldOperatorsSchema.parse(data); - -// Type-safe usage -const myFieldOperators: FieldOperators = { -}; -``` - diff --git a/content/docs/references/data/filter/FieldReference.mdx b/content/docs/references/data/filter/FieldReference.mdx deleted file mode 100644 index ce8ccbd63..000000000 --- a/content/docs/references/data/filter/FieldReference.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FieldReference -description: FieldReference Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$field** | `string` | ✅ | Field Reference/Column Name | - -## TypeScript Usage - -```typescript -import { FieldReferenceSchema } from '@objectstack/spec/data'; -import type { FieldReference } from '@objectstack/spec/data'; - -// Validate data -const result = FieldReferenceSchema.parse(data); - -// Type-safe usage -const myFieldReference: FieldReference = { - $field: 'example' -}; -``` - diff --git a/content/docs/references/data/filter/FilterCondition.mdx b/content/docs/references/data/filter/FilterCondition.mdx deleted file mode 100644 index fbc3c415b..000000000 --- a/content/docs/references/data/filter/FilterCondition.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: FilterCondition -description: FilterCondition Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - diff --git a/content/docs/references/data/filter/NormalizedFilter.mdx b/content/docs/references/data/filter/NormalizedFilter.mdx deleted file mode 100644 index 7c6daac58..000000000 --- a/content/docs/references/data/filter/NormalizedFilter.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: NormalizedFilter -description: NormalizedFilter Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$and** | `Record \| any[]` | optional | | -| **$or** | `Record \| any[]` | optional | | -| **$not** | `Record \| any` | optional | | - -## TypeScript Usage - -```typescript -import { NormalizedFilterSchema } from '@objectstack/spec/data'; -import type { NormalizedFilter } from '@objectstack/spec/data'; - -// Validate data -const result = NormalizedFilterSchema.parse(data); - -// Type-safe usage -const myNormalizedFilter: NormalizedFilter = { -}; -``` - diff --git a/content/docs/references/data/filter/QueryFilter.mdx b/content/docs/references/data/filter/QueryFilter.mdx deleted file mode 100644 index 82ad21bbd..000000000 --- a/content/docs/references/data/filter/QueryFilter.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: QueryFilter -description: QueryFilter Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **where** | `any` | optional | | - -## TypeScript Usage - -```typescript -import { QueryFilterSchema } from '@objectstack/spec/data'; -import type { QueryFilter } from '@objectstack/spec/data'; - -// Validate data -const result = QueryFilterSchema.parse(data); - -// Type-safe usage -const myQueryFilter: QueryFilter = { -}; -``` - diff --git a/content/docs/references/data/filter/RangeOperator.mdx b/content/docs/references/data/filter/RangeOperator.mdx deleted file mode 100644 index 53786a120..000000000 --- a/content/docs/references/data/filter/RangeOperator.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: RangeOperator -description: RangeOperator Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$between** | `any[]` | optional | | - -## TypeScript Usage - -```typescript -import { RangeOperatorSchema } from '@objectstack/spec/data'; -import type { RangeOperator } from '@objectstack/spec/data'; - -// Validate data -const result = RangeOperatorSchema.parse(data); - -// Type-safe usage -const myRangeOperator: RangeOperator = { -}; -``` - diff --git a/content/docs/references/data/filter/SetOperator.mdx b/content/docs/references/data/filter/SetOperator.mdx deleted file mode 100644 index e9d7dd186..000000000 --- a/content/docs/references/data/filter/SetOperator.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: SetOperator -description: SetOperator Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$in** | `any[]` | optional | | -| **$nin** | `any[]` | optional | | - -## TypeScript Usage - -```typescript -import { SetOperatorSchema } from '@objectstack/spec/data'; -import type { SetOperator } from '@objectstack/spec/data'; - -// Validate data -const result = SetOperatorSchema.parse(data); - -// Type-safe usage -const mySetOperator: SetOperator = { -}; -``` - diff --git a/content/docs/references/data/filter/SpecialOperator.mdx b/content/docs/references/data/filter/SpecialOperator.mdx deleted file mode 100644 index 3bbeb519e..000000000 --- a/content/docs/references/data/filter/SpecialOperator.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: SpecialOperator -description: SpecialOperator Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$null** | `boolean` | optional | | -| **$exist** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { SpecialOperatorSchema } from '@objectstack/spec/data'; -import type { SpecialOperator } from '@objectstack/spec/data'; - -// Validate data -const result = SpecialOperatorSchema.parse(data); - -// Type-safe usage -const mySpecialOperator: SpecialOperator = { -}; -``` - diff --git a/content/docs/references/data/filter/StringOperator.mdx b/content/docs/references/data/filter/StringOperator.mdx deleted file mode 100644 index 33db2ff95..000000000 --- a/content/docs/references/data/filter/StringOperator.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StringOperator -description: StringOperator Schema Reference -category: data -zodFile: filter ---- - - - -**Source:** `packages/spec/src/data/filter.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **$contains** | `string` | optional | | -| **$startsWith** | `string` | optional | | -| **$endsWith** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { StringOperatorSchema } from '@objectstack/spec/data'; -import type { StringOperator } from '@objectstack/spec/data'; - -// Validate data -const result = StringOperatorSchema.parse(data); - -// Type-safe usage -const myStringOperator: StringOperator = { -}; -``` - diff --git a/content/docs/references/data/filter/meta.json b/content/docs/references/data/filter/meta.json deleted file mode 100644 index 88580d7e4..000000000 --- a/content/docs/references/data/filter/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Filter" -} \ No newline at end of file diff --git a/content/docs/references/data/hook.mdx b/content/docs/references/data/hook.mdx new file mode 100644 index 000000000..028c09e74 --- /dev/null +++ b/content/docs/references/data/hook.mdx @@ -0,0 +1,84 @@ +--- +title: Hook +description: Hook protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Hook + + +**Source:** `packages/spec/src/data/hook.zod.ts` + + +## TypeScript Usage + +```typescript +import { HookSchema, HookContextSchema, HookEventSchema } from '@objectstack/spec/data'; +import type { Hook, HookContext, HookEvent } from '@objectstack/spec/data'; + +// Validate data +const result = HookSchema.parse(data); +``` + +--- + +## Hook + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Hook unique name (snake_case) | +| **label** | `string` | optional | Description of what this hook does | +| **object** | `string \| string[]` | ✅ | Target object(s) | +| **events** | `Enum<'beforeFind' \| 'afterFind' \| 'beforeFindOne' \| 'afterFindOne' \| 'beforeCount' \| 'afterCount' \| 'beforeAggregate' \| 'afterAggregate' \| 'beforeInsert' \| 'afterInsert' \| 'beforeUpdate' \| 'afterUpdate' \| 'beforeDelete' \| 'afterDelete' \| 'beforeUpdateMany' \| 'afterUpdateMany' \| 'beforeDeleteMany' \| 'afterDeleteMany'>[]` | ✅ | Lifecycle events | +| **handler** | `string \| any` | optional | Function handler name or direct function | +| **priority** | `number` | optional | Execution priority | +| **async** | `boolean` | optional | Run specifically as fire-and-forget | +| **onError** | `Enum<'abort' \| 'log'>` | optional | Error handling strategy | + +--- + +## HookContext + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | optional | Unique execution ID for tracing | +| **object** | `string` | ✅ | | +| **event** | `Enum<'beforeFind' \| 'afterFind' \| 'beforeFindOne' \| 'afterFindOne' \| 'beforeCount' \| 'afterCount' \| 'beforeAggregate' \| 'afterAggregate' \| 'beforeInsert' \| 'afterInsert' \| 'beforeUpdate' \| 'afterUpdate' \| 'beforeDelete' \| 'afterDelete' \| 'beforeUpdateMany' \| 'afterUpdateMany' \| 'beforeDeleteMany' \| 'afterDeleteMany'>` | ✅ | | +| **input** | `Record` | ✅ | Mutable input parameters | +| **result** | `any` | optional | Operation result (After hooks only) | +| **previous** | `Record` | optional | Record state before operation | +| **session** | `object` | optional | Current session context | +| **transaction** | `any` | optional | Database transaction handle | +| **ql** | `any` | optional | ObjectQL Engine Reference | + +--- + +## HookEvent + +### Allowed Values + +* `beforeFind` +* `afterFind` +* `beforeFindOne` +* `afterFindOne` +* `beforeCount` +* `afterCount` +* `beforeAggregate` +* `afterAggregate` +* `beforeInsert` +* `afterInsert` +* `beforeUpdate` +* `afterUpdate` +* `beforeDelete` +* `afterDelete` +* `beforeUpdateMany` +* `afterUpdateMany` +* `beforeDeleteMany` +* `afterDeleteMany` + diff --git a/content/docs/references/data/hook/Hook.mdx b/content/docs/references/data/hook/Hook.mdx deleted file mode 100644 index 1240b69ca..000000000 --- a/content/docs/references/data/hook/Hook.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Hook -description: Hook Schema Reference -category: data -zodFile: hook ---- - - - -**Source:** `packages/spec/src/data/hook.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Hook unique name (snake_case) | -| **label** | `string` | optional | Description of what this hook does | -| **object** | `string \| string[]` | ✅ | Target object(s) | -| **events** | `Enum<'beforeFind' \| 'afterFind' \| 'beforeFindOne' \| 'afterFindOne' \| 'beforeCount' \| 'afterCount' \| 'beforeAggregate' \| 'afterAggregate' \| 'beforeInsert' \| 'afterInsert' \| 'beforeUpdate' \| 'afterUpdate' \| 'beforeDelete' \| 'afterDelete' \| 'beforeUpdateMany' \| 'afterUpdateMany' \| 'beforeDeleteMany' \| 'afterDeleteMany'>[]` | ✅ | Lifecycle events | -| **handler** | `string \| any` | optional | Function handler name or direct function | -| **priority** | `number` | optional | Execution priority | -| **async** | `boolean` | optional | Run specifically as fire-and-forget | -| **onError** | `Enum<'abort' \| 'log'>` | optional | Error handling strategy | - -## TypeScript Usage - -```typescript -import { HookSchema } from '@objectstack/spec/data'; -import type { Hook } from '@objectstack/spec/data'; - -// Validate data -const result = HookSchema.parse(data); - -// Type-safe usage -const myHook: Hook = { - name: 'name', - object: null, - events: [] -}; -``` - diff --git a/content/docs/references/data/hook/HookContext.mdx b/content/docs/references/data/hook/HookContext.mdx deleted file mode 100644 index 218bc11bc..000000000 --- a/content/docs/references/data/hook/HookContext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: HookContext -description: HookContext Schema Reference -category: data -zodFile: hook ---- - - - -**Source:** `packages/spec/src/data/hook.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | optional | Unique execution ID for tracing | -| **object** | `string` | ✅ | | -| **event** | `Enum<'beforeFind' \| 'afterFind' \| 'beforeFindOne' \| 'afterFindOne' \| 'beforeCount' \| 'afterCount' \| 'beforeAggregate' \| 'afterAggregate' \| 'beforeInsert' \| 'afterInsert' \| 'beforeUpdate' \| 'afterUpdate' \| 'beforeDelete' \| 'afterDelete' \| 'beforeUpdateMany' \| 'afterUpdateMany' \| 'beforeDeleteMany' \| 'afterDeleteMany'>` | ✅ | | -| **input** | `Record` | ✅ | Mutable input parameters | -| **result** | `any` | optional | Operation result (After hooks only) | -| **previous** | `Record` | optional | Record state before operation | -| **session** | `object` | optional | Current session context | -| **transaction** | `any` | optional | Database transaction handle | -| **ql** | `any` | optional | ObjectQL Engine Reference | - -## TypeScript Usage - -```typescript -import { HookContextSchema } from '@objectstack/spec/data'; -import type { HookContext } from '@objectstack/spec/data'; - -// Validate data -const result = HookContextSchema.parse(data); - -// Type-safe usage -const myHookContext: HookContext = { - object: 'example', - event: 'beforeFind', - input: {} -}; -``` - diff --git a/content/docs/references/data/hook/HookEvent.mdx b/content/docs/references/data/hook/HookEvent.mdx deleted file mode 100644 index 76f37ee1b..000000000 --- a/content/docs/references/data/hook/HookEvent.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: HookEvent -description: HookEvent Schema Reference -category: data -zodFile: hook ---- - - - -**Source:** `packages/spec/src/data/hook.zod.ts` - - -## Allowed Values - -* `beforeFind` -* `afterFind` -* `beforeFindOne` -* `afterFindOne` -* `beforeCount` -* `afterCount` -* `beforeAggregate` -* `afterAggregate` -* `beforeInsert` -* `afterInsert` -* `beforeUpdate` -* `afterUpdate` -* `beforeDelete` -* `afterDelete` -* `beforeUpdateMany` -* `afterUpdateMany` -* `beforeDeleteMany` -* `afterDeleteMany` - -## TypeScript Usage - -```typescript -import { HookEvent } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: HookEvent = 'beforeFind'; -``` - diff --git a/content/docs/references/data/hook/meta.json b/content/docs/references/data/hook/meta.json deleted file mode 100644 index f34deeaf7..000000000 --- a/content/docs/references/data/hook/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Hook" -} \ No newline at end of file diff --git a/content/docs/references/data/index.mdx b/content/docs/references/data/index.mdx index e67fb60e2..eac4e1038 100644 --- a/content/docs/references/data/index.mdx +++ b/content/docs/references/data/index.mdx @@ -3,106 +3,20 @@ title: Data Protocol Overview description: Complete reference for all data protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # Data Protocol This section contains all protocol schemas for the data layer of ObjectStack. -## Dataset - -Source: `packages/spec/src/data/dataset.zod.ts` - - - - - - -## Field - -Source: `packages/spec/src/data/field.zod.ts` - - - - - - - - - - - - -## Filter - -Source: `packages/spec/src/data/filter.zod.ts` - - - - - - - - - - - - - - - -## Hook - -Source: `packages/spec/src/data/hook.zod.ts` - - - - - - - -## Object - -Source: `packages/spec/src/data/object.zod.ts` - - - - - - - - -## Query - -Source: `packages/spec/src/data/query.zod.ts` - - - - - - - - - - - - - - - -## Validation - -Source: `packages/spec/src/data/validation.zod.ts` - - - - - - - - - - - + + + + + + + + diff --git a/content/docs/references/data/mapping/meta.json b/content/docs/references/data/mapping/meta.json deleted file mode 100644 index 868fa1e73..000000000 --- a/content/docs/references/data/mapping/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Mapping" -} \ No newline at end of file diff --git a/content/docs/references/data/object.mdx b/content/docs/references/data/object.mdx new file mode 100644 index 000000000..125fc1ad2 --- /dev/null +++ b/content/docs/references/data/object.mdx @@ -0,0 +1,95 @@ +--- +title: Object +description: Object protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Object + + +**Source:** `packages/spec/src/data/object.zod.ts` + + +## TypeScript Usage + +```typescript +import { IndexSchema, ObjectSchema, ObjectCapabilitiesSchema, SearchConfigSchema } from '@objectstack/spec/data'; +import type { Index, Object, ObjectCapabilities, SearchConfig } from '@objectstack/spec/data'; + +// Validate data +const result = IndexSchema.parse(data); +``` + +--- + +## Index + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | optional | Index name | +| **fields** | `string[]` | ✅ | Fields included in the index | +| **unique** | `boolean` | optional | Whether the index is unique | +| **type** | `Enum<'btree' \| 'hash' \| 'gin' \| 'gist'>` | optional | Index type (default: btree) | + +--- + +## Object + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Machine unique key (snake_case). Immutable. | +| **label** | `string` | optional | Human readable singular label (e.g. "Account") | +| **pluralLabel** | `string` | optional | Human readable plural label (e.g. "Accounts") | +| **description** | `string` | optional | Developer documentation / description | +| **icon** | `string` | optional | Icon name (Lucide/Material) for UI representation | +| **tags** | `string[]` | optional | Categorization tags (e.g. "sales", "system", "reference") | +| **active** | `boolean` | optional | Is the object active and usable | +| **isSystem** | `boolean` | optional | Is system object (protected from deletion) | +| **abstract** | `boolean` | optional | Is abstract base object (cannot be instantiated) | +| **datasource** | `string` | optional | Target Datasource ID. "default" is the primary DB. | +| **tableName** | `string` | optional | Physical table/collection name in the target datasource | +| **fields** | `Record` | ✅ | Field definitions map | +| **indexes** | `object[]` | optional | Database performance indexes | +| **validations** | `object \| object \| object \| object \| object \| object \| object \| object \| object[]` | optional | Object-level validation rules | +| **titleFormat** | `string` | optional | Title expression (e.g. "`{name}` - `{code}`"). Overrides nameField. | +| **compactLayout** | `string[]` | optional | Primary fields for hover/cards/lookups | +| **search** | `object` | optional | Search engine configuration | +| **enable** | `object` | optional | Enabled system features modules | + +--- + +## ObjectCapabilities + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **trackHistory** | `boolean` | optional | Enable field history tracking for audit compliance | +| **searchable** | `boolean` | optional | Index records for global search | +| **apiEnabled** | `boolean` | optional | Expose object via automatic APIs | +| **apiMethods** | `Enum<'get' \| 'list' \| 'create' \| 'update' \| 'delete' \| 'upsert' \| 'bulk' \| 'aggregate' \| 'history' \| 'search' \| 'restore' \| 'purge' \| 'import' \| 'export'>[]` | optional | Whitelist of allowed API operations | +| **files** | `boolean` | optional | Enable file attachments and document management | +| **feeds** | `boolean` | optional | Enable social feed, comments, and mentions (Chatter-like) | +| **activities** | `boolean` | optional | Enable standard tasks and events tracking | +| **trash** | `boolean` | optional | Enable soft-delete with restore capability | +| **mru** | `boolean` | optional | Track Most Recently Used (MRU) list for users | +| **clone** | `boolean` | optional | Allow record deep cloning | + +--- + +## SearchConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **fields** | `string[]` | ✅ | Fields to index for full-text search weighting | +| **displayFields** | `string[]` | optional | Fields to display in search result cards | +| **filters** | `string[]` | optional | Default filters for search results | + diff --git a/content/docs/references/data/object/Index.mdx b/content/docs/references/data/object/Index.mdx deleted file mode 100644 index 32244c642..000000000 --- a/content/docs/references/data/object/Index.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Index -description: Index Schema Reference -category: data -zodFile: object ---- - - - -**Source:** `packages/spec/src/data/object.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | optional | Index name | -| **fields** | `string[]` | ✅ | Fields included in the index | -| **unique** | `boolean` | optional | Whether the index is unique | -| **type** | `Enum<'btree' \| 'hash' \| 'gin' \| 'gist'>` | optional | Index type (default: btree) | - -## TypeScript Usage - -```typescript -import { IndexSchema } from '@objectstack/spec/data'; -import type { Index } from '@objectstack/spec/data'; - -// Validate data -const result = IndexSchema.parse(data); - -// Type-safe usage -const myIndex: Index = { - fields: [] -}; -``` - diff --git a/content/docs/references/data/object/Object.mdx b/content/docs/references/data/object/Object.mdx deleted file mode 100644 index 8cf2e07b7..000000000 --- a/content/docs/references/data/object/Object.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Object -description: Object Schema Reference -category: data -zodFile: object ---- - - - -**Source:** `packages/spec/src/data/object.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Machine unique key (snake_case). Immutable. | -| **label** | `string` | optional | Human readable singular label (e.g. "Account") | -| **pluralLabel** | `string` | optional | Human readable plural label (e.g. "Accounts") | -| **description** | `string` | optional | Developer documentation / description | -| **icon** | `string` | optional | Icon name (Lucide/Material) for UI representation | -| **tags** | `string[]` | optional | Categorization tags (e.g. "sales", "system", "reference") | -| **active** | `boolean` | optional | Is the object active and usable | -| **isSystem** | `boolean` | optional | Is system object (protected from deletion) | -| **abstract** | `boolean` | optional | Is abstract base object (cannot be instantiated) | -| **datasource** | `string` | optional | Target Datasource ID. "default" is the primary DB. | -| **tableName** | `string` | optional | Physical table/collection name in the target datasource | -| **fields** | `Record` | ✅ | Field definitions map | -| **indexes** | `object[]` | optional | Database performance indexes | -| **validations** | `object \| object \| object \| object \| object \| object \| object \| object \| object[]` | optional | Object-level validation rules | -| **titleFormat** | `string` | optional | Title expression (e.g. "`{name}` - `{code}`"). Overrides nameField. | -| **compactLayout** | `string[]` | optional | Primary fields for hover/cards/lookups | -| **search** | `object` | optional | Search engine configuration | -| **enable** | `object` | optional | Enabled system features modules | - -## TypeScript Usage - -```typescript -import { ObjectSchema } from '@objectstack/spec/data'; -import type { Object } from '@objectstack/spec/data'; - -// Validate data -const result = ObjectSchema.parse(data); - -// Type-safe usage -const myObject: Object = { - name: 'name', - fields: {} -}; -``` - diff --git a/content/docs/references/data/object/ObjectCapabilities.mdx b/content/docs/references/data/object/ObjectCapabilities.mdx deleted file mode 100644 index 87bc79fa7..000000000 --- a/content/docs/references/data/object/ObjectCapabilities.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ObjectCapabilities -description: ObjectCapabilities Schema Reference -category: data -zodFile: object ---- - - - -**Source:** `packages/spec/src/data/object.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **trackHistory** | `boolean` | optional | Enable field history tracking for audit compliance | -| **searchable** | `boolean` | optional | Index records for global search | -| **apiEnabled** | `boolean` | optional | Expose object via automatic APIs | -| **apiMethods** | `Enum<'get' \| 'list' \| 'create' \| 'update' \| 'delete' \| 'upsert' \| 'bulk' \| 'aggregate' \| 'history' \| 'search' \| 'restore' \| 'purge' \| 'import' \| 'export'>[]` | optional | Whitelist of allowed API operations | -| **files** | `boolean` | optional | Enable file attachments and document management | -| **feeds** | `boolean` | optional | Enable social feed, comments, and mentions (Chatter-like) | -| **activities** | `boolean` | optional | Enable standard tasks and events tracking | -| **trash** | `boolean` | optional | Enable soft-delete with restore capability | -| **mru** | `boolean` | optional | Track Most Recently Used (MRU) list for users | -| **clone** | `boolean` | optional | Allow record deep cloning | - -## TypeScript Usage - -```typescript -import { ObjectCapabilitiesSchema } from '@objectstack/spec/data'; -import type { ObjectCapabilities } from '@objectstack/spec/data'; - -// Validate data -const result = ObjectCapabilitiesSchema.parse(data); - -// Type-safe usage -const myObjectCapabilities: ObjectCapabilities = { -}; -``` - diff --git a/content/docs/references/data/object/SearchConfig.mdx b/content/docs/references/data/object/SearchConfig.mdx deleted file mode 100644 index 915d28e9c..000000000 --- a/content/docs/references/data/object/SearchConfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SearchConfig -description: SearchConfig Schema Reference -category: data -zodFile: object ---- - - - -**Source:** `packages/spec/src/data/object.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **fields** | `string[]` | ✅ | Fields to index for full-text search weighting | -| **displayFields** | `string[]` | optional | Fields to display in search result cards | -| **filters** | `string[]` | optional | Default filters for search results | - -## TypeScript Usage - -```typescript -import { SearchConfigSchema } from '@objectstack/spec/data'; -import type { SearchConfig } from '@objectstack/spec/data'; - -// Validate data -const result = SearchConfigSchema.parse(data); - -// Type-safe usage -const mySearchConfig: SearchConfig = { - fields: [] -}; -``` - diff --git a/content/docs/references/data/object/meta.json b/content/docs/references/data/object/meta.json deleted file mode 100644 index 60779931f..000000000 --- a/content/docs/references/data/object/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Object" -} \ No newline at end of file diff --git a/content/docs/references/data/query.mdx b/content/docs/references/data/query.mdx new file mode 100644 index 000000000..6756c9e9f --- /dev/null +++ b/content/docs/references/data/query.mdx @@ -0,0 +1,172 @@ +--- +title: Query +description: Query protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Query + + +**Source:** `packages/spec/src/data/query.zod.ts` + + +## TypeScript Usage + +```typescript +import { AggregationFunctionSchema, AggregationNodeSchema, FieldNodeSchema, JoinNodeSchema, JoinStrategySchema, JoinTypeSchema, QuerySchema, SortNodeSchema, WindowFunctionSchema, WindowFunctionNodeSchema, WindowSpecSchema } from '@objectstack/spec/data'; +import type { AggregationFunction, AggregationNode, FieldNode, JoinNode, JoinStrategy, JoinType, Query, SortNode, WindowFunction, WindowFunctionNode, WindowSpec } from '@objectstack/spec/data'; + +// Validate data +const result = AggregationFunctionSchema.parse(data); +``` + +--- + +## AggregationFunction + +### Allowed Values + +* `count` +* `sum` +* `avg` +* `min` +* `max` +* `count_distinct` +* `array_agg` +* `string_agg` + +--- + +## AggregationNode + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **function** | `Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max' \| 'count_distinct' \| 'array_agg' \| 'string_agg'>` | ✅ | Aggregation function | +| **field** | `string` | optional | Field to aggregate (optional for COUNT(*)) | +| **alias** | `string` | ✅ | Result column alias | +| **distinct** | `boolean` | optional | Apply DISTINCT before aggregation | +| **filter** | `any` | optional | Filter/Condition to apply to the aggregation (FILTER WHERE clause) | + +--- + +## FieldNode + +--- + +## JoinNode + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'inner' \| 'left' \| 'right' \| 'full'>` | ✅ | Join type | +| **strategy** | `Enum<'auto' \| 'database' \| 'hash' \| 'loop'>` | optional | Execution strategy hint | +| **object** | `string` | ✅ | Object/table to join | +| **alias** | `string` | optional | Table alias | +| **on** | `any` | ✅ | Join condition | +| **subquery** | `object` | optional | Subquery instead of object | + +--- + +## JoinStrategy + +### Allowed Values + +* `auto` +* `database` +* `hash` +* `loop` + +--- + +## JoinType + +### Allowed Values + +* `inner` +* `left` +* `right` +* `full` + +--- + +## Query + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **object** | `string` | ✅ | Object name (e.g. account) | +| **fields** | `string \| object[]` | optional | Fields to retrieve | +| **where** | `any` | optional | Filtering criteria (WHERE) | +| **orderBy** | `object[]` | optional | Sorting instructions (ORDER BY) | +| **limit** | `number` | optional | Max records to return (LIMIT) | +| **offset** | `number` | optional | Records to skip (OFFSET) | +| **cursor** | `Record` | optional | Cursor for keyset pagination | +| **joins** | `object[]` | optional | Explicit Table Joins | +| **aggregations** | `object[]` | optional | Aggregation functions | +| **groupBy** | `string[]` | optional | GROUP BY fields | +| **having** | `any` | optional | HAVING clause for aggregation filtering | +| **windowFunctions** | `object[]` | optional | Window functions with OVER clause | +| **distinct** | `boolean` | optional | SELECT DISTINCT flag | + +--- + +## SortNode + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | | +| **order** | `Enum<'asc' \| 'desc'>` | optional | | + +--- + +## WindowFunction + +### Allowed Values + +* `row_number` +* `rank` +* `dense_rank` +* `percent_rank` +* `lag` +* `lead` +* `first_value` +* `last_value` +* `sum` +* `avg` +* `count` +* `min` +* `max` + +--- + +## WindowFunctionNode + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **function** | `Enum<'row_number' \| 'rank' \| 'dense_rank' \| 'percent_rank' \| 'lag' \| 'lead' \| 'first_value' \| 'last_value' \| 'sum' \| 'avg' \| 'count' \| 'min' \| 'max'>` | ✅ | Window function name | +| **field** | `string` | optional | Field to operate on (for aggregate window functions) | +| **alias** | `string` | ✅ | Result column alias | +| **over** | `object` | ✅ | Window specification (OVER clause) | + +--- + +## WindowSpec + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **partitionBy** | `string[]` | optional | PARTITION BY fields | +| **orderBy** | `object[]` | optional | ORDER BY specification | +| **frame** | `object` | optional | Window frame specification | + diff --git a/content/docs/references/data/query/AggregationFunction.mdx b/content/docs/references/data/query/AggregationFunction.mdx deleted file mode 100644 index 345df91fa..000000000 --- a/content/docs/references/data/query/AggregationFunction.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: AggregationFunction -description: AggregationFunction Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Allowed Values - -* `count` -* `sum` -* `avg` -* `min` -* `max` -* `count_distinct` -* `array_agg` -* `string_agg` - -## TypeScript Usage - -```typescript -import { AggregationFunction } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: AggregationFunction = 'count'; -``` - diff --git a/content/docs/references/data/query/AggregationNode.mdx b/content/docs/references/data/query/AggregationNode.mdx deleted file mode 100644 index 296d93580..000000000 --- a/content/docs/references/data/query/AggregationNode.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AggregationNode -description: AggregationNode Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **function** | `Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max' \| 'count_distinct' \| 'array_agg' \| 'string_agg'>` | ✅ | Aggregation function | -| **field** | `string` | optional | Field to aggregate (optional for COUNT(*)) | -| **alias** | `string` | ✅ | Result column alias | -| **distinct** | `boolean` | optional | Apply DISTINCT before aggregation | -| **filter** | `any` | optional | Filter/Condition to apply to the aggregation (FILTER WHERE clause) | - -## TypeScript Usage - -```typescript -import { AggregationNodeSchema } from '@objectstack/spec/data'; -import type { AggregationNode } from '@objectstack/spec/data'; - -// Validate data -const result = AggregationNodeSchema.parse(data); - -// Type-safe usage -const myAggregationNode: AggregationNode = { - function: 'count', - alias: 'example' -}; -``` - diff --git a/content/docs/references/data/query/FieldNode.mdx b/content/docs/references/data/query/FieldNode.mdx deleted file mode 100644 index 781957f4f..000000000 --- a/content/docs/references/data/query/FieldNode.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: FieldNode -description: FieldNode Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - diff --git a/content/docs/references/data/query/JoinNode.mdx b/content/docs/references/data/query/JoinNode.mdx deleted file mode 100644 index 2b16b43f7..000000000 --- a/content/docs/references/data/query/JoinNode.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: JoinNode -description: JoinNode Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'inner' \| 'left' \| 'right' \| 'full'>` | ✅ | Join type | -| **strategy** | `Enum<'auto' \| 'database' \| 'hash' \| 'loop'>` | optional | Execution strategy hint | -| **object** | `string` | ✅ | Object/table to join | -| **alias** | `string` | optional | Table alias | -| **on** | `any` | ✅ | Join condition | -| **subquery** | `object` | optional | Subquery instead of object | - -## TypeScript Usage - -```typescript -import { JoinNodeSchema } from '@objectstack/spec/data'; -import type { JoinNode } from '@objectstack/spec/data'; - -// Validate data -const result = JoinNodeSchema.parse(data); - -// Type-safe usage -const myJoinNode: JoinNode = { - type: 'inner', - object: 'example', - on: null -}; -``` - diff --git a/content/docs/references/data/query/JoinStrategy.mdx b/content/docs/references/data/query/JoinStrategy.mdx deleted file mode 100644 index 2434f2ac6..000000000 --- a/content/docs/references/data/query/JoinStrategy.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: JoinStrategy -description: JoinStrategy Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Allowed Values - -* `auto` -* `database` -* `hash` -* `loop` - -## TypeScript Usage - -```typescript -import { JoinStrategy } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: JoinStrategy = 'auto'; -``` - diff --git a/content/docs/references/data/query/JoinType.mdx b/content/docs/references/data/query/JoinType.mdx deleted file mode 100644 index 4155a1a5e..000000000 --- a/content/docs/references/data/query/JoinType.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: JoinType -description: JoinType Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Allowed Values - -* `inner` -* `left` -* `right` -* `full` - -## TypeScript Usage - -```typescript -import { JoinType } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: JoinType = 'inner'; -``` - diff --git a/content/docs/references/data/query/Query.mdx b/content/docs/references/data/query/Query.mdx deleted file mode 100644 index be7ea41bb..000000000 --- a/content/docs/references/data/query/Query.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Query -description: Query Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **object** | `string` | ✅ | Object name (e.g. account) | -| **fields** | `string \| object[]` | optional | Fields to retrieve | -| **where** | `any` | optional | Filtering criteria (WHERE) | -| **orderBy** | `object[]` | optional | Sorting instructions (ORDER BY) | -| **limit** | `number` | optional | Max records to return (LIMIT) | -| **offset** | `number` | optional | Records to skip (OFFSET) | -| **cursor** | `Record` | optional | Cursor for keyset pagination | -| **joins** | `object[]` | optional | Explicit Table Joins | -| **aggregations** | `object[]` | optional | Aggregation functions | -| **groupBy** | `string[]` | optional | GROUP BY fields | -| **having** | `any` | optional | HAVING clause for aggregation filtering | -| **windowFunctions** | `object[]` | optional | Window functions with OVER clause | -| **distinct** | `boolean` | optional | SELECT DISTINCT flag | - -## TypeScript Usage - -```typescript -import { QuerySchema } from '@objectstack/spec/data'; -import type { Query } from '@objectstack/spec/data'; - -// Validate data -const result = QuerySchema.parse(data); - -// Type-safe usage -const myQuery: Query = { - object: 'example' -}; -``` - diff --git a/content/docs/references/data/query/SortNode.mdx b/content/docs/references/data/query/SortNode.mdx deleted file mode 100644 index 4554ed9e2..000000000 --- a/content/docs/references/data/query/SortNode.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SortNode -description: SortNode Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | | -| **order** | `Enum<'asc' \| 'desc'>` | optional | | - -## TypeScript Usage - -```typescript -import { SortNodeSchema } from '@objectstack/spec/data'; -import type { SortNode } from '@objectstack/spec/data'; - -// Validate data -const result = SortNodeSchema.parse(data); - -// Type-safe usage -const mySortNode: SortNode = { - field: 'example' -}; -``` - diff --git a/content/docs/references/data/query/WindowFunction.mdx b/content/docs/references/data/query/WindowFunction.mdx deleted file mode 100644 index 2046049e6..000000000 --- a/content/docs/references/data/query/WindowFunction.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WindowFunction -description: WindowFunction Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Allowed Values - -* `row_number` -* `rank` -* `dense_rank` -* `percent_rank` -* `lag` -* `lead` -* `first_value` -* `last_value` -* `sum` -* `avg` -* `count` -* `min` -* `max` - -## TypeScript Usage - -```typescript -import { WindowFunction } from '@objectstack/spec/data'; - -// Type-safe enum value -const value: WindowFunction = 'row_number'; -``` - diff --git a/content/docs/references/data/query/WindowFunctionNode.mdx b/content/docs/references/data/query/WindowFunctionNode.mdx deleted file mode 100644 index 66f9ba679..000000000 --- a/content/docs/references/data/query/WindowFunctionNode.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: WindowFunctionNode -description: WindowFunctionNode Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **function** | `Enum<'row_number' \| 'rank' \| 'dense_rank' \| 'percent_rank' \| 'lag' \| 'lead' \| 'first_value' \| 'last_value' \| 'sum' \| 'avg' \| 'count' \| 'min' \| 'max'>` | ✅ | Window function name | -| **field** | `string` | optional | Field to operate on (for aggregate window functions) | -| **alias** | `string` | ✅ | Result column alias | -| **over** | `object` | ✅ | Window specification (OVER clause) | - -## TypeScript Usage - -```typescript -import { WindowFunctionNodeSchema } from '@objectstack/spec/data'; -import type { WindowFunctionNode } from '@objectstack/spec/data'; - -// Validate data -const result = WindowFunctionNodeSchema.parse(data); - -// Type-safe usage -const myWindowFunctionNode: WindowFunctionNode = { - function: 'row_number', - alias: 'example', - over: {} -}; -``` - diff --git a/content/docs/references/data/query/WindowSpec.mdx b/content/docs/references/data/query/WindowSpec.mdx deleted file mode 100644 index c8c23a53e..000000000 --- a/content/docs/references/data/query/WindowSpec.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WindowSpec -description: WindowSpec Schema Reference -category: data -zodFile: query ---- - - - -**Source:** `packages/spec/src/data/query.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **partitionBy** | `string[]` | optional | PARTITION BY fields | -| **orderBy** | `object[]` | optional | ORDER BY specification | -| **frame** | `object` | optional | Window frame specification | - -## TypeScript Usage - -```typescript -import { WindowSpecSchema } from '@objectstack/spec/data'; -import type { WindowSpec } from '@objectstack/spec/data'; - -// Validate data -const result = WindowSpecSchema.parse(data); - -// Type-safe usage -const myWindowSpec: WindowSpec = { -}; -``` - diff --git a/content/docs/references/data/query/meta.json b/content/docs/references/data/query/meta.json deleted file mode 100644 index 00be5107e..000000000 --- a/content/docs/references/data/query/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Query" -} \ No newline at end of file diff --git a/content/docs/references/data/validation.mdx b/content/docs/references/data/validation.mdx new file mode 100644 index 000000000..8a8e8bd4f --- /dev/null +++ b/content/docs/references/data/validation.mdx @@ -0,0 +1,216 @@ +--- +title: Validation +description: Validation protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Validation + + +**Source:** `packages/spec/src/data/validation.zod.ts` + + +## TypeScript Usage + +```typescript +import { AsyncValidationSchema, ConditionalValidationSchema, CrossFieldValidationSchema, CustomValidatorSchema, FormatValidationSchema, JSONValidationSchema, ScriptValidationSchema, StateMachineValidationSchema, UniquenessValidationSchema, ValidationRuleSchema } from '@objectstack/spec/data'; +import type { AsyncValidation, ConditionalValidation, CrossFieldValidation, CustomValidator, FormatValidation, JSONValidation, ScriptValidation, StateMachineValidation, UniquenessValidation, ValidationRule } from '@objectstack/spec/data'; + +// Validate data +const result = AsyncValidationSchema.parse(data); +``` + +--- + +## AsyncValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **field** | `string` | ✅ | Field to validate | +| **validatorUrl** | `string` | optional | External API endpoint for validation | +| **method** | `Enum<'GET' \| 'POST'>` | optional | HTTP method for external call | +| **headers** | `Record` | optional | Custom headers for the request | +| **validatorFunction** | `string` | optional | Reference to custom validator function | +| **timeout** | `number` | optional | Timeout in milliseconds | +| **debounce** | `number` | optional | Debounce delay in milliseconds | +| **params** | `Record` | optional | Additional parameters to pass to validator | + +--- + +## ConditionalValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **when** | `string` | ✅ | Condition formula (e.g. "type = 'enterprise'") | +| **then** | `object \| object \| object \| object \| object \| object \| object \| object \| any` | ✅ | Validation rule to apply when condition is true | +| **otherwise** | `object \| object \| object \| object \| object \| object \| object \| object \| any` | optional | Validation rule to apply when condition is false | + +--- + +## CrossFieldValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **condition** | `string` | ✅ | Formula expression comparing fields (e.g. "end_date > start_date") | +| **fields** | `string[]` | ✅ | Fields involved in the validation | + +--- + +## CustomValidator + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **handler** | `string` | ✅ | Name of the custom validation function registered in the system | +| **params** | `Record` | optional | Parameters passed to the custom handler | + +--- + +## FormatValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **field** | `string` | ✅ | | +| **regex** | `string` | optional | | +| **format** | `Enum<'email' \| 'url' \| 'phone' \| 'json'>` | optional | | + +--- + +## JSONValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **field** | `string` | ✅ | JSON field to validate | +| **schema** | `Record` | ✅ | JSON Schema object definition | + +--- + +## ScriptValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **condition** | `string` | ✅ | Formula expression. If TRUE, validation fails. (e.g. amount < 0) | + +--- + +## StateMachineValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **field** | `string` | ✅ | State field (e.g. status) | +| **transitions** | `Record` | ✅ | Map of `{ OldState: [AllowedNewStates] }` | + +--- + +## UniquenessValidation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label for the rule listing | +| **description** | `string` | optional | Administrative notes explaining the business reason | +| **active** | `boolean` | optional | | +| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | +| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | +| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | +| **message** | `string` | ✅ | Error message to display to the user | +| **type** | `string` | ✅ | | +| **fields** | `string[]` | ✅ | Fields that must be combined unique | +| **scope** | `string` | optional | Formula condition for scope (e.g. active = true) | +| **caseSensitive** | `boolean` | optional | | + +--- + +## ValidationRule + diff --git a/content/docs/references/data/validation/AsyncValidation.mdx b/content/docs/references/data/validation/AsyncValidation.mdx deleted file mode 100644 index 1a44fa498..000000000 --- a/content/docs/references/data/validation/AsyncValidation.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: AsyncValidation -description: AsyncValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **field** | `string` | ✅ | Field to validate | -| **validatorUrl** | `string` | optional | External API endpoint for validation | -| **method** | `Enum<'GET' \| 'POST'>` | optional | HTTP method for external call | -| **headers** | `Record` | optional | Custom headers for the request | -| **validatorFunction** | `string` | optional | Reference to custom validator function | -| **timeout** | `number` | optional | Timeout in milliseconds | -| **debounce** | `number` | optional | Debounce delay in milliseconds | -| **params** | `Record` | optional | Additional parameters to pass to validator | - -## TypeScript Usage - -```typescript -import { AsyncValidationSchema } from '@objectstack/spec/data'; -import type { AsyncValidation } from '@objectstack/spec/data'; - -// Validate data -const result = AsyncValidationSchema.parse(data); - -// Type-safe usage -const myAsyncValidation: AsyncValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/ConditionalValidation.mdx b/content/docs/references/data/validation/ConditionalValidation.mdx deleted file mode 100644 index 10e79b861..000000000 --- a/content/docs/references/data/validation/ConditionalValidation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ConditionalValidation -description: ConditionalValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **when** | `string` | ✅ | Condition formula (e.g. "type = 'enterprise'") | -| **then** | `object \| object \| object \| object \| object \| object \| object \| object \| any` | ✅ | Validation rule to apply when condition is true | -| **otherwise** | `object \| object \| object \| object \| object \| object \| object \| object \| any` | optional | Validation rule to apply when condition is false | - -## TypeScript Usage - -```typescript -import { ConditionalValidationSchema } from '@objectstack/spec/data'; -import type { ConditionalValidation } from '@objectstack/spec/data'; - -// Validate data -const result = ConditionalValidationSchema.parse(data); - -// Type-safe usage -const myConditionalValidation: ConditionalValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/CrossFieldValidation.mdx b/content/docs/references/data/validation/CrossFieldValidation.mdx deleted file mode 100644 index 722efc9fe..000000000 --- a/content/docs/references/data/validation/CrossFieldValidation.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CrossFieldValidation -description: CrossFieldValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **condition** | `string` | ✅ | Formula expression comparing fields (e.g. "end_date > start_date") | -| **fields** | `string[]` | ✅ | Fields involved in the validation | - -## TypeScript Usage - -```typescript -import { CrossFieldValidationSchema } from '@objectstack/spec/data'; -import type { CrossFieldValidation } from '@objectstack/spec/data'; - -// Validate data -const result = CrossFieldValidationSchema.parse(data); - -// Type-safe usage -const myCrossFieldValidation: CrossFieldValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/CustomValidator.mdx b/content/docs/references/data/validation/CustomValidator.mdx deleted file mode 100644 index d7b665c61..000000000 --- a/content/docs/references/data/validation/CustomValidator.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CustomValidator -description: CustomValidator Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **handler** | `string` | ✅ | Name of the custom validation function registered in the system | -| **params** | `Record` | optional | Parameters passed to the custom handler | - -## TypeScript Usage - -```typescript -import { CustomValidatorSchema } from '@objectstack/spec/data'; -import type { CustomValidator } from '@objectstack/spec/data'; - -// Validate data -const result = CustomValidatorSchema.parse(data); - -// Type-safe usage -const myCustomValidator: CustomValidator = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/FormatValidation.mdx b/content/docs/references/data/validation/FormatValidation.mdx deleted file mode 100644 index 0d8b9e62f..000000000 --- a/content/docs/references/data/validation/FormatValidation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FormatValidation -description: FormatValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **field** | `string` | ✅ | | -| **regex** | `string` | optional | | -| **format** | `Enum<'email' \| 'url' \| 'phone' \| 'json'>` | optional | | - -## TypeScript Usage - -```typescript -import { FormatValidationSchema } from '@objectstack/spec/data'; -import type { FormatValidation } from '@objectstack/spec/data'; - -// Validate data -const result = FormatValidationSchema.parse(data); - -// Type-safe usage -const myFormatValidation: FormatValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/JSONValidation.mdx b/content/docs/references/data/validation/JSONValidation.mdx deleted file mode 100644 index 54cf67427..000000000 --- a/content/docs/references/data/validation/JSONValidation.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: JSONValidation -description: JSONValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **field** | `string` | ✅ | JSON field to validate | -| **schema** | `Record` | ✅ | JSON Schema object definition | - -## TypeScript Usage - -```typescript -import { JSONValidationSchema } from '@objectstack/spec/data'; -import type { JSONValidation } from '@objectstack/spec/data'; - -// Validate data -const result = JSONValidationSchema.parse(data); - -// Type-safe usage -const myJSONValidation: JSONValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/ScriptValidation.mdx b/content/docs/references/data/validation/ScriptValidation.mdx deleted file mode 100644 index 0e41ddfdb..000000000 --- a/content/docs/references/data/validation/ScriptValidation.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ScriptValidation -description: ScriptValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **condition** | `string` | ✅ | Formula expression. If TRUE, validation fails. (e.g. amount < 0) | - -## TypeScript Usage - -```typescript -import { ScriptValidationSchema } from '@objectstack/spec/data'; -import type { ScriptValidation } from '@objectstack/spec/data'; - -// Validate data -const result = ScriptValidationSchema.parse(data); - -// Type-safe usage -const myScriptValidation: ScriptValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/StateMachineValidation.mdx b/content/docs/references/data/validation/StateMachineValidation.mdx deleted file mode 100644 index fa1211149..000000000 --- a/content/docs/references/data/validation/StateMachineValidation.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: StateMachineValidation -description: StateMachineValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **field** | `string` | ✅ | State field (e.g. status) | -| **transitions** | `Record` | ✅ | Map of `{ OldState: [AllowedNewStates] }` | - -## TypeScript Usage - -```typescript -import { StateMachineValidationSchema } from '@objectstack/spec/data'; -import type { StateMachineValidation } from '@objectstack/spec/data'; - -// Validate data -const result = StateMachineValidationSchema.parse(data); - -// Type-safe usage -const myStateMachineValidation: StateMachineValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/UniquenessValidation.mdx b/content/docs/references/data/validation/UniquenessValidation.mdx deleted file mode 100644 index 122257917..000000000 --- a/content/docs/references/data/validation/UniquenessValidation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: UniquenessValidation -description: UniquenessValidation Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label for the rule listing | -| **description** | `string` | optional | Administrative notes explaining the business reason | -| **active** | `boolean` | optional | | -| **events** | `Enum<'insert' \| 'update' \| 'delete'>[]` | optional | Validation contexts | -| **tags** | `string[]` | optional | Categorization tags (e.g., "compliance", "billing") | -| **severity** | `Enum<'error' \| 'warning' \| 'info'>` | optional | | -| **message** | `string` | ✅ | Error message to display to the user | -| **type** | `string` | ✅ | | -| **fields** | `string[]` | ✅ | Fields that must be combined unique | -| **scope** | `string` | optional | Formula condition for scope (e.g. active = true) | -| **caseSensitive** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { UniquenessValidationSchema } from '@objectstack/spec/data'; -import type { UniquenessValidation } from '@objectstack/spec/data'; - -// Validate data -const result = UniquenessValidationSchema.parse(data); - -// Type-safe usage -const myUniquenessValidation: UniquenessValidation = { - name: 'name', - message: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/data/validation/ValidationRule.mdx b/content/docs/references/data/validation/ValidationRule.mdx deleted file mode 100644 index 8ba14a3a0..000000000 --- a/content/docs/references/data/validation/ValidationRule.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: ValidationRule -description: ValidationRule Schema Reference -category: data -zodFile: validation ---- - - - -**Source:** `packages/spec/src/data/validation.zod.ts` - - diff --git a/content/docs/references/data/validation/meta.json b/content/docs/references/data/validation/meta.json deleted file mode 100644 index 8ef4e45b2..000000000 --- a/content/docs/references/data/validation/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Validation" -} \ No newline at end of file diff --git a/content/docs/references/hub/composer.mdx b/content/docs/references/hub/composer.mdx new file mode 100644 index 000000000..0e2234d22 --- /dev/null +++ b/content/docs/references/hub/composer.mdx @@ -0,0 +1,93 @@ +--- +title: Composer +description: Composer protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Composer + + +**Source:** `packages/spec/src/hub/composer.zod.ts` + + +## TypeScript Usage + +```typescript +import { BillOfMaterialsSchema, ComposerRequestSchema, ComposerResponseSchema, ConflictReportSchema, DependencyRequirementSchema } from '@objectstack/spec/hub'; +import type { BillOfMaterials, ComposerRequest, ComposerResponse, ConflictReport, DependencyRequirement } from '@objectstack/spec/hub'; + +// Validate data +const result = BillOfMaterialsSchema.parse(data); +``` + +--- + +## BillOfMaterials + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **tenantId** | `string` | ✅ | Target Tenant ID | +| **dependencies** | `object[]` | ✅ | Installed packages | +| **environment** | `Record` | optional | | +| **resolutionStrategy** | `Enum<'strict' \| 'override' \| 'merge'>` | optional | Conflict resolution strategy (strict=fail, override=last-wins, merge=deep-merge) | + +--- + +## ComposerRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **bom** | `object` | ✅ | | +| **runtimeVersion** | `string` | optional | | +| **dryRun** | `boolean` | optional | | + +--- + +## ComposerResponse + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **success** | `boolean` | ✅ | | +| **manifest** | `object` | optional | The compiled System Manifest | +| **manifestUrl** | `string` | optional | Presigned download URL | +| **buildId** | `string` | ✅ | | +| **timestamp** | `string` | ✅ | | +| **duration** | `number` | ✅ | Compilation time in ms | +| **conflicts** | `object[]` | optional | | +| **errors** | `string[]` | optional | | + +--- + +## ConflictReport + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **resourceType** | `Enum<'object' \| 'field' \| 'api' \| 'ui'>` | ✅ | Type of colliding resource | +| **resourceId** | `string` | ✅ | ID of the resource | +| **sources** | `string[]` | ✅ | List of plugin IDs defining this resource | +| **resolution** | `string` | ✅ | How it was resolved (e.g. "com.example.erp won") | +| **severity** | `Enum<'info' \| 'warning' \| 'error'>` | ✅ | Severity of the conflict | + +--- + +## DependencyRequirement + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Plugin ID (e.g. "com.example.crm") | +| **version** | `string` | optional | SemVer range or "latest" | +| **configuration** | `Record` | optional | Configuration overrides | +| **features** | `Record` | optional | Feature toggles | + diff --git a/content/docs/references/hub/composer/BillOfMaterials.mdx b/content/docs/references/hub/composer/BillOfMaterials.mdx deleted file mode 100644 index 7f6aee114..000000000 --- a/content/docs/references/hub/composer/BillOfMaterials.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: BillOfMaterials -description: BillOfMaterials Schema Reference -category: hub -zodFile: composer ---- - - - -**Source:** `packages/spec/src/hub/composer.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **tenantId** | `string` | ✅ | Target Tenant ID | -| **dependencies** | `object[]` | ✅ | Installed packages | -| **environment** | `Record` | optional | | -| **resolutionStrategy** | `Enum<'strict' \| 'override' \| 'merge'>` | optional | Conflict resolution strategy (strict=fail, override=last-wins, merge=deep-merge) | - -## TypeScript Usage - -```typescript -import { BillOfMaterialsSchema } from '@objectstack/spec/hub'; -import type { BillOfMaterials } from '@objectstack/spec/hub'; - -// Validate data -const result = BillOfMaterialsSchema.parse(data); - -// Type-safe usage -const myBillOfMaterials: BillOfMaterials = { - tenantId: 'example', - dependencies: [] -}; -``` - diff --git a/content/docs/references/hub/composer/ComposerRequest.mdx b/content/docs/references/hub/composer/ComposerRequest.mdx deleted file mode 100644 index e642767ca..000000000 --- a/content/docs/references/hub/composer/ComposerRequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ComposerRequest -description: ComposerRequest Schema Reference -category: hub -zodFile: composer ---- - - - -**Source:** `packages/spec/src/hub/composer.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **bom** | `object` | ✅ | | -| **runtimeVersion** | `string` | optional | | -| **dryRun** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { ComposerRequestSchema } from '@objectstack/spec/hub'; -import type { ComposerRequest } from '@objectstack/spec/hub'; - -// Validate data -const result = ComposerRequestSchema.parse(data); - -// Type-safe usage -const myComposerRequest: ComposerRequest = { - bom: {} -}; -``` - diff --git a/content/docs/references/hub/composer/ComposerResponse.mdx b/content/docs/references/hub/composer/ComposerResponse.mdx deleted file mode 100644 index 3d47977f7..000000000 --- a/content/docs/references/hub/composer/ComposerResponse.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ComposerResponse -description: ComposerResponse Schema Reference -category: hub -zodFile: composer ---- - - - -**Source:** `packages/spec/src/hub/composer.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **success** | `boolean` | ✅ | | -| **manifest** | `object` | optional | The compiled System Manifest | -| **manifestUrl** | `string` | optional | Presigned download URL | -| **buildId** | `string` | ✅ | | -| **timestamp** | `string` | ✅ | | -| **duration** | `number` | ✅ | Compilation time in ms | -| **conflicts** | `object[]` | optional | | -| **errors** | `string[]` | optional | | - -## TypeScript Usage - -```typescript -import { ComposerResponseSchema } from '@objectstack/spec/hub'; -import type { ComposerResponse } from '@objectstack/spec/hub'; - -// Validate data -const result = ComposerResponseSchema.parse(data); - -// Type-safe usage -const myComposerResponse: ComposerResponse = { - success: false, - buildId: 'example', - timestamp: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/hub/composer/ConflictReport.mdx b/content/docs/references/hub/composer/ConflictReport.mdx deleted file mode 100644 index ffaa5e8e1..000000000 --- a/content/docs/references/hub/composer/ConflictReport.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ConflictReport -description: ConflictReport Schema Reference -category: hub -zodFile: composer ---- - - - -**Source:** `packages/spec/src/hub/composer.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **resourceType** | `Enum<'object' \| 'field' \| 'api' \| 'ui'>` | ✅ | Type of colliding resource | -| **resourceId** | `string` | ✅ | ID of the resource | -| **sources** | `string[]` | ✅ | List of plugin IDs defining this resource | -| **resolution** | `string` | ✅ | How it was resolved (e.g. "com.example.erp won") | -| **severity** | `Enum<'info' \| 'warning' \| 'error'>` | ✅ | Severity of the conflict | - -## TypeScript Usage - -```typescript -import { ConflictReportSchema } from '@objectstack/spec/hub'; -import type { ConflictReport } from '@objectstack/spec/hub'; - -// Validate data -const result = ConflictReportSchema.parse(data); - -// Type-safe usage -const myConflictReport: ConflictReport = { - resourceType: 'object', - resourceId: 'example', - sources: [], - // ... other required fields -}; -``` - diff --git a/content/docs/references/hub/composer/DependencyRequirement.mdx b/content/docs/references/hub/composer/DependencyRequirement.mdx deleted file mode 100644 index 9553d2158..000000000 --- a/content/docs/references/hub/composer/DependencyRequirement.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DependencyRequirement -description: DependencyRequirement Schema Reference -category: hub -zodFile: composer ---- - - - -**Source:** `packages/spec/src/hub/composer.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Plugin ID (e.g. "com.example.crm") | -| **version** | `string` | optional | SemVer range or "latest" | -| **configuration** | `Record` | optional | Configuration overrides | -| **features** | `Record` | optional | Feature toggles | - -## TypeScript Usage - -```typescript -import { DependencyRequirementSchema } from '@objectstack/spec/hub'; -import type { DependencyRequirement } from '@objectstack/spec/hub'; - -// Validate data -const result = DependencyRequirementSchema.parse(data); - -// Type-safe usage -const myDependencyRequirement: DependencyRequirement = { - id: 'example' -}; -``` - diff --git a/content/docs/references/hub/composer/meta.json b/content/docs/references/hub/composer/meta.json deleted file mode 100644 index 92983b39a..000000000 --- a/content/docs/references/hub/composer/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Composer" -} \ No newline at end of file diff --git a/content/docs/references/hub/index.mdx b/content/docs/references/hub/index.mdx index 400392eca..ba3601706 100644 --- a/content/docs/references/hub/index.mdx +++ b/content/docs/references/hub/index.mdx @@ -3,67 +3,17 @@ title: Hub Protocol Overview description: Complete reference for all hub protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # Hub Protocol This section contains all protocol schemas for the hub layer of ObjectStack. -## Composer - -Source: `packages/spec/src/hub/composer.zod.ts` - - - - - - - - - -## License - -Source: `packages/spec/src/hub/license.zod.ts` - - - - - - - - -## Marketplace - -Source: `packages/spec/src/hub/marketplace.zod.ts` - - - - - - - -## Space - -Source: `packages/spec/src/hub/space.zod.ts` - - - - - - - - -## Tenant - -Source: `packages/spec/src/hub/tenant.zod.ts` - - - - - - - - - + + + + + diff --git a/content/docs/references/hub/license.mdx b/content/docs/references/hub/license.mdx new file mode 100644 index 000000000..901ba7e7a --- /dev/null +++ b/content/docs/references/hub/license.mdx @@ -0,0 +1,84 @@ +--- +title: License +description: License protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# License + + +**Source:** `packages/spec/src/hub/license.zod.ts` + + +## TypeScript Usage + +```typescript +import { FeatureSchema, LicenseSchema, MetricTypeSchema, PlanSchema } from '@objectstack/spec/hub'; +import type { Feature, License, MetricType, Plan } from '@objectstack/spec/hub'; + +// Validate data +const result = FeatureSchema.parse(data); +``` + +--- + +## Feature + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **code** | `string` | ✅ | Feature code (e.g. core.api_access) | +| **label** | `string` | ✅ | | +| **description** | `string` | optional | | +| **type** | `Enum<'boolean' \| 'counter' \| 'gauge'>` | optional | | +| **unit** | `Enum<'count' \| 'bytes' \| 'seconds' \| 'percent'>` | optional | | +| **requires** | `string[]` | optional | | + +--- + +## License + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **spaceId** | `string` | ✅ | Target Space ID | +| **planCode** | `string` | ✅ | | +| **issuedAt** | `string` | ✅ | | +| **expiresAt** | `string` | optional | | +| **status** | `Enum<'active' \| 'expired' \| 'suspended' \| 'trial'>` | ✅ | | +| **customFeatures** | `string[]` | optional | | +| **customLimits** | `Record` | optional | | +| **plugins** | `string[]` | optional | List of enabled plugin package IDs | +| **signature** | `string` | optional | Cryptographic signature of the license | + +--- + +## MetricType + +### Allowed Values + +* `boolean` +* `counter` +* `gauge` + +--- + +## Plan + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **code** | `string` | ✅ | Plan code (e.g. pro_v1) | +| **label** | `string` | ✅ | | +| **active** | `boolean` | optional | | +| **features** | `string[]` | ✅ | List of enabled boolean features | +| **limits** | `Record` | ✅ | Map of metric codes to limit values (e.g. `{ storage_gb: 10 }`) | +| **currency** | `string` | optional | | +| **priceMonthly** | `number` | optional | | +| **priceYearly** | `number` | optional | | + diff --git a/content/docs/references/hub/license/Feature.mdx b/content/docs/references/hub/license/Feature.mdx deleted file mode 100644 index 30d399f51..000000000 --- a/content/docs/references/hub/license/Feature.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Feature -description: Feature Schema Reference -category: hub -zodFile: license ---- - - - -**Source:** `packages/spec/src/hub/license.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **code** | `string` | ✅ | Feature code (e.g. core.api_access) | -| **label** | `string` | ✅ | | -| **description** | `string` | optional | | -| **type** | `Enum<'boolean' \| 'counter' \| 'gauge'>` | optional | | -| **unit** | `Enum<'count' \| 'bytes' \| 'seconds' \| 'percent'>` | optional | | -| **requires** | `string[]` | optional | | - -## TypeScript Usage - -```typescript -import { FeatureSchema } from '@objectstack/spec/hub'; -import type { Feature } from '@objectstack/spec/hub'; - -// Validate data -const result = FeatureSchema.parse(data); - -// Type-safe usage -const myFeature: Feature = { - code: 'example', - label: 'example' -}; -``` - diff --git a/content/docs/references/hub/license/License.mdx b/content/docs/references/hub/license/License.mdx deleted file mode 100644 index 4cfc9136a..000000000 --- a/content/docs/references/hub/license/License.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: License -description: License Schema Reference -category: hub -zodFile: license ---- - - - -**Source:** `packages/spec/src/hub/license.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **spaceId** | `string` | ✅ | Target Space ID | -| **planCode** | `string` | ✅ | | -| **issuedAt** | `string` | ✅ | | -| **expiresAt** | `string` | optional | | -| **status** | `Enum<'active' \| 'expired' \| 'suspended' \| 'trial'>` | ✅ | | -| **customFeatures** | `string[]` | optional | | -| **customLimits** | `Record` | optional | | -| **plugins** | `string[]` | optional | List of enabled plugin package IDs | -| **signature** | `string` | optional | Cryptographic signature of the license | - -## TypeScript Usage - -```typescript -import { LicenseSchema } from '@objectstack/spec/hub'; -import type { License } from '@objectstack/spec/hub'; - -// Validate data -const result = LicenseSchema.parse(data); - -// Type-safe usage -const myLicense: License = { - spaceId: 'example', - planCode: 'example', - issuedAt: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/hub/license/MetricType.mdx b/content/docs/references/hub/license/MetricType.mdx deleted file mode 100644 index 7a80e8a04..000000000 --- a/content/docs/references/hub/license/MetricType.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: MetricType -description: MetricType Schema Reference -category: hub -zodFile: license ---- - - - -**Source:** `packages/spec/src/hub/license.zod.ts` - - -## Allowed Values - -* `boolean` -* `counter` -* `gauge` - -## TypeScript Usage - -```typescript -import { MetricType } from '@objectstack/spec/hub'; - -// Type-safe enum value -const value: MetricType = 'boolean'; -``` - diff --git a/content/docs/references/hub/license/Plan.mdx b/content/docs/references/hub/license/Plan.mdx deleted file mode 100644 index 3f9f1e954..000000000 --- a/content/docs/references/hub/license/Plan.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Plan -description: Plan Schema Reference -category: hub -zodFile: license ---- - - - -**Source:** `packages/spec/src/hub/license.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **code** | `string` | ✅ | Plan code (e.g. pro_v1) | -| **label** | `string` | ✅ | | -| **active** | `boolean` | optional | | -| **features** | `string[]` | ✅ | List of enabled boolean features | -| **limits** | `Record` | ✅ | Map of metric codes to limit values (e.g. `{ storage_gb: 10 }`) | -| **currency** | `string` | optional | | -| **priceMonthly** | `number` | optional | | -| **priceYearly** | `number` | optional | | - -## TypeScript Usage - -```typescript -import { PlanSchema } from '@objectstack/spec/hub'; -import type { Plan } from '@objectstack/spec/hub'; - -// Validate data -const result = PlanSchema.parse(data); - -// Type-safe usage -const myPlan: Plan = { - code: 'example', - label: 'example', - features: [], - // ... other required fields -}; -``` - diff --git a/content/docs/references/hub/license/meta.json b/content/docs/references/hub/license/meta.json deleted file mode 100644 index a27b22f95..000000000 --- a/content/docs/references/hub/license/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "License" -} \ No newline at end of file diff --git a/content/docs/references/hub/marketplace/MarketplacePlugin.mdx b/content/docs/references/hub/marketplace.mdx similarity index 50% rename from content/docs/references/hub/marketplace/MarketplacePlugin.mdx rename to content/docs/references/hub/marketplace.mdx index 1104da02c..00d9c4143 100644 --- a/content/docs/references/hub/marketplace/MarketplacePlugin.mdx +++ b/content/docs/references/hub/marketplace.mdx @@ -1,16 +1,32 @@ --- -title: MarketplacePlugin -description: MarketplacePlugin Schema Reference -category: hub -zodFile: marketplace +title: Marketplace +description: Marketplace protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Marketplace **Source:** `packages/spec/src/hub/marketplace.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { MarketplacePluginSchema, PluginAuthorSchema, PluginPricingSchema } from '@objectstack/spec/hub'; +import type { MarketplacePlugin, PluginAuthor, PluginPricing } from '@objectstack/spec/hub'; + +// Validate data +const result = MarketplacePluginSchema.parse(data); +``` + +--- + +## MarketplacePlugin + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -32,20 +48,29 @@ zodFile: marketplace | **pricing** | `object` | optional | | | **verified** | `boolean` | optional | Is verified maintaned by ObjectStack | -## TypeScript Usage +--- -```typescript -import { MarketplacePluginSchema } from '@objectstack/spec/hub'; -import type { MarketplacePlugin } from '@objectstack/spec/hub'; +## PluginAuthor -// Validate data -const result = MarketplacePluginSchema.parse(data); +### Properties -// Type-safe usage -const myMarketplacePlugin: MarketplacePlugin = { - id: 'example', - label: 'example', - version: 'example' -}; -``` +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | | +| **email** | `string` | optional | | +| **url** | `string` | optional | | + +--- + +## PluginPricing + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'free' \| 'one_time' \| 'recurring'>` | ✅ | | +| **currency** | `string` | optional | | +| **amount** | `number` | ✅ | | +| **interval** | `Enum<'month' \| 'year'>` | optional | Required if type is recurring | +| **trialDays** | `integer` | optional | | diff --git a/content/docs/references/hub/marketplace/PluginAuthor.mdx b/content/docs/references/hub/marketplace/PluginAuthor.mdx deleted file mode 100644 index ad5732d4c..000000000 --- a/content/docs/references/hub/marketplace/PluginAuthor.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PluginAuthor -description: PluginAuthor Schema Reference -category: hub -zodFile: marketplace ---- - - - -**Source:** `packages/spec/src/hub/marketplace.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | | -| **email** | `string` | optional | | -| **url** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { PluginAuthorSchema } from '@objectstack/spec/hub'; -import type { PluginAuthor } from '@objectstack/spec/hub'; - -// Validate data -const result = PluginAuthorSchema.parse(data); - -// Type-safe usage -const myPluginAuthor: PluginAuthor = { - name: 'name' -}; -``` - diff --git a/content/docs/references/hub/marketplace/PluginPricing.mdx b/content/docs/references/hub/marketplace/PluginPricing.mdx deleted file mode 100644 index 8c7c4a747..000000000 --- a/content/docs/references/hub/marketplace/PluginPricing.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PluginPricing -description: PluginPricing Schema Reference -category: hub -zodFile: marketplace ---- - - - -**Source:** `packages/spec/src/hub/marketplace.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'free' \| 'one_time' \| 'recurring'>` | ✅ | | -| **currency** | `string` | optional | | -| **amount** | `number` | ✅ | | -| **interval** | `Enum<'month' \| 'year'>` | optional | Required if type is recurring | -| **trialDays** | `integer` | optional | | - -## TypeScript Usage - -```typescript -import { PluginPricingSchema } from '@objectstack/spec/hub'; -import type { PluginPricing } from '@objectstack/spec/hub'; - -// Validate data -const result = PluginPricingSchema.parse(data); - -// Type-safe usage -const myPluginPricing: PluginPricing = { - type: 'free', - amount: 0 -}; -``` - diff --git a/content/docs/references/hub/marketplace/meta.json b/content/docs/references/hub/marketplace/meta.json deleted file mode 100644 index 8beddadc3..000000000 --- a/content/docs/references/hub/marketplace/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Marketplace" -} \ No newline at end of file diff --git a/content/docs/references/hub/space.mdx b/content/docs/references/hub/space.mdx new file mode 100644 index 000000000..bf1602a56 --- /dev/null +++ b/content/docs/references/hub/space.mdx @@ -0,0 +1,85 @@ +--- +title: Space +description: Space protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Space + + +**Source:** `packages/spec/src/hub/space.zod.ts` + + +## TypeScript Usage + +```typescript +import { DeploymentTargetSchema, HubSpaceSchema, SpaceSubscriptionSchema, SubscriptionStatusSchema } from '@objectstack/spec/hub'; +import type { DeploymentTarget, HubSpace, SpaceSubscription, SubscriptionStatus } from '@objectstack/spec/hub'; + +// Validate data +const result = DeploymentTargetSchema.parse(data); +``` + +--- + +## DeploymentTarget + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **provider** | `Enum<'vercel' \| 'docker' \| 'kubernetes'>` | ✅ | | +| **region** | `string` | optional | | +| **url** | `string` | optional | Public Access URL | +| **env** | `Record` | optional | Runtime Environment Variables | + +--- + +## HubSpace + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | | +| **name** | `string` | ✅ | | +| **slug** | `string` | ✅ | URL friendly identifier | +| **ownerId** | `string` | ✅ | | +| **runtime** | `object` | optional | Runtime instance configuration | +| **bom** | `object` | ✅ | | +| **lastBuild** | `object` | optional | | +| **subscription** | `object` | optional | | +| **deployment** | `object` | optional | | +| **createdAt** | `string` | ✅ | | +| **updatedAt** | `string` | ✅ | | + +--- + +## SpaceSubscription + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **planId** | `string` | ✅ | Reference to Plan Code | +| **status** | `Enum<'active' \| 'past_due' \| 'canceled' \| 'trialing' \| 'incomplete'>` | ✅ | | +| **currentPeriodEnd** | `string` | optional | | +| **stripeCustomerId** | `string` | optional | | +| **stripeSubscriptionId** | `string` | optional | | +| **addons** | `object[]` | optional | | +| **usage** | `Record` | optional | | + +--- + +## SubscriptionStatus + +### Allowed Values + +* `active` +* `past_due` +* `canceled` +* `trialing` +* `incomplete` + diff --git a/content/docs/references/hub/space/DeploymentTarget.mdx b/content/docs/references/hub/space/DeploymentTarget.mdx deleted file mode 100644 index 9cc356d92..000000000 --- a/content/docs/references/hub/space/DeploymentTarget.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeploymentTarget -description: DeploymentTarget Schema Reference -category: hub -zodFile: space ---- - - - -**Source:** `packages/spec/src/hub/space.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **provider** | `Enum<'vercel' \| 'docker' \| 'kubernetes'>` | ✅ | | -| **region** | `string` | optional | | -| **url** | `string` | optional | Public Access URL | -| **env** | `Record` | optional | Runtime Environment Variables | - -## TypeScript Usage - -```typescript -import { DeploymentTargetSchema } from '@objectstack/spec/hub'; -import type { DeploymentTarget } from '@objectstack/spec/hub'; - -// Validate data -const result = DeploymentTargetSchema.parse(data); - -// Type-safe usage -const myDeploymentTarget: DeploymentTarget = { - provider: 'vercel' -}; -``` - diff --git a/content/docs/references/hub/space/HubSpace.mdx b/content/docs/references/hub/space/HubSpace.mdx deleted file mode 100644 index 0c8d68675..000000000 --- a/content/docs/references/hub/space/HubSpace.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: HubSpace -description: HubSpace Schema Reference -category: hub -zodFile: space ---- - - - -**Source:** `packages/spec/src/hub/space.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | | -| **name** | `string` | ✅ | | -| **slug** | `string` | ✅ | URL friendly identifier | -| **ownerId** | `string` | ✅ | | -| **runtime** | `object` | optional | Runtime instance configuration | -| **bom** | `object` | ✅ | | -| **lastBuild** | `object` | optional | | -| **subscription** | `object` | optional | | -| **deployment** | `object` | optional | | -| **createdAt** | `string` | ✅ | | -| **updatedAt** | `string` | ✅ | | - -## TypeScript Usage - -```typescript -import { HubSpaceSchema } from '@objectstack/spec/hub'; -import type { HubSpace } from '@objectstack/spec/hub'; - -// Validate data -const result = HubSpaceSchema.parse(data); - -// Type-safe usage -const myHubSpace: HubSpace = { - id: 'example', - name: 'name', - slug: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/hub/space/SpaceSubscription.mdx b/content/docs/references/hub/space/SpaceSubscription.mdx deleted file mode 100644 index 14cd798e0..000000000 --- a/content/docs/references/hub/space/SpaceSubscription.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: SpaceSubscription -description: SpaceSubscription Schema Reference -category: hub -zodFile: space ---- - - - -**Source:** `packages/spec/src/hub/space.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **planId** | `string` | ✅ | Reference to Plan Code | -| **status** | `Enum<'active' \| 'past_due' \| 'canceled' \| 'trialing' \| 'incomplete'>` | ✅ | | -| **currentPeriodEnd** | `string` | optional | | -| **stripeCustomerId** | `string` | optional | | -| **stripeSubscriptionId** | `string` | optional | | -| **addons** | `object[]` | optional | | -| **usage** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { SpaceSubscriptionSchema } from '@objectstack/spec/hub'; -import type { SpaceSubscription } from '@objectstack/spec/hub'; - -// Validate data -const result = SpaceSubscriptionSchema.parse(data); - -// Type-safe usage -const mySpaceSubscription: SpaceSubscription = { - planId: 'example', - status: 'active' -}; -``` - diff --git a/content/docs/references/hub/space/SubscriptionStatus.mdx b/content/docs/references/hub/space/SubscriptionStatus.mdx deleted file mode 100644 index ead6549d2..000000000 --- a/content/docs/references/hub/space/SubscriptionStatus.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: SubscriptionStatus -description: SubscriptionStatus Schema Reference -category: hub -zodFile: space ---- - - - -**Source:** `packages/spec/src/hub/space.zod.ts` - - -## Allowed Values - -* `active` -* `past_due` -* `canceled` -* `trialing` -* `incomplete` - -## TypeScript Usage - -```typescript -import { SubscriptionStatus } from '@objectstack/spec/hub'; - -// Type-safe enum value -const value: SubscriptionStatus = 'active'; -``` - diff --git a/content/docs/references/hub/space/meta.json b/content/docs/references/hub/space/meta.json deleted file mode 100644 index a7ea693af..000000000 --- a/content/docs/references/hub/space/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Space" -} \ No newline at end of file diff --git a/content/docs/references/hub/tenant.mdx b/content/docs/references/hub/tenant.mdx new file mode 100644 index 000000000..0fd5de31d --- /dev/null +++ b/content/docs/references/hub/tenant.mdx @@ -0,0 +1,115 @@ +--- +title: Tenant +description: Tenant protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Tenant + + +**Source:** `packages/spec/src/hub/tenant.zod.ts` + + +## TypeScript Usage + +```typescript +import { DatabaseLevelIsolationStrategySchema, LevelIsolationStrategySchemaSchema, RowLevelIsolationStrategySchema, TenantSchema, TenantIsolationConfigSchema, TenantIsolationLevelSchema, TenantQuotaSchema, TenantSecurityPolicySchema } from '@objectstack/spec/hub'; +import type { DatabaseLevelIsolationStrategy, LevelIsolationStrategySchema, RowLevelIsolationStrategy, Tenant, TenantIsolationConfig, TenantIsolationLevel, TenantQuota, TenantSecurityPolicy } from '@objectstack/spec/hub'; + +// Validate data +const result = DatabaseLevelIsolationStrategySchema.parse(data); +``` + +--- + +## DatabaseLevelIsolationStrategy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **strategy** | `string` | ✅ | Database-level isolation strategy | +| **database** | `object` | optional | Database configuration | +| **connectionPool** | `object` | optional | Connection pool configuration | +| **backup** | `object` | optional | Backup configuration | +| **encryption** | `object` | optional | Encryption configuration | + +--- + +## LevelIsolationStrategySchema + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **strategy** | `string` | ✅ | Schema-level isolation strategy | +| **schema** | `object` | optional | Schema configuration | +| **migrations** | `object` | optional | Migration configuration | +| **performance** | `object` | optional | Performance settings | + +--- + +## RowLevelIsolationStrategy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **strategy** | `string` | ✅ | Row-level isolation strategy | +| **database** | `object` | optional | Database configuration | +| **performance** | `object` | optional | Performance settings | + +--- + +## Tenant + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique tenant identifier | +| **name** | `string` | ✅ | Tenant display name | +| **isolationLevel** | `Enum<'shared_schema' \| 'isolated_schema' \| 'isolated_db'>` | ✅ | | +| **customizations** | `Record` | optional | Custom configuration values | +| **quotas** | `object` | optional | | + +--- + +## TenantIsolationConfig + +--- + +## TenantIsolationLevel + +### Allowed Values + +* `shared_schema` +* `isolated_schema` +* `isolated_db` + +--- + +## TenantQuota + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **maxUsers** | `integer` | optional | Maximum number of users | +| **maxStorage** | `integer` | optional | Maximum storage in bytes | +| **apiRateLimit** | `integer` | optional | API requests per minute | + +--- + +## TenantSecurityPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **encryption** | `object` | optional | Encryption requirements | +| **accessControl** | `object` | optional | Access control requirements | +| **compliance** | `object` | optional | Compliance requirements | + diff --git a/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx b/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx deleted file mode 100644 index e0fa7304d..000000000 --- a/content/docs/references/hub/tenant/DatabaseLevelIsolationStrategy.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DatabaseLevelIsolationStrategy -description: DatabaseLevelIsolationStrategy Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **strategy** | `string` | ✅ | Database-level isolation strategy | -| **database** | `object` | optional | Database configuration | -| **connectionPool** | `object` | optional | Connection pool configuration | -| **backup** | `object` | optional | Backup configuration | -| **encryption** | `object` | optional | Encryption configuration | - -## TypeScript Usage - -```typescript -import { DatabaseLevelIsolationStrategySchema } from '@objectstack/spec/hub'; -import type { DatabaseLevelIsolationStrategy } from '@objectstack/spec/hub'; - -// Validate data -const result = DatabaseLevelIsolationStrategySchema.parse(data); - -// Type-safe usage -const myDatabaseLevelIsolationStrategy: DatabaseLevelIsolationStrategy = { - strategy: 'example' -}; -``` - diff --git a/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx b/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx deleted file mode 100644 index fa8f652a8..000000000 --- a/content/docs/references/hub/tenant/LevelIsolationStrategySchema.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: LevelIsolationStrategySchema -description: LevelIsolationStrategySchema Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **strategy** | `string` | ✅ | Schema-level isolation strategy | -| **schema** | `object` | optional | Schema configuration | -| **migrations** | `object` | optional | Migration configuration | -| **performance** | `object` | optional | Performance settings | - -## TypeScript Usage - -```typescript -import { LevelIsolationStrategySchemaSchema } from '@objectstack/spec/hub'; -import type { LevelIsolationStrategySchema } from '@objectstack/spec/hub'; - -// Validate data -const result = LevelIsolationStrategySchemaSchema.parse(data); - -// Type-safe usage -const myLevelIsolationStrategySchema: LevelIsolationStrategySchema = { - strategy: 'example' -}; -``` - diff --git a/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx b/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx deleted file mode 100644 index a80a893fc..000000000 --- a/content/docs/references/hub/tenant/RowLevelIsolationStrategy.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RowLevelIsolationStrategy -description: RowLevelIsolationStrategy Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **strategy** | `string` | ✅ | Row-level isolation strategy | -| **database** | `object` | optional | Database configuration | -| **performance** | `object` | optional | Performance settings | - -## TypeScript Usage - -```typescript -import { RowLevelIsolationStrategySchema } from '@objectstack/spec/hub'; -import type { RowLevelIsolationStrategy } from '@objectstack/spec/hub'; - -// Validate data -const result = RowLevelIsolationStrategySchema.parse(data); - -// Type-safe usage -const myRowLevelIsolationStrategy: RowLevelIsolationStrategy = { - strategy: 'example' -}; -``` - diff --git a/content/docs/references/hub/tenant/Tenant.mdx b/content/docs/references/hub/tenant/Tenant.mdx deleted file mode 100644 index d082e9adf..000000000 --- a/content/docs/references/hub/tenant/Tenant.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Tenant -description: Tenant Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique tenant identifier | -| **name** | `string` | ✅ | Tenant display name | -| **isolationLevel** | `Enum<'shared_schema' \| 'isolated_schema' \| 'isolated_db'>` | ✅ | | -| **customizations** | `Record` | optional | Custom configuration values | -| **quotas** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { TenantSchema } from '@objectstack/spec/hub'; -import type { Tenant } from '@objectstack/spec/hub'; - -// Validate data -const result = TenantSchema.parse(data); - -// Type-safe usage -const myTenant: Tenant = { - id: 'example', - name: 'name', - isolationLevel: 'shared_schema' -}; -``` - diff --git a/content/docs/references/hub/tenant/TenantIsolationConfig.mdx b/content/docs/references/hub/tenant/TenantIsolationConfig.mdx deleted file mode 100644 index dd99923bb..000000000 --- a/content/docs/references/hub/tenant/TenantIsolationConfig.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: TenantIsolationConfig -description: TenantIsolationConfig Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - diff --git a/content/docs/references/hub/tenant/TenantIsolationLevel.mdx b/content/docs/references/hub/tenant/TenantIsolationLevel.mdx deleted file mode 100644 index 8f61bc454..000000000 --- a/content/docs/references/hub/tenant/TenantIsolationLevel.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: TenantIsolationLevel -description: TenantIsolationLevel Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Allowed Values - -* `shared_schema` -* `isolated_schema` -* `isolated_db` - -## TypeScript Usage - -```typescript -import { TenantIsolationLevel } from '@objectstack/spec/hub'; - -// Type-safe enum value -const value: TenantIsolationLevel = 'shared_schema'; -``` - diff --git a/content/docs/references/hub/tenant/TenantQuota.mdx b/content/docs/references/hub/tenant/TenantQuota.mdx deleted file mode 100644 index c32ac8dcc..000000000 --- a/content/docs/references/hub/tenant/TenantQuota.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TenantQuota -description: TenantQuota Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **maxUsers** | `integer` | optional | Maximum number of users | -| **maxStorage** | `integer` | optional | Maximum storage in bytes | -| **apiRateLimit** | `integer` | optional | API requests per minute | - -## TypeScript Usage - -```typescript -import { TenantQuotaSchema } from '@objectstack/spec/hub'; -import type { TenantQuota } from '@objectstack/spec/hub'; - -// Validate data -const result = TenantQuotaSchema.parse(data); - -// Type-safe usage -const myTenantQuota: TenantQuota = { -}; -``` - diff --git a/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx b/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx deleted file mode 100644 index 89068f38d..000000000 --- a/content/docs/references/hub/tenant/TenantSecurityPolicy.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TenantSecurityPolicy -description: TenantSecurityPolicy Schema Reference -category: hub -zodFile: tenant ---- - - - -**Source:** `packages/spec/src/hub/tenant.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **encryption** | `object` | optional | Encryption requirements | -| **accessControl** | `object` | optional | Access control requirements | -| **compliance** | `object` | optional | Compliance requirements | - -## TypeScript Usage - -```typescript -import { TenantSecurityPolicySchema } from '@objectstack/spec/hub'; -import type { TenantSecurityPolicy } from '@objectstack/spec/hub'; - -// Validate data -const result = TenantSecurityPolicySchema.parse(data); - -// Type-safe usage -const myTenantSecurityPolicy: TenantSecurityPolicy = { -}; -``` - diff --git a/content/docs/references/hub/tenant/meta.json b/content/docs/references/hub/tenant/meta.json deleted file mode 100644 index f3b2fd222..000000000 --- a/content/docs/references/hub/tenant/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Tenant" -} \ No newline at end of file diff --git a/content/docs/references/permission/index.mdx b/content/docs/references/permission/index.mdx index e1366bbd2..a5af9e05b 100644 --- a/content/docs/references/permission/index.mdx +++ b/content/docs/references/permission/index.mdx @@ -3,54 +3,16 @@ title: Permission Protocol Overview description: Complete reference for all permission protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # Permission Protocol This section contains all protocol schemas for the permission layer of ObjectStack. -## Permission - -Source: `packages/spec/src/permission/permission.zod.ts` - - - - - - - -## Rls - -Source: `packages/spec/src/permission/rls.zod.ts` - - - - - - - - - -## Sharing - -Source: `packages/spec/src/permission/sharing.zod.ts` - - - - - - - - - - - -## Territory - -Source: `packages/spec/src/permission/territory.zod.ts` - - - - + + + + diff --git a/content/docs/references/permission/permission.mdx b/content/docs/references/permission/permission.mdx new file mode 100644 index 000000000..1c512a83f --- /dev/null +++ b/content/docs/references/permission/permission.mdx @@ -0,0 +1,68 @@ +--- +title: Permission +description: Permission protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Permission + + +**Source:** `packages/spec/src/permission/permission.zod.ts` + + +## TypeScript Usage + +```typescript +import { FieldPermissionSchema, ObjectPermissionSchema, PermissionSetSchema } from '@objectstack/spec/permission'; +import type { FieldPermission, ObjectPermission, PermissionSet } from '@objectstack/spec/permission'; + +// Validate data +const result = FieldPermissionSchema.parse(data); +``` + +--- + +## FieldPermission + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **readable** | `boolean` | optional | Field read access | +| **editable** | `boolean` | optional | Field edit access | + +--- + +## ObjectPermission + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **allowCreate** | `boolean` | optional | Create permission | +| **allowRead** | `boolean` | optional | Read permission | +| **allowEdit** | `boolean` | optional | Edit permission | +| **allowDelete** | `boolean` | optional | Delete permission | +| **allowTransfer** | `boolean` | optional | Change record ownership | +| **allowRestore** | `boolean` | optional | Restore from trash (Undelete) | +| **allowPurge** | `boolean` | optional | Permanently delete (Hard Delete/GDPR) | +| **viewAllRecords** | `boolean` | optional | View All Data (Bypass Sharing) | +| **modifyAllRecords** | `boolean` | optional | Modify All Data (Bypass Sharing) | + +--- + +## PermissionSet + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Permission set unique name (lowercase snake_case) | +| **label** | `string` | optional | Display label | +| **isProfile** | `boolean` | optional | Whether this is a user profile | +| **objects** | `Record` | ✅ | Entity permissions | +| **fields** | `Record` | optional | Field level security | +| **systemPermissions** | `string[]` | optional | System level capabilities | + diff --git a/content/docs/references/permission/permission/FieldPermission.mdx b/content/docs/references/permission/permission/FieldPermission.mdx deleted file mode 100644 index bf6204a59..000000000 --- a/content/docs/references/permission/permission/FieldPermission.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FieldPermission -description: FieldPermission Schema Reference -category: permission -zodFile: permission ---- - - - -**Source:** `packages/spec/src/permission/permission.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **readable** | `boolean` | optional | Field read access | -| **editable** | `boolean` | optional | Field edit access | - -## TypeScript Usage - -```typescript -import { FieldPermissionSchema } from '@objectstack/spec/permission'; -import type { FieldPermission } from '@objectstack/spec/permission'; - -// Validate data -const result = FieldPermissionSchema.parse(data); - -// Type-safe usage -const myFieldPermission: FieldPermission = { -}; -``` - diff --git a/content/docs/references/permission/permission/ObjectPermission.mdx b/content/docs/references/permission/permission/ObjectPermission.mdx deleted file mode 100644 index 8a3e399e9..000000000 --- a/content/docs/references/permission/permission/ObjectPermission.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ObjectPermission -description: ObjectPermission Schema Reference -category: permission -zodFile: permission ---- - - - -**Source:** `packages/spec/src/permission/permission.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **allowCreate** | `boolean` | optional | Create permission | -| **allowRead** | `boolean` | optional | Read permission | -| **allowEdit** | `boolean` | optional | Edit permission | -| **allowDelete** | `boolean` | optional | Delete permission | -| **allowTransfer** | `boolean` | optional | Change record ownership | -| **allowRestore** | `boolean` | optional | Restore from trash (Undelete) | -| **allowPurge** | `boolean` | optional | Permanently delete (Hard Delete/GDPR) | -| **viewAllRecords** | `boolean` | optional | View All Data (Bypass Sharing) | -| **modifyAllRecords** | `boolean` | optional | Modify All Data (Bypass Sharing) | - -## TypeScript Usage - -```typescript -import { ObjectPermissionSchema } from '@objectstack/spec/permission'; -import type { ObjectPermission } from '@objectstack/spec/permission'; - -// Validate data -const result = ObjectPermissionSchema.parse(data); - -// Type-safe usage -const myObjectPermission: ObjectPermission = { -}; -``` - diff --git a/content/docs/references/permission/permission/PermissionSet.mdx b/content/docs/references/permission/permission/PermissionSet.mdx deleted file mode 100644 index ca6e372d8..000000000 --- a/content/docs/references/permission/permission/PermissionSet.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PermissionSet -description: PermissionSet Schema Reference -category: permission -zodFile: permission ---- - - - -**Source:** `packages/spec/src/permission/permission.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Permission set unique name (lowercase snake_case) | -| **label** | `string` | optional | Display label | -| **isProfile** | `boolean` | optional | Whether this is a user profile | -| **objects** | `Record` | ✅ | Entity permissions | -| **fields** | `Record` | optional | Field level security | -| **systemPermissions** | `string[]` | optional | System level capabilities | - -## TypeScript Usage - -```typescript -import { PermissionSetSchema } from '@objectstack/spec/permission'; -import type { PermissionSet } from '@objectstack/spec/permission'; - -// Validate data -const result = PermissionSetSchema.parse(data); - -// Type-safe usage -const myPermissionSet: PermissionSet = { - name: 'name', - objects: {} -}; -``` - diff --git a/content/docs/references/permission/permission/meta.json b/content/docs/references/permission/permission/meta.json deleted file mode 100644 index b5d4b6b2b..000000000 --- a/content/docs/references/permission/permission/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Permission" -} \ No newline at end of file diff --git a/content/docs/references/permission/rls.mdx b/content/docs/references/permission/rls.mdx new file mode 100644 index 000000000..337b1b9bc --- /dev/null +++ b/content/docs/references/permission/rls.mdx @@ -0,0 +1,103 @@ +--- +title: Rls +description: Rls protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Rls + + +**Source:** `packages/spec/src/permission/rls.zod.ts` + + +## TypeScript Usage + +```typescript +import { RLSConfigSchema, RLSEvaluationResultSchema, RLSOperationSchema, RLSUserContextSchema, RowLevelSecurityPolicySchema } from '@objectstack/spec/permission'; +import type { RLSConfig, RLSEvaluationResult, RLSOperation, RLSUserContext, RowLevelSecurityPolicy } from '@objectstack/spec/permission'; + +// Validate data +const result = RLSConfigSchema.parse(data); +``` + +--- + +## RLSConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | Enable RLS enforcement globally | +| **defaultPolicy** | `Enum<'deny' \| 'allow'>` | optional | Default action when no policies match | +| **allowSuperuserBypass** | `boolean` | optional | Allow superusers to bypass RLS | +| **bypassRoles** | `string[]` | optional | Roles that bypass RLS (see all data) | +| **logEvaluations** | `boolean` | optional | Log RLS policy evaluations for debugging | +| **cacheResults** | `boolean` | optional | Cache RLS evaluation results | +| **cacheTtlSeconds** | `integer` | optional | Cache TTL in seconds | +| **prefetchUserContext** | `boolean` | optional | Pre-fetch user context for performance | + +--- + +## RLSEvaluationResult + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **policyName** | `string` | ✅ | Policy name | +| **granted** | `boolean` | ✅ | Whether access was granted | +| **durationMs** | `number` | optional | Evaluation duration in milliseconds | +| **error** | `string` | optional | Error message if evaluation failed | +| **usingResult** | `boolean` | optional | USING clause evaluation result | +| **checkResult** | `boolean` | optional | CHECK clause evaluation result | + +--- + +## RLSOperation + +### Allowed Values + +* `select` +* `insert` +* `update` +* `delete` +* `all` + +--- + +## RLSUserContext + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | User ID | +| **email** | `string` | optional | User email | +| **tenantId** | `string` | optional | Tenant/Organization ID | +| **role** | `string \| string[]` | optional | User role(s) | +| **department** | `string` | optional | User department | +| **attributes** | `Record` | optional | Additional custom user attributes | + +--- + +## RowLevelSecurityPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Policy unique identifier (snake_case) | +| **label** | `string` | optional | Human-readable policy label | +| **description** | `string` | optional | Policy description and business justification | +| **object** | `string` | ✅ | Target object name | +| **operation** | `Enum<'select' \| 'insert' \| 'update' \| 'delete' \| 'all'>` | ✅ | Database operation this policy applies to | +| **using** | `string` | optional | Filter condition for SELECT/UPDATE/DELETE (PostgreSQL SQL WHERE clause syntax with parameterized context variables). Optional for INSERT-only policies. | +| **check** | `string` | optional | Validation condition for INSERT/UPDATE (defaults to USING clause if not specified - enforced at application level) | +| **roles** | `string[]` | optional | Roles this policy applies to (omit for all roles) | +| **enabled** | `boolean` | optional | Whether this policy is active | +| **priority** | `integer` | optional | Policy evaluation priority (higher = evaluated first) | +| **tags** | `string[]` | optional | Policy categorization tags | + diff --git a/content/docs/references/permission/rls/RLSConfig.mdx b/content/docs/references/permission/rls/RLSConfig.mdx deleted file mode 100644 index e14e7ffa3..000000000 --- a/content/docs/references/permission/rls/RLSConfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: RLSConfig -description: RLSConfig Schema Reference -category: permission -zodFile: rls ---- - - - -**Source:** `packages/spec/src/permission/rls.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | Enable RLS enforcement globally | -| **defaultPolicy** | `Enum<'deny' \| 'allow'>` | optional | Default action when no policies match | -| **allowSuperuserBypass** | `boolean` | optional | Allow superusers to bypass RLS | -| **bypassRoles** | `string[]` | optional | Roles that bypass RLS (see all data) | -| **logEvaluations** | `boolean` | optional | Log RLS policy evaluations for debugging | -| **cacheResults** | `boolean` | optional | Cache RLS evaluation results | -| **cacheTtlSeconds** | `integer` | optional | Cache TTL in seconds | -| **prefetchUserContext** | `boolean` | optional | Pre-fetch user context for performance | - -## TypeScript Usage - -```typescript -import { RLSConfigSchema } from '@objectstack/spec/permission'; -import type { RLSConfig } from '@objectstack/spec/permission'; - -// Validate data -const result = RLSConfigSchema.parse(data); - -// Type-safe usage -const myRLSConfig: RLSConfig = { -}; -``` - diff --git a/content/docs/references/permission/rls/RLSEvaluationResult.mdx b/content/docs/references/permission/rls/RLSEvaluationResult.mdx deleted file mode 100644 index d09baf5de..000000000 --- a/content/docs/references/permission/rls/RLSEvaluationResult.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: RLSEvaluationResult -description: RLSEvaluationResult Schema Reference -category: permission -zodFile: rls ---- - - - -**Source:** `packages/spec/src/permission/rls.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **policyName** | `string` | ✅ | Policy name | -| **granted** | `boolean` | ✅ | Whether access was granted | -| **durationMs** | `number` | optional | Evaluation duration in milliseconds | -| **error** | `string` | optional | Error message if evaluation failed | -| **usingResult** | `boolean` | optional | USING clause evaluation result | -| **checkResult** | `boolean` | optional | CHECK clause evaluation result | - -## TypeScript Usage - -```typescript -import { RLSEvaluationResultSchema } from '@objectstack/spec/permission'; -import type { RLSEvaluationResult } from '@objectstack/spec/permission'; - -// Validate data -const result = RLSEvaluationResultSchema.parse(data); - -// Type-safe usage -const myRLSEvaluationResult: RLSEvaluationResult = { - policyName: 'example', - granted: false -}; -``` - diff --git a/content/docs/references/permission/rls/RLSOperation.mdx b/content/docs/references/permission/rls/RLSOperation.mdx deleted file mode 100644 index 96ae64635..000000000 --- a/content/docs/references/permission/rls/RLSOperation.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: RLSOperation -description: RLSOperation Schema Reference -category: permission -zodFile: rls ---- - - - -**Source:** `packages/spec/src/permission/rls.zod.ts` - - -## Allowed Values - -* `select` -* `insert` -* `update` -* `delete` -* `all` - -## TypeScript Usage - -```typescript -import { RLSOperation } from '@objectstack/spec/permission'; - -// Type-safe enum value -const value: RLSOperation = 'select'; -``` - diff --git a/content/docs/references/permission/rls/RLSUserContext.mdx b/content/docs/references/permission/rls/RLSUserContext.mdx deleted file mode 100644 index e85d0fd0a..000000000 --- a/content/docs/references/permission/rls/RLSUserContext.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: RLSUserContext -description: RLSUserContext Schema Reference -category: permission -zodFile: rls ---- - - - -**Source:** `packages/spec/src/permission/rls.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | User ID | -| **email** | `string` | optional | User email | -| **tenantId** | `string` | optional | Tenant/Organization ID | -| **role** | `string \| string[]` | optional | User role(s) | -| **department** | `string` | optional | User department | -| **attributes** | `Record` | optional | Additional custom user attributes | - -## TypeScript Usage - -```typescript -import { RLSUserContextSchema } from '@objectstack/spec/permission'; -import type { RLSUserContext } from '@objectstack/spec/permission'; - -// Validate data -const result = RLSUserContextSchema.parse(data); - -// Type-safe usage -const myRLSUserContext: RLSUserContext = { - id: 'example' -}; -``` - diff --git a/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx b/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx deleted file mode 100644 index e3f4aa6b9..000000000 --- a/content/docs/references/permission/rls/RowLevelSecurityPolicy.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: RowLevelSecurityPolicy -description: RowLevelSecurityPolicy Schema Reference -category: permission -zodFile: rls ---- - - - -**Source:** `packages/spec/src/permission/rls.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Policy unique identifier (snake_case) | -| **label** | `string` | optional | Human-readable policy label | -| **description** | `string` | optional | Policy description and business justification | -| **object** | `string` | ✅ | Target object name | -| **operation** | `Enum<'select' \| 'insert' \| 'update' \| 'delete' \| 'all'>` | ✅ | Database operation this policy applies to | -| **using** | `string` | optional | Filter condition for SELECT/UPDATE/DELETE (PostgreSQL SQL WHERE clause syntax with parameterized context variables). Optional for INSERT-only policies. | -| **check** | `string` | optional | Validation condition for INSERT/UPDATE (defaults to USING clause if not specified - enforced at application level) | -| **roles** | `string[]` | optional | Roles this policy applies to (omit for all roles) | -| **enabled** | `boolean` | optional | Whether this policy is active | -| **priority** | `integer` | optional | Policy evaluation priority (higher = evaluated first) | -| **tags** | `string[]` | optional | Policy categorization tags | - -## TypeScript Usage - -```typescript -import { RowLevelSecurityPolicySchema } from '@objectstack/spec/permission'; -import type { RowLevelSecurityPolicy } from '@objectstack/spec/permission'; - -// Validate data -const result = RowLevelSecurityPolicySchema.parse(data); - -// Type-safe usage -const myRowLevelSecurityPolicy: RowLevelSecurityPolicy = { - name: 'name', - object: 'example', - operation: 'select' -}; -``` - diff --git a/content/docs/references/permission/rls/meta.json b/content/docs/references/permission/rls/meta.json deleted file mode 100644 index 5a808ca2f..000000000 --- a/content/docs/references/permission/rls/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Rls" -} \ No newline at end of file diff --git a/content/docs/references/permission/sharing.mdx b/content/docs/references/permission/sharing.mdx new file mode 100644 index 000000000..c68eba07e --- /dev/null +++ b/content/docs/references/permission/sharing.mdx @@ -0,0 +1,106 @@ +--- +title: Sharing +description: Sharing protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Sharing + + +**Source:** `packages/spec/src/permission/sharing.zod.ts` + + +## TypeScript Usage + +```typescript +import { CriteriaSharingRuleSchema, OWDModelSchema, OwnerSharingRuleSchema, ShareRecipientTypeSchema, SharingLevelSchema, SharingRuleSchema, SharingRuleTypeSchema } from '@objectstack/spec/permission'; +import type { CriteriaSharingRule, OWDModel, OwnerSharingRule, ShareRecipientType, SharingLevel, SharingRule, SharingRuleType } from '@objectstack/spec/permission'; + +// Validate data +const result = CriteriaSharingRuleSchema.parse(data); +``` + +--- + +## CriteriaSharingRule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label | +| **description** | `string` | optional | Administrative notes | +| **object** | `string` | ✅ | Target Object Name | +| **active** | `boolean` | optional | | +| **accessLevel** | `Enum<'read' \| 'edit' \| 'full'>` | optional | | +| **sharedWith** | `object` | ✅ | The recipient of the shared access | +| **type** | `string` | ✅ | | +| **condition** | `string` | ✅ | Formula condition (e.g. "department = 'Sales'") | + +--- + +## OWDModel + +### Allowed Values + +* `private` +* `public_read` +* `public_read_write` +* `controlled_by_parent` + +--- + +## OwnerSharingRule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique rule name (snake_case) | +| **label** | `string` | optional | Human-readable label | +| **description** | `string` | optional | Administrative notes | +| **object** | `string` | ✅ | Target Object Name | +| **active** | `boolean` | optional | | +| **accessLevel** | `Enum<'read' \| 'edit' \| 'full'>` | optional | | +| **sharedWith** | `object` | ✅ | The recipient of the shared access | +| **type** | `string` | ✅ | | +| **ownedBy** | `object` | ✅ | Source group/role whose records are being shared | + +--- + +## ShareRecipientType + +### Allowed Values + +* `user` +* `group` +* `role` +* `role_and_subordinates` +* `guest` + +--- + +## SharingLevel + +### Allowed Values + +* `read` +* `edit` +* `full` + +--- + +## SharingRule + +--- + +## SharingRuleType + +### Allowed Values + +* `owner` +* `criteria` + diff --git a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx b/content/docs/references/permission/sharing/CriteriaSharingRule.mdx deleted file mode 100644 index 29fe79123..000000000 --- a/content/docs/references/permission/sharing/CriteriaSharingRule.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CriteriaSharingRule -description: CriteriaSharingRule Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label | -| **description** | `string` | optional | Administrative notes | -| **object** | `string` | ✅ | Target Object Name | -| **active** | `boolean` | optional | | -| **accessLevel** | `Enum<'read' \| 'edit' \| 'full'>` | optional | | -| **sharedWith** | `object` | ✅ | The recipient of the shared access | -| **type** | `string` | ✅ | | -| **condition** | `string` | ✅ | Formula condition (e.g. "department = 'Sales'") | - -## TypeScript Usage - -```typescript -import { CriteriaSharingRuleSchema } from '@objectstack/spec/permission'; -import type { CriteriaSharingRule } from '@objectstack/spec/permission'; - -// Validate data -const result = CriteriaSharingRuleSchema.parse(data); - -// Type-safe usage -const myCriteriaSharingRule: CriteriaSharingRule = { - name: 'name', - object: 'example', - sharedWith: {}, - // ... other required fields -}; -``` - diff --git a/content/docs/references/permission/sharing/OWDModel.mdx b/content/docs/references/permission/sharing/OWDModel.mdx deleted file mode 100644 index 68f578dff..000000000 --- a/content/docs/references/permission/sharing/OWDModel.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: OWDModel -description: OWDModel Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - -## Allowed Values - -* `private` -* `public_read` -* `public_read_write` -* `controlled_by_parent` - -## TypeScript Usage - -```typescript -import { OWDModel } from '@objectstack/spec/permission'; - -// Type-safe enum value -const value: OWDModel = 'private'; -``` - diff --git a/content/docs/references/permission/sharing/OwnerSharingRule.mdx b/content/docs/references/permission/sharing/OwnerSharingRule.mdx deleted file mode 100644 index b49519609..000000000 --- a/content/docs/references/permission/sharing/OwnerSharingRule.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OwnerSharingRule -description: OwnerSharingRule Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique rule name (snake_case) | -| **label** | `string` | optional | Human-readable label | -| **description** | `string` | optional | Administrative notes | -| **object** | `string` | ✅ | Target Object Name | -| **active** | `boolean` | optional | | -| **accessLevel** | `Enum<'read' \| 'edit' \| 'full'>` | optional | | -| **sharedWith** | `object` | ✅ | The recipient of the shared access | -| **type** | `string` | ✅ | | -| **ownedBy** | `object` | ✅ | Source group/role whose records are being shared | - -## TypeScript Usage - -```typescript -import { OwnerSharingRuleSchema } from '@objectstack/spec/permission'; -import type { OwnerSharingRule } from '@objectstack/spec/permission'; - -// Validate data -const result = OwnerSharingRuleSchema.parse(data); - -// Type-safe usage -const myOwnerSharingRule: OwnerSharingRule = { - name: 'name', - object: 'example', - sharedWith: {}, - // ... other required fields -}; -``` - diff --git a/content/docs/references/permission/sharing/ShareRecipientType.mdx b/content/docs/references/permission/sharing/ShareRecipientType.mdx deleted file mode 100644 index 2a23e3cca..000000000 --- a/content/docs/references/permission/sharing/ShareRecipientType.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: ShareRecipientType -description: ShareRecipientType Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - -## Allowed Values - -* `user` -* `group` -* `role` -* `role_and_subordinates` -* `guest` - -## TypeScript Usage - -```typescript -import { ShareRecipientType } from '@objectstack/spec/permission'; - -// Type-safe enum value -const value: ShareRecipientType = 'user'; -``` - diff --git a/content/docs/references/permission/sharing/SharingLevel.mdx b/content/docs/references/permission/sharing/SharingLevel.mdx deleted file mode 100644 index d86cbbb63..000000000 --- a/content/docs/references/permission/sharing/SharingLevel.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: SharingLevel -description: SharingLevel Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - -## Allowed Values - -* `read` -* `edit` -* `full` - -## TypeScript Usage - -```typescript -import { SharingLevel } from '@objectstack/spec/permission'; - -// Type-safe enum value -const value: SharingLevel = 'read'; -``` - diff --git a/content/docs/references/permission/sharing/SharingRule.mdx b/content/docs/references/permission/sharing/SharingRule.mdx deleted file mode 100644 index 9148169e6..000000000 --- a/content/docs/references/permission/sharing/SharingRule.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: SharingRule -description: SharingRule Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - diff --git a/content/docs/references/permission/sharing/SharingRuleType.mdx b/content/docs/references/permission/sharing/SharingRuleType.mdx deleted file mode 100644 index 51aeee259..000000000 --- a/content/docs/references/permission/sharing/SharingRuleType.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: SharingRuleType -description: SharingRuleType Schema Reference -category: permission -zodFile: sharing ---- - - - -**Source:** `packages/spec/src/permission/sharing.zod.ts` - - -## Allowed Values - -* `owner` -* `criteria` - -## TypeScript Usage - -```typescript -import { SharingRuleType } from '@objectstack/spec/permission'; - -// Type-safe enum value -const value: SharingRuleType = 'owner'; -``` - diff --git a/content/docs/references/permission/sharing/meta.json b/content/docs/references/permission/sharing/meta.json deleted file mode 100644 index 49071aa3c..000000000 --- a/content/docs/references/permission/sharing/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Sharing" -} \ No newline at end of file diff --git a/content/docs/references/permission/territory/Territory.mdx b/content/docs/references/permission/territory.mdx similarity index 53% rename from content/docs/references/permission/territory/Territory.mdx rename to content/docs/references/permission/territory.mdx index 90c2cf76c..fa3a8ab1d 100644 --- a/content/docs/references/permission/territory/Territory.mdx +++ b/content/docs/references/permission/territory.mdx @@ -1,16 +1,32 @@ --- title: Territory -description: Territory Schema Reference -category: permission -zodFile: territory +description: Territory protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Territory **Source:** `packages/spec/src/permission/territory.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { TerritorySchema, TerritoryModelSchema, TerritoryTypeSchema } from '@objectstack/spec/permission'; +import type { Territory, TerritoryModel, TerritoryType } from '@objectstack/spec/permission'; + +// Validate data +const result = TerritorySchema.parse(data); +``` + +--- + +## Territory + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -25,20 +41,27 @@ zodFile: territory | **opportunityAccess** | `Enum<'read' \| 'edit'>` | optional | | | **caseAccess** | `Enum<'read' \| 'edit'>` | optional | | -## TypeScript Usage +--- -```typescript -import { TerritorySchema } from '@objectstack/spec/permission'; -import type { Territory } from '@objectstack/spec/permission'; +## TerritoryModel -// Validate data -const result = TerritorySchema.parse(data); +### Properties -// Type-safe usage -const myTerritory: Territory = { - name: 'name', - label: 'example', - modelId: 'example' -}; -``` +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Model Name (e.g. FY24 Planning) | +| **state** | `Enum<'planning' \| 'active' \| 'archived'>` | optional | | +| **startDate** | `string` | optional | | +| **endDate** | `string` | optional | | + +--- + +## TerritoryType + +### Allowed Values + +* `geography` +* `industry` +* `named_account` +* `product_line` diff --git a/content/docs/references/permission/territory/TerritoryModel.mdx b/content/docs/references/permission/territory/TerritoryModel.mdx deleted file mode 100644 index f0d305241..000000000 --- a/content/docs/references/permission/territory/TerritoryModel.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: TerritoryModel -description: TerritoryModel Schema Reference -category: permission -zodFile: territory ---- - - - -**Source:** `packages/spec/src/permission/territory.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Model Name (e.g. FY24 Planning) | -| **state** | `Enum<'planning' \| 'active' \| 'archived'>` | optional | | -| **startDate** | `string` | optional | | -| **endDate** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { TerritoryModelSchema } from '@objectstack/spec/permission'; -import type { TerritoryModel } from '@objectstack/spec/permission'; - -// Validate data -const result = TerritoryModelSchema.parse(data); - -// Type-safe usage -const myTerritoryModel: TerritoryModel = { - name: 'name' -}; -``` - diff --git a/content/docs/references/permission/territory/TerritoryType.mdx b/content/docs/references/permission/territory/TerritoryType.mdx deleted file mode 100644 index 98a86d704..000000000 --- a/content/docs/references/permission/territory/TerritoryType.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: TerritoryType -description: TerritoryType Schema Reference -category: permission -zodFile: territory ---- - - - -**Source:** `packages/spec/src/permission/territory.zod.ts` - - -## Allowed Values - -* `geography` -* `industry` -* `named_account` -* `product_line` - -## TypeScript Usage - -```typescript -import { TerritoryType } from '@objectstack/spec/permission'; - -// Type-safe enum value -const value: TerritoryType = 'geography'; -``` - diff --git a/content/docs/references/permission/territory/meta.json b/content/docs/references/permission/territory/meta.json deleted file mode 100644 index e87a9053e..000000000 --- a/content/docs/references/permission/territory/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Territory" -} \ No newline at end of file diff --git a/content/docs/references/shared/identifiers.mdx b/content/docs/references/shared/identifiers.mdx new file mode 100644 index 000000000..85b56afda --- /dev/null +++ b/content/docs/references/shared/identifiers.mdx @@ -0,0 +1,42 @@ +--- +title: Identifiers +description: Identifiers protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Identifiers + + +**Source:** `packages/spec/src/shared/identifiers.zod.ts` + + +## TypeScript Usage + +```typescript +import { EventNameSchema, SnakeCaseIdentifierSchema, SystemIdentifierSchema } from '@objectstack/spec/shared'; +import type { EventName, SnakeCaseIdentifier, SystemIdentifier } from '@objectstack/spec/shared'; + +// Validate data +const result = EventNameSchema.parse(data); +``` + +--- + +## EventName + +Event name (lowercase with dot notation for namespacing) + +--- + +## SnakeCaseIdentifier + +Snake case identifier (lowercase with underscores only) + +--- + +## SystemIdentifier + +System identifier (lowercase with underscores or dots) + diff --git a/content/docs/references/shared/identifiers/EventName.mdx b/content/docs/references/shared/identifiers/EventName.mdx deleted file mode 100644 index 4cf40a384..000000000 --- a/content/docs/references/shared/identifiers/EventName.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: EventName -description: Event name (lowercase with dot notation for namespacing) -category: shared -zodFile: identifiers ---- - - -Event name (lowercase with dot notation for namespacing) - - -**Source:** `packages/spec/src/shared/identifiers.zod.ts` - - diff --git a/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx b/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx deleted file mode 100644 index 9f296b945..000000000 --- a/content/docs/references/shared/identifiers/SnakeCaseIdentifier.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: SnakeCaseIdentifier -description: Snake case identifier (lowercase with underscores only) -category: shared -zodFile: identifiers ---- - - -Snake case identifier (lowercase with underscores only) - - -**Source:** `packages/spec/src/shared/identifiers.zod.ts` - - diff --git a/content/docs/references/shared/identifiers/SystemIdentifier.mdx b/content/docs/references/shared/identifiers/SystemIdentifier.mdx deleted file mode 100644 index aeb82dd23..000000000 --- a/content/docs/references/shared/identifiers/SystemIdentifier.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: SystemIdentifier -description: System identifier (lowercase with underscores or dots) -category: shared -zodFile: identifiers ---- - - -System identifier (lowercase with underscores or dots) - - -**Source:** `packages/spec/src/shared/identifiers.zod.ts` - - diff --git a/content/docs/references/shared/identifiers/meta.json b/content/docs/references/shared/identifiers/meta.json deleted file mode 100644 index 4d42ed94c..000000000 --- a/content/docs/references/shared/identifiers/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Identifiers" -} \ No newline at end of file diff --git a/content/docs/references/shared/index.mdx b/content/docs/references/shared/index.mdx index 50bf2d8f1..4e800c507 100644 --- a/content/docs/references/shared/index.mdx +++ b/content/docs/references/shared/index.mdx @@ -3,18 +3,13 @@ title: Shared Protocol Overview description: Complete reference for all shared protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # Shared Protocol This section contains all protocol schemas for the shared layer of ObjectStack. -## Identifiers - -Source: `packages/spec/src/shared/identifiers.zod.ts` - - - - + diff --git a/content/docs/references/system/audit.mdx b/content/docs/references/system/audit.mdx new file mode 100644 index 000000000..dd1672996 --- /dev/null +++ b/content/docs/references/system/audit.mdx @@ -0,0 +1,241 @@ +--- +title: Audit +description: Audit protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Audit + + +**Source:** `packages/spec/src/system/audit.zod.ts` + + +## TypeScript Usage + +```typescript +import { AuditConfigSchema, AuditEventSchema, AuditEventActorSchema, AuditEventChangeSchema, AuditEventFilterSchema, AuditEventSeveritySchema, AuditEventTargetSchema, AuditEventTypeSchema, AuditRetentionPolicySchema, AuditStorageConfigSchema, SuspiciousActivityRuleSchema } from '@objectstack/spec/system'; +import type { AuditConfig, AuditEvent, AuditEventActor, AuditEventChange, AuditEventFilter, AuditEventSeverity, AuditEventTarget, AuditEventType, AuditRetentionPolicy, AuditStorageConfig, SuspiciousActivityRule } from '@objectstack/spec/system'; + +// Validate data +const result = AuditConfigSchema.parse(data); +``` + +--- + +## AuditConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Configuration name (snake_case, max 64 chars) | +| **label** | `string` | ✅ | Display label | +| **enabled** | `boolean` | optional | Enable audit logging | +| **eventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | optional | Event types to audit | +| **excludeEventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | optional | Event types to exclude | +| **minimumSeverity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Minimum severity level | +| **storage** | `object` | ✅ | Storage configuration | +| **retentionPolicy** | `object` | optional | Retention policy | +| **suspiciousActivityRules** | `object[]` | optional | Suspicious activity rules | +| **includeSensitiveData** | `boolean` | optional | Include sensitive data | +| **redactFields** | `string[]` | optional | Fields to redact | +| **logReads** | `boolean` | optional | Log read operations | +| **readSamplingRate** | `number` | optional | Read sampling rate | +| **logSystemEvents** | `boolean` | optional | Log system events | +| **customHandlers** | `object[]` | optional | Custom event handler references | +| **compliance** | `object` | optional | Compliance configuration | + +--- + +## AuditEvent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Audit event ID | +| **eventType** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>` | ✅ | Event type | +| **severity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Event severity | +| **timestamp** | `string` | ✅ | Event timestamp | +| **actor** | `object` | ✅ | Event actor | +| **target** | `object` | optional | Event target | +| **description** | `string` | ✅ | Event description | +| **changes** | `object[]` | optional | List of changes | +| **result** | `Enum<'success' \| 'failure' \| 'partial'>` | optional | Action result | +| **errorMessage** | `string` | optional | Error message | +| **tenantId** | `string` | optional | Tenant identifier | +| **requestId** | `string` | optional | Request ID for tracing | +| **metadata** | `Record` | optional | Additional metadata | +| **location** | `object` | optional | Geographic location | + +--- + +## AuditEventActor + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'user' \| 'system' \| 'service' \| 'api_client' \| 'integration'>` | ✅ | Actor type | +| **id** | `string` | ✅ | Actor identifier | +| **name** | `string` | optional | Actor display name | +| **email** | `string` | optional | Actor email address | +| **ipAddress** | `string` | optional | Actor IP address | +| **userAgent** | `string` | optional | User agent string | + +--- + +## AuditEventChange + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | Changed field name | +| **oldValue** | `any` | optional | Previous value | +| **newValue** | `any` | optional | New value | + +--- + +## AuditEventFilter + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **eventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | optional | Event types to include | +| **severities** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>[]` | optional | Severity levels to include | +| **actorId** | `string` | optional | Actor identifier | +| **tenantId** | `string` | optional | Tenant identifier | +| **timeRange** | `object` | optional | Time range filter | +| **result** | `Enum<'success' \| 'failure' \| 'partial'>` | optional | Result status | +| **searchQuery** | `string` | optional | Search query | +| **customFilters** | `Record` | optional | Custom filters | + +--- + +## AuditEventSeverity + +### Allowed Values + +* `debug` +* `info` +* `notice` +* `warning` +* `error` +* `critical` +* `alert` +* `emergency` + +--- + +## AuditEventTarget + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `string` | ✅ | Target type | +| **id** | `string` | ✅ | Target identifier | +| **name** | `string` | optional | Target display name | +| **metadata** | `Record` | optional | Target metadata | + +--- + +## AuditEventType + +### Allowed Values + +* `data.create` +* `data.read` +* `data.update` +* `data.delete` +* `data.export` +* `data.import` +* `data.bulk_update` +* `data.bulk_delete` +* `auth.login` +* `auth.login_failed` +* `auth.logout` +* `auth.session_created` +* `auth.session_expired` +* `auth.password_reset` +* `auth.password_changed` +* `auth.email_verified` +* `auth.mfa_enabled` +* `auth.mfa_disabled` +* `auth.account_locked` +* `auth.account_unlocked` +* `authz.permission_granted` +* `authz.permission_revoked` +* `authz.role_assigned` +* `authz.role_removed` +* `authz.role_created` +* `authz.role_updated` +* `authz.role_deleted` +* `authz.policy_created` +* `authz.policy_updated` +* `authz.policy_deleted` +* `system.config_changed` +* `system.plugin_installed` +* `system.plugin_uninstalled` +* `system.backup_created` +* `system.backup_restored` +* `system.integration_added` +* `system.integration_removed` +* `security.access_denied` +* `security.suspicious_activity` +* `security.data_breach` +* `security.api_key_created` +* `security.api_key_revoked` + +--- + +## AuditRetentionPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **retentionDays** | `integer` | optional | Retention period in days | +| **archiveAfterRetention** | `boolean` | optional | Archive logs after retention period | +| **archiveStorage** | `object` | optional | Archive storage configuration | +| **customRetention** | `Record` | optional | Custom retention by event type | +| **minimumRetentionDays** | `integer` | optional | Minimum retention for compliance | + +--- + +## AuditStorageConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'database' \| 'elasticsearch' \| 'mongodb' \| 'clickhouse' \| 's3' \| 'gcs' \| 'azure_blob' \| 'custom'>` | ✅ | Storage backend type | +| **connectionString** | `string` | optional | Connection string | +| **config** | `Record` | optional | Storage-specific configuration | +| **bufferEnabled** | `boolean` | optional | Enable buffering | +| **bufferSize** | `integer` | optional | Buffer size | +| **flushIntervalSeconds** | `integer` | optional | Flush interval in seconds | +| **compression** | `boolean` | optional | Enable compression | + +--- + +## SuspiciousActivityRule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Rule identifier | +| **name** | `string` | ✅ | Rule name | +| **description** | `string` | optional | Rule description | +| **enabled** | `boolean` | optional | Rule enabled status | +| **eventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | ✅ | Event types to monitor | +| **condition** | `object` | ✅ | Detection condition | +| **actions** | `Enum<'alert' \| 'lock_account' \| 'block_ip' \| 'require_mfa' \| 'log_critical' \| 'webhook'>[]` | ✅ | Actions to take | +| **alertSeverity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Alert severity | +| **notifications** | `object` | optional | Notification configuration | + diff --git a/content/docs/references/system/audit/AuditConfig.mdx b/content/docs/references/system/audit/AuditConfig.mdx deleted file mode 100644 index 5b942b1a3..000000000 --- a/content/docs/references/system/audit/AuditConfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: AuditConfig -description: AuditConfig Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Configuration name (snake_case, max 64 chars) | -| **label** | `string` | ✅ | Display label | -| **enabled** | `boolean` | optional | Enable audit logging | -| **eventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | optional | Event types to audit | -| **excludeEventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | optional | Event types to exclude | -| **minimumSeverity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Minimum severity level | -| **storage** | `object` | ✅ | Storage configuration | -| **retentionPolicy** | `object` | optional | Retention policy | -| **suspiciousActivityRules** | `object[]` | optional | Suspicious activity rules | -| **includeSensitiveData** | `boolean` | optional | Include sensitive data | -| **redactFields** | `string[]` | optional | Fields to redact | -| **logReads** | `boolean` | optional | Log read operations | -| **readSamplingRate** | `number` | optional | Read sampling rate | -| **logSystemEvents** | `boolean` | optional | Log system events | -| **customHandlers** | `object[]` | optional | Custom event handler references | -| **compliance** | `object` | optional | Compliance configuration | - -## TypeScript Usage - -```typescript -import { AuditConfigSchema } from '@objectstack/spec/system'; -import type { AuditConfig } from '@objectstack/spec/system'; - -// Validate data -const result = AuditConfigSchema.parse(data); - -// Type-safe usage -const myAuditConfig: AuditConfig = { - name: 'name', - label: 'example', - storage: {} -}; -``` - diff --git a/content/docs/references/system/audit/AuditEvent.mdx b/content/docs/references/system/audit/AuditEvent.mdx deleted file mode 100644 index f5d080d54..000000000 --- a/content/docs/references/system/audit/AuditEvent.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: AuditEvent -description: AuditEvent Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Audit event ID | -| **eventType** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>` | ✅ | Event type | -| **severity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Event severity | -| **timestamp** | `string` | ✅ | Event timestamp | -| **actor** | `object` | ✅ | Event actor | -| **target** | `object` | optional | Event target | -| **description** | `string` | ✅ | Event description | -| **changes** | `object[]` | optional | List of changes | -| **result** | `Enum<'success' \| 'failure' \| 'partial'>` | optional | Action result | -| **errorMessage** | `string` | optional | Error message | -| **tenantId** | `string` | optional | Tenant identifier | -| **requestId** | `string` | optional | Request ID for tracing | -| **metadata** | `Record` | optional | Additional metadata | -| **location** | `object` | optional | Geographic location | - -## TypeScript Usage - -```typescript -import { AuditEventSchema } from '@objectstack/spec/system'; -import type { AuditEvent } from '@objectstack/spec/system'; - -// Validate data -const result = AuditEventSchema.parse(data); - -// Type-safe usage -const myAuditEvent: AuditEvent = { - id: 'example', - eventType: 'data.create', - timestamp: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/system/audit/AuditEventActor.mdx b/content/docs/references/system/audit/AuditEventActor.mdx deleted file mode 100644 index cb7bf05cd..000000000 --- a/content/docs/references/system/audit/AuditEventActor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AuditEventActor -description: AuditEventActor Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'user' \| 'system' \| 'service' \| 'api_client' \| 'integration'>` | ✅ | Actor type | -| **id** | `string` | ✅ | Actor identifier | -| **name** | `string` | optional | Actor display name | -| **email** | `string` | optional | Actor email address | -| **ipAddress** | `string` | optional | Actor IP address | -| **userAgent** | `string` | optional | User agent string | - -## TypeScript Usage - -```typescript -import { AuditEventActorSchema } from '@objectstack/spec/system'; -import type { AuditEventActor } from '@objectstack/spec/system'; - -// Validate data -const result = AuditEventActorSchema.parse(data); - -// Type-safe usage -const myAuditEventActor: AuditEventActor = { - type: 'user', - id: 'example' -}; -``` - diff --git a/content/docs/references/system/audit/AuditEventChange.mdx b/content/docs/references/system/audit/AuditEventChange.mdx deleted file mode 100644 index 72b020ec5..000000000 --- a/content/docs/references/system/audit/AuditEventChange.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AuditEventChange -description: AuditEventChange Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | Changed field name | -| **oldValue** | `any` | optional | Previous value | -| **newValue** | `any` | optional | New value | - -## TypeScript Usage - -```typescript -import { AuditEventChangeSchema } from '@objectstack/spec/system'; -import type { AuditEventChange } from '@objectstack/spec/system'; - -// Validate data -const result = AuditEventChangeSchema.parse(data); - -// Type-safe usage -const myAuditEventChange: AuditEventChange = { - field: 'example' -}; -``` - diff --git a/content/docs/references/system/audit/AuditEventFilter.mdx b/content/docs/references/system/audit/AuditEventFilter.mdx deleted file mode 100644 index df99baaac..000000000 --- a/content/docs/references/system/audit/AuditEventFilter.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AuditEventFilter -description: AuditEventFilter Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **eventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | optional | Event types to include | -| **severities** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>[]` | optional | Severity levels to include | -| **actorId** | `string` | optional | Actor identifier | -| **tenantId** | `string` | optional | Tenant identifier | -| **timeRange** | `object` | optional | Time range filter | -| **result** | `Enum<'success' \| 'failure' \| 'partial'>` | optional | Result status | -| **searchQuery** | `string` | optional | Search query | -| **customFilters** | `Record` | optional | Custom filters | - -## TypeScript Usage - -```typescript -import { AuditEventFilterSchema } from '@objectstack/spec/system'; -import type { AuditEventFilter } from '@objectstack/spec/system'; - -// Validate data -const result = AuditEventFilterSchema.parse(data); - -// Type-safe usage -const myAuditEventFilter: AuditEventFilter = { -}; -``` - diff --git a/content/docs/references/system/audit/AuditEventSeverity.mdx b/content/docs/references/system/audit/AuditEventSeverity.mdx deleted file mode 100644 index ada0adc4e..000000000 --- a/content/docs/references/system/audit/AuditEventSeverity.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: AuditEventSeverity -description: AuditEventSeverity Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Allowed Values - -* `debug` -* `info` -* `notice` -* `warning` -* `error` -* `critical` -* `alert` -* `emergency` - -## TypeScript Usage - -```typescript -import { AuditEventSeverity } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: AuditEventSeverity = 'debug'; -``` - diff --git a/content/docs/references/system/audit/AuditEventTarget.mdx b/content/docs/references/system/audit/AuditEventTarget.mdx deleted file mode 100644 index 7c0e4e3f3..000000000 --- a/content/docs/references/system/audit/AuditEventTarget.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AuditEventTarget -description: AuditEventTarget Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `string` | ✅ | Target type | -| **id** | `string` | ✅ | Target identifier | -| **name** | `string` | optional | Target display name | -| **metadata** | `Record` | optional | Target metadata | - -## TypeScript Usage - -```typescript -import { AuditEventTargetSchema } from '@objectstack/spec/system'; -import type { AuditEventTarget } from '@objectstack/spec/system'; - -// Validate data -const result = AuditEventTargetSchema.parse(data); - -// Type-safe usage -const myAuditEventTarget: AuditEventTarget = { - type: 'example', - id: 'example' -}; -``` - diff --git a/content/docs/references/system/audit/AuditEventType.mdx b/content/docs/references/system/audit/AuditEventType.mdx deleted file mode 100644 index 41d563983..000000000 --- a/content/docs/references/system/audit/AuditEventType.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: AuditEventType -description: AuditEventType Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Allowed Values - -* `data.create` -* `data.read` -* `data.update` -* `data.delete` -* `data.export` -* `data.import` -* `data.bulk_update` -* `data.bulk_delete` -* `auth.login` -* `auth.login_failed` -* `auth.logout` -* `auth.session_created` -* `auth.session_expired` -* `auth.password_reset` -* `auth.password_changed` -* `auth.email_verified` -* `auth.mfa_enabled` -* `auth.mfa_disabled` -* `auth.account_locked` -* `auth.account_unlocked` -* `authz.permission_granted` -* `authz.permission_revoked` -* `authz.role_assigned` -* `authz.role_removed` -* `authz.role_created` -* `authz.role_updated` -* `authz.role_deleted` -* `authz.policy_created` -* `authz.policy_updated` -* `authz.policy_deleted` -* `system.config_changed` -* `system.plugin_installed` -* `system.plugin_uninstalled` -* `system.backup_created` -* `system.backup_restored` -* `system.integration_added` -* `system.integration_removed` -* `security.access_denied` -* `security.suspicious_activity` -* `security.data_breach` -* `security.api_key_created` -* `security.api_key_revoked` - -## TypeScript Usage - -```typescript -import { AuditEventType } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: AuditEventType = 'data.create'; -``` - diff --git a/content/docs/references/system/audit/AuditRetentionPolicy.mdx b/content/docs/references/system/audit/AuditRetentionPolicy.mdx deleted file mode 100644 index a37de681d..000000000 --- a/content/docs/references/system/audit/AuditRetentionPolicy.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AuditRetentionPolicy -description: AuditRetentionPolicy Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **retentionDays** | `integer` | optional | Retention period in days | -| **archiveAfterRetention** | `boolean` | optional | Archive logs after retention period | -| **archiveStorage** | `object` | optional | Archive storage configuration | -| **customRetention** | `Record` | optional | Custom retention by event type | -| **minimumRetentionDays** | `integer` | optional | Minimum retention for compliance | - -## TypeScript Usage - -```typescript -import { AuditRetentionPolicySchema } from '@objectstack/spec/system'; -import type { AuditRetentionPolicy } from '@objectstack/spec/system'; - -// Validate data -const result = AuditRetentionPolicySchema.parse(data); - -// Type-safe usage -const myAuditRetentionPolicy: AuditRetentionPolicy = { -}; -``` - diff --git a/content/docs/references/system/audit/AuditStorageConfig.mdx b/content/docs/references/system/audit/AuditStorageConfig.mdx deleted file mode 100644 index 0f6379b4f..000000000 --- a/content/docs/references/system/audit/AuditStorageConfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AuditStorageConfig -description: AuditStorageConfig Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'database' \| 'elasticsearch' \| 'mongodb' \| 'clickhouse' \| 's3' \| 'gcs' \| 'azure_blob' \| 'custom'>` | ✅ | Storage backend type | -| **connectionString** | `string` | optional | Connection string | -| **config** | `Record` | optional | Storage-specific configuration | -| **bufferEnabled** | `boolean` | optional | Enable buffering | -| **bufferSize** | `integer` | optional | Buffer size | -| **flushIntervalSeconds** | `integer` | optional | Flush interval in seconds | -| **compression** | `boolean` | optional | Enable compression | - -## TypeScript Usage - -```typescript -import { AuditStorageConfigSchema } from '@objectstack/spec/system'; -import type { AuditStorageConfig } from '@objectstack/spec/system'; - -// Validate data -const result = AuditStorageConfigSchema.parse(data); - -// Type-safe usage -const myAuditStorageConfig: AuditStorageConfig = { - type: 'database' -}; -``` - diff --git a/content/docs/references/system/audit/SuspiciousActivityRule.mdx b/content/docs/references/system/audit/SuspiciousActivityRule.mdx deleted file mode 100644 index a6661d028..000000000 --- a/content/docs/references/system/audit/SuspiciousActivityRule.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SuspiciousActivityRule -description: SuspiciousActivityRule Schema Reference -category: system -zodFile: audit ---- - - - -**Source:** `packages/spec/src/system/audit.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Rule identifier | -| **name** | `string` | ✅ | Rule name | -| **description** | `string` | optional | Rule description | -| **enabled** | `boolean` | optional | Rule enabled status | -| **eventTypes** | `Enum<'data.create' \| 'data.read' \| 'data.update' \| 'data.delete' \| 'data.export' \| 'data.import' \| 'data.bulk_update' \| 'data.bulk_delete' \| 'auth.login' \| 'auth.login_failed' \| 'auth.logout' \| 'auth.session_created' \| 'auth.session_expired' \| 'auth.password_reset' \| 'auth.password_changed' \| 'auth.email_verified' \| 'auth.mfa_enabled' \| 'auth.mfa_disabled' \| 'auth.account_locked' \| 'auth.account_unlocked' \| 'authz.permission_granted' \| 'authz.permission_revoked' \| 'authz.role_assigned' \| 'authz.role_removed' \| 'authz.role_created' \| 'authz.role_updated' \| 'authz.role_deleted' \| 'authz.policy_created' \| 'authz.policy_updated' \| 'authz.policy_deleted' \| 'system.config_changed' \| 'system.plugin_installed' \| 'system.plugin_uninstalled' \| 'system.backup_created' \| 'system.backup_restored' \| 'system.integration_added' \| 'system.integration_removed' \| 'security.access_denied' \| 'security.suspicious_activity' \| 'security.data_breach' \| 'security.api_key_created' \| 'security.api_key_revoked'>[]` | ✅ | Event types to monitor | -| **condition** | `object` | ✅ | Detection condition | -| **actions** | `Enum<'alert' \| 'lock_account' \| 'block_ip' \| 'require_mfa' \| 'log_critical' \| 'webhook'>[]` | ✅ | Actions to take | -| **alertSeverity** | `Enum<'debug' \| 'info' \| 'notice' \| 'warning' \| 'error' \| 'critical' \| 'alert' \| 'emergency'>` | optional | Alert severity | -| **notifications** | `object` | optional | Notification configuration | - -## TypeScript Usage - -```typescript -import { SuspiciousActivityRuleSchema } from '@objectstack/spec/system'; -import type { SuspiciousActivityRule } from '@objectstack/spec/system'; - -// Validate data -const result = SuspiciousActivityRuleSchema.parse(data); - -// Type-safe usage -const mySuspiciousActivityRule: SuspiciousActivityRule = { - id: 'example', - name: 'name', - eventTypes: [], - // ... other required fields -}; -``` - diff --git a/content/docs/references/system/audit/meta.json b/content/docs/references/system/audit/meta.json deleted file mode 100644 index 22cff814c..000000000 --- a/content/docs/references/system/audit/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Audit" -} \ No newline at end of file diff --git a/content/docs/references/system/context/KernelContext.mdx b/content/docs/references/system/context.mdx similarity index 63% rename from content/docs/references/system/context/KernelContext.mdx rename to content/docs/references/system/context.mdx index fa868fe86..8349bb6c9 100644 --- a/content/docs/references/system/context/KernelContext.mdx +++ b/content/docs/references/system/context.mdx @@ -1,16 +1,32 @@ --- -title: KernelContext -description: KernelContext Schema Reference -category: system -zodFile: context +title: Context +description: Context protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Context **Source:** `packages/spec/src/system/context.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { KernelContextSchema, RuntimeModeSchema } from '@objectstack/spec/system'; +import type { KernelContext, RuntimeMode } from '@objectstack/spec/system'; + +// Validate data +const result = KernelContextSchema.parse(data); +``` + +--- + +## KernelContext + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -23,21 +39,16 @@ zodFile: context | **startTime** | `integer` | ✅ | Boot timestamp (ms) | | **features** | `Record` | optional | Global feature toggles | -## TypeScript Usage +--- -```typescript -import { KernelContextSchema } from '@objectstack/spec/system'; -import type { KernelContext } from '@objectstack/spec/system'; +## RuntimeMode -// Validate data -const result = KernelContextSchema.parse(data); +Kernel operating mode -// Type-safe usage -const myKernelContext: KernelContext = { - instanceId: 'example', - version: 'example', - cwd: 'example', - // ... other required fields -}; -``` +### Allowed Values + +* `development` +* `production` +* `test` +* `provisioning` diff --git a/content/docs/references/system/context/RuntimeMode.mdx b/content/docs/references/system/context/RuntimeMode.mdx deleted file mode 100644 index d35309640..000000000 --- a/content/docs/references/system/context/RuntimeMode.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: RuntimeMode -description: Kernel operating mode -category: system -zodFile: context ---- - - -Kernel operating mode - - -**Source:** `packages/spec/src/system/context.zod.ts` - - -## Allowed Values - -* `development` -* `production` -* `test` -* `provisioning` - -## TypeScript Usage - -```typescript -import { RuntimeMode } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: RuntimeMode = 'development'; -``` - diff --git a/content/docs/references/system/context/meta.json b/content/docs/references/system/context/meta.json deleted file mode 100644 index 807685cb1..000000000 --- a/content/docs/references/system/context/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Context" -} \ No newline at end of file diff --git a/content/docs/references/system/datasource.mdx b/content/docs/references/system/datasource.mdx new file mode 100644 index 000000000..f572bcfc5 --- /dev/null +++ b/content/docs/references/system/datasource.mdx @@ -0,0 +1,83 @@ +--- +title: Datasource +description: Datasource protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Datasource + + +**Source:** `packages/spec/src/system/datasource.zod.ts` + + +## TypeScript Usage + +```typescript +import { DatasourceSchema, DatasourceCapabilitiesSchema, DriverDefinitionSchema, DriverTypeSchema } from '@objectstack/spec/system'; +import type { Datasource, DatasourceCapabilities, DriverDefinition, DriverType } from '@objectstack/spec/system'; + +// Validate data +const result = DatasourceSchema.parse(data); +``` + +--- + +## Datasource + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique datasource identifier | +| **label** | `string` | optional | Display label | +| **driver** | `string` | ✅ | Underlying driver type | +| **config** | `Record` | ✅ | Driver specific configuration | +| **pool** | `object` | optional | Connection pool settings | +| **readReplicas** | `Record[]` | optional | Read-only replica configurations | +| **capabilities** | `object` | optional | Capability overrides | +| **description** | `string` | optional | Internal description | +| **active** | `boolean` | optional | Is datasource enabled | + +--- + +## DatasourceCapabilities + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **transactions** | `boolean` | optional | | +| **queryFilters** | `boolean` | optional | | +| **queryAggregations** | `boolean` | optional | | +| **querySorting** | `boolean` | optional | | +| **queryPagination** | `boolean` | optional | | +| **queryWindowFunctions** | `boolean` | optional | | +| **querySubqueries** | `boolean` | optional | | +| **joins** | `boolean` | optional | | +| **fullTextSearch** | `boolean` | optional | | +| **readOnly** | `boolean` | optional | | +| **dynamicSchema** | `boolean` | optional | | + +--- + +## DriverDefinition + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique driver identifier (e.g. "postgres") | +| **label** | `string` | ✅ | Display label (e.g. "PostgreSQL") | +| **description** | `string` | optional | | +| **icon** | `string` | optional | | +| **configSchema** | `Record` | ✅ | JSON Schema for connection configuration | +| **capabilities** | `object` | optional | | + +--- + +## DriverType + +Underlying driver identifier + diff --git a/content/docs/references/system/datasource/Datasource.mdx b/content/docs/references/system/datasource/Datasource.mdx deleted file mode 100644 index e0633ff62..000000000 --- a/content/docs/references/system/datasource/Datasource.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Datasource -description: Datasource Schema Reference -category: system -zodFile: datasource ---- - - - -**Source:** `packages/spec/src/system/datasource.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique datasource identifier | -| **label** | `string` | optional | Display label | -| **driver** | `string` | ✅ | Underlying driver type | -| **config** | `Record` | ✅ | Driver specific configuration | -| **pool** | `object` | optional | Connection pool settings | -| **readReplicas** | `Record[]` | optional | Read-only replica configurations | -| **capabilities** | `object` | optional | Capability overrides | -| **description** | `string` | optional | Internal description | -| **active** | `boolean` | optional | Is datasource enabled | - -## TypeScript Usage - -```typescript -import { DatasourceSchema } from '@objectstack/spec/system'; -import type { Datasource } from '@objectstack/spec/system'; - -// Validate data -const result = DatasourceSchema.parse(data); - -// Type-safe usage -const myDatasource: Datasource = { - name: 'name', - driver: 'example', - config: {} -}; -``` - diff --git a/content/docs/references/system/datasource/DatasourceCapabilities.mdx b/content/docs/references/system/datasource/DatasourceCapabilities.mdx deleted file mode 100644 index 4a5d229df..000000000 --- a/content/docs/references/system/datasource/DatasourceCapabilities.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: DatasourceCapabilities -description: DatasourceCapabilities Schema Reference -category: system -zodFile: datasource ---- - - - -**Source:** `packages/spec/src/system/datasource.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **transactions** | `boolean` | optional | | -| **queryFilters** | `boolean` | optional | | -| **queryAggregations** | `boolean` | optional | | -| **querySorting** | `boolean` | optional | | -| **queryPagination** | `boolean` | optional | | -| **queryWindowFunctions** | `boolean` | optional | | -| **querySubqueries** | `boolean` | optional | | -| **joins** | `boolean` | optional | | -| **fullTextSearch** | `boolean` | optional | | -| **readOnly** | `boolean` | optional | | -| **dynamicSchema** | `boolean` | optional | | - -## TypeScript Usage - -```typescript -import { DatasourceCapabilitiesSchema } from '@objectstack/spec/system'; -import type { DatasourceCapabilities } from '@objectstack/spec/system'; - -// Validate data -const result = DatasourceCapabilitiesSchema.parse(data); - -// Type-safe usage -const myDatasourceCapabilities: DatasourceCapabilities = { -}; -``` - diff --git a/content/docs/references/system/datasource/DriverDefinition.mdx b/content/docs/references/system/datasource/DriverDefinition.mdx deleted file mode 100644 index 568d70938..000000000 --- a/content/docs/references/system/datasource/DriverDefinition.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: DriverDefinition -description: DriverDefinition Schema Reference -category: system -zodFile: datasource ---- - - - -**Source:** `packages/spec/src/system/datasource.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique driver identifier (e.g. "postgres") | -| **label** | `string` | ✅ | Display label (e.g. "PostgreSQL") | -| **description** | `string` | optional | | -| **icon** | `string` | optional | | -| **configSchema** | `Record` | ✅ | JSON Schema for connection configuration | -| **capabilities** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { DriverDefinitionSchema } from '@objectstack/spec/system'; -import type { DriverDefinition } from '@objectstack/spec/system'; - -// Validate data -const result = DriverDefinitionSchema.parse(data); - -// Type-safe usage -const myDriverDefinition: DriverDefinition = { - id: 'example', - label: 'example', - configSchema: {} -}; -``` - diff --git a/content/docs/references/system/datasource/DriverType.mdx b/content/docs/references/system/datasource/DriverType.mdx deleted file mode 100644 index fc10154f4..000000000 --- a/content/docs/references/system/datasource/DriverType.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: DriverType -description: Underlying driver identifier -category: system -zodFile: datasource ---- - - -Underlying driver identifier - - -**Source:** `packages/spec/src/system/datasource.zod.ts` - - diff --git a/content/docs/references/system/datasource/meta.json b/content/docs/references/system/datasource/meta.json deleted file mode 100644 index 6dfcbf686..000000000 --- a/content/docs/references/system/datasource/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Datasource" -} \ No newline at end of file diff --git a/content/docs/references/system/driver/DriverCapabilities.mdx b/content/docs/references/system/driver.mdx similarity index 51% rename from content/docs/references/system/driver/DriverCapabilities.mdx rename to content/docs/references/system/driver.mdx index f619a2df0..770841d59 100644 --- a/content/docs/references/system/driver/DriverCapabilities.mdx +++ b/content/docs/references/system/driver.mdx @@ -1,16 +1,32 @@ --- -title: DriverCapabilities -description: DriverCapabilities Schema Reference -category: system -zodFile: driver +title: Driver +description: Driver protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Driver **Source:** `packages/spec/src/system/driver.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { DriverCapabilitiesSchema, DriverInterfaceSchema, DriverOptionsSchema } from '@objectstack/spec/system'; +import type { DriverCapabilities, DriverInterface, DriverOptions } from '@objectstack/spec/system'; + +// Validate data +const result = DriverCapabilitiesSchema.parse(data); +``` + +--- + +## DriverCapabilities + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -28,21 +44,29 @@ zodFile: driver | **vectorSearch** | `boolean` | optional | Supports vector embeddings and similarity search | | **geoSpatial** | `boolean` | optional | Supports geospatial queries | -## TypeScript Usage +--- -```typescript -import { DriverCapabilitiesSchema } from '@objectstack/spec/system'; -import type { DriverCapabilities } from '@objectstack/spec/system'; +## DriverInterface -// Validate data -const result = DriverCapabilitiesSchema.parse(data); +### Properties -// Type-safe usage -const myDriverCapabilities: DriverCapabilities = { - transactions: false, - queryFilters: false, - queryAggregations: false, - // ... other required fields -}; -``` +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Driver unique name | +| **version** | `string` | ✅ | Driver version | +| **supports** | `object` | ✅ | | + +--- + +## DriverOptions + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **transaction** | `any` | optional | Transaction handle | +| **timeout** | `number` | optional | Timeout in ms | +| **skipCache** | `boolean` | optional | Bypass cache | +| **traceContext** | `Record` | optional | OpenTelemetry context or request ID | +| **tenantId** | `string` | optional | Tenant Isolation identifier | diff --git a/content/docs/references/system/driver/DriverInterface.mdx b/content/docs/references/system/driver/DriverInterface.mdx deleted file mode 100644 index 98861c870..000000000 --- a/content/docs/references/system/driver/DriverInterface.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DriverInterface -description: DriverInterface Schema Reference -category: system -zodFile: driver ---- - - - -**Source:** `packages/spec/src/system/driver.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Driver unique name | -| **version** | `string` | ✅ | Driver version | -| **supports** | `object` | ✅ | | - -## TypeScript Usage - -```typescript -import { DriverInterfaceSchema } from '@objectstack/spec/system'; -import type { DriverInterface } from '@objectstack/spec/system'; - -// Validate data -const result = DriverInterfaceSchema.parse(data); - -// Type-safe usage -const myDriverInterface: DriverInterface = { - name: 'name', - version: 'example', - supports: {} -}; -``` - diff --git a/content/docs/references/system/driver/DriverOptions.mdx b/content/docs/references/system/driver/DriverOptions.mdx deleted file mode 100644 index 5f73036d6..000000000 --- a/content/docs/references/system/driver/DriverOptions.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DriverOptions -description: DriverOptions Schema Reference -category: system -zodFile: driver ---- - - - -**Source:** `packages/spec/src/system/driver.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **transaction** | `any` | optional | Transaction handle | -| **timeout** | `number` | optional | Timeout in ms | -| **skipCache** | `boolean` | optional | Bypass cache | -| **traceContext** | `Record` | optional | OpenTelemetry context or request ID | -| **tenantId** | `string` | optional | Tenant Isolation identifier | - -## TypeScript Usage - -```typescript -import { DriverOptionsSchema } from '@objectstack/spec/system'; -import type { DriverOptions } from '@objectstack/spec/system'; - -// Validate data -const result = DriverOptionsSchema.parse(data); - -// Type-safe usage -const myDriverOptions: DriverOptions = { -}; -``` - diff --git a/content/docs/references/system/driver/meta.json b/content/docs/references/system/driver/meta.json deleted file mode 100644 index fa70124c5..000000000 --- a/content/docs/references/system/driver/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Driver" -} \ No newline at end of file diff --git a/content/docs/references/system/events.mdx b/content/docs/references/system/events.mdx new file mode 100644 index 000000000..4eb939738 --- /dev/null +++ b/content/docs/references/system/events.mdx @@ -0,0 +1,83 @@ +--- +title: Events +description: Events protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Events + + +**Source:** `packages/spec/src/system/events.zod.ts` + + +## TypeScript Usage + +```typescript +import { EventSchema, EventHandlerSchema, EventMetadataSchema, EventPersistenceSchema, EventRouteSchema } from '@objectstack/spec/system'; +import type { Event, EventHandler, EventMetadata, EventPersistence, EventRoute } from '@objectstack/spec/system'; + +// Validate data +const result = EventSchema.parse(data); +``` + +--- + +## Event + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Event name (lowercase with dots, e.g., user.created, order.paid) | +| **payload** | `any` | optional | Event payload schema | +| **metadata** | `object` | ✅ | Event metadata | + +--- + +## EventHandler + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **eventName** | `string` | ✅ | Name of event to handle (supports wildcards like user.*) | +| **priority** | `integer` | optional | Execution priority (lower numbers execute first) | +| **async** | `boolean` | optional | Execute in background (true) or block (false) | + +--- + +## EventMetadata + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **source** | `string` | ✅ | Event source (e.g., plugin name, system component) | +| **timestamp** | `string` | ✅ | ISO 8601 datetime when event was created | +| **userId** | `string` | optional | User who triggered the event | +| **tenantId** | `string` | optional | Tenant identifier for multi-tenant systems | + +--- + +## EventPersistence + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **enabled** | `boolean` | optional | Enable event persistence | +| **retention** | `integer` | ✅ | Days to retain persisted events | + +--- + +## EventRoute + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **from** | `string` | ✅ | Source event pattern (supports wildcards, e.g., user.* or *.created) | +| **to** | `string[]` | ✅ | Target event names to route to | + diff --git a/content/docs/references/system/events/Event.mdx b/content/docs/references/system/events/Event.mdx deleted file mode 100644 index fe01cb2b5..000000000 --- a/content/docs/references/system/events/Event.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Event -description: Event Schema Reference -category: system -zodFile: events ---- - - - -**Source:** `packages/spec/src/system/events.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Event name (lowercase with dots, e.g., user.created, order.paid) | -| **payload** | `any` | optional | Event payload schema | -| **metadata** | `object` | ✅ | Event metadata | - -## TypeScript Usage - -```typescript -import { EventSchema } from '@objectstack/spec/system'; -import type { Event } from '@objectstack/spec/system'; - -// Validate data -const result = EventSchema.parse(data); - -// Type-safe usage -const myEvent: Event = { - name: 'name', - metadata: {} -}; -``` - diff --git a/content/docs/references/system/events/EventHandler.mdx b/content/docs/references/system/events/EventHandler.mdx deleted file mode 100644 index c0a04ba91..000000000 --- a/content/docs/references/system/events/EventHandler.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EventHandler -description: EventHandler Schema Reference -category: system -zodFile: events ---- - - - -**Source:** `packages/spec/src/system/events.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **eventName** | `string` | ✅ | Name of event to handle (supports wildcards like user.*) | -| **priority** | `integer` | optional | Execution priority (lower numbers execute first) | -| **async** | `boolean` | optional | Execute in background (true) or block (false) | - -## TypeScript Usage - -```typescript -import { EventHandlerSchema } from '@objectstack/spec/system'; -import type { EventHandler } from '@objectstack/spec/system'; - -// Validate data -const result = EventHandlerSchema.parse(data); - -// Type-safe usage -const myEventHandler: EventHandler = { - eventName: 'example' -}; -``` - diff --git a/content/docs/references/system/events/EventMetadata.mdx b/content/docs/references/system/events/EventMetadata.mdx deleted file mode 100644 index f8b5af6ae..000000000 --- a/content/docs/references/system/events/EventMetadata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EventMetadata -description: EventMetadata Schema Reference -category: system -zodFile: events ---- - - - -**Source:** `packages/spec/src/system/events.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **source** | `string` | ✅ | Event source (e.g., plugin name, system component) | -| **timestamp** | `string` | ✅ | ISO 8601 datetime when event was created | -| **userId** | `string` | optional | User who triggered the event | -| **tenantId** | `string` | optional | Tenant identifier for multi-tenant systems | - -## TypeScript Usage - -```typescript -import { EventMetadataSchema } from '@objectstack/spec/system'; -import type { EventMetadata } from '@objectstack/spec/system'; - -// Validate data -const result = EventMetadataSchema.parse(data); - -// Type-safe usage -const myEventMetadata: EventMetadata = { - source: 'example', - timestamp: 'example' -}; -``` - diff --git a/content/docs/references/system/events/EventPersistence.mdx b/content/docs/references/system/events/EventPersistence.mdx deleted file mode 100644 index ee037ef8f..000000000 --- a/content/docs/references/system/events/EventPersistence.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EventPersistence -description: EventPersistence Schema Reference -category: system -zodFile: events ---- - - - -**Source:** `packages/spec/src/system/events.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **enabled** | `boolean` | optional | Enable event persistence | -| **retention** | `integer` | ✅ | Days to retain persisted events | - -## TypeScript Usage - -```typescript -import { EventPersistenceSchema } from '@objectstack/spec/system'; -import type { EventPersistence } from '@objectstack/spec/system'; - -// Validate data -const result = EventPersistenceSchema.parse(data); - -// Type-safe usage -const myEventPersistence: EventPersistence = { - retention: null -}; -``` - diff --git a/content/docs/references/system/events/EventRoute.mdx b/content/docs/references/system/events/EventRoute.mdx deleted file mode 100644 index 8301914d9..000000000 --- a/content/docs/references/system/events/EventRoute.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EventRoute -description: EventRoute Schema Reference -category: system -zodFile: events ---- - - - -**Source:** `packages/spec/src/system/events.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **from** | `string` | ✅ | Source event pattern (supports wildcards, e.g., user.* or *.created) | -| **to** | `string[]` | ✅ | Target event names to route to | - -## TypeScript Usage - -```typescript -import { EventRouteSchema } from '@objectstack/spec/system'; -import type { EventRoute } from '@objectstack/spec/system'; - -// Validate data -const result = EventRouteSchema.parse(data); - -// Type-safe usage -const myEventRoute: EventRoute = { - from: 'example', - to: [] -}; -``` - diff --git a/content/docs/references/system/events/meta.json b/content/docs/references/system/events/meta.json deleted file mode 100644 index b14d07304..000000000 --- a/content/docs/references/system/events/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Events" -} \ No newline at end of file diff --git a/content/docs/references/system/feature/FeatureFlag.mdx b/content/docs/references/system/feature.mdx similarity index 62% rename from content/docs/references/system/feature/FeatureFlag.mdx rename to content/docs/references/system/feature.mdx index 0ee334a03..731a9a638 100644 --- a/content/docs/references/system/feature/FeatureFlag.mdx +++ b/content/docs/references/system/feature.mdx @@ -1,16 +1,32 @@ --- -title: FeatureFlag -description: FeatureFlag Schema Reference -category: system -zodFile: feature +title: Feature +description: Feature protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Feature **Source:** `packages/spec/src/system/feature.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { FeatureFlagSchema, FeatureStrategySchema } from '@objectstack/spec/system'; +import type { FeatureFlag, FeatureStrategy } from '@objectstack/spec/system'; + +// Validate data +const result = FeatureFlagSchema.parse(data); +``` + +--- + +## FeatureFlag + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -23,18 +39,15 @@ zodFile: feature | **environment** | `Enum<'dev' \| 'staging' \| 'prod' \| 'all'>` | optional | Environment validity | | **expiresAt** | `string` | optional | Feature flag expiration date | -## TypeScript Usage +--- -```typescript -import { FeatureFlagSchema } from '@objectstack/spec/system'; -import type { FeatureFlag } from '@objectstack/spec/system'; +## FeatureStrategy -// Validate data -const result = FeatureFlagSchema.parse(data); +### Allowed Values -// Type-safe usage -const myFeatureFlag: FeatureFlag = { - name: 'name' -}; -``` +* `boolean` +* `percentage` +* `user_list` +* `group` +* `custom` diff --git a/content/docs/references/system/feature/FeatureStrategy.mdx b/content/docs/references/system/feature/FeatureStrategy.mdx deleted file mode 100644 index 5c2af0c75..000000000 --- a/content/docs/references/system/feature/FeatureStrategy.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: FeatureStrategy -description: FeatureStrategy Schema Reference -category: system -zodFile: feature ---- - - - -**Source:** `packages/spec/src/system/feature.zod.ts` - - -## Allowed Values - -* `boolean` -* `percentage` -* `user_list` -* `group` -* `custom` - -## TypeScript Usage - -```typescript -import { FeatureStrategy } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: FeatureStrategy = 'boolean'; -``` - diff --git a/content/docs/references/system/feature/meta.json b/content/docs/references/system/feature/meta.json deleted file mode 100644 index 8a1211fca..000000000 --- a/content/docs/references/system/feature/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Feature" -} \ No newline at end of file diff --git a/content/docs/references/system/index.mdx b/content/docs/references/system/index.mdx index 233f43d70..a2fab13dc 100644 --- a/content/docs/references/system/index.mdx +++ b/content/docs/references/system/index.mdx @@ -3,149 +3,24 @@ title: System Protocol Overview description: Complete reference for all system protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # System Protocol This section contains all protocol schemas for the system layer of ObjectStack. -## Audit - -Source: `packages/spec/src/system/audit.zod.ts` - - - - - - - - - - - - - - - -## Context - -Source: `packages/spec/src/system/context.zod.ts` - - - - - - -## Datasource - -Source: `packages/spec/src/system/datasource.zod.ts` - - - - - - - - -## Driver - -Source: `packages/spec/src/system/driver.zod.ts` - - - - - - - -## Events - -Source: `packages/spec/src/system/events.zod.ts` - - - - - - - - - -## Feature - -Source: `packages/spec/src/system/feature.zod.ts` - - - - - - -## Job - -Source: `packages/spec/src/system/job.zod.ts` - - - - - - - - - - - - -## Logger - -Source: `packages/spec/src/system/logger.zod.ts` - - - - - - - - -## Manifest - -Source: `packages/spec/src/system/manifest.zod.ts` - - - - - -## Plugin - -Source: `packages/spec/src/system/plugin.zod.ts` - - - - - - - - - - - - - - -## Scoped Storage - -Source: `packages/spec/src/system/scoped-storage.zod.ts` - - - - - - - - -## Translation - -Source: `packages/spec/src/system/translation.zod.ts` - - - - + + + + + + + + + + + + diff --git a/content/docs/references/system/job.mdx b/content/docs/references/system/job.mdx new file mode 100644 index 000000000..8625ccb55 --- /dev/null +++ b/content/docs/references/system/job.mdx @@ -0,0 +1,115 @@ +--- +title: Job +description: Job protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Job + + +**Source:** `packages/spec/src/system/job.zod.ts` + + +## TypeScript Usage + +```typescript +import { CronScheduleSchema, IntervalScheduleSchema, JobSchema, JobExecutionSchema, JobExecutionStatusSchema, OnceScheduleSchema, RetryPolicySchema, ScheduleSchema } from '@objectstack/spec/system'; +import type { CronSchedule, IntervalSchedule, Job, JobExecution, JobExecutionStatus, OnceSchedule, RetryPolicy, Schedule } from '@objectstack/spec/system'; + +// Validate data +const result = CronScheduleSchema.parse(data); +``` + +--- + +## CronSchedule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `string` | ✅ | | +| **expression** | `string` | ✅ | Cron expression (e.g., "0 0 * * *" for daily at midnight) | +| **timezone** | `string` | optional | Timezone for cron execution (e.g., "America/New_York") | + +--- + +## IntervalSchedule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `string` | ✅ | | +| **intervalMs** | `integer` | ✅ | Interval in milliseconds | + +--- + +## Job + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique job identifier | +| **name** | `string` | ✅ | Job name (snake_case) | +| **schedule** | `object \| object \| object` | ✅ | Job schedule configuration | +| **retryPolicy** | `object` | optional | Retry policy configuration | +| **timeout** | `integer` | optional | Timeout in milliseconds | +| **enabled** | `boolean` | optional | Whether the job is enabled | + +--- + +## JobExecution + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **jobId** | `string` | ✅ | Job identifier | +| **startedAt** | `string` | ✅ | ISO 8601 datetime when execution started | +| **completedAt** | `string` | optional | ISO 8601 datetime when execution completed | +| **status** | `Enum<'running' \| 'success' \| 'failed' \| 'timeout'>` | ✅ | Execution status | +| **error** | `string` | optional | Error message if failed | +| **duration** | `integer` | optional | Execution duration in milliseconds | + +--- + +## JobExecutionStatus + +### Allowed Values + +* `running` +* `success` +* `failed` +* `timeout` + +--- + +## OnceSchedule + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `string` | ✅ | | +| **at** | `string` | ✅ | ISO 8601 datetime when to execute | + +--- + +## RetryPolicy + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **maxRetries** | `integer` | optional | Maximum number of retry attempts | +| **backoffMs** | `integer` | optional | Initial backoff delay in milliseconds | +| **backoffMultiplier** | `number` | optional | Multiplier for exponential backoff | + +--- + +## Schedule + diff --git a/content/docs/references/system/job/CronSchedule.mdx b/content/docs/references/system/job/CronSchedule.mdx deleted file mode 100644 index d5ca20a9c..000000000 --- a/content/docs/references/system/job/CronSchedule.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CronSchedule -description: CronSchedule Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `string` | ✅ | | -| **expression** | `string` | ✅ | Cron expression (e.g., "0 0 * * *" for daily at midnight) | -| **timezone** | `string` | optional | Timezone for cron execution (e.g., "America/New_York") | - -## TypeScript Usage - -```typescript -import { CronScheduleSchema } from '@objectstack/spec/system'; -import type { CronSchedule } from '@objectstack/spec/system'; - -// Validate data -const result = CronScheduleSchema.parse(data); - -// Type-safe usage -const myCronSchedule: CronSchedule = { - type: 'example', - expression: 'example' -}; -``` - diff --git a/content/docs/references/system/job/IntervalSchedule.mdx b/content/docs/references/system/job/IntervalSchedule.mdx deleted file mode 100644 index bd0bc5673..000000000 --- a/content/docs/references/system/job/IntervalSchedule.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: IntervalSchedule -description: IntervalSchedule Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `string` | ✅ | | -| **intervalMs** | `integer` | ✅ | Interval in milliseconds | - -## TypeScript Usage - -```typescript -import { IntervalScheduleSchema } from '@objectstack/spec/system'; -import type { IntervalSchedule } from '@objectstack/spec/system'; - -// Validate data -const result = IntervalScheduleSchema.parse(data); - -// Type-safe usage -const myIntervalSchedule: IntervalSchedule = { - type: 'example', - intervalMs: null -}; -``` - diff --git a/content/docs/references/system/job/Job.mdx b/content/docs/references/system/job/Job.mdx deleted file mode 100644 index 524215ce8..000000000 --- a/content/docs/references/system/job/Job.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Job -description: Job Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique job identifier | -| **name** | `string` | ✅ | Job name (snake_case) | -| **schedule** | `object \| object \| object` | ✅ | Job schedule configuration | -| **retryPolicy** | `object` | optional | Retry policy configuration | -| **timeout** | `integer` | optional | Timeout in milliseconds | -| **enabled** | `boolean` | optional | Whether the job is enabled | - -## TypeScript Usage - -```typescript -import { JobSchema } from '@objectstack/spec/system'; -import type { Job } from '@objectstack/spec/system'; - -// Validate data -const result = JobSchema.parse(data); - -// Type-safe usage -const myJob: Job = { - id: 'example', - name: 'name', - schedule: null -}; -``` - diff --git a/content/docs/references/system/job/JobExecution.mdx b/content/docs/references/system/job/JobExecution.mdx deleted file mode 100644 index 8b40ceddb..000000000 --- a/content/docs/references/system/job/JobExecution.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: JobExecution -description: JobExecution Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **jobId** | `string` | ✅ | Job identifier | -| **startedAt** | `string` | ✅ | ISO 8601 datetime when execution started | -| **completedAt** | `string` | optional | ISO 8601 datetime when execution completed | -| **status** | `Enum<'running' \| 'success' \| 'failed' \| 'timeout'>` | ✅ | Execution status | -| **error** | `string` | optional | Error message if failed | -| **duration** | `integer` | optional | Execution duration in milliseconds | - -## TypeScript Usage - -```typescript -import { JobExecutionSchema } from '@objectstack/spec/system'; -import type { JobExecution } from '@objectstack/spec/system'; - -// Validate data -const result = JobExecutionSchema.parse(data); - -// Type-safe usage -const myJobExecution: JobExecution = { - jobId: 'example', - startedAt: 'example', - status: 'running' -}; -``` - diff --git a/content/docs/references/system/job/JobExecutionStatus.mdx b/content/docs/references/system/job/JobExecutionStatus.mdx deleted file mode 100644 index 7d3cde079..000000000 --- a/content/docs/references/system/job/JobExecutionStatus.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: JobExecutionStatus -description: JobExecutionStatus Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Allowed Values - -* `running` -* `success` -* `failed` -* `timeout` - -## TypeScript Usage - -```typescript -import { JobExecutionStatus } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: JobExecutionStatus = 'running'; -``` - diff --git a/content/docs/references/system/job/OnceSchedule.mdx b/content/docs/references/system/job/OnceSchedule.mdx deleted file mode 100644 index 221e967fb..000000000 --- a/content/docs/references/system/job/OnceSchedule.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OnceSchedule -description: OnceSchedule Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `string` | ✅ | | -| **at** | `string` | ✅ | ISO 8601 datetime when to execute | - -## TypeScript Usage - -```typescript -import { OnceScheduleSchema } from '@objectstack/spec/system'; -import type { OnceSchedule } from '@objectstack/spec/system'; - -// Validate data -const result = OnceScheduleSchema.parse(data); - -// Type-safe usage -const myOnceSchedule: OnceSchedule = { - type: 'example', - at: 'example' -}; -``` - diff --git a/content/docs/references/system/job/RetryPolicy.mdx b/content/docs/references/system/job/RetryPolicy.mdx deleted file mode 100644 index c114bd300..000000000 --- a/content/docs/references/system/job/RetryPolicy.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RetryPolicy -description: RetryPolicy Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **maxRetries** | `integer` | optional | Maximum number of retry attempts | -| **backoffMs** | `integer` | optional | Initial backoff delay in milliseconds | -| **backoffMultiplier** | `number` | optional | Multiplier for exponential backoff | - -## TypeScript Usage - -```typescript -import { RetryPolicySchema } from '@objectstack/spec/system'; -import type { RetryPolicy } from '@objectstack/spec/system'; - -// Validate data -const result = RetryPolicySchema.parse(data); - -// Type-safe usage -const myRetryPolicy: RetryPolicy = { -}; -``` - diff --git a/content/docs/references/system/job/Schedule.mdx b/content/docs/references/system/job/Schedule.mdx deleted file mode 100644 index 5c7f3b549..000000000 --- a/content/docs/references/system/job/Schedule.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Schedule -description: Schedule Schema Reference -category: system -zodFile: job ---- - - - -**Source:** `packages/spec/src/system/job.zod.ts` - - diff --git a/content/docs/references/system/job/meta.json b/content/docs/references/system/job/meta.json deleted file mode 100644 index b99cc8c03..000000000 --- a/content/docs/references/system/job/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Job" -} \ No newline at end of file diff --git a/content/docs/references/system/logger.mdx b/content/docs/references/system/logger.mdx new file mode 100644 index 000000000..b058456f5 --- /dev/null +++ b/content/docs/references/system/logger.mdx @@ -0,0 +1,83 @@ +--- +title: Logger +description: Logger protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Logger + + +**Source:** `packages/spec/src/system/logger.zod.ts` + + +## TypeScript Usage + +```typescript +import { LogEntrySchema, LogFormatSchema, LogLevelSchema, LoggerConfigSchema } from '@objectstack/spec/system'; +import type { LogEntry, LogFormat, LogLevel, LoggerConfig } from '@objectstack/spec/system'; + +// Validate data +const result = LogEntrySchema.parse(data); +``` + +--- + +## LogEntry + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **timestamp** | `string` | ✅ | ISO 8601 timestamp | +| **level** | `Enum<'debug' \| 'info' \| 'warn' \| 'error' \| 'fatal'>` | ✅ | Log severity level | +| **message** | `string` | ✅ | Log message | +| **context** | `Record` | optional | Structured context data | +| **error** | `Record` | optional | Error object if present | +| **traceId** | `string` | optional | Distributed trace ID | +| **spanId** | `string` | optional | Span ID | +| **service** | `string` | optional | Service name | +| **component** | `string` | optional | Component name (e.g. plugin id) | + +--- + +## LogFormat + +Log output format + +### Allowed Values + +* `json` +* `text` +* `pretty` + +--- + +## LogLevel + +Log severity level + +### Allowed Values + +* `debug` +* `info` +* `warn` +* `error` +* `fatal` + +--- + +## LoggerConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **level** | `Enum<'debug' \| 'info' \| 'warn' \| 'error' \| 'fatal'>` | optional | Log severity level | +| **format** | `Enum<'json' \| 'text' \| 'pretty'>` | optional | Log output format | +| **redact** | `string[]` | optional | Keys to redact from log context | +| **sourceLocation** | `boolean` | optional | Include file and line number | +| **file** | `string` | optional | Path to log file | +| **rotation** | `object` | optional | | + diff --git a/content/docs/references/system/logger/LogEntry.mdx b/content/docs/references/system/logger/LogEntry.mdx deleted file mode 100644 index 9c1d4a56c..000000000 --- a/content/docs/references/system/logger/LogEntry.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: LogEntry -description: LogEntry Schema Reference -category: system -zodFile: logger ---- - - - -**Source:** `packages/spec/src/system/logger.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **timestamp** | `string` | ✅ | ISO 8601 timestamp | -| **level** | `Enum<'debug' \| 'info' \| 'warn' \| 'error' \| 'fatal'>` | ✅ | Log severity level | -| **message** | `string` | ✅ | Log message | -| **context** | `Record` | optional | Structured context data | -| **error** | `Record` | optional | Error object if present | -| **traceId** | `string` | optional | Distributed trace ID | -| **spanId** | `string` | optional | Span ID | -| **service** | `string` | optional | Service name | -| **component** | `string` | optional | Component name (e.g. plugin id) | - -## TypeScript Usage - -```typescript -import { LogEntrySchema } from '@objectstack/spec/system'; -import type { LogEntry } from '@objectstack/spec/system'; - -// Validate data -const result = LogEntrySchema.parse(data); - -// Type-safe usage -const myLogEntry: LogEntry = { - timestamp: 'example', - level: 'debug', - message: 'example' -}; -``` - diff --git a/content/docs/references/system/logger/LogFormat.mdx b/content/docs/references/system/logger/LogFormat.mdx deleted file mode 100644 index a588bcd43..000000000 --- a/content/docs/references/system/logger/LogFormat.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: LogFormat -description: Log output format -category: system -zodFile: logger ---- - - -Log output format - - -**Source:** `packages/spec/src/system/logger.zod.ts` - - -## Allowed Values - -* `json` -* `text` -* `pretty` - -## TypeScript Usage - -```typescript -import { LogFormat } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: LogFormat = 'json'; -``` - diff --git a/content/docs/references/system/logger/LogLevel.mdx b/content/docs/references/system/logger/LogLevel.mdx deleted file mode 100644 index d6a5eeb45..000000000 --- a/content/docs/references/system/logger/LogLevel.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: LogLevel -description: Log severity level -category: system -zodFile: logger ---- - - -Log severity level - - -**Source:** `packages/spec/src/system/logger.zod.ts` - - -## Allowed Values - -* `debug` -* `info` -* `warn` -* `error` -* `fatal` - -## TypeScript Usage - -```typescript -import { LogLevel } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: LogLevel = 'debug'; -``` - diff --git a/content/docs/references/system/logger/LoggerConfig.mdx b/content/docs/references/system/logger/LoggerConfig.mdx deleted file mode 100644 index 6084f4cc4..000000000 --- a/content/docs/references/system/logger/LoggerConfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: LoggerConfig -description: LoggerConfig Schema Reference -category: system -zodFile: logger ---- - - - -**Source:** `packages/spec/src/system/logger.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **level** | `Enum<'debug' \| 'info' \| 'warn' \| 'error' \| 'fatal'>` | optional | Log severity level | -| **format** | `Enum<'json' \| 'text' \| 'pretty'>` | optional | Log output format | -| **redact** | `string[]` | optional | Keys to redact from log context | -| **sourceLocation** | `boolean` | optional | Include file and line number | -| **file** | `string` | optional | Path to log file | -| **rotation** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { LoggerConfigSchema } from '@objectstack/spec/system'; -import type { LoggerConfig } from '@objectstack/spec/system'; - -// Validate data -const result = LoggerConfigSchema.parse(data); - -// Type-safe usage -const myLoggerConfig: LoggerConfig = { -}; -``` - diff --git a/content/docs/references/system/logger/meta.json b/content/docs/references/system/logger/meta.json deleted file mode 100644 index 55e960b67..000000000 --- a/content/docs/references/system/logger/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Logger" -} \ No newline at end of file diff --git a/content/docs/references/system/manifest/Manifest.mdx b/content/docs/references/system/manifest.mdx similarity index 86% rename from content/docs/references/system/manifest/Manifest.mdx rename to content/docs/references/system/manifest.mdx index 7a0112592..69791a918 100644 --- a/content/docs/references/system/manifest/Manifest.mdx +++ b/content/docs/references/system/manifest.mdx @@ -1,16 +1,32 @@ --- title: Manifest -description: Manifest Schema Reference -category: system -zodFile: manifest +description: Manifest protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Manifest **Source:** `packages/spec/src/system/manifest.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { ManifestSchema } from '@objectstack/spec/system'; +import type { Manifest } from '@objectstack/spec/system'; + +// Validate data +const result = ManifestSchema.parse(data); +``` + +--- + +## Manifest + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -28,21 +44,3 @@ zodFile: manifest | **data** | `object[]` | optional | Initial seed data | | **extensions** | `Record` | optional | Extension points and contributions | -## TypeScript Usage - -```typescript -import { ManifestSchema } from '@objectstack/spec/system'; -import type { Manifest } from '@objectstack/spec/system'; - -// Validate data -const result = ManifestSchema.parse(data); - -// Type-safe usage -const myManifest: Manifest = { - id: 'example', - version: 'example', - type: 'app', - // ... other required fields -}; -``` - diff --git a/content/docs/references/system/manifest/meta.json b/content/docs/references/system/manifest/meta.json deleted file mode 100644 index 698ba3541..000000000 --- a/content/docs/references/system/manifest/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Manifest" -} \ No newline at end of file diff --git a/content/docs/references/system/misc.mdx b/content/docs/references/system/misc.mdx new file mode 100644 index 000000000..844724f6d --- /dev/null +++ b/content/docs/references/system/misc.mdx @@ -0,0 +1,70 @@ +--- +title: Misc +description: Misc protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Misc + + +**Source:** `packages/spec/src/system/misc.zod.ts` + + +## TypeScript Usage + +```typescript +import { MongoConfigSchema, PostgresConfigSchema } from '@objectstack/spec/system'; +import type { MongoConfig, PostgresConfig } from '@objectstack/spec/system'; + +// Validate data +const result = MongoConfigSchema.parse(data); +``` + +--- + +## MongoConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **url** | `string` | optional | Connection URI | +| **database** | `string` | ✅ | Database Name | +| **host** | `string` | optional | Host address | +| **port** | `number` | optional | Port number | +| **username** | `string` | optional | Auth User | +| **password** | `string` | optional | Auth Password | +| **authSource** | `string` | optional | Authentication Database | +| **ssl** | `boolean` | optional | Enable SSL | +| **replicaSet** | `string` | optional | Replica Set Name | +| **readPreference** | `Enum<'primary' \| 'primaryPreferred' \| 'secondary' \| 'secondaryPreferred' \| 'nearest'>` | optional | Read Preference | +| **maxPoolSize** | `number` | optional | Max Connection Pool Size | +| **minPoolSize** | `number` | optional | Min Connection Pool Size | +| **connectTimeoutMS** | `number` | optional | Connection Timeout (ms) | +| **socketTimeoutMS** | `number` | optional | Socket Timeout (ms) | + +--- + +## PostgresConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **url** | `string` | optional | Connection URI | +| **database** | `string` | ✅ | Database Name | +| **host** | `string` | optional | Host address | +| **port** | `number` | optional | Port number | +| **username** | `string` | optional | Auth User | +| **password** | `string` | optional | Auth Password | +| **schema** | `string` | optional | Default Schema | +| **ssl** | `boolean \| object` | optional | Enable SSL | +| **applicationName** | `string` | optional | Application Name | +| **max** | `number` | optional | Max Pool Size | +| **min** | `number` | optional | Min Pool Size | +| **idleTimeoutMillis** | `number` | optional | Idle Timeout (ms) | +| **connectionTimeoutMillis** | `number` | optional | Connection Timeout (ms) | +| **statementTimeout** | `number` | optional | Statement Timeout (ms) | + diff --git a/content/docs/references/system/misc/MongoConfig.mdx b/content/docs/references/system/misc/MongoConfig.mdx deleted file mode 100644 index b0fd47143..000000000 --- a/content/docs/references/system/misc/MongoConfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: MongoConfig -description: MongoConfig Schema Reference -category: system -zodFile: misc ---- - - - -**Source:** `packages/spec/src/system/misc.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **url** | `string` | optional | Connection URI | -| **database** | `string` | ✅ | Database Name | -| **host** | `string` | optional | Host address | -| **port** | `number` | optional | Port number | -| **username** | `string` | optional | Auth User | -| **password** | `string` | optional | Auth Password | -| **authSource** | `string` | optional | Authentication Database | -| **ssl** | `boolean` | optional | Enable SSL | -| **replicaSet** | `string` | optional | Replica Set Name | -| **readPreference** | `Enum<'primary' \| 'primaryPreferred' \| 'secondary' \| 'secondaryPreferred' \| 'nearest'>` | optional | Read Preference | -| **maxPoolSize** | `number` | optional | Max Connection Pool Size | -| **minPoolSize** | `number` | optional | Min Connection Pool Size | -| **connectTimeoutMS** | `number` | optional | Connection Timeout (ms) | -| **socketTimeoutMS** | `number` | optional | Socket Timeout (ms) | - -## TypeScript Usage - -```typescript -import { MongoConfigSchema } from '@objectstack/spec/system'; -import type { MongoConfig } from '@objectstack/spec/system'; - -// Validate data -const result = MongoConfigSchema.parse(data); - -// Type-safe usage -const myMongoConfig: MongoConfig = { - database: 'example' -}; -``` - diff --git a/content/docs/references/system/misc/PostgresConfig.mdx b/content/docs/references/system/misc/PostgresConfig.mdx deleted file mode 100644 index c53740d27..000000000 --- a/content/docs/references/system/misc/PostgresConfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PostgresConfig -description: PostgresConfig Schema Reference -category: system -zodFile: misc ---- - - - -**Source:** `packages/spec/src/system/misc.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **url** | `string` | optional | Connection URI | -| **database** | `string` | ✅ | Database Name | -| **host** | `string` | optional | Host address | -| **port** | `number` | optional | Port number | -| **username** | `string` | optional | Auth User | -| **password** | `string` | optional | Auth Password | -| **schema** | `string` | optional | Default Schema | -| **ssl** | `boolean \| object` | optional | Enable SSL | -| **applicationName** | `string` | optional | Application Name | -| **max** | `number` | optional | Max Pool Size | -| **min** | `number` | optional | Min Pool Size | -| **idleTimeoutMillis** | `number` | optional | Idle Timeout (ms) | -| **connectionTimeoutMillis** | `number` | optional | Connection Timeout (ms) | -| **statementTimeout** | `number` | optional | Statement Timeout (ms) | - -## TypeScript Usage - -```typescript -import { PostgresConfigSchema } from '@objectstack/spec/system'; -import type { PostgresConfig } from '@objectstack/spec/system'; - -// Validate data -const result = PostgresConfigSchema.parse(data); - -// Type-safe usage -const myPostgresConfig: PostgresConfig = { - database: 'example' -}; -``` - diff --git a/content/docs/references/system/plugin.mdx b/content/docs/references/system/plugin.mdx new file mode 100644 index 000000000..1d3ac9dfd --- /dev/null +++ b/content/docs/references/system/plugin.mdx @@ -0,0 +1,143 @@ +--- +title: Plugin +description: Plugin protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Plugin + + +**Source:** `packages/spec/src/system/plugin.zod.ts` + + +## TypeScript Usage + +```typescript +import { I18nContextSchema, LoggerSchema, ObjectQLClientSchema, PluginSchema, PluginContextSchema, PluginLifecycleSchema, RouterSchema, SchedulerSchema, ScopedStorageSchema, SystemAPISchema } from '@objectstack/spec/system'; +import type { I18nContext, Logger, ObjectQLClient, Plugin, PluginContext, PluginLifecycle, Router, Scheduler, ScopedStorage, SystemAPI } from '@objectstack/spec/system'; + +// Validate data +const result = I18nContextSchema.parse(data); +``` + +--- + +## I18nContext + +Internationalization Helper + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + +--- + +## Logger + +Structured Logger + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **debug** | `any` | optional | (message: string, ...meta: any[]) => void | +| **info** | `any` | optional | (message: string, ...meta: any[]) => void | +| **warn** | `any` | optional | (message: string, ...meta: any[]) => void | +| **error** | `any` | optional | (message: string, ...meta: any[]) => void | + +--- + +## ObjectQLClient + +ObjectQL Data Access Client + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + +--- + +## Plugin + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | optional | Plugin identifier | +| **version** | `string` | optional | Plugin version | + +--- + +## PluginContext + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **ql** | `object` | ✅ | ObjectQL Data Access Client | +| **os** | `object` | ✅ | Access to System Core | +| **logger** | `object` | ✅ | Structured Logger | +| **storage** | `object` | ✅ | Plugin Scoped Data Storage (KV) | +| **i18n** | `object` | ✅ | Internationalization Helper | +| **metadata** | `any` | optional | Metadata registry | +| **events** | `any` | optional | Event bus | +| **app** | `object` | ✅ | App Runtime Capabilities | +| **drivers** | `object` | ✅ | Driver Management | + +--- + +## PluginLifecycle + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + +--- + +## Router + +HTTP Router Interface + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + +--- + +## Scheduler + +Job Scheduler Interface + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + +--- + +## ScopedStorage + +Plugin Scoped Data Storage (KV) + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + +--- + +## SystemAPI + +Access to System Core + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | + diff --git a/content/docs/references/system/plugin/I18nContext.mdx b/content/docs/references/system/plugin/I18nContext.mdx deleted file mode 100644 index 83334b304..000000000 --- a/content/docs/references/system/plugin/I18nContext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: I18nContext -description: Internationalization Helper -category: system -zodFile: plugin ---- - - -Internationalization Helper - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { I18nContextSchema } from '@objectstack/spec/system'; -import type { I18nContext } from '@objectstack/spec/system'; - -// Validate data -const result = I18nContextSchema.parse(data); - -// Type-safe usage -const myI18nContext: I18nContext = { -}; -``` - diff --git a/content/docs/references/system/plugin/Logger.mdx b/content/docs/references/system/plugin/Logger.mdx deleted file mode 100644 index e5a08a780..000000000 --- a/content/docs/references/system/plugin/Logger.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Logger -description: Structured Logger -category: system -zodFile: plugin ---- - - -Structured Logger - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **debug** | `any` | optional | (message: string, ...meta: any[]) => void | -| **info** | `any` | optional | (message: string, ...meta: any[]) => void | -| **warn** | `any` | optional | (message: string, ...meta: any[]) => void | -| **error** | `any` | optional | (message: string, ...meta: any[]) => void | - -## TypeScript Usage - -```typescript -import { LoggerSchema } from '@objectstack/spec/system'; -import type { Logger } from '@objectstack/spec/system'; - -// Validate data -const result = LoggerSchema.parse(data); - -// Type-safe usage -const myLogger: Logger = { -}; -``` - diff --git a/content/docs/references/system/plugin/ObjectQLClient.mdx b/content/docs/references/system/plugin/ObjectQLClient.mdx deleted file mode 100644 index f403f56f1..000000000 --- a/content/docs/references/system/plugin/ObjectQLClient.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ObjectQLClient -description: ObjectQL Data Access Client -category: system -zodFile: plugin ---- - - -ObjectQL Data Access Client - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { ObjectQLClientSchema } from '@objectstack/spec/system'; -import type { ObjectQLClient } from '@objectstack/spec/system'; - -// Validate data -const result = ObjectQLClientSchema.parse(data); - -// Type-safe usage -const myObjectQLClient: ObjectQLClient = { -}; -``` - diff --git a/content/docs/references/system/plugin/Plugin.mdx b/content/docs/references/system/plugin/Plugin.mdx deleted file mode 100644 index c5aa3310a..000000000 --- a/content/docs/references/system/plugin/Plugin.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Plugin -description: Plugin Schema Reference -category: system -zodFile: plugin ---- - - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | optional | Plugin identifier | -| **version** | `string` | optional | Plugin version | - -## TypeScript Usage - -```typescript -import { PluginSchema } from '@objectstack/spec/system'; -import type { Plugin } from '@objectstack/spec/system'; - -// Validate data -const result = PluginSchema.parse(data); - -// Type-safe usage -const myPlugin: Plugin = { -}; -``` - diff --git a/content/docs/references/system/plugin/PluginContext.mdx b/content/docs/references/system/plugin/PluginContext.mdx deleted file mode 100644 index d9fec97ee..000000000 --- a/content/docs/references/system/plugin/PluginContext.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PluginContext -description: PluginContext Schema Reference -category: system -zodFile: plugin ---- - - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **ql** | `object` | ✅ | ObjectQL Data Access Client | -| **os** | `object` | ✅ | Access to System Core | -| **logger** | `object` | ✅ | Structured Logger | -| **storage** | `object` | ✅ | Plugin Scoped Data Storage (KV) | -| **i18n** | `object` | ✅ | Internationalization Helper | -| **metadata** | `any` | optional | Metadata registry | -| **events** | `any` | optional | Event bus | -| **app** | `object` | ✅ | App Runtime Capabilities | -| **drivers** | `object` | ✅ | Driver Management | - -## TypeScript Usage - -```typescript -import { PluginContextSchema } from '@objectstack/spec/system'; -import type { PluginContext } from '@objectstack/spec/system'; - -// Validate data -const result = PluginContextSchema.parse(data); - -// Type-safe usage -const myPluginContext: PluginContext = { - ql: {}, - os: {}, - logger: {}, - // ... other required fields -}; -``` - diff --git a/content/docs/references/system/plugin/PluginLifecycle.mdx b/content/docs/references/system/plugin/PluginLifecycle.mdx deleted file mode 100644 index aa9e88a83..000000000 --- a/content/docs/references/system/plugin/PluginLifecycle.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: PluginLifecycle -description: PluginLifecycle Schema Reference -category: system -zodFile: plugin ---- - - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { PluginLifecycleSchema } from '@objectstack/spec/system'; -import type { PluginLifecycle } from '@objectstack/spec/system'; - -// Validate data -const result = PluginLifecycleSchema.parse(data); - -// Type-safe usage -const myPluginLifecycle: PluginLifecycle = { -}; -``` - diff --git a/content/docs/references/system/plugin/Router.mdx b/content/docs/references/system/plugin/Router.mdx deleted file mode 100644 index e47be7df3..000000000 --- a/content/docs/references/system/plugin/Router.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Router -description: HTTP Router Interface -category: system -zodFile: plugin ---- - - -HTTP Router Interface - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { RouterSchema } from '@objectstack/spec/system'; -import type { Router } from '@objectstack/spec/system'; - -// Validate data -const result = RouterSchema.parse(data); - -// Type-safe usage -const myRouter: Router = { -}; -``` - diff --git a/content/docs/references/system/plugin/Scheduler.mdx b/content/docs/references/system/plugin/Scheduler.mdx deleted file mode 100644 index 3034b7788..000000000 --- a/content/docs/references/system/plugin/Scheduler.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Scheduler -description: Job Scheduler Interface -category: system -zodFile: plugin ---- - - -Job Scheduler Interface - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { SchedulerSchema } from '@objectstack/spec/system'; -import type { Scheduler } from '@objectstack/spec/system'; - -// Validate data -const result = SchedulerSchema.parse(data); - -// Type-safe usage -const myScheduler: Scheduler = { -}; -``` - diff --git a/content/docs/references/system/plugin/ScopedStorage.mdx b/content/docs/references/system/plugin/ScopedStorage.mdx deleted file mode 100644 index 5e0bde096..000000000 --- a/content/docs/references/system/plugin/ScopedStorage.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ScopedStorage -description: Plugin Scoped Data Storage (KV) -category: system -zodFile: plugin ---- - - -Plugin Scoped Data Storage (KV) - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { ScopedStorageSchema } from '@objectstack/spec/system'; -import type { ScopedStorage } from '@objectstack/spec/system'; - -// Validate data -const result = ScopedStorageSchema.parse(data); - -// Type-safe usage -const myScopedStorage: ScopedStorage = { -}; -``` - diff --git a/content/docs/references/system/plugin/SystemAPI.mdx b/content/docs/references/system/plugin/SystemAPI.mdx deleted file mode 100644 index ab00b912d..000000000 --- a/content/docs/references/system/plugin/SystemAPI.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: SystemAPI -description: Access to System Core -category: system -zodFile: plugin ---- - - -Access to System Core - - -**Source:** `packages/spec/src/system/plugin.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | - -## TypeScript Usage - -```typescript -import { SystemAPISchema } from '@objectstack/spec/system'; -import type { SystemAPI } from '@objectstack/spec/system'; - -// Validate data -const result = SystemAPISchema.parse(data); - -// Type-safe usage -const mySystemAPI: SystemAPI = { -}; -``` - diff --git a/content/docs/references/system/plugin/meta.json b/content/docs/references/system/plugin/meta.json deleted file mode 100644 index b2d5705b5..000000000 --- a/content/docs/references/system/plugin/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Plugin" -} \ No newline at end of file diff --git a/content/docs/references/system/scoped-storage.mdx b/content/docs/references/system/scoped-storage.mdx new file mode 100644 index 000000000..abeab1d25 --- /dev/null +++ b/content/docs/references/system/scoped-storage.mdx @@ -0,0 +1,82 @@ +--- +title: Scoped Storage +description: Scoped Storage protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Scoped Storage + + +**Source:** `packages/spec/src/system/scoped-storage.zod.ts` + + +## TypeScript Usage + +```typescript +import { FileMetadataSchema, ScopedStorageConfigSchema, StorageAdapterTypeSchema, StorageScopeSchema } from '@objectstack/spec/system'; +import type { FileMetadata, ScopedStorageConfig, StorageAdapterType, StorageScope } from '@objectstack/spec/system'; + +// Validate data +const result = FileMetadataSchema.parse(data); +``` + +--- + +## FileMetadata + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **path** | `string` | ✅ | | +| **name** | `string` | ✅ | | +| **size** | `integer` | ✅ | | +| **mimeType** | `string` | ✅ | | +| **lastModified** | `string` | ✅ | | +| **created** | `string` | ✅ | | +| **etag** | `string` | optional | | + +--- + +## ScopedStorageConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **scope** | `Enum<'temp' \| 'cache' \| 'data' \| 'logs' \| 'config' \| 'public'>` | ✅ | Generic storage scope classification | +| **adapter** | `Enum<'local' \| 'memory' \| 's3' \| 'gcs' \| 'azure' \| 'gridfs'>` | optional | | +| **location** | `string` | ✅ | Root path (local) or Bucket name (remote) | +| **options** | `Record` | optional | Driver specific options (region, endpoint, etc) | +| **quota** | `integer` | optional | Max size in bytes | + +--- + +## StorageAdapterType + +### Allowed Values + +* `local` +* `memory` +* `s3` +* `gcs` +* `azure` +* `gridfs` + +--- + +## StorageScope + +Generic storage scope classification + +### Allowed Values + +* `temp` +* `cache` +* `data` +* `logs` +* `config` +* `public` + diff --git a/content/docs/references/system/scoped-storage/FileMetadata.mdx b/content/docs/references/system/scoped-storage/FileMetadata.mdx deleted file mode 100644 index 3fbb1cc9a..000000000 --- a/content/docs/references/system/scoped-storage/FileMetadata.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FileMetadata -description: FileMetadata Schema Reference -category: system -zodFile: scoped-storage ---- - - - -**Source:** `packages/spec/src/system/scoped-storage.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **path** | `string` | ✅ | | -| **name** | `string` | ✅ | | -| **size** | `integer` | ✅ | | -| **mimeType** | `string` | ✅ | | -| **lastModified** | `string` | ✅ | | -| **created** | `string` | ✅ | | -| **etag** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { FileMetadataSchema } from '@objectstack/spec/system'; -import type { FileMetadata } from '@objectstack/spec/system'; - -// Validate data -const result = FileMetadataSchema.parse(data); - -// Type-safe usage -const myFileMetadata: FileMetadata = { - path: 'example', - name: 'name', - size: null, - // ... other required fields -}; -``` - diff --git a/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx b/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx deleted file mode 100644 index a8d0fbcae..000000000 --- a/content/docs/references/system/scoped-storage/ScopedStorageConfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ScopedStorageConfig -description: ScopedStorageConfig Schema Reference -category: system -zodFile: scoped-storage ---- - - - -**Source:** `packages/spec/src/system/scoped-storage.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **scope** | `Enum<'temp' \| 'cache' \| 'data' \| 'logs' \| 'config' \| 'public'>` | ✅ | Generic storage scope classification | -| **adapter** | `Enum<'local' \| 'memory' \| 's3' \| 'gcs' \| 'azure' \| 'gridfs'>` | optional | | -| **location** | `string` | ✅ | Root path (local) or Bucket name (remote) | -| **options** | `Record` | optional | Driver specific options (region, endpoint, etc) | -| **quota** | `integer` | optional | Max size in bytes | - -## TypeScript Usage - -```typescript -import { ScopedStorageConfigSchema } from '@objectstack/spec/system'; -import type { ScopedStorageConfig } from '@objectstack/spec/system'; - -// Validate data -const result = ScopedStorageConfigSchema.parse(data); - -// Type-safe usage -const myScopedStorageConfig: ScopedStorageConfig = { - scope: 'temp', - location: 'example' -}; -``` - diff --git a/content/docs/references/system/scoped-storage/StorageAdapterType.mdx b/content/docs/references/system/scoped-storage/StorageAdapterType.mdx deleted file mode 100644 index 71104f04c..000000000 --- a/content/docs/references/system/scoped-storage/StorageAdapterType.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: StorageAdapterType -description: StorageAdapterType Schema Reference -category: system -zodFile: scoped-storage ---- - - - -**Source:** `packages/spec/src/system/scoped-storage.zod.ts` - - -## Allowed Values - -* `local` -* `memory` -* `s3` -* `gcs` -* `azure` -* `gridfs` - -## TypeScript Usage - -```typescript -import { StorageAdapterType } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: StorageAdapterType = 'local'; -``` - diff --git a/content/docs/references/system/scoped-storage/StorageScope.mdx b/content/docs/references/system/scoped-storage/StorageScope.mdx deleted file mode 100644 index c05feb579..000000000 --- a/content/docs/references/system/scoped-storage/StorageScope.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: StorageScope -description: Generic storage scope classification -category: system -zodFile: scoped-storage ---- - - -Generic storage scope classification - - -**Source:** `packages/spec/src/system/scoped-storage.zod.ts` - - -## Allowed Values - -* `temp` -* `cache` -* `data` -* `logs` -* `config` -* `public` - -## TypeScript Usage - -```typescript -import { StorageScope } from '@objectstack/spec/system'; - -// Type-safe enum value -const value: StorageScope = 'temp'; -``` - diff --git a/content/docs/references/system/scoped-storage/meta.json b/content/docs/references/system/scoped-storage/meta.json deleted file mode 100644 index 8a0466cfb..000000000 --- a/content/docs/references/system/scoped-storage/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Scoped Storage" -} \ No newline at end of file diff --git a/content/docs/references/system/translation.mdx b/content/docs/references/system/translation.mdx new file mode 100644 index 000000000..015e5f4fb --- /dev/null +++ b/content/docs/references/system/translation.mdx @@ -0,0 +1,46 @@ +--- +title: Translation +description: Translation protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Translation + + +**Source:** `packages/spec/src/system/translation.zod.ts` + + +## TypeScript Usage + +```typescript +import { LocaleSchema, TranslationBundleSchema, TranslationDataSchema } from '@objectstack/spec/system'; +import type { Locale, TranslationBundle, TranslationData } from '@objectstack/spec/system'; + +// Validate data +const result = LocaleSchema.parse(data); +``` + +--- + +## Locale + +BCP-47 Language Tag (e.g. en-US, zh-CN) + +--- + +## TranslationBundle + +--- + +## TranslationData + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **objects** | `Record` | optional | | +| **apps** | `Record` | optional | | +| **messages** | `Record` | optional | | + diff --git a/content/docs/references/system/translation/Locale.mdx b/content/docs/references/system/translation/Locale.mdx deleted file mode 100644 index 13374cd81..000000000 --- a/content/docs/references/system/translation/Locale.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Locale -description: BCP-47 Language Tag (e.g. en-US, zh-CN) -category: system -zodFile: translation ---- - - -BCP-47 Language Tag (e.g. en-US, zh-CN) - - -**Source:** `packages/spec/src/system/translation.zod.ts` - - diff --git a/content/docs/references/system/translation/TranslationBundle.mdx b/content/docs/references/system/translation/TranslationBundle.mdx deleted file mode 100644 index ccddeacf2..000000000 --- a/content/docs/references/system/translation/TranslationBundle.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: TranslationBundle -description: TranslationBundle Schema Reference -category: system -zodFile: translation ---- - - - -**Source:** `packages/spec/src/system/translation.zod.ts` - - diff --git a/content/docs/references/system/translation/TranslationData.mdx b/content/docs/references/system/translation/TranslationData.mdx deleted file mode 100644 index 43a820138..000000000 --- a/content/docs/references/system/translation/TranslationData.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TranslationData -description: TranslationData Schema Reference -category: system -zodFile: translation ---- - - - -**Source:** `packages/spec/src/system/translation.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **objects** | `Record` | optional | | -| **apps** | `Record` | optional | | -| **messages** | `Record` | optional | | - -## TypeScript Usage - -```typescript -import { TranslationDataSchema } from '@objectstack/spec/system'; -import type { TranslationData } from '@objectstack/spec/system'; - -// Validate data -const result = TranslationDataSchema.parse(data); - -// Type-safe usage -const myTranslationData: TranslationData = { -}; -``` - diff --git a/content/docs/references/system/translation/meta.json b/content/docs/references/system/translation/meta.json deleted file mode 100644 index 3e61aa3e8..000000000 --- a/content/docs/references/system/translation/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Translation" -} \ No newline at end of file diff --git a/content/docs/references/ui/action/Action.mdx b/content/docs/references/ui/action.mdx similarity index 55% rename from content/docs/references/ui/action/Action.mdx rename to content/docs/references/ui/action.mdx index 691d0dd29..682665aa1 100644 --- a/content/docs/references/ui/action/Action.mdx +++ b/content/docs/references/ui/action.mdx @@ -1,16 +1,32 @@ --- title: Action -description: Action Schema Reference -category: ui -zodFile: action +description: Action protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Action **Source:** `packages/spec/src/ui/action.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { ActionSchema, ActionParamSchema } from '@objectstack/spec/ui'; +import type { Action, ActionParam } from '@objectstack/spec/ui'; + +// Validate data +const result = ActionSchema.parse(data); +``` + +--- + +## Action + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -29,19 +45,17 @@ zodFile: action | **refreshAfter** | `boolean` | optional | Refresh view after execution | | **visible** | `string` | optional | Formula returning boolean | -## TypeScript Usage +--- -```typescript -import { ActionSchema } from '@objectstack/spec/ui'; -import type { Action } from '@objectstack/spec/ui'; +## ActionParam -// Validate data -const result = ActionSchema.parse(data); +### Properties -// Type-safe usage -const myAction: Action = { - name: 'name', - label: 'example' -}; -``` +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | | +| **label** | `string` | ✅ | | +| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'toggle' \| 'select' \| 'multiselect' \| 'radio' \| 'checkboxes' \| 'lookup' \| 'master_detail' \| 'tree' \| 'image' \| 'file' \| 'avatar' \| 'video' \| 'audio' \| 'formula' \| 'summary' \| 'autonumber' \| 'location' \| 'address' \| 'code' \| 'json' \| 'color' \| 'rating' \| 'slider' \| 'signature' \| 'qrcode' \| 'progress' \| 'tags' \| 'vector'>` | ✅ | | +| **required** | `boolean` | optional | | +| **options** | `object[]` | optional | | diff --git a/content/docs/references/ui/action/ActionParam.mdx b/content/docs/references/ui/action/ActionParam.mdx deleted file mode 100644 index d3eb10fc5..000000000 --- a/content/docs/references/ui/action/ActionParam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ActionParam -description: ActionParam Schema Reference -category: ui -zodFile: action ---- - - - -**Source:** `packages/spec/src/ui/action.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | | -| **label** | `string` | ✅ | | -| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'toggle' \| 'select' \| 'multiselect' \| 'radio' \| 'checkboxes' \| 'lookup' \| 'master_detail' \| 'tree' \| 'image' \| 'file' \| 'avatar' \| 'video' \| 'audio' \| 'formula' \| 'summary' \| 'autonumber' \| 'location' \| 'address' \| 'code' \| 'json' \| 'color' \| 'rating' \| 'slider' \| 'signature' \| 'qrcode' \| 'progress' \| 'tags' \| 'vector'>` | ✅ | | -| **required** | `boolean` | optional | | -| **options** | `object[]` | optional | | - -## TypeScript Usage - -```typescript -import { ActionParamSchema } from '@objectstack/spec/ui'; -import type { ActionParam } from '@objectstack/spec/ui'; - -// Validate data -const result = ActionParamSchema.parse(data); - -// Type-safe usage -const myActionParam: ActionParam = { - name: 'name', - label: 'example', - type: 'text' -}; -``` - diff --git a/content/docs/references/ui/action/meta.json b/content/docs/references/ui/action/meta.json deleted file mode 100644 index 98e37fd51..000000000 --- a/content/docs/references/ui/action/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Action" -} \ No newline at end of file diff --git a/content/docs/references/ui/app.mdx b/content/docs/references/ui/app.mdx new file mode 100644 index 000000000..36d340c32 --- /dev/null +++ b/content/docs/references/ui/app.mdx @@ -0,0 +1,140 @@ +--- +title: App +description: App protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# App + + +**Source:** `packages/spec/src/ui/app.zod.ts` + + +## TypeScript Usage + +```typescript +import { AppSchema, AppBrandingSchema, DashboardNavItemSchema, GroupNavItemSchema, NavigationItemSchema, ObjectNavItemSchema, PageNavItemSchema, UrlNavItemSchema } from '@objectstack/spec/ui'; +import type { App, AppBranding, DashboardNavItem, GroupNavItem, NavigationItem, ObjectNavItem, PageNavItem, UrlNavItem } from '@objectstack/spec/ui'; + +// Validate data +const result = AppSchema.parse(data); +``` + +--- + +## App + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | App unique machine name (lowercase snake_case) | +| **label** | `string` | ✅ | App display label | +| **version** | `string` | optional | App version | +| **description** | `string` | optional | App description | +| **icon** | `string` | optional | App icon used in the App Launcher | +| **branding** | `object` | optional | App-specific branding | +| **active** | `boolean` | optional | Whether the app is enabled | +| **isDefault** | `boolean` | optional | Is default app | +| **navigation** | `object \| object \| object \| object \| object[]` | optional | Structured navigation menu tree | +| **homePageId** | `string` | optional | ID of the navigation item to serve as landing page | +| **requiredPermissions** | `string[]` | optional | Permissions required to access this app | +| **objects** | `any[]` | optional | Objects belonging to this app | +| **apis** | `any[]` | optional | Custom APIs belonging to this app | + +--- + +## AppBranding + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **primaryColor** | `string` | optional | Primary theme color hex code | +| **logo** | `string` | optional | Custom logo URL for this app | +| **favicon** | `string` | optional | Custom favicon URL for this app | + +--- + +## DashboardNavItem + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | +| **label** | `string` | ✅ | Display proper label | +| **icon** | `string` | optional | Icon name | +| **visible** | `string` | optional | Visibility formula condition | +| **type** | `string` | ✅ | | +| **dashboardName** | `string` | ✅ | Target dashboard name | + +--- + +## GroupNavItem + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | +| **label** | `string` | ✅ | Display proper label | +| **icon** | `string` | optional | Icon name | +| **visible** | `string` | optional | Visibility formula condition | +| **type** | `string` | ✅ | | +| **expanded** | `boolean` | optional | Default expansion state in sidebar | + +--- + +## NavigationItem + +--- + +## ObjectNavItem + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | +| **label** | `string` | ✅ | Display proper label | +| **icon** | `string` | optional | Icon name | +| **visible** | `string` | optional | Visibility formula condition | +| **type** | `string` | ✅ | | +| **objectName** | `string` | ✅ | Target object name | +| **viewName** | `string` | optional | Default list view to open. Defaults to "all" | + +--- + +## PageNavItem + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | +| **label** | `string` | ✅ | Display proper label | +| **icon** | `string` | optional | Icon name | +| **visible** | `string` | optional | Visibility formula condition | +| **type** | `string` | ✅ | | +| **pageName** | `string` | ✅ | Target custom page component name | +| **params** | `Record` | optional | Parameters passed to the page context | + +--- + +## UrlNavItem + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | +| **label** | `string` | ✅ | Display proper label | +| **icon** | `string` | optional | Icon name | +| **visible** | `string` | optional | Visibility formula condition | +| **type** | `string` | ✅ | | +| **url** | `string` | ✅ | Target external URL | +| **target** | `Enum<'_self' \| '_blank'>` | optional | Link target window | + diff --git a/content/docs/references/ui/app/App.mdx b/content/docs/references/ui/app/App.mdx deleted file mode 100644 index 9e0940387..000000000 --- a/content/docs/references/ui/app/App.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: App -description: App Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | App unique machine name (lowercase snake_case) | -| **label** | `string` | ✅ | App display label | -| **version** | `string` | optional | App version | -| **description** | `string` | optional | App description | -| **icon** | `string` | optional | App icon used in the App Launcher | -| **branding** | `object` | optional | App-specific branding | -| **active** | `boolean` | optional | Whether the app is enabled | -| **isDefault** | `boolean` | optional | Is default app | -| **navigation** | `object \| object \| object \| object \| object[]` | optional | Structured navigation menu tree | -| **homePageId** | `string` | optional | ID of the navigation item to serve as landing page | -| **requiredPermissions** | `string[]` | optional | Permissions required to access this app | -| **objects** | `any[]` | optional | Objects belonging to this app | -| **apis** | `any[]` | optional | Custom APIs belonging to this app | - -## TypeScript Usage - -```typescript -import { AppSchema } from '@objectstack/spec/ui'; -import type { App } from '@objectstack/spec/ui'; - -// Validate data -const result = AppSchema.parse(data); - -// Type-safe usage -const myApp: App = { - name: 'name', - label: 'example' -}; -``` - diff --git a/content/docs/references/ui/app/AppBranding.mdx b/content/docs/references/ui/app/AppBranding.mdx deleted file mode 100644 index 75412e626..000000000 --- a/content/docs/references/ui/app/AppBranding.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AppBranding -description: AppBranding Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **primaryColor** | `string` | optional | Primary theme color hex code | -| **logo** | `string` | optional | Custom logo URL for this app | -| **favicon** | `string` | optional | Custom favicon URL for this app | - -## TypeScript Usage - -```typescript -import { AppBrandingSchema } from '@objectstack/spec/ui'; -import type { AppBranding } from '@objectstack/spec/ui'; - -// Validate data -const result = AppBrandingSchema.parse(data); - -// Type-safe usage -const myAppBranding: AppBranding = { -}; -``` - diff --git a/content/docs/references/ui/app/DashboardNavItem.mdx b/content/docs/references/ui/app/DashboardNavItem.mdx deleted file mode 100644 index aadd62d21..000000000 --- a/content/docs/references/ui/app/DashboardNavItem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: DashboardNavItem -description: DashboardNavItem Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | -| **label** | `string` | ✅ | Display proper label | -| **icon** | `string` | optional | Icon name | -| **visible** | `string` | optional | Visibility formula condition | -| **type** | `string` | ✅ | | -| **dashboardName** | `string` | ✅ | Target dashboard name | - -## TypeScript Usage - -```typescript -import { DashboardNavItemSchema } from '@objectstack/spec/ui'; -import type { DashboardNavItem } from '@objectstack/spec/ui'; - -// Validate data -const result = DashboardNavItemSchema.parse(data); - -// Type-safe usage -const myDashboardNavItem: DashboardNavItem = { - id: 'example', - label: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ui/app/GroupNavItem.mdx b/content/docs/references/ui/app/GroupNavItem.mdx deleted file mode 100644 index 9482539fd..000000000 --- a/content/docs/references/ui/app/GroupNavItem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: GroupNavItem -description: GroupNavItem Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | -| **label** | `string` | ✅ | Display proper label | -| **icon** | `string` | optional | Icon name | -| **visible** | `string` | optional | Visibility formula condition | -| **type** | `string` | ✅ | | -| **expanded** | `boolean` | optional | Default expansion state in sidebar | - -## TypeScript Usage - -```typescript -import { GroupNavItemSchema } from '@objectstack/spec/ui'; -import type { GroupNavItem } from '@objectstack/spec/ui'; - -// Validate data -const result = GroupNavItemSchema.parse(data); - -// Type-safe usage -const myGroupNavItem: GroupNavItem = { - id: 'example', - label: 'example', - type: 'example' -}; -``` - diff --git a/content/docs/references/ui/app/NavigationItem.mdx b/content/docs/references/ui/app/NavigationItem.mdx deleted file mode 100644 index 2ba6d23ee..000000000 --- a/content/docs/references/ui/app/NavigationItem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: NavigationItem -description: NavigationItem Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - diff --git a/content/docs/references/ui/app/ObjectNavItem.mdx b/content/docs/references/ui/app/ObjectNavItem.mdx deleted file mode 100644 index 727cb054b..000000000 --- a/content/docs/references/ui/app/ObjectNavItem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ObjectNavItem -description: ObjectNavItem Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | -| **label** | `string` | ✅ | Display proper label | -| **icon** | `string` | optional | Icon name | -| **visible** | `string` | optional | Visibility formula condition | -| **type** | `string` | ✅ | | -| **objectName** | `string` | ✅ | Target object name | -| **viewName** | `string` | optional | Default list view to open. Defaults to "all" | - -## TypeScript Usage - -```typescript -import { ObjectNavItemSchema } from '@objectstack/spec/ui'; -import type { ObjectNavItem } from '@objectstack/spec/ui'; - -// Validate data -const result = ObjectNavItemSchema.parse(data); - -// Type-safe usage -const myObjectNavItem: ObjectNavItem = { - id: 'example', - label: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ui/app/PageNavItem.mdx b/content/docs/references/ui/app/PageNavItem.mdx deleted file mode 100644 index 9c00b48b5..000000000 --- a/content/docs/references/ui/app/PageNavItem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PageNavItem -description: PageNavItem Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | -| **label** | `string` | ✅ | Display proper label | -| **icon** | `string` | optional | Icon name | -| **visible** | `string` | optional | Visibility formula condition | -| **type** | `string` | ✅ | | -| **pageName** | `string` | ✅ | Target custom page component name | -| **params** | `Record` | optional | Parameters passed to the page context | - -## TypeScript Usage - -```typescript -import { PageNavItemSchema } from '@objectstack/spec/ui'; -import type { PageNavItem } from '@objectstack/spec/ui'; - -// Validate data -const result = PageNavItemSchema.parse(data); - -// Type-safe usage -const myPageNavItem: PageNavItem = { - id: 'example', - label: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ui/app/UrlNavItem.mdx b/content/docs/references/ui/app/UrlNavItem.mdx deleted file mode 100644 index 6beabf08b..000000000 --- a/content/docs/references/ui/app/UrlNavItem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: UrlNavItem -description: UrlNavItem Schema Reference -category: ui -zodFile: app ---- - - - -**Source:** `packages/spec/src/ui/app.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) | -| **label** | `string` | ✅ | Display proper label | -| **icon** | `string` | optional | Icon name | -| **visible** | `string` | optional | Visibility formula condition | -| **type** | `string` | ✅ | | -| **url** | `string` | ✅ | Target external URL | -| **target** | `Enum<'_self' \| '_blank'>` | optional | Link target window | - -## TypeScript Usage - -```typescript -import { UrlNavItemSchema } from '@objectstack/spec/ui'; -import type { UrlNavItem } from '@objectstack/spec/ui'; - -// Validate data -const result = UrlNavItemSchema.parse(data); - -// Type-safe usage -const myUrlNavItem: UrlNavItem = { - id: 'example', - label: 'example', - type: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ui/app/meta.json b/content/docs/references/ui/app/meta.json deleted file mode 100644 index d13b942e6..000000000 --- a/content/docs/references/ui/app/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "App" -} \ No newline at end of file diff --git a/content/docs/references/ui/block/meta.json b/content/docs/references/ui/block/meta.json deleted file mode 100644 index 7321928ac..000000000 --- a/content/docs/references/ui/block/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Block" -} \ No newline at end of file diff --git a/content/docs/references/ui/component.mdx b/content/docs/references/ui/component.mdx new file mode 100644 index 000000000..61ef8296e --- /dev/null +++ b/content/docs/references/ui/component.mdx @@ -0,0 +1,99 @@ +--- +title: Component +description: Component protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Component + + +**Source:** `packages/spec/src/ui/component.zod.ts` + + +## TypeScript Usage + +```typescript +import { PageCardPropsSchema, PageHeaderPropsSchema, PageTabsPropsSchema, RecordDetailsPropsSchema, RecordHighlightsPropsSchema, RecordRelatedListPropsSchema } from '@objectstack/spec/ui'; +import type { PageCardProps, PageHeaderProps, PageTabsProps, RecordDetailsProps, RecordHighlightsProps, RecordRelatedListProps } from '@objectstack/spec/ui'; + +// Validate data +const result = PageCardPropsSchema.parse(data); +``` + +--- + +## PageCardProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **title** | `string` | optional | | +| **bordered** | `boolean` | optional | | +| **actions** | `string[]` | optional | | +| **children** | `any[]` | ✅ | Card content | + +--- + +## PageHeaderProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **title** | `string` | ✅ | Page title | +| **subtitle** | `string` | optional | Page subtitle | +| **icon** | `string` | optional | Icon name | +| **breadcrumb** | `boolean` | optional | Show breadcrumb | +| **actions** | `string[]` | optional | Action IDs to show in header | + +--- + +## PageTabsProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'line' \| 'card' \| 'pill'>` | optional | | +| **position** | `Enum<'top' \| 'left'>` | optional | | +| **items** | `object[]` | ✅ | | + +--- + +## RecordDetailsProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | | +| **layout** | `Enum<'auto' \| 'custom'>` | optional | | +| **sections** | `string[]` | optional | Section IDs to show | + +--- + +## RecordHighlightsProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **fields** | `string[]` | ✅ | Key fields to highlights (max 7) | + +--- + +## RecordRelatedListProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **objectName** | `string` | ✅ | Related object name | +| **relationshipField** | `string` | ✅ | Field on related object that points to this record | +| **columns** | `string[]` | ✅ | Fields to display | +| **sort** | `string` | optional | | +| **limit** | `number` | optional | | + diff --git a/content/docs/references/ui/component/PageCardProps.mdx b/content/docs/references/ui/component/PageCardProps.mdx deleted file mode 100644 index 091ee5f3b..000000000 --- a/content/docs/references/ui/component/PageCardProps.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PageCardProps -description: PageCardProps Schema Reference -category: ui -zodFile: component ---- - - - -**Source:** `packages/spec/src/ui/component.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **title** | `string` | optional | | -| **bordered** | `boolean` | optional | | -| **actions** | `string[]` | optional | | -| **children** | `any[]` | ✅ | Card content | - -## TypeScript Usage - -```typescript -import { PageCardPropsSchema } from '@objectstack/spec/ui'; -import type { PageCardProps } from '@objectstack/spec/ui'; - -// Validate data -const result = PageCardPropsSchema.parse(data); - -// Type-safe usage -const myPageCardProps: PageCardProps = { - children: [] -}; -``` - diff --git a/content/docs/references/ui/component/PageHeaderProps.mdx b/content/docs/references/ui/component/PageHeaderProps.mdx deleted file mode 100644 index d7b71e749..000000000 --- a/content/docs/references/ui/component/PageHeaderProps.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PageHeaderProps -description: PageHeaderProps Schema Reference -category: ui -zodFile: component ---- - - - -**Source:** `packages/spec/src/ui/component.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **title** | `string` | ✅ | Page title | -| **subtitle** | `string` | optional | Page subtitle | -| **icon** | `string` | optional | Icon name | -| **breadcrumb** | `boolean` | optional | Show breadcrumb | -| **actions** | `string[]` | optional | Action IDs to show in header | - -## TypeScript Usage - -```typescript -import { PageHeaderPropsSchema } from '@objectstack/spec/ui'; -import type { PageHeaderProps } from '@objectstack/spec/ui'; - -// Validate data -const result = PageHeaderPropsSchema.parse(data); - -// Type-safe usage -const myPageHeaderProps: PageHeaderProps = { - title: 'example' -}; -``` - diff --git a/content/docs/references/ui/component/PageTabsProps.mdx b/content/docs/references/ui/component/PageTabsProps.mdx deleted file mode 100644 index 3f28ab337..000000000 --- a/content/docs/references/ui/component/PageTabsProps.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PageTabsProps -description: PageTabsProps Schema Reference -category: ui -zodFile: component ---- - - - -**Source:** `packages/spec/src/ui/component.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'line' \| 'card' \| 'pill'>` | optional | | -| **position** | `Enum<'top' \| 'left'>` | optional | | -| **items** | `object[]` | ✅ | | - -## TypeScript Usage - -```typescript -import { PageTabsPropsSchema } from '@objectstack/spec/ui'; -import type { PageTabsProps } from '@objectstack/spec/ui'; - -// Validate data -const result = PageTabsPropsSchema.parse(data); - -// Type-safe usage -const myPageTabsProps: PageTabsProps = { - items: [] -}; -``` - diff --git a/content/docs/references/ui/component/RecordDetailsProps.mdx b/content/docs/references/ui/component/RecordDetailsProps.mdx deleted file mode 100644 index 197197279..000000000 --- a/content/docs/references/ui/component/RecordDetailsProps.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RecordDetailsProps -description: RecordDetailsProps Schema Reference -category: ui -zodFile: component ---- - - - -**Source:** `packages/spec/src/ui/component.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | | -| **layout** | `Enum<'auto' \| 'custom'>` | optional | | -| **sections** | `string[]` | optional | Section IDs to show | - -## TypeScript Usage - -```typescript -import { RecordDetailsPropsSchema } from '@objectstack/spec/ui'; -import type { RecordDetailsProps } from '@objectstack/spec/ui'; - -// Validate data -const result = RecordDetailsPropsSchema.parse(data); - -// Type-safe usage -const myRecordDetailsProps: RecordDetailsProps = { -}; -``` - diff --git a/content/docs/references/ui/component/RecordHighlightsProps.mdx b/content/docs/references/ui/component/RecordHighlightsProps.mdx deleted file mode 100644 index 116e01ab4..000000000 --- a/content/docs/references/ui/component/RecordHighlightsProps.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: RecordHighlightsProps -description: RecordHighlightsProps Schema Reference -category: ui -zodFile: component ---- - - - -**Source:** `packages/spec/src/ui/component.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **fields** | `string[]` | ✅ | Key fields to highlights (max 7) | - -## TypeScript Usage - -```typescript -import { RecordHighlightsPropsSchema } from '@objectstack/spec/ui'; -import type { RecordHighlightsProps } from '@objectstack/spec/ui'; - -// Validate data -const result = RecordHighlightsPropsSchema.parse(data); - -// Type-safe usage -const myRecordHighlightsProps: RecordHighlightsProps = { - fields: [] -}; -``` - diff --git a/content/docs/references/ui/component/RecordRelatedListProps.mdx b/content/docs/references/ui/component/RecordRelatedListProps.mdx deleted file mode 100644 index bb17932a5..000000000 --- a/content/docs/references/ui/component/RecordRelatedListProps.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: RecordRelatedListProps -description: RecordRelatedListProps Schema Reference -category: ui -zodFile: component ---- - - - -**Source:** `packages/spec/src/ui/component.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **objectName** | `string` | ✅ | Related object name | -| **relationshipField** | `string` | ✅ | Field on related object that points to this record | -| **columns** | `string[]` | ✅ | Fields to display | -| **sort** | `string` | optional | | -| **limit** | `number` | optional | | - -## TypeScript Usage - -```typescript -import { RecordRelatedListPropsSchema } from '@objectstack/spec/ui'; -import type { RecordRelatedListProps } from '@objectstack/spec/ui'; - -// Validate data -const result = RecordRelatedListPropsSchema.parse(data); - -// Type-safe usage -const myRecordRelatedListProps: RecordRelatedListProps = { - objectName: 'example', - relationshipField: 'example', - columns: [] -}; -``` - diff --git a/content/docs/references/ui/component/meta.json b/content/docs/references/ui/component/meta.json deleted file mode 100644 index fb9d9f60a..000000000 --- a/content/docs/references/ui/component/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Component" -} \ No newline at end of file diff --git a/content/docs/references/ui/dashboard/DashboardWidget.mdx b/content/docs/references/ui/dashboard.mdx similarity index 50% rename from content/docs/references/ui/dashboard/DashboardWidget.mdx rename to content/docs/references/ui/dashboard.mdx index b7c9b6490..5556f8b3f 100644 --- a/content/docs/references/ui/dashboard/DashboardWidget.mdx +++ b/content/docs/references/ui/dashboard.mdx @@ -1,16 +1,68 @@ --- -title: DashboardWidget -description: DashboardWidget Schema Reference -category: ui -zodFile: dashboard +title: Dashboard +description: Dashboard protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Dashboard **Source:** `packages/spec/src/ui/dashboard.zod.ts` -## Properties +## TypeScript Usage + +```typescript +import { ChartTypeSchema, DashboardSchema, DashboardWidgetSchema } from '@objectstack/spec/ui'; +import type { ChartType, Dashboard, DashboardWidget } from '@objectstack/spec/ui'; + +// Validate data +const result = ChartTypeSchema.parse(data); +``` + +--- + +## ChartType + +### Allowed Values + +* `metric` +* `bar` +* `line` +* `pie` +* `donut` +* `gauge` +* `funnel` +* `radar` +* `scatter` +* `heatmap` +* `pivot` +* `table` +* `list` +* `text` +* `image` +* `frame` + +--- + +## Dashboard + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Dashboard unique name | +| **label** | `string` | ✅ | Dashboard label | +| **description** | `string` | optional | Dashboard description | +| **widgets** | `object[]` | ✅ | Widgets to display | + +--- + +## DashboardWidget + +### Properties | Property | Type | Required | Description | | :--- | :--- | :--- | :--- | @@ -24,18 +76,3 @@ zodFile: dashboard | **layout** | `object` | ✅ | Grid layout position | | **options** | `any` | optional | Widget specific configuration | -## TypeScript Usage - -```typescript -import { DashboardWidgetSchema } from '@objectstack/spec/ui'; -import type { DashboardWidget } from '@objectstack/spec/ui'; - -// Validate data -const result = DashboardWidgetSchema.parse(data); - -// Type-safe usage -const myDashboardWidget: DashboardWidget = { - layout: {} -}; -``` - diff --git a/content/docs/references/ui/dashboard/ChartType.mdx b/content/docs/references/ui/dashboard/ChartType.mdx deleted file mode 100644 index d52df9f56..000000000 --- a/content/docs/references/ui/dashboard/ChartType.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChartType -description: ChartType Schema Reference -category: ui -zodFile: dashboard ---- - - - -**Source:** `packages/spec/src/ui/dashboard.zod.ts` - - -## Allowed Values - -* `metric` -* `bar` -* `line` -* `pie` -* `donut` -* `gauge` -* `funnel` -* `radar` -* `scatter` -* `heatmap` -* `pivot` -* `table` -* `list` -* `text` -* `image` -* `frame` - -## TypeScript Usage - -```typescript -import { ChartType } from '@objectstack/spec/ui'; - -// Type-safe enum value -const value: ChartType = 'metric'; -``` - diff --git a/content/docs/references/ui/dashboard/Dashboard.mdx b/content/docs/references/ui/dashboard/Dashboard.mdx deleted file mode 100644 index 97d77a9ad..000000000 --- a/content/docs/references/ui/dashboard/Dashboard.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Dashboard -description: Dashboard Schema Reference -category: ui -zodFile: dashboard ---- - - - -**Source:** `packages/spec/src/ui/dashboard.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Dashboard unique name | -| **label** | `string` | ✅ | Dashboard label | -| **description** | `string` | optional | Dashboard description | -| **widgets** | `object[]` | ✅ | Widgets to display | - -## TypeScript Usage - -```typescript -import { DashboardSchema } from '@objectstack/spec/ui'; -import type { Dashboard } from '@objectstack/spec/ui'; - -// Validate data -const result = DashboardSchema.parse(data); - -// Type-safe usage -const myDashboard: Dashboard = { - name: 'name', - label: 'example', - widgets: [] -}; -``` - diff --git a/content/docs/references/ui/dashboard/meta.json b/content/docs/references/ui/dashboard/meta.json deleted file mode 100644 index cfc92c3ca..000000000 --- a/content/docs/references/ui/dashboard/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Dashboard" -} \ No newline at end of file diff --git a/content/docs/references/ui/index.mdx b/content/docs/references/ui/index.mdx index 4696930aa..52ba18c52 100644 --- a/content/docs/references/ui/index.mdx +++ b/content/docs/references/ui/index.mdx @@ -3,128 +3,22 @@ title: UI Protocol Overview description: Complete reference for all ui protocol schemas --- +import { Card, Cards } from 'fumadocs-ui/components/card'; # UI Protocol This section contains all protocol schemas for the ui layer of ObjectStack. -## Action - -Source: `packages/spec/src/ui/action.zod.ts` - - - - - - -## App - -Source: `packages/spec/src/ui/app.zod.ts` - - - - - - - - - - - - -## Component - -Source: `packages/spec/src/ui/component.zod.ts` - - - - - - - - - - -## Dashboard - -Source: `packages/spec/src/ui/dashboard.zod.ts` - - - - - - - -## Page - -Source: `packages/spec/src/ui/page.zod.ts` - - - - - - - - -## Report - -Source: `packages/spec/src/ui/report.zod.ts` - - - - - - - - - -## Theme - -Source: `packages/spec/src/ui/theme.zod.ts` - - - - - - - - - - - - - - -## View - -Source: `packages/spec/src/ui/view.zod.ts` - - - - - - - - - - - - - - - - - - -## Widget - -Source: `packages/spec/src/ui/widget.zod.ts` - - - - - - + + + + + + + + + + diff --git a/content/docs/references/ui/page.mdx b/content/docs/references/ui/page.mdx new file mode 100644 index 000000000..4813fcfad --- /dev/null +++ b/content/docs/references/ui/page.mdx @@ -0,0 +1,96 @@ +--- +title: Page +description: Page protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Page + + +**Source:** `packages/spec/src/ui/page.zod.ts` + + +## TypeScript Usage + +```typescript +import { PageSchema, PageComponentSchema, PageComponentTypeSchema, PageRegionSchema } from '@objectstack/spec/ui'; +import type { Page, PageComponent, PageComponentType, PageRegion } from '@objectstack/spec/ui'; + +// Validate data +const result = PageSchema.parse(data); +``` + +--- + +## Page + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Page unique name (lowercase snake_case) | +| **label** | `string` | ✅ | | +| **description** | `string` | optional | | +| **type** | `Enum<'record' \| 'home' \| 'app' \| 'utility'>` | optional | | +| **object** | `string` | optional | Bound object (for Record pages) | +| **template** | `string` | optional | Layout template name (e.g. "header-sidebar-main") | +| **regions** | `object[]` | ✅ | Defined regions with components | +| **isDefault** | `boolean` | optional | | +| **assignedProfiles** | `string[]` | optional | | + +--- + +## PageComponent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'page:header' \| 'page:footer' \| 'page:sidebar' \| 'page:tabs' \| 'page:accordion' \| 'page:card' \| 'page:section' \| 'record:details' \| 'record:highlights' \| 'record:related_list' \| 'record:activity' \| 'record:chatter' \| 'record:path' \| 'app:launcher' \| 'nav:menu' \| 'nav:breadcrumb' \| 'global:search' \| 'global:notifications' \| 'user:profile' \| 'ai:chat_window' \| 'ai:suggestion'> \| string` | ✅ | Component Type (Standard enum or custom string) | +| **id** | `string` | optional | Unique instance ID | +| **label** | `string` | optional | | +| **properties** | `Record` | ✅ | Component props passed to the widget. See block.zod.ts for schemas. | +| **visibility** | `string` | optional | Visibility filter/formula | + +--- + +## PageComponentType + +### Allowed Values + +* `page:header` +* `page:footer` +* `page:sidebar` +* `page:tabs` +* `page:accordion` +* `page:card` +* `page:section` +* `record:details` +* `record:highlights` +* `record:related_list` +* `record:activity` +* `record:chatter` +* `record:path` +* `app:launcher` +* `nav:menu` +* `nav:breadcrumb` +* `global:search` +* `global:notifications` +* `user:profile` +* `ai:chat_window` +* `ai:suggestion` + +--- + +## PageRegion + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Region name (e.g. "sidebar", "main", "header") | +| **width** | `Enum<'small' \| 'medium' \| 'large' \| 'full'>` | optional | | +| **components** | `object[]` | ✅ | Components in this region | + diff --git a/content/docs/references/ui/page/Page.mdx b/content/docs/references/ui/page/Page.mdx deleted file mode 100644 index 1598b47b6..000000000 --- a/content/docs/references/ui/page/Page.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Page -description: Page Schema Reference -category: ui -zodFile: page ---- - - - -**Source:** `packages/spec/src/ui/page.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Page unique name (lowercase snake_case) | -| **label** | `string` | ✅ | | -| **description** | `string` | optional | | -| **type** | `Enum<'record' \| 'home' \| 'app' \| 'utility'>` | optional | | -| **object** | `string` | optional | Bound object (for Record pages) | -| **template** | `string` | optional | Layout template name (e.g. "header-sidebar-main") | -| **regions** | `object[]` | ✅ | Defined regions with components | -| **isDefault** | `boolean` | optional | | -| **assignedProfiles** | `string[]` | optional | | - -## TypeScript Usage - -```typescript -import { PageSchema } from '@objectstack/spec/ui'; -import type { Page } from '@objectstack/spec/ui'; - -// Validate data -const result = PageSchema.parse(data); - -// Type-safe usage -const myPage: Page = { - name: 'name', - label: 'example', - regions: [] -}; -``` - diff --git a/content/docs/references/ui/page/PageComponent.mdx b/content/docs/references/ui/page/PageComponent.mdx deleted file mode 100644 index 0c28660a2..000000000 --- a/content/docs/references/ui/page/PageComponent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PageComponent -description: PageComponent Schema Reference -category: ui -zodFile: page ---- - - - -**Source:** `packages/spec/src/ui/page.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'page:header' \| 'page:footer' \| 'page:sidebar' \| 'page:tabs' \| 'page:accordion' \| 'page:card' \| 'page:section' \| 'record:details' \| 'record:highlights' \| 'record:related_list' \| 'record:activity' \| 'record:chatter' \| 'record:path' \| 'app:launcher' \| 'nav:menu' \| 'nav:breadcrumb' \| 'global:search' \| 'global:notifications' \| 'user:profile' \| 'ai:chat_window' \| 'ai:suggestion'> \| string` | ✅ | Component Type (Standard enum or custom string) | -| **id** | `string` | optional | Unique instance ID | -| **label** | `string` | optional | | -| **properties** | `Record` | ✅ | Component props passed to the widget. See block.zod.ts for schemas. | -| **visibility** | `string` | optional | Visibility filter/formula | - -## TypeScript Usage - -```typescript -import { PageComponentSchema } from '@objectstack/spec/ui'; -import type { PageComponent } from '@objectstack/spec/ui'; - -// Validate data -const result = PageComponentSchema.parse(data); - -// Type-safe usage -const myPageComponent: PageComponent = { - type: null, - properties: {} -}; -``` - diff --git a/content/docs/references/ui/page/PageComponentType.mdx b/content/docs/references/ui/page/PageComponentType.mdx deleted file mode 100644 index e5fae63a3..000000000 --- a/content/docs/references/ui/page/PageComponentType.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: PageComponentType -description: PageComponentType Schema Reference -category: ui -zodFile: page ---- - - - -**Source:** `packages/spec/src/ui/page.zod.ts` - - -## Allowed Values - -* `page:header` -* `page:footer` -* `page:sidebar` -* `page:tabs` -* `page:accordion` -* `page:card` -* `page:section` -* `record:details` -* `record:highlights` -* `record:related_list` -* `record:activity` -* `record:chatter` -* `record:path` -* `app:launcher` -* `nav:menu` -* `nav:breadcrumb` -* `global:search` -* `global:notifications` -* `user:profile` -* `ai:chat_window` -* `ai:suggestion` - -## TypeScript Usage - -```typescript -import { PageComponentType } from '@objectstack/spec/ui'; - -// Type-safe enum value -const value: PageComponentType = 'page:header'; -``` - diff --git a/content/docs/references/ui/page/PageRegion.mdx b/content/docs/references/ui/page/PageRegion.mdx deleted file mode 100644 index bdcc0967c..000000000 --- a/content/docs/references/ui/page/PageRegion.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PageRegion -description: PageRegion Schema Reference -category: ui -zodFile: page ---- - - - -**Source:** `packages/spec/src/ui/page.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Region name (e.g. "sidebar", "main", "header") | -| **width** | `Enum<'small' \| 'medium' \| 'large' \| 'full'>` | optional | | -| **components** | `object[]` | ✅ | Components in this region | - -## TypeScript Usage - -```typescript -import { PageRegionSchema } from '@objectstack/spec/ui'; -import type { PageRegion } from '@objectstack/spec/ui'; - -// Validate data -const result = PageRegionSchema.parse(data); - -// Type-safe usage -const myPageRegion: PageRegion = { - name: 'name', - components: [] -}; -``` - diff --git a/content/docs/references/ui/page/meta.json b/content/docs/references/ui/page/meta.json deleted file mode 100644 index 527041315..000000000 --- a/content/docs/references/ui/page/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Page" -} \ No newline at end of file diff --git a/content/docs/references/ui/report.mdx b/content/docs/references/ui/report.mdx new file mode 100644 index 000000000..95557aee5 --- /dev/null +++ b/content/docs/references/ui/report.mdx @@ -0,0 +1,92 @@ +--- +title: Report +description: Report protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Report + + +**Source:** `packages/spec/src/ui/report.zod.ts` + + +## TypeScript Usage + +```typescript +import { ReportSchema, ReportChartSchema, ReportColumnSchema, ReportGroupingSchema, ReportTypeSchema } from '@objectstack/spec/ui'; +import type { Report, ReportChart, ReportColumn, ReportGrouping, ReportType } from '@objectstack/spec/ui'; + +// Validate data +const result = ReportSchema.parse(data); +``` + +--- + +## Report + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Report unique name | +| **label** | `string` | ✅ | Report label | +| **description** | `string` | optional | | +| **objectName** | `string` | ✅ | Primary object | +| **type** | `Enum<'tabular' \| 'summary' \| 'matrix' \| 'joined'>` | optional | Report format type | +| **columns** | `object[]` | ✅ | Columns to display | +| **groupingsDown** | `object[]` | optional | Row groupings | +| **groupingsAcross** | `object[]` | optional | Column groupings (Matrix only) | +| **filter** | `any` | optional | Filter criteria | +| **chart** | `object` | optional | Embedded chart configuration | + +--- + +## ReportChart + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'bar' \| 'column' \| 'line' \| 'pie' \| 'donut' \| 'scatter' \| 'funnel'>` | ✅ | Chart type | +| **title** | `string` | optional | | +| **showLegend** | `boolean` | optional | | +| **xAxis** | `string` | ✅ | Grouping field for X-Axis | +| **yAxis** | `string` | ✅ | Summary field for Y-Axis | + +--- + +## ReportColumn + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | Field name | +| **label** | `string` | optional | Override label | +| **aggregate** | `Enum<'sum' \| 'avg' \| 'max' \| 'min' \| 'count' \| 'unique'>` | optional | Aggregation function | + +--- + +## ReportGrouping + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | Field to group by | +| **sortOrder** | `Enum<'asc' \| 'desc'>` | optional | | +| **dateGranularity** | `Enum<'day' \| 'week' \| 'month' \| 'quarter' \| 'year'>` | optional | For date fields | + +--- + +## ReportType + +### Allowed Values + +* `tabular` +* `summary` +* `matrix` +* `joined` + diff --git a/content/docs/references/ui/report/Report.mdx b/content/docs/references/ui/report/Report.mdx deleted file mode 100644 index 49cc8a44b..000000000 --- a/content/docs/references/ui/report/Report.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Report -description: Report Schema Reference -category: ui -zodFile: report ---- - - - -**Source:** `packages/spec/src/ui/report.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Report unique name | -| **label** | `string` | ✅ | Report label | -| **description** | `string` | optional | | -| **objectName** | `string` | ✅ | Primary object | -| **type** | `Enum<'tabular' \| 'summary' \| 'matrix' \| 'joined'>` | optional | Report format type | -| **columns** | `object[]` | ✅ | Columns to display | -| **groupingsDown** | `object[]` | optional | Row groupings | -| **groupingsAcross** | `object[]` | optional | Column groupings (Matrix only) | -| **filter** | `any` | optional | Filter criteria | -| **chart** | `object` | optional | Embedded chart configuration | - -## TypeScript Usage - -```typescript -import { ReportSchema } from '@objectstack/spec/ui'; -import type { Report } from '@objectstack/spec/ui'; - -// Validate data -const result = ReportSchema.parse(data); - -// Type-safe usage -const myReport: Report = { - name: 'name', - label: 'example', - objectName: 'example', - // ... other required fields -}; -``` - diff --git a/content/docs/references/ui/report/ReportChart.mdx b/content/docs/references/ui/report/ReportChart.mdx deleted file mode 100644 index d74665915..000000000 --- a/content/docs/references/ui/report/ReportChart.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ReportChart -description: ReportChart Schema Reference -category: ui -zodFile: report ---- - - - -**Source:** `packages/spec/src/ui/report.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'bar' \| 'column' \| 'line' \| 'pie' \| 'donut' \| 'scatter' \| 'funnel'>` | ✅ | Chart type | -| **title** | `string` | optional | | -| **showLegend** | `boolean` | optional | | -| **xAxis** | `string` | ✅ | Grouping field for X-Axis | -| **yAxis** | `string` | ✅ | Summary field for Y-Axis | - -## TypeScript Usage - -```typescript -import { ReportChartSchema } from '@objectstack/spec/ui'; -import type { ReportChart } from '@objectstack/spec/ui'; - -// Validate data -const result = ReportChartSchema.parse(data); - -// Type-safe usage -const myReportChart: ReportChart = { - type: 'bar', - xAxis: 'example', - yAxis: 'example' -}; -``` - diff --git a/content/docs/references/ui/report/ReportColumn.mdx b/content/docs/references/ui/report/ReportColumn.mdx deleted file mode 100644 index 5b2223fa6..000000000 --- a/content/docs/references/ui/report/ReportColumn.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ReportColumn -description: ReportColumn Schema Reference -category: ui -zodFile: report ---- - - - -**Source:** `packages/spec/src/ui/report.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | Field name | -| **label** | `string` | optional | Override label | -| **aggregate** | `Enum<'sum' \| 'avg' \| 'max' \| 'min' \| 'count' \| 'unique'>` | optional | Aggregation function | - -## TypeScript Usage - -```typescript -import { ReportColumnSchema } from '@objectstack/spec/ui'; -import type { ReportColumn } from '@objectstack/spec/ui'; - -// Validate data -const result = ReportColumnSchema.parse(data); - -// Type-safe usage -const myReportColumn: ReportColumn = { - field: 'example' -}; -``` - diff --git a/content/docs/references/ui/report/ReportGrouping.mdx b/content/docs/references/ui/report/ReportGrouping.mdx deleted file mode 100644 index 46314109e..000000000 --- a/content/docs/references/ui/report/ReportGrouping.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ReportGrouping -description: ReportGrouping Schema Reference -category: ui -zodFile: report ---- - - - -**Source:** `packages/spec/src/ui/report.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | Field to group by | -| **sortOrder** | `Enum<'asc' \| 'desc'>` | optional | | -| **dateGranularity** | `Enum<'day' \| 'week' \| 'month' \| 'quarter' \| 'year'>` | optional | For date fields | - -## TypeScript Usage - -```typescript -import { ReportGroupingSchema } from '@objectstack/spec/ui'; -import type { ReportGrouping } from '@objectstack/spec/ui'; - -// Validate data -const result = ReportGroupingSchema.parse(data); - -// Type-safe usage -const myReportGrouping: ReportGrouping = { - field: 'example' -}; -``` - diff --git a/content/docs/references/ui/report/ReportType.mdx b/content/docs/references/ui/report/ReportType.mdx deleted file mode 100644 index d33132c72..000000000 --- a/content/docs/references/ui/report/ReportType.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: ReportType -description: ReportType Schema Reference -category: ui -zodFile: report ---- - - - -**Source:** `packages/spec/src/ui/report.zod.ts` - - -## Allowed Values - -* `tabular` -* `summary` -* `matrix` -* `joined` - -## TypeScript Usage - -```typescript -import { ReportType } from '@objectstack/spec/ui'; - -// Type-safe enum value -const value: ReportType = 'tabular'; -``` - diff --git a/content/docs/references/ui/report/meta.json b/content/docs/references/ui/report/meta.json deleted file mode 100644 index 09ce8c366..000000000 --- a/content/docs/references/ui/report/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Report" -} \ No newline at end of file diff --git a/content/docs/references/ui/theme.mdx b/content/docs/references/ui/theme.mdx new file mode 100644 index 000000000..d79985533 --- /dev/null +++ b/content/docs/references/ui/theme.mdx @@ -0,0 +1,197 @@ +--- +title: Theme +description: Theme protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Theme + + +**Source:** `packages/spec/src/ui/theme.zod.ts` + + +## TypeScript Usage + +```typescript +import { AnimationSchema, BorderRadiusSchema, BreakpointsSchema, ColorPaletteSchema, ShadowSchema, SpacingSchema, ThemeSchema, ThemeModeSchema, TypographySchema, ZIndexSchema } from '@objectstack/spec/ui'; +import type { Animation, BorderRadius, Breakpoints, ColorPalette, Shadow, Spacing, Theme, ThemeMode, Typography, ZIndex } from '@objectstack/spec/ui'; + +// Validate data +const result = AnimationSchema.parse(data); +``` + +--- + +## Animation + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **duration** | `object` | optional | | +| **timing** | `object` | optional | | + +--- + +## BorderRadius + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **none** | `string` | optional | No border radius (0) | +| **sm** | `string` | optional | Small border radius (e.g., 0.125rem) | +| **base** | `string` | optional | Base border radius (e.g., 0.25rem) | +| **md** | `string` | optional | Medium border radius (e.g., 0.375rem) | +| **lg** | `string` | optional | Large border radius (e.g., 0.5rem) | +| **xl** | `string` | optional | Extra large border radius (e.g., 0.75rem) | +| **2xl** | `string` | optional | 2X large border radius (e.g., 1rem) | +| **full** | `string` | optional | Full border radius (50%) | + +--- + +## Breakpoints + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **xs** | `string` | optional | Extra small breakpoint (e.g., 480px) | +| **sm** | `string` | optional | Small breakpoint (e.g., 640px) | +| **md** | `string` | optional | Medium breakpoint (e.g., 768px) | +| **lg** | `string` | optional | Large breakpoint (e.g., 1024px) | +| **xl** | `string` | optional | Extra large breakpoint (e.g., 1280px) | +| **2xl** | `string` | optional | 2X large breakpoint (e.g., 1536px) | + +--- + +## ColorPalette + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **primary** | `string` | ✅ | Primary brand color (hex, rgb, or hsl) | +| **secondary** | `string` | optional | Secondary brand color | +| **accent** | `string` | optional | Accent color for highlights | +| **success** | `string` | optional | Success state color (default: green) | +| **warning** | `string` | optional | Warning state color (default: yellow) | +| **error** | `string` | optional | Error state color (default: red) | +| **info** | `string` | optional | Info state color (default: blue) | +| **background** | `string` | optional | Background color | +| **surface** | `string` | optional | Surface/card background color | +| **text** | `string` | optional | Primary text color | +| **textSecondary** | `string` | optional | Secondary text color | +| **border** | `string` | optional | Border color | +| **disabled** | `string` | optional | Disabled state color | +| **primaryLight** | `string` | optional | Lighter shade of primary | +| **primaryDark** | `string` | optional | Darker shade of primary | +| **secondaryLight** | `string` | optional | Lighter shade of secondary | +| **secondaryDark** | `string` | optional | Darker shade of secondary | + +--- + +## Shadow + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **none** | `string` | optional | No shadow | +| **sm** | `string` | optional | Small shadow | +| **base** | `string` | optional | Base shadow | +| **md** | `string` | optional | Medium shadow | +| **lg** | `string` | optional | Large shadow | +| **xl** | `string` | optional | Extra large shadow | +| **2xl** | `string` | optional | 2X large shadow | +| **inner** | `string` | optional | Inner shadow (inset) | + +--- + +## Spacing + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **0** | `string` | optional | 0 spacing (0) | +| **1** | `string` | optional | Spacing unit 1 (e.g., 0.25rem) | +| **2** | `string` | optional | Spacing unit 2 (e.g., 0.5rem) | +| **3** | `string` | optional | Spacing unit 3 (e.g., 0.75rem) | +| **4** | `string` | optional | Spacing unit 4 (e.g., 1rem) | +| **5** | `string` | optional | Spacing unit 5 (e.g., 1.25rem) | +| **6** | `string` | optional | Spacing unit 6 (e.g., 1.5rem) | +| **8** | `string` | optional | Spacing unit 8 (e.g., 2rem) | +| **10** | `string` | optional | Spacing unit 10 (e.g., 2.5rem) | +| **12** | `string` | optional | Spacing unit 12 (e.g., 3rem) | +| **16** | `string` | optional | Spacing unit 16 (e.g., 4rem) | +| **20** | `string` | optional | Spacing unit 20 (e.g., 5rem) | +| **24** | `string` | optional | Spacing unit 24 (e.g., 6rem) | + +--- + +## Theme + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Unique theme identifier (snake_case) | +| **label** | `string` | ✅ | Human-readable theme name | +| **description** | `string` | optional | Theme description | +| **mode** | `Enum<'light' \| 'dark' \| 'auto'>` | optional | Theme mode (light, dark, or auto) | +| **colors** | `object` | ✅ | Color palette configuration | +| **typography** | `object` | optional | Typography settings | +| **spacing** | `object` | optional | Spacing scale | +| **borderRadius** | `object` | optional | Border radius scale | +| **shadows** | `object` | optional | Box shadow effects | +| **breakpoints** | `object` | optional | Responsive breakpoints | +| **animation** | `object` | optional | Animation settings | +| **zIndex** | `object` | optional | Z-index scale for layering | +| **customVars** | `Record` | optional | Custom CSS variables (key-value pairs) | +| **logo** | `object` | optional | Logo assets | +| **extends** | `string` | optional | Base theme to extend from | + +--- + +## ThemeMode + +### Allowed Values + +* `light` +* `dark` +* `auto` + +--- + +## Typography + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **fontFamily** | `object` | optional | | +| **fontSize** | `object` | optional | | +| **fontWeight** | `object` | optional | | +| **lineHeight** | `object` | optional | | +| **letterSpacing** | `object` | optional | | + +--- + +## ZIndex + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **base** | `number` | optional | Base z-index (e.g., 0) | +| **dropdown** | `number` | optional | Dropdown z-index (e.g., 1000) | +| **sticky** | `number` | optional | Sticky z-index (e.g., 1020) | +| **fixed** | `number` | optional | Fixed z-index (e.g., 1030) | +| **modalBackdrop** | `number` | optional | Modal backdrop z-index (e.g., 1040) | +| **modal** | `number` | optional | Modal z-index (e.g., 1050) | +| **popover** | `number` | optional | Popover z-index (e.g., 1060) | +| **tooltip** | `number` | optional | Tooltip z-index (e.g., 1070) | + diff --git a/content/docs/references/ui/theme/Animation.mdx b/content/docs/references/ui/theme/Animation.mdx deleted file mode 100644 index 86efeba0a..000000000 --- a/content/docs/references/ui/theme/Animation.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Animation -description: Animation Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **duration** | `object` | optional | | -| **timing** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { AnimationSchema } from '@objectstack/spec/ui'; -import type { Animation } from '@objectstack/spec/ui'; - -// Validate data -const result = AnimationSchema.parse(data); - -// Type-safe usage -const myAnimation: Animation = { -}; -``` - diff --git a/content/docs/references/ui/theme/BorderRadius.mdx b/content/docs/references/ui/theme/BorderRadius.mdx deleted file mode 100644 index ff17120a2..000000000 --- a/content/docs/references/ui/theme/BorderRadius.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: BorderRadius -description: BorderRadius Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **none** | `string` | optional | No border radius (0) | -| **sm** | `string` | optional | Small border radius (e.g., 0.125rem) | -| **base** | `string` | optional | Base border radius (e.g., 0.25rem) | -| **md** | `string` | optional | Medium border radius (e.g., 0.375rem) | -| **lg** | `string` | optional | Large border radius (e.g., 0.5rem) | -| **xl** | `string` | optional | Extra large border radius (e.g., 0.75rem) | -| **2xl** | `string` | optional | 2X large border radius (e.g., 1rem) | -| **full** | `string` | optional | Full border radius (50%) | - -## TypeScript Usage - -```typescript -import { BorderRadiusSchema } from '@objectstack/spec/ui'; -import type { BorderRadius } from '@objectstack/spec/ui'; - -// Validate data -const result = BorderRadiusSchema.parse(data); - -// Type-safe usage -const myBorderRadius: BorderRadius = { -}; -``` - diff --git a/content/docs/references/ui/theme/Breakpoints.mdx b/content/docs/references/ui/theme/Breakpoints.mdx deleted file mode 100644 index 8bb0e9bf5..000000000 --- a/content/docs/references/ui/theme/Breakpoints.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Breakpoints -description: Breakpoints Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **xs** | `string` | optional | Extra small breakpoint (e.g., 480px) | -| **sm** | `string` | optional | Small breakpoint (e.g., 640px) | -| **md** | `string` | optional | Medium breakpoint (e.g., 768px) | -| **lg** | `string` | optional | Large breakpoint (e.g., 1024px) | -| **xl** | `string` | optional | Extra large breakpoint (e.g., 1280px) | -| **2xl** | `string` | optional | 2X large breakpoint (e.g., 1536px) | - -## TypeScript Usage - -```typescript -import { BreakpointsSchema } from '@objectstack/spec/ui'; -import type { Breakpoints } from '@objectstack/spec/ui'; - -// Validate data -const result = BreakpointsSchema.parse(data); - -// Type-safe usage -const myBreakpoints: Breakpoints = { -}; -``` - diff --git a/content/docs/references/ui/theme/ColorPalette.mdx b/content/docs/references/ui/theme/ColorPalette.mdx deleted file mode 100644 index e67839758..000000000 --- a/content/docs/references/ui/theme/ColorPalette.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ColorPalette -description: ColorPalette Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **primary** | `string` | ✅ | Primary brand color (hex, rgb, or hsl) | -| **secondary** | `string` | optional | Secondary brand color | -| **accent** | `string` | optional | Accent color for highlights | -| **success** | `string` | optional | Success state color (default: green) | -| **warning** | `string` | optional | Warning state color (default: yellow) | -| **error** | `string` | optional | Error state color (default: red) | -| **info** | `string` | optional | Info state color (default: blue) | -| **background** | `string` | optional | Background color | -| **surface** | `string` | optional | Surface/card background color | -| **text** | `string` | optional | Primary text color | -| **textSecondary** | `string` | optional | Secondary text color | -| **border** | `string` | optional | Border color | -| **disabled** | `string` | optional | Disabled state color | -| **primaryLight** | `string` | optional | Lighter shade of primary | -| **primaryDark** | `string` | optional | Darker shade of primary | -| **secondaryLight** | `string` | optional | Lighter shade of secondary | -| **secondaryDark** | `string` | optional | Darker shade of secondary | - -## TypeScript Usage - -```typescript -import { ColorPaletteSchema } from '@objectstack/spec/ui'; -import type { ColorPalette } from '@objectstack/spec/ui'; - -// Validate data -const result = ColorPaletteSchema.parse(data); - -// Type-safe usage -const myColorPalette: ColorPalette = { - primary: 'example' -}; -``` - diff --git a/content/docs/references/ui/theme/Shadow.mdx b/content/docs/references/ui/theme/Shadow.mdx deleted file mode 100644 index 71bdd00de..000000000 --- a/content/docs/references/ui/theme/Shadow.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Shadow -description: Shadow Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **none** | `string` | optional | No shadow | -| **sm** | `string` | optional | Small shadow | -| **base** | `string` | optional | Base shadow | -| **md** | `string` | optional | Medium shadow | -| **lg** | `string` | optional | Large shadow | -| **xl** | `string` | optional | Extra large shadow | -| **2xl** | `string` | optional | 2X large shadow | -| **inner** | `string` | optional | Inner shadow (inset) | - -## TypeScript Usage - -```typescript -import { ShadowSchema } from '@objectstack/spec/ui'; -import type { Shadow } from '@objectstack/spec/ui'; - -// Validate data -const result = ShadowSchema.parse(data); - -// Type-safe usage -const myShadow: Shadow = { -}; -``` - diff --git a/content/docs/references/ui/theme/Spacing.mdx b/content/docs/references/ui/theme/Spacing.mdx deleted file mode 100644 index 06eadc572..000000000 --- a/content/docs/references/ui/theme/Spacing.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Spacing -description: Spacing Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **0** | `string` | optional | 0 spacing (0) | -| **1** | `string` | optional | Spacing unit 1 (e.g., 0.25rem) | -| **2** | `string` | optional | Spacing unit 2 (e.g., 0.5rem) | -| **3** | `string` | optional | Spacing unit 3 (e.g., 0.75rem) | -| **4** | `string` | optional | Spacing unit 4 (e.g., 1rem) | -| **5** | `string` | optional | Spacing unit 5 (e.g., 1.25rem) | -| **6** | `string` | optional | Spacing unit 6 (e.g., 1.5rem) | -| **8** | `string` | optional | Spacing unit 8 (e.g., 2rem) | -| **10** | `string` | optional | Spacing unit 10 (e.g., 2.5rem) | -| **12** | `string` | optional | Spacing unit 12 (e.g., 3rem) | -| **16** | `string` | optional | Spacing unit 16 (e.g., 4rem) | -| **20** | `string` | optional | Spacing unit 20 (e.g., 5rem) | -| **24** | `string` | optional | Spacing unit 24 (e.g., 6rem) | - -## TypeScript Usage - -```typescript -import { SpacingSchema } from '@objectstack/spec/ui'; -import type { Spacing } from '@objectstack/spec/ui'; - -// Validate data -const result = SpacingSchema.parse(data); - -// Type-safe usage -const mySpacing: Spacing = { -}; -``` - diff --git a/content/docs/references/ui/theme/Theme.mdx b/content/docs/references/ui/theme/Theme.mdx deleted file mode 100644 index 4a663cc26..000000000 --- a/content/docs/references/ui/theme/Theme.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Theme -description: Theme Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Unique theme identifier (snake_case) | -| **label** | `string` | ✅ | Human-readable theme name | -| **description** | `string` | optional | Theme description | -| **mode** | `Enum<'light' \| 'dark' \| 'auto'>` | optional | Theme mode (light, dark, or auto) | -| **colors** | `object` | ✅ | Color palette configuration | -| **typography** | `object` | optional | Typography settings | -| **spacing** | `object` | optional | Spacing scale | -| **borderRadius** | `object` | optional | Border radius scale | -| **shadows** | `object` | optional | Box shadow effects | -| **breakpoints** | `object` | optional | Responsive breakpoints | -| **animation** | `object` | optional | Animation settings | -| **zIndex** | `object` | optional | Z-index scale for layering | -| **customVars** | `Record` | optional | Custom CSS variables (key-value pairs) | -| **logo** | `object` | optional | Logo assets | -| **extends** | `string` | optional | Base theme to extend from | - -## TypeScript Usage - -```typescript -import { ThemeSchema } from '@objectstack/spec/ui'; -import type { Theme } from '@objectstack/spec/ui'; - -// Validate data -const result = ThemeSchema.parse(data); - -// Type-safe usage -const myTheme: Theme = { - name: 'name', - label: 'example', - colors: {} -}; -``` - diff --git a/content/docs/references/ui/theme/ThemeMode.mdx b/content/docs/references/ui/theme/ThemeMode.mdx deleted file mode 100644 index c8c926c66..000000000 --- a/content/docs/references/ui/theme/ThemeMode.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: ThemeMode -description: ThemeMode Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Allowed Values - -* `light` -* `dark` -* `auto` - -## TypeScript Usage - -```typescript -import { ThemeMode } from '@objectstack/spec/ui'; - -// Type-safe enum value -const value: ThemeMode = 'light'; -``` - diff --git a/content/docs/references/ui/theme/Typography.mdx b/content/docs/references/ui/theme/Typography.mdx deleted file mode 100644 index d2c3b180c..000000000 --- a/content/docs/references/ui/theme/Typography.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Typography -description: Typography Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **fontFamily** | `object` | optional | | -| **fontSize** | `object` | optional | | -| **fontWeight** | `object` | optional | | -| **lineHeight** | `object` | optional | | -| **letterSpacing** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { TypographySchema } from '@objectstack/spec/ui'; -import type { Typography } from '@objectstack/spec/ui'; - -// Validate data -const result = TypographySchema.parse(data); - -// Type-safe usage -const myTypography: Typography = { -}; -``` - diff --git a/content/docs/references/ui/theme/ZIndex.mdx b/content/docs/references/ui/theme/ZIndex.mdx deleted file mode 100644 index 52003a3f1..000000000 --- a/content/docs/references/ui/theme/ZIndex.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ZIndex -description: ZIndex Schema Reference -category: ui -zodFile: theme ---- - - - -**Source:** `packages/spec/src/ui/theme.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **base** | `number` | optional | Base z-index (e.g., 0) | -| **dropdown** | `number` | optional | Dropdown z-index (e.g., 1000) | -| **sticky** | `number` | optional | Sticky z-index (e.g., 1020) | -| **fixed** | `number` | optional | Fixed z-index (e.g., 1030) | -| **modalBackdrop** | `number` | optional | Modal backdrop z-index (e.g., 1040) | -| **modal** | `number` | optional | Modal z-index (e.g., 1050) | -| **popover** | `number` | optional | Popover z-index (e.g., 1060) | -| **tooltip** | `number` | optional | Tooltip z-index (e.g., 1070) | - -## TypeScript Usage - -```typescript -import { ZIndexSchema } from '@objectstack/spec/ui'; -import type { ZIndex } from '@objectstack/spec/ui'; - -// Validate data -const result = ZIndexSchema.parse(data); - -// Type-safe usage -const myZIndex: ZIndex = { -}; -``` - diff --git a/content/docs/references/ui/theme/meta.json b/content/docs/references/ui/theme/meta.json deleted file mode 100644 index 23efbd7e3..000000000 --- a/content/docs/references/ui/theme/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Theme" -} \ No newline at end of file diff --git a/content/docs/references/ui/view.mdx b/content/docs/references/ui/view.mdx new file mode 100644 index 000000000..28e3d074d --- /dev/null +++ b/content/docs/references/ui/view.mdx @@ -0,0 +1,217 @@ +--- +title: View +description: View protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# View + + +**Source:** `packages/spec/src/ui/view.zod.ts` + + +## TypeScript Usage + +```typescript +import { CalendarConfigSchema, FormFieldSchema, FormSectionSchema, FormViewSchema, GanttConfigSchema, HttpMethodSchema, HttpRequestSchema, KanbanConfigSchema, ListColumnSchema, ListViewSchema, PaginationConfigSchema, SelectionConfigSchema, ViewSchema, ViewDataSchema } from '@objectstack/spec/ui'; +import type { CalendarConfig, FormField, FormSection, FormView, GanttConfig, HttpMethod, HttpRequest, KanbanConfig, ListColumn, ListView, PaginationConfig, SelectionConfig, View, ViewData } from '@objectstack/spec/ui'; + +// Validate data +const result = CalendarConfigSchema.parse(data); +``` + +--- + +## CalendarConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **startDateField** | `string` | ✅ | | +| **endDateField** | `string` | optional | | +| **titleField** | `string` | ✅ | | +| **colorField** | `string` | optional | | + +--- + +## FormField + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | Field name (snake_case) | +| **label** | `string` | optional | Display label override | +| **placeholder** | `string` | optional | Placeholder text | +| **helpText** | `string` | optional | Help/hint text | +| **readonly** | `boolean` | optional | Read-only override | +| **required** | `boolean` | optional | Required override | +| **hidden** | `boolean` | optional | Hidden override | +| **colSpan** | `integer` | optional | Column span in grid layout (1-4) | +| **widget** | `string` | optional | Custom widget/component name | +| **dependsOn** | `string` | optional | Parent field name for cascading | +| **visibleOn** | `string` | optional | Visibility condition expression | + +--- + +## FormSection + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **label** | `string` | optional | | +| **collapsible** | `boolean` | optional | | +| **collapsed** | `boolean` | optional | | +| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | | +| **fields** | `string \| object[]` | ✅ | | + +--- + +## FormView + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'simple' \| 'tabbed' \| 'wizard' \| 'split' \| 'drawer' \| 'modal'>` | optional | | +| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) | +| **sections** | `object[]` | optional | | +| **groups** | `object[]` | optional | | + +--- + +## GanttConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **startDateField** | `string` | ✅ | | +| **endDateField** | `string` | ✅ | | +| **titleField** | `string` | ✅ | | +| **progressField** | `string` | optional | | +| **dependenciesField** | `string` | optional | | + +--- + +## HttpMethod + +### Allowed Values + +* `GET` +* `POST` +* `PUT` +* `PATCH` +* `DELETE` + +--- + +## HttpRequest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **url** | `string` | ✅ | API endpoint URL | +| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'>` | optional | HTTP method | +| **headers** | `Record` | optional | Custom HTTP headers | +| **params** | `Record` | optional | Query parameters | +| **body** | `any` | optional | Request body for POST/PUT/PATCH | + +--- + +## KanbanConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **groupByField** | `string` | ✅ | Field to group columns by (usually status/select) | +| **summarizeField** | `string` | optional | Field to sum at top of column (e.g. amount) | +| **columns** | `string[]` | ✅ | Fields to show on cards | + +--- + +## ListColumn + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **field** | `string` | ✅ | Field name (snake_case) | +| **label** | `string` | optional | Display label override | +| **width** | `number` | optional | Column width in pixels | +| **align** | `Enum<'left' \| 'center' \| 'right'>` | optional | Text alignment | +| **hidden** | `boolean` | optional | Hide column by default | +| **sortable** | `boolean` | optional | Allow sorting by this column | +| **resizable** | `boolean` | optional | Allow resizing this column | +| **wrap** | `boolean` | optional | Allow text wrapping | +| **type** | `string` | optional | Renderer type override (e.g., "currency", "date") | + +--- + +## ListView + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | optional | Internal view name (lowercase snake_case) | +| **label** | `string` | optional | | +| **type** | `Enum<'grid' \| 'spreadsheet' \| 'kanban' \| 'gallery' \| 'calendar' \| 'timeline' \| 'gantt' \| 'map'>` | optional | | +| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) | +| **columns** | `string[] \| object[]` | ✅ | Fields to display as columns | +| **filter** | `any[]` | optional | Filter criteria (JSON Rules) | +| **sort** | `string \| object[]` | optional | | +| **searchableFields** | `string[]` | optional | Fields enabled for search | +| **resizable** | `boolean` | optional | Enable column resizing | +| **striped** | `boolean` | optional | Striped row styling | +| **bordered** | `boolean` | optional | Show borders | +| **selection** | `object` | optional | Row selection configuration | +| **pagination** | `object` | optional | Pagination configuration | +| **kanban** | `object` | optional | | +| **calendar** | `object` | optional | | +| **gantt** | `object` | optional | | + +--- + +## PaginationConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **pageSize** | `integer` | optional | Number of records per page | +| **pageSizeOptions** | `integer[]` | optional | Available page size options | + +--- + +## SelectionConfig + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **type** | `Enum<'none' \| 'single' \| 'multiple'>` | optional | Selection mode | + +--- + +## View + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **list** | `object` | optional | | +| **form** | `object` | optional | | +| **listViews** | `Record` | optional | Additional named list views | +| **formViews** | `Record` | optional | Additional named form views | + +--- + +## ViewData + diff --git a/content/docs/references/ui/view/CalendarConfig.mdx b/content/docs/references/ui/view/CalendarConfig.mdx deleted file mode 100644 index 50b508a4d..000000000 --- a/content/docs/references/ui/view/CalendarConfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CalendarConfig -description: CalendarConfig Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **startDateField** | `string` | ✅ | | -| **endDateField** | `string` | optional | | -| **titleField** | `string` | ✅ | | -| **colorField** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { CalendarConfigSchema } from '@objectstack/spec/ui'; -import type { CalendarConfig } from '@objectstack/spec/ui'; - -// Validate data -const result = CalendarConfigSchema.parse(data); - -// Type-safe usage -const myCalendarConfig: CalendarConfig = { - startDateField: 'example', - titleField: 'example' -}; -``` - diff --git a/content/docs/references/ui/view/FormField.mdx b/content/docs/references/ui/view/FormField.mdx deleted file mode 100644 index 3433beed8..000000000 --- a/content/docs/references/ui/view/FormField.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FormField -description: FormField Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | Field name (snake_case) | -| **label** | `string` | optional | Display label override | -| **placeholder** | `string` | optional | Placeholder text | -| **helpText** | `string` | optional | Help/hint text | -| **readonly** | `boolean` | optional | Read-only override | -| **required** | `boolean` | optional | Required override | -| **hidden** | `boolean` | optional | Hidden override | -| **colSpan** | `integer` | optional | Column span in grid layout (1-4) | -| **widget** | `string` | optional | Custom widget/component name | -| **dependsOn** | `string` | optional | Parent field name for cascading | -| **visibleOn** | `string` | optional | Visibility condition expression | - -## TypeScript Usage - -```typescript -import { FormFieldSchema } from '@objectstack/spec/ui'; -import type { FormField } from '@objectstack/spec/ui'; - -// Validate data -const result = FormFieldSchema.parse(data); - -// Type-safe usage -const myFormField: FormField = { - field: 'example' -}; -``` - diff --git a/content/docs/references/ui/view/FormSection.mdx b/content/docs/references/ui/view/FormSection.mdx deleted file mode 100644 index 20de614ff..000000000 --- a/content/docs/references/ui/view/FormSection.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FormSection -description: FormSection Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **label** | `string` | optional | | -| **collapsible** | `boolean` | optional | | -| **collapsed** | `boolean` | optional | | -| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | | -| **fields** | `string \| object[]` | ✅ | | - -## TypeScript Usage - -```typescript -import { FormSectionSchema } from '@objectstack/spec/ui'; -import type { FormSection } from '@objectstack/spec/ui'; - -// Validate data -const result = FormSectionSchema.parse(data); - -// Type-safe usage -const myFormSection: FormSection = { - fields: [] -}; -``` - diff --git a/content/docs/references/ui/view/FormView.mdx b/content/docs/references/ui/view/FormView.mdx deleted file mode 100644 index fca3fb43d..000000000 --- a/content/docs/references/ui/view/FormView.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FormView -description: FormView Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'simple' \| 'tabbed' \| 'wizard' \| 'split' \| 'drawer' \| 'modal'>` | optional | | -| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) | -| **sections** | `object[]` | optional | | -| **groups** | `object[]` | optional | | - -## TypeScript Usage - -```typescript -import { FormViewSchema } from '@objectstack/spec/ui'; -import type { FormView } from '@objectstack/spec/ui'; - -// Validate data -const result = FormViewSchema.parse(data); - -// Type-safe usage -const myFormView: FormView = { -}; -``` - diff --git a/content/docs/references/ui/view/GanttConfig.mdx b/content/docs/references/ui/view/GanttConfig.mdx deleted file mode 100644 index 64fe69c67..000000000 --- a/content/docs/references/ui/view/GanttConfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: GanttConfig -description: GanttConfig Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **startDateField** | `string` | ✅ | | -| **endDateField** | `string` | ✅ | | -| **titleField** | `string` | ✅ | | -| **progressField** | `string` | optional | | -| **dependenciesField** | `string` | optional | | - -## TypeScript Usage - -```typescript -import { GanttConfigSchema } from '@objectstack/spec/ui'; -import type { GanttConfig } from '@objectstack/spec/ui'; - -// Validate data -const result = GanttConfigSchema.parse(data); - -// Type-safe usage -const myGanttConfig: GanttConfig = { - startDateField: 'example', - endDateField: 'example', - titleField: 'example' -}; -``` - diff --git a/content/docs/references/ui/view/HttpMethod.mdx b/content/docs/references/ui/view/HttpMethod.mdx deleted file mode 100644 index 73939ba9b..000000000 --- a/content/docs/references/ui/view/HttpMethod.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: HttpMethod -description: HttpMethod Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Allowed Values - -* `GET` -* `POST` -* `PUT` -* `PATCH` -* `DELETE` - -## TypeScript Usage - -```typescript -import { HttpMethod } from '@objectstack/spec/ui'; - -// Type-safe enum value -const value: HttpMethod = 'GET'; -``` - diff --git a/content/docs/references/ui/view/HttpRequest.mdx b/content/docs/references/ui/view/HttpRequest.mdx deleted file mode 100644 index 93cee31a7..000000000 --- a/content/docs/references/ui/view/HttpRequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: HttpRequest -description: HttpRequest Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **url** | `string` | ✅ | API endpoint URL | -| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'>` | optional | HTTP method | -| **headers** | `Record` | optional | Custom HTTP headers | -| **params** | `Record` | optional | Query parameters | -| **body** | `any` | optional | Request body for POST/PUT/PATCH | - -## TypeScript Usage - -```typescript -import { HttpRequestSchema } from '@objectstack/spec/ui'; -import type { HttpRequest } from '@objectstack/spec/ui'; - -// Validate data -const result = HttpRequestSchema.parse(data); - -// Type-safe usage -const myHttpRequest: HttpRequest = { - url: 'https://example.com' -}; -``` - diff --git a/content/docs/references/ui/view/KanbanConfig.mdx b/content/docs/references/ui/view/KanbanConfig.mdx deleted file mode 100644 index f57159b62..000000000 --- a/content/docs/references/ui/view/KanbanConfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: KanbanConfig -description: KanbanConfig Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **groupByField** | `string` | ✅ | Field to group columns by (usually status/select) | -| **summarizeField** | `string` | optional | Field to sum at top of column (e.g. amount) | -| **columns** | `string[]` | ✅ | Fields to show on cards | - -## TypeScript Usage - -```typescript -import { KanbanConfigSchema } from '@objectstack/spec/ui'; -import type { KanbanConfig } from '@objectstack/spec/ui'; - -// Validate data -const result = KanbanConfigSchema.parse(data); - -// Type-safe usage -const myKanbanConfig: KanbanConfig = { - groupByField: 'example', - columns: [] -}; -``` - diff --git a/content/docs/references/ui/view/ListColumn.mdx b/content/docs/references/ui/view/ListColumn.mdx deleted file mode 100644 index 6287282c5..000000000 --- a/content/docs/references/ui/view/ListColumn.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ListColumn -description: ListColumn Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **field** | `string` | ✅ | Field name (snake_case) | -| **label** | `string` | optional | Display label override | -| **width** | `number` | optional | Column width in pixels | -| **align** | `Enum<'left' \| 'center' \| 'right'>` | optional | Text alignment | -| **hidden** | `boolean` | optional | Hide column by default | -| **sortable** | `boolean` | optional | Allow sorting by this column | -| **resizable** | `boolean` | optional | Allow resizing this column | -| **wrap** | `boolean` | optional | Allow text wrapping | -| **type** | `string` | optional | Renderer type override (e.g., "currency", "date") | - -## TypeScript Usage - -```typescript -import { ListColumnSchema } from '@objectstack/spec/ui'; -import type { ListColumn } from '@objectstack/spec/ui'; - -// Validate data -const result = ListColumnSchema.parse(data); - -// Type-safe usage -const myListColumn: ListColumn = { - field: 'example' -}; -``` - diff --git a/content/docs/references/ui/view/ListView.mdx b/content/docs/references/ui/view/ListView.mdx deleted file mode 100644 index 8f446cd9d..000000000 --- a/content/docs/references/ui/view/ListView.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ListView -description: ListView Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | optional | Internal view name (lowercase snake_case) | -| **label** | `string` | optional | | -| **type** | `Enum<'grid' \| 'spreadsheet' \| 'kanban' \| 'gallery' \| 'calendar' \| 'timeline' \| 'gantt' \| 'map'>` | optional | | -| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) | -| **columns** | `string[] \| object[]` | ✅ | Fields to display as columns | -| **filter** | `any[]` | optional | Filter criteria (JSON Rules) | -| **sort** | `string \| object[]` | optional | | -| **searchableFields** | `string[]` | optional | Fields enabled for search | -| **resizable** | `boolean` | optional | Enable column resizing | -| **striped** | `boolean` | optional | Striped row styling | -| **bordered** | `boolean` | optional | Show borders | -| **selection** | `object` | optional | Row selection configuration | -| **pagination** | `object` | optional | Pagination configuration | -| **kanban** | `object` | optional | | -| **calendar** | `object` | optional | | -| **gantt** | `object` | optional | | - -## TypeScript Usage - -```typescript -import { ListViewSchema } from '@objectstack/spec/ui'; -import type { ListView } from '@objectstack/spec/ui'; - -// Validate data -const result = ListViewSchema.parse(data); - -// Type-safe usage -const myListView: ListView = { - columns: null -}; -``` - diff --git a/content/docs/references/ui/view/PaginationConfig.mdx b/content/docs/references/ui/view/PaginationConfig.mdx deleted file mode 100644 index 6c8d29a83..000000000 --- a/content/docs/references/ui/view/PaginationConfig.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: PaginationConfig -description: PaginationConfig Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **pageSize** | `integer` | optional | Number of records per page | -| **pageSizeOptions** | `integer[]` | optional | Available page size options | - -## TypeScript Usage - -```typescript -import { PaginationConfigSchema } from '@objectstack/spec/ui'; -import type { PaginationConfig } from '@objectstack/spec/ui'; - -// Validate data -const result = PaginationConfigSchema.parse(data); - -// Type-safe usage -const myPaginationConfig: PaginationConfig = { -}; -``` - diff --git a/content/docs/references/ui/view/SelectionConfig.mdx b/content/docs/references/ui/view/SelectionConfig.mdx deleted file mode 100644 index 50f9dca3e..000000000 --- a/content/docs/references/ui/view/SelectionConfig.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: SelectionConfig -description: SelectionConfig Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **type** | `Enum<'none' \| 'single' \| 'multiple'>` | optional | Selection mode | - -## TypeScript Usage - -```typescript -import { SelectionConfigSchema } from '@objectstack/spec/ui'; -import type { SelectionConfig } from '@objectstack/spec/ui'; - -// Validate data -const result = SelectionConfigSchema.parse(data); - -// Type-safe usage -const mySelectionConfig: SelectionConfig = { -}; -``` - diff --git a/content/docs/references/ui/view/View.mdx b/content/docs/references/ui/view/View.mdx deleted file mode 100644 index 75ebcf1d4..000000000 --- a/content/docs/references/ui/view/View.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: View -description: View Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **list** | `object` | optional | | -| **form** | `object` | optional | | -| **listViews** | `Record` | optional | Additional named list views | -| **formViews** | `Record` | optional | Additional named form views | - -## TypeScript Usage - -```typescript -import { ViewSchema } from '@objectstack/spec/ui'; -import type { View } from '@objectstack/spec/ui'; - -// Validate data -const result = ViewSchema.parse(data); - -// Type-safe usage -const myView: View = { -}; -``` - diff --git a/content/docs/references/ui/view/ViewData.mdx b/content/docs/references/ui/view/ViewData.mdx deleted file mode 100644 index 3b33b9b6c..000000000 --- a/content/docs/references/ui/view/ViewData.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: ViewData -description: ViewData Schema Reference -category: ui -zodFile: view ---- - - - -**Source:** `packages/spec/src/ui/view.zod.ts` - - diff --git a/content/docs/references/ui/view/meta.json b/content/docs/references/ui/view/meta.json deleted file mode 100644 index efcfa4d25..000000000 --- a/content/docs/references/ui/view/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "View" -} \ No newline at end of file diff --git a/content/docs/references/ui/widget.mdx b/content/docs/references/ui/widget.mdx new file mode 100644 index 000000000..cb65563af --- /dev/null +++ b/content/docs/references/ui/widget.mdx @@ -0,0 +1,114 @@ +--- +title: Widget +description: Widget protocol schemas +--- + +import { Card, Cards } from 'fumadocs-ui/components/card'; +import { Callout } from 'fumadocs-ui/components/callout'; + +# Widget + + +**Source:** `packages/spec/src/ui/widget.zod.ts` + + +## TypeScript Usage + +```typescript +import { FieldWidgetPropsSchema, WidgetEventSchema, WidgetLifecycleSchema, WidgetManifestSchema, WidgetPropertySchema } from '@objectstack/spec/ui'; +import type { FieldWidgetProps, WidgetEvent, WidgetLifecycle, WidgetManifest, WidgetProperty } from '@objectstack/spec/ui'; + +// Validate data +const result = FieldWidgetPropsSchema.parse(data); +``` + +--- + +## FieldWidgetProps + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **value** | `any` | optional | Current field value | +| **readonly** | `boolean` | optional | Read-only mode flag | +| **required** | `boolean` | optional | Required field flag | +| **error** | `string` | optional | Validation error message | +| **field** | `object` | ✅ | Field schema definition | +| **record** | `Record` | optional | Complete record data | +| **options** | `Record` | optional | Custom widget options | + +--- + +## WidgetEvent + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Event name | +| **label** | `string` | optional | Human-readable event label | +| **description** | `string` | optional | Event description and usage | +| **bubbles** | `boolean` | optional | Whether event bubbles | +| **cancelable** | `boolean` | optional | Whether event is cancelable | +| **payload** | `Record` | optional | Event payload schema | + +--- + +## WidgetLifecycle + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **onMount** | `string` | optional | Initialization code when widget mounts | +| **onUpdate** | `string` | optional | Code to run when props change | +| **onUnmount** | `string` | optional | Cleanup code when widget unmounts | +| **onValidate** | `string` | optional | Custom validation logic | +| **onFocus** | `string` | optional | Code to run on focus | +| **onBlur** | `string` | optional | Code to run on blur | +| **onError** | `string` | optional | Error handling code | + +--- + +## WidgetManifest + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Widget identifier (snake_case) | +| **label** | `string` | ✅ | Widget display name | +| **description** | `string` | optional | Widget description | +| **version** | `string` | optional | Widget version (semver) | +| **author** | `string` | optional | Widget author | +| **icon** | `string` | optional | Widget icon | +| **fieldTypes** | `string[]` | optional | Supported field types | +| **category** | `Enum<'input' \| 'display' \| 'picker' \| 'editor' \| 'custom'>` | optional | Widget category | +| **lifecycle** | `object` | optional | Lifecycle hooks | +| **events** | `object[]` | optional | Custom events | +| **properties** | `object[]` | optional | Configuration properties | +| **implementation** | `object` | optional | Widget implementation | +| **dependencies** | `object[]` | optional | Widget dependencies | +| **screenshots** | `string[]` | optional | Screenshot URLs | +| **documentation** | `string` | optional | Documentation URL | +| **license** | `string` | optional | License (SPDX identifier) | +| **tags** | `string[]` | optional | Tags for categorization | + +--- + +## WidgetProperty + +### Properties + +| Property | Type | Required | Description | +| :--- | :--- | :--- | :--- | +| **name** | `string` | ✅ | Property name (camelCase) | +| **label** | `string` | optional | Human-readable label | +| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'array' \| 'object' \| 'function' \| 'any'>` | ✅ | TypeScript type | +| **required** | `boolean` | optional | Whether property is required | +| **default** | `any` | optional | Default value | +| **description** | `string` | optional | Property description | +| **validation** | `Record` | optional | Validation rules | +| **category** | `string` | optional | Property category | + diff --git a/content/docs/references/ui/widget/FieldWidgetProps.mdx b/content/docs/references/ui/widget/FieldWidgetProps.mdx deleted file mode 100644 index 7efa357df..000000000 --- a/content/docs/references/ui/widget/FieldWidgetProps.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: FieldWidgetProps -description: FieldWidgetProps Schema Reference -category: ui -zodFile: widget ---- - - - -**Source:** `packages/spec/src/ui/widget.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **value** | `any` | optional | Current field value | -| **readonly** | `boolean` | optional | Read-only mode flag | -| **required** | `boolean` | optional | Required field flag | -| **error** | `string` | optional | Validation error message | -| **field** | `object` | ✅ | Field schema definition | -| **record** | `Record` | optional | Complete record data | -| **options** | `Record` | optional | Custom widget options | - -## TypeScript Usage - -```typescript -import { FieldWidgetPropsSchema } from '@objectstack/spec/ui'; -import type { FieldWidgetProps } from '@objectstack/spec/ui'; - -// Validate data -const result = FieldWidgetPropsSchema.parse(data); - -// Type-safe usage -const myFieldWidgetProps: FieldWidgetProps = { - field: {} -}; -``` - diff --git a/content/docs/references/ui/widget/WidgetEvent.mdx b/content/docs/references/ui/widget/WidgetEvent.mdx deleted file mode 100644 index 0891ddfa2..000000000 --- a/content/docs/references/ui/widget/WidgetEvent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: WidgetEvent -description: WidgetEvent Schema Reference -category: ui -zodFile: widget ---- - - - -**Source:** `packages/spec/src/ui/widget.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Event name | -| **label** | `string` | optional | Human-readable event label | -| **description** | `string` | optional | Event description and usage | -| **bubbles** | `boolean` | optional | Whether event bubbles | -| **cancelable** | `boolean` | optional | Whether event is cancelable | -| **payload** | `Record` | optional | Event payload schema | - -## TypeScript Usage - -```typescript -import { WidgetEventSchema } from '@objectstack/spec/ui'; -import type { WidgetEvent } from '@objectstack/spec/ui'; - -// Validate data -const result = WidgetEventSchema.parse(data); - -// Type-safe usage -const myWidgetEvent: WidgetEvent = { - name: 'name' -}; -``` - diff --git a/content/docs/references/ui/widget/WidgetLifecycle.mdx b/content/docs/references/ui/widget/WidgetLifecycle.mdx deleted file mode 100644 index 7beea3875..000000000 --- a/content/docs/references/ui/widget/WidgetLifecycle.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: WidgetLifecycle -description: WidgetLifecycle Schema Reference -category: ui -zodFile: widget ---- - - - -**Source:** `packages/spec/src/ui/widget.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **onMount** | `string` | optional | Initialization code when widget mounts | -| **onUpdate** | `string` | optional | Code to run when props change | -| **onUnmount** | `string` | optional | Cleanup code when widget unmounts | -| **onValidate** | `string` | optional | Custom validation logic | -| **onFocus** | `string` | optional | Code to run on focus | -| **onBlur** | `string` | optional | Code to run on blur | -| **onError** | `string` | optional | Error handling code | - -## TypeScript Usage - -```typescript -import { WidgetLifecycleSchema } from '@objectstack/spec/ui'; -import type { WidgetLifecycle } from '@objectstack/spec/ui'; - -// Validate data -const result = WidgetLifecycleSchema.parse(data); - -// Type-safe usage -const myWidgetLifecycle: WidgetLifecycle = { -}; -``` - diff --git a/content/docs/references/ui/widget/WidgetManifest.mdx b/content/docs/references/ui/widget/WidgetManifest.mdx deleted file mode 100644 index 69f9f5dc9..000000000 --- a/content/docs/references/ui/widget/WidgetManifest.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: WidgetManifest -description: WidgetManifest Schema Reference -category: ui -zodFile: widget ---- - - - -**Source:** `packages/spec/src/ui/widget.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Widget identifier (snake_case) | -| **label** | `string` | ✅ | Widget display name | -| **description** | `string` | optional | Widget description | -| **version** | `string` | optional | Widget version (semver) | -| **author** | `string` | optional | Widget author | -| **icon** | `string` | optional | Widget icon | -| **fieldTypes** | `string[]` | optional | Supported field types | -| **category** | `Enum<'input' \| 'display' \| 'picker' \| 'editor' \| 'custom'>` | optional | Widget category | -| **lifecycle** | `object` | optional | Lifecycle hooks | -| **events** | `object[]` | optional | Custom events | -| **properties** | `object[]` | optional | Configuration properties | -| **implementation** | `object` | optional | Widget implementation | -| **dependencies** | `object[]` | optional | Widget dependencies | -| **screenshots** | `string[]` | optional | Screenshot URLs | -| **documentation** | `string` | optional | Documentation URL | -| **license** | `string` | optional | License (SPDX identifier) | -| **tags** | `string[]` | optional | Tags for categorization | - -## TypeScript Usage - -```typescript -import { WidgetManifestSchema } from '@objectstack/spec/ui'; -import type { WidgetManifest } from '@objectstack/spec/ui'; - -// Validate data -const result = WidgetManifestSchema.parse(data); - -// Type-safe usage -const myWidgetManifest: WidgetManifest = { - name: 'name', - label: 'example' -}; -``` - diff --git a/content/docs/references/ui/widget/WidgetProperty.mdx b/content/docs/references/ui/widget/WidgetProperty.mdx deleted file mode 100644 index 5133d59c1..000000000 --- a/content/docs/references/ui/widget/WidgetProperty.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: WidgetProperty -description: WidgetProperty Schema Reference -category: ui -zodFile: widget ---- - - - -**Source:** `packages/spec/src/ui/widget.zod.ts` - - -## Properties - -| Property | Type | Required | Description | -| :--- | :--- | :--- | :--- | -| **name** | `string` | ✅ | Property name (camelCase) | -| **label** | `string` | optional | Human-readable label | -| **type** | `Enum<'string' \| 'number' \| 'boolean' \| 'array' \| 'object' \| 'function' \| 'any'>` | ✅ | TypeScript type | -| **required** | `boolean` | optional | Whether property is required | -| **default** | `any` | optional | Default value | -| **description** | `string` | optional | Property description | -| **validation** | `Record` | optional | Validation rules | -| **category** | `string` | optional | Property category | - -## TypeScript Usage - -```typescript -import { WidgetPropertySchema } from '@objectstack/spec/ui'; -import type { WidgetProperty } from '@objectstack/spec/ui'; - -// Validate data -const result = WidgetPropertySchema.parse(data); - -// Type-safe usage -const myWidgetProperty: WidgetProperty = { - name: 'name', - type: 'string' -}; -``` - diff --git a/content/docs/references/ui/widget/meta.json b/content/docs/references/ui/widget/meta.json deleted file mode 100644 index cbf2edecb..000000000 --- a/content/docs/references/ui/widget/meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "title": "Widget" -} \ No newline at end of file diff --git a/packages/spec/scripts/build-docs.ts b/packages/spec/scripts/build-docs.ts index 432d3ccdf..d13e0b3ec 100644 --- a/packages/spec/scripts/build-docs.ts +++ b/packages/spec/scripts/build-docs.ts @@ -96,30 +96,18 @@ function generateMarkdown(schemaName: string, schema: any, category: string, zod if (!mainDef) return ''; - // Enhanced frontmatter with more metadata - let md = `---\ntitle: ${schemaName}\ndescription: ${mainDef.description || schemaName + ' Schema Reference'}\n`; - md += `category: ${category}\n`; - md += `zodFile: ${zodFile}\n`; - md += `---\n\n`; + let md = ''; - // Add breadcrumb navigation - const categoryTitle = getCategoryTitle(category); - md += `import { Card, Cards } from 'fumadocs-ui/components/card';\n`; - md += `import { Tab, Tabs } from 'fumadocs-ui/components/tabs';\n`; - md += `import { Callout } from 'fumadocs-ui/components/callout';\n\n`; + // Add schema heading + md += `## ${schemaName}\n\n`; // Add description with better formatting if (mainDef.description) { md += `${mainDef.description}\n\n`; } - - // Add source code reference - md += `\n`; - md += `**Source:** \`packages/spec/src/${category}/${zodFile}.zod.ts\`\n`; - md += `\n\n`; if (mainDef.type === 'object' && mainDef.properties) { - md += `## Properties\n\n`; + md += `### Properties\n\n`; md += `| Property | Type | Required | Description |\n`; md += `| :--- | :--- | :--- | :--- |\n`; @@ -135,100 +123,68 @@ function generateMarkdown(schemaName: string, schema: any, category: string, zod md += `| **${key}** | \`${typeStr}\` | ${isReq} | ${desc} |\n`; } - // Add TypeScript usage example - md += `\n## TypeScript Usage\n\n`; - md += `\`\`\`typescript\n`; - md += `import { ${schemaName}Schema } from '@objectstack/spec/${category}';\n`; - md += `import type { ${schemaName} } from '@objectstack/spec/${category}';\n\n`; - md += `// Validate data\n`; - md += `const result = ${schemaName}Schema.parse(data);\n\n`; - md += `// Type-safe usage\n`; - md += `const my${schemaName}: ${schemaName} = {\n`; - - // Generate example based on required fields - const requiredProps = Array.from(required).slice(0, 3); // Show first 3 required fields - requiredProps.forEach((propName, idx) => { - const prop = (mainDef.properties as any)[propName]; - const exampleValue = getExampleValue(prop, propName as string); - const isLast = (idx === requiredProps.length - 1) && (mainDef.required?.length <= 3); - md += ` ${propName}: ${exampleValue}${isLast ? '' : ','}\n`; - }); - - if (mainDef.required?.length > 3) { - md += ` // ... other required fields\n`; - } - - md += `};\n`; - md += `\`\`\`\n\n`; + md += `\n`; } else if (mainDef.type === 'string' && mainDef.enum) { - md += `## Allowed Values\n\n`; + md += `### Allowed Values\n\n`; md += mainDef.enum.map((e: string) => `* \`${e}\``).join('\n'); - md += `\n\n## TypeScript Usage\n\n`; - md += `\`\`\`typescript\n`; - md += `import { ${schemaName} } from '@objectstack/spec/${category}';\n\n`; - md += `// Type-safe enum value\n`; - md += `const value: ${schemaName} = '${mainDef.enum[0]}';\n`; - md += `\`\`\`\n\n`; - } - - // Add "See Also" section with related schemas - const relatedSchemas = findRelatedSchemas(schemaName, mainDef, category); - if (relatedSchemas.length > 0) { - md += `## Related\n\n`; - md += `\n`; - relatedSchemas.forEach(related => { - md += ` \n`; - }); - md += `\n\n`; + md += `\n\n`; } return md; } -// Helper to generate example values for fields -function getExampleValue(prop: any, fieldName: string): string { - if (prop.type === 'string') { - if (prop.enum) return `'${prop.enum[0]}'`; - if (fieldName.includes('name')) return `'${fieldName.replace(/_/g, ' ')}'`; - if (fieldName.includes('email')) return `'user@example.com'`; - if (fieldName.includes('url')) return `'https://example.com'`; - return `'example'`; - } - if (prop.type === 'number') return prop.default !== undefined ? prop.default : '0'; - if (prop.type === 'boolean') return prop.default !== undefined ? String(prop.default) : 'false'; - if (prop.type === 'array') return '[]'; - if (prop.type === 'object') return '{}'; - return 'null'; -} - -// Helper to find related schemas (referenced in properties) -function findRelatedSchemas(schemaName: string, mainDef: any, category: string): Array<{name: string, zodFile: string}> { - const related: Array<{name: string, zodFile: string}> = []; - const seen = new Set(); +// New function to generate combined documentation for all schemas in a zod file +function generateZodFileMarkdown(zodFile: string, schemas: Array<{name: string, content: any}>, category: string): string { + const zodTitle = zodFile.split('-').map(w => w.charAt(0).toUpperCase() + w.slice(1)).join(' '); - if (mainDef.properties) { - for (const prop of Object.values(mainDef.properties) as any[]) { - if (prop.$ref && typeof prop.$ref === 'string' && prop.$ref.includes('/')) { - const refName = prop.$ref.split('/').pop(); - if (refName && refName !== schemaName && !seen.has(refName)) { - const zodFile = schemaZodFileMap.get(refName); - if (zodFile && schemaCategoryMap.get(refName) === category) { - related.push({ name: refName, zodFile }); - seen.add(refName); - } - } - } + let md = `---\n`; + md += `title: ${zodTitle}\n`; + md += `description: ${zodTitle} protocol schemas\n`; + md += `---\n\n`; + + md += `import { Card, Cards } from 'fumadocs-ui/components/card';\n`; + md += `import { Callout } from 'fumadocs-ui/components/callout';\n\n`; + + md += `# ${zodTitle}\n\n`; + + // Add source reference + md += `\n`; + md += `**Source:** \`packages/spec/src/${category}/${zodFile}.zod.ts\`\n`; + md += `\n\n`; + + // Add TypeScript usage example + md += `## TypeScript Usage\n\n`; + md += `\`\`\`typescript\n`; + md += `import { `; + + // Import all schemas + const schemaNames = schemas.map(s => s.name + 'Schema').join(', '); + md += schemaNames; + md += ` } from '@objectstack/spec/${category}';\n`; + md += `import type { `; + md += schemas.map(s => s.name).join(', '); + md += ` } from '@objectstack/spec/${category}';\n\n`; + md += `// Validate data\n`; + md += `const result = ${schemas[0].name}Schema.parse(data);\n`; + md += `\`\`\`\n\n`; + + md += `---\n\n`; + + // Generate documentation for each schema + schemas.forEach((schema, idx) => { + md += generateMarkdown(schema.name, schema.content, category, zodFile); + if (idx < schemas.length - 1) { + md += `---\n\n`; } - } + }); - return related.slice(0, 6); // Limit to 6 related items + return md; } + // 2. Clean up old documentation structure -// IMPORTANT: This removes old .mdx files and subdirectories to ensure a clean state. -// Only category roots are cleaned (data/, ui/, system/, ai/, api/). The root meta.json is preserved. -// All necessary directories and files are regenerated in step 3, so this is safe. +// Remove old .mdx files and subdirectories to ensure a clean state. Object.keys(CATEGORIES).forEach(category => { const dir = path.join(DOCS_ROOT, category); if (fs.existsSync(dir)) { @@ -237,13 +193,12 @@ Object.keys(CATEGORIES).forEach(category => { const entryPath = path.join(dir, entry); const stat = fs.statSync(entryPath); - // Remove old .mdx files from category root (these will be moved to subfolders) - if (stat.isFile() && entry.endsWith('.mdx')) { + // Remove old .mdx files (will be regenerated) + if (stat.isFile() && entry.endsWith('.mdx') && entry !== 'index.mdx') { fs.unlinkSync(entryPath); console.log(`Removed old file: ${category}/${entry}`); } - // Remove old subdirectories (will be recreated with correct structure in step 3) - // Note: meta.json is preserved as it's not a directory + // Remove old subdirectories (schemas are now in single files) else if (stat.isDirectory()) { fs.rmSync(entryPath, { recursive: true, force: true }); console.log(`Removed old directory: ${category}/${entry}`); @@ -252,19 +207,19 @@ Object.keys(CATEGORIES).forEach(category => { } }); -// 3. Prepare Directories +// 3. Prepare Directories and Generate meta.json if (!fs.existsSync(DOCS_ROOT)) { fs.mkdirSync(DOCS_ROOT, { recursive: true }); } -// Generate meta.json for categories and zod file subfolders +// Generate meta.json for categories - now just listing zod files Object.entries(CATEGORIES).forEach(([key, title]) => { const dir = path.join(DOCS_ROOT, key); if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true }); const zodFiles = categoryZodFiles.get(key) || new Set(); - // Create top-level meta.json for the protocol + // Create top-level meta.json for the protocol with zod files as pages const meta: any = { title, }; @@ -273,24 +228,14 @@ Object.entries(CATEGORIES).forEach(([key, title]) => { const sortedZodFiles = Array.from(zodFiles).sort(); if (sortedZodFiles.length > 0) { - // Enforce order using 'pages' meta.pages = sortedZodFiles; } fs.writeFileSync(path.join(dir, 'meta.json'), JSON.stringify(meta, null, 2)); - - // Create zod file directories and meta.json files - sortedZodFiles.forEach(zodFile => { - const subDir = path.join(dir, zodFile); - if (!fs.existsSync(subDir)) fs.mkdirSync(subDir, { recursive: true }); - - const subTitle = zodFile.split('-').map(w => w.charAt(0).toUpperCase() + w.slice(1)).join(' '); - fs.writeFileSync(path.join(subDir, 'meta.json'), JSON.stringify({ title: subTitle }, null, 2)); - }); }); -// 4. Generate Docs -// Read JSON schema files from category subdirectories +// 4. Generate Docs - One file per zod file containing all schemas +// Group schemas by zod file Object.keys(CATEGORIES).forEach(category => { const categorySchemaDir = path.join(SCHEMA_DIR, category); @@ -301,32 +246,36 @@ Object.keys(CATEGORIES).forEach(category => { const files = fs.readdirSync(categorySchemaDir).filter(f => f.endsWith('.json')); + // Group schemas by their zod file + const zodFileSchemas = new Map>(); + files.forEach(file => { const schemaName = file.replace('.json', ''); const schemaPath = path.join(categorySchemaDir, file); const content = JSON.parse(fs.readFileSync(schemaPath, 'utf-8')); const zodFile = schemaZodFileMap.get(schemaName) || 'misc'; - const mdx = generateMarkdown(schemaName, content, category, zodFile); - if (mdx) { - // Determine output directory - let outDir = path.join(DOCS_ROOT, category); - if (zodFile) { - outDir = path.join(outDir, zodFile); - } - - if (!fs.existsSync(outDir)) fs.mkdirSync(outDir, { recursive: true }); - - const fileName = `${schemaName}.mdx`; - fs.writeFileSync(path.join(outDir, fileName), mdx); - - console.log(`✓ Generated docs for ${schemaName} in ${category}${zodFile ? '/' + zodFile : ''}`); + if (!zodFileSchemas.has(zodFile)) { + zodFileSchemas.set(zodFile, []); } + zodFileSchemas.get(zodFile)!.push({ name: schemaName, content }); + }); + + // Generate one file per zod file + zodFileSchemas.forEach((schemas, zodFile) => { + const outDir = path.join(DOCS_ROOT, category); + if (!fs.existsSync(outDir)) fs.mkdirSync(outDir, { recursive: true }); + + const mdx = generateZodFileMarkdown(zodFile, schemas, category); + const fileName = `${zodFile}.mdx`; + fs.writeFileSync(path.join(outDir, fileName), mdx); + + console.log(`✓ Generated docs for ${zodFile}.zod.ts in ${category} (${schemas.length} schemas)`); }); }); // 4.5. Generate Protocol Overview Pages -// Create index.mdx for each category with overview of all schemas +// Create index.mdx for each category with overview of all zod files Object.entries(CATEGORIES).forEach(([category, title]) => { const categoryDir = path.join(DOCS_ROOT, category); const zodFiles = categoryZodFiles.get(category) || new Set(); @@ -339,50 +288,15 @@ Object.entries(CATEGORIES).forEach(([category, title]) => { overviewMd += `# ${title}\n\n`; overviewMd += `This section contains all protocol schemas for the ${category} layer of ObjectStack.\n\n`; - // Group schemas by zod file - const zodFileGroups = new Map(); - - // Read category schema directory to get all schemas - const categorySchemaDir = path.join(SCHEMA_DIR, category); - if (fs.existsSync(categorySchemaDir)) { - const schemaFiles = fs.readdirSync(categorySchemaDir).filter(f => f.endsWith('.json')); - schemaFiles.forEach(file => { - const schemaName = file.replace('.json', ''); - const zodFile = schemaZodFileMap.get(schemaName) || 'misc'; - - if (!zodFileGroups.has(zodFile)) { - zodFileGroups.set(zodFile, []); - } - zodFileGroups.get(zodFile)!.push(schemaName); - }); - } - - // Generate overview sections + // List all zod files const sortedZodFiles = Array.from(zodFiles).sort(); + + overviewMd += `\n`; sortedZodFiles.forEach(zodFile => { - const schemas = zodFileGroups.get(zodFile) || []; - if (schemas.length === 0) return; - const zodTitle = zodFile.split('-').map(w => w.charAt(0).toUpperCase() + w.slice(1)).join(' '); - overviewMd += `## ${zodTitle}\n\n`; - overviewMd += `Source: \`packages/spec/src/${category}/${zodFile}.zod.ts\`\n\n`; - overviewMd += `\n`; - - schemas.sort().forEach(schemaName => { - // Read schema to get description - const schemaPath = path.join(categorySchemaDir, `${schemaName}.json`); - if (fs.existsSync(schemaPath)) { - const schema = JSON.parse(fs.readFileSync(schemaPath, 'utf-8')); - const defs = schema.definitions || {}; - const mainDef = defs[schemaName] || Object.values(defs)[0]; - const description = mainDef?.description || `${schemaName} schema reference`; - - overviewMd += ` \n`; - } - }); - - overviewMd += `\n\n`; + overviewMd += ` \n`; }); + overviewMd += `\n\n`; // Write overview page fs.writeFileSync(path.join(categoryDir, 'index.mdx'), overviewMd); From 9daa8e37d52bdfe0f9d223b8af619479bc0f5760 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 27 Jan 2026 16:14:06 +0000 Subject: [PATCH 10/10] Remove fumadocs-ui component imports from generated MDX files Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com> --- content/docs/references/ai/agent.mdx | 3 --- content/docs/references/ai/conversation.mdx | 3 --- content/docs/references/ai/cost.mdx | 3 --- content/docs/references/ai/index.mdx | 2 -- content/docs/references/ai/model-registry.mdx | 3 --- content/docs/references/ai/nlq.mdx | 3 --- content/docs/references/ai/orchestration.mdx | 3 --- content/docs/references/ai/predictive.mdx | 3 --- content/docs/references/ai/rag-pipeline.mdx | 3 --- content/docs/references/api/contract.mdx | 3 --- content/docs/references/api/discovery.mdx | 3 --- content/docs/references/api/endpoint.mdx | 3 --- content/docs/references/api/index.mdx | 2 -- content/docs/references/api/odata.mdx | 3 --- content/docs/references/api/realtime.mdx | 3 --- content/docs/references/api/router.mdx | 3 --- content/docs/references/api/view.mdx | 3 --- content/docs/references/auth/config.mdx | 3 --- content/docs/references/auth/identity.mdx | 3 --- content/docs/references/auth/index.mdx | 2 -- content/docs/references/auth/organization.mdx | 3 --- content/docs/references/auth/policy.mdx | 3 --- content/docs/references/auth/role.mdx | 3 --- content/docs/references/auth/scim.mdx | 3 --- content/docs/references/automation/approval.mdx | 3 --- content/docs/references/automation/connector.mdx | 3 --- content/docs/references/automation/etl.mdx | 3 --- content/docs/references/automation/flow.mdx | 3 --- content/docs/references/automation/index.mdx | 2 -- content/docs/references/automation/mapping.mdx | 3 --- content/docs/references/automation/sync.mdx | 3 --- content/docs/references/automation/webhook.mdx | 3 --- content/docs/references/automation/workflow.mdx | 3 --- content/docs/references/data/dataset.mdx | 3 --- content/docs/references/data/field.mdx | 3 --- content/docs/references/data/filter.mdx | 3 --- content/docs/references/data/hook.mdx | 3 --- content/docs/references/data/index.mdx | 2 -- content/docs/references/data/object.mdx | 3 --- content/docs/references/data/query.mdx | 3 --- content/docs/references/data/validation.mdx | 3 --- content/docs/references/hub/composer.mdx | 3 --- content/docs/references/hub/index.mdx | 2 -- content/docs/references/hub/license.mdx | 3 --- content/docs/references/hub/marketplace.mdx | 3 --- content/docs/references/hub/space.mdx | 3 --- content/docs/references/hub/tenant.mdx | 3 --- content/docs/references/permission/index.mdx | 2 -- content/docs/references/permission/permission.mdx | 3 --- content/docs/references/permission/rls.mdx | 3 --- content/docs/references/permission/sharing.mdx | 3 --- content/docs/references/permission/territory.mdx | 3 --- content/docs/references/shared/identifiers.mdx | 3 --- content/docs/references/shared/index.mdx | 2 -- content/docs/references/system/audit.mdx | 3 --- content/docs/references/system/context.mdx | 3 --- content/docs/references/system/datasource.mdx | 3 --- content/docs/references/system/driver.mdx | 3 --- content/docs/references/system/events.mdx | 3 --- content/docs/references/system/feature.mdx | 3 --- content/docs/references/system/index.mdx | 2 -- content/docs/references/system/job.mdx | 3 --- content/docs/references/system/logger.mdx | 3 --- content/docs/references/system/manifest.mdx | 3 --- content/docs/references/system/misc.mdx | 3 --- content/docs/references/system/plugin.mdx | 3 --- content/docs/references/system/scoped-storage.mdx | 3 --- content/docs/references/system/translation.mdx | 3 --- content/docs/references/ui/action.mdx | 3 --- content/docs/references/ui/app.mdx | 3 --- content/docs/references/ui/component.mdx | 3 --- content/docs/references/ui/dashboard.mdx | 3 --- content/docs/references/ui/index.mdx | 2 -- content/docs/references/ui/page.mdx | 3 --- content/docs/references/ui/report.mdx | 3 --- content/docs/references/ui/theme.mdx | 3 --- content/docs/references/ui/view.mdx | 3 --- content/docs/references/ui/widget.mdx | 3 --- packages/spec/scripts/build-docs.ts | 4 ---- 79 files changed, 228 deletions(-) diff --git a/content/docs/references/ai/agent.mdx b/content/docs/references/ai/agent.mdx index 5d73188c3..619aa6aa2 100644 --- a/content/docs/references/ai/agent.mdx +++ b/content/docs/references/ai/agent.mdx @@ -3,9 +3,6 @@ title: Agent description: Agent protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Agent diff --git a/content/docs/references/ai/conversation.mdx b/content/docs/references/ai/conversation.mdx index 9e5626bef..0fd508b7b 100644 --- a/content/docs/references/ai/conversation.mdx +++ b/content/docs/references/ai/conversation.mdx @@ -3,9 +3,6 @@ title: Conversation description: Conversation protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Conversation diff --git a/content/docs/references/ai/cost.mdx b/content/docs/references/ai/cost.mdx index bd3c0ce29..d2cc5d1e5 100644 --- a/content/docs/references/ai/cost.mdx +++ b/content/docs/references/ai/cost.mdx @@ -3,9 +3,6 @@ title: Cost description: Cost protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Cost diff --git a/content/docs/references/ai/index.mdx b/content/docs/references/ai/index.mdx index fcdea1448..e20102453 100644 --- a/content/docs/references/ai/index.mdx +++ b/content/docs/references/ai/index.mdx @@ -3,8 +3,6 @@ title: AI Protocol Overview description: Complete reference for all ai protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # AI Protocol This section contains all protocol schemas for the ai layer of ObjectStack. diff --git a/content/docs/references/ai/model-registry.mdx b/content/docs/references/ai/model-registry.mdx index 15e1541e9..4b7d2d2c8 100644 --- a/content/docs/references/ai/model-registry.mdx +++ b/content/docs/references/ai/model-registry.mdx @@ -3,9 +3,6 @@ title: Model Registry description: Model Registry protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Model Registry diff --git a/content/docs/references/ai/nlq.mdx b/content/docs/references/ai/nlq.mdx index 079f071a3..deff51c9a 100644 --- a/content/docs/references/ai/nlq.mdx +++ b/content/docs/references/ai/nlq.mdx @@ -3,9 +3,6 @@ title: Nlq description: Nlq protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Nlq diff --git a/content/docs/references/ai/orchestration.mdx b/content/docs/references/ai/orchestration.mdx index f520fcc4f..bb0670c8f 100644 --- a/content/docs/references/ai/orchestration.mdx +++ b/content/docs/references/ai/orchestration.mdx @@ -3,9 +3,6 @@ title: Orchestration description: Orchestration protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Orchestration diff --git a/content/docs/references/ai/predictive.mdx b/content/docs/references/ai/predictive.mdx index 6fff86bae..63e6eefe4 100644 --- a/content/docs/references/ai/predictive.mdx +++ b/content/docs/references/ai/predictive.mdx @@ -3,9 +3,6 @@ title: Predictive description: Predictive protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Predictive diff --git a/content/docs/references/ai/rag-pipeline.mdx b/content/docs/references/ai/rag-pipeline.mdx index 6f778a22f..6456c7519 100644 --- a/content/docs/references/ai/rag-pipeline.mdx +++ b/content/docs/references/ai/rag-pipeline.mdx @@ -3,9 +3,6 @@ title: Rag Pipeline description: Rag Pipeline protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Rag Pipeline diff --git a/content/docs/references/api/contract.mdx b/content/docs/references/api/contract.mdx index 324b2bf2a..7f0cd9cc2 100644 --- a/content/docs/references/api/contract.mdx +++ b/content/docs/references/api/contract.mdx @@ -3,9 +3,6 @@ title: Contract description: Contract protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Contract diff --git a/content/docs/references/api/discovery.mdx b/content/docs/references/api/discovery.mdx index d9a1cbb07..317f32033 100644 --- a/content/docs/references/api/discovery.mdx +++ b/content/docs/references/api/discovery.mdx @@ -3,9 +3,6 @@ title: Discovery description: Discovery protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Discovery diff --git a/content/docs/references/api/endpoint.mdx b/content/docs/references/api/endpoint.mdx index 92e9b6fb4..d4028bd00 100644 --- a/content/docs/references/api/endpoint.mdx +++ b/content/docs/references/api/endpoint.mdx @@ -3,9 +3,6 @@ title: Endpoint description: Endpoint protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Endpoint diff --git a/content/docs/references/api/index.mdx b/content/docs/references/api/index.mdx index f633a10bc..764e3f46c 100644 --- a/content/docs/references/api/index.mdx +++ b/content/docs/references/api/index.mdx @@ -3,8 +3,6 @@ title: API Protocol Overview description: Complete reference for all api protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # API Protocol This section contains all protocol schemas for the api layer of ObjectStack. diff --git a/content/docs/references/api/odata.mdx b/content/docs/references/api/odata.mdx index 2fc63d7be..87468810e 100644 --- a/content/docs/references/api/odata.mdx +++ b/content/docs/references/api/odata.mdx @@ -3,9 +3,6 @@ title: Odata description: Odata protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Odata diff --git a/content/docs/references/api/realtime.mdx b/content/docs/references/api/realtime.mdx index d517558de..9532ed757 100644 --- a/content/docs/references/api/realtime.mdx +++ b/content/docs/references/api/realtime.mdx @@ -3,9 +3,6 @@ title: Realtime description: Realtime protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Realtime diff --git a/content/docs/references/api/router.mdx b/content/docs/references/api/router.mdx index 11e46eb67..bfed2ea45 100644 --- a/content/docs/references/api/router.mdx +++ b/content/docs/references/api/router.mdx @@ -3,9 +3,6 @@ title: Router description: Router protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Router diff --git a/content/docs/references/api/view.mdx b/content/docs/references/api/view.mdx index 9b55e8f5a..1ce01caf7 100644 --- a/content/docs/references/api/view.mdx +++ b/content/docs/references/api/view.mdx @@ -3,9 +3,6 @@ title: View description: View protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # View diff --git a/content/docs/references/auth/config.mdx b/content/docs/references/auth/config.mdx index 76c0dd922..f78bdb912 100644 --- a/content/docs/references/auth/config.mdx +++ b/content/docs/references/auth/config.mdx @@ -3,9 +3,6 @@ title: Config description: Config protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Config diff --git a/content/docs/references/auth/identity.mdx b/content/docs/references/auth/identity.mdx index 4ffe2f73c..40b134427 100644 --- a/content/docs/references/auth/identity.mdx +++ b/content/docs/references/auth/identity.mdx @@ -3,9 +3,6 @@ title: Identity description: Identity protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Identity diff --git a/content/docs/references/auth/index.mdx b/content/docs/references/auth/index.mdx index 49316c982..df0b4da8a 100644 --- a/content/docs/references/auth/index.mdx +++ b/content/docs/references/auth/index.mdx @@ -3,8 +3,6 @@ title: Auth Protocol Overview description: Complete reference for all auth protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # Auth Protocol This section contains all protocol schemas for the auth layer of ObjectStack. diff --git a/content/docs/references/auth/organization.mdx b/content/docs/references/auth/organization.mdx index f908c273b..31d58abc0 100644 --- a/content/docs/references/auth/organization.mdx +++ b/content/docs/references/auth/organization.mdx @@ -3,9 +3,6 @@ title: Organization description: Organization protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Organization diff --git a/content/docs/references/auth/policy.mdx b/content/docs/references/auth/policy.mdx index ceccc86e2..aa2edc0c8 100644 --- a/content/docs/references/auth/policy.mdx +++ b/content/docs/references/auth/policy.mdx @@ -3,9 +3,6 @@ title: Policy description: Policy protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Policy diff --git a/content/docs/references/auth/role.mdx b/content/docs/references/auth/role.mdx index 12fb1f615..f03d545c7 100644 --- a/content/docs/references/auth/role.mdx +++ b/content/docs/references/auth/role.mdx @@ -3,9 +3,6 @@ title: Role description: Role protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Role diff --git a/content/docs/references/auth/scim.mdx b/content/docs/references/auth/scim.mdx index 2c8a027d1..4295cf9be 100644 --- a/content/docs/references/auth/scim.mdx +++ b/content/docs/references/auth/scim.mdx @@ -3,9 +3,6 @@ title: Scim description: Scim protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Scim diff --git a/content/docs/references/automation/approval.mdx b/content/docs/references/automation/approval.mdx index e989b8ded..1fda95f88 100644 --- a/content/docs/references/automation/approval.mdx +++ b/content/docs/references/automation/approval.mdx @@ -3,9 +3,6 @@ title: Approval description: Approval protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Approval diff --git a/content/docs/references/automation/connector.mdx b/content/docs/references/automation/connector.mdx index 52e775af9..a0363065b 100644 --- a/content/docs/references/automation/connector.mdx +++ b/content/docs/references/automation/connector.mdx @@ -3,9 +3,6 @@ title: Connector description: Connector protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Connector diff --git a/content/docs/references/automation/etl.mdx b/content/docs/references/automation/etl.mdx index 037795b52..f5bb7c6aa 100644 --- a/content/docs/references/automation/etl.mdx +++ b/content/docs/references/automation/etl.mdx @@ -3,9 +3,6 @@ title: Etl description: Etl protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Etl diff --git a/content/docs/references/automation/flow.mdx b/content/docs/references/automation/flow.mdx index 243e52364..8adab3d5f 100644 --- a/content/docs/references/automation/flow.mdx +++ b/content/docs/references/automation/flow.mdx @@ -3,9 +3,6 @@ title: Flow description: Flow protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Flow diff --git a/content/docs/references/automation/index.mdx b/content/docs/references/automation/index.mdx index 157a61322..c071ba213 100644 --- a/content/docs/references/automation/index.mdx +++ b/content/docs/references/automation/index.mdx @@ -3,8 +3,6 @@ title: Automation Protocol Overview description: Complete reference for all automation protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # Automation Protocol This section contains all protocol schemas for the automation layer of ObjectStack. diff --git a/content/docs/references/automation/mapping.mdx b/content/docs/references/automation/mapping.mdx index 45581e06b..b20c29daf 100644 --- a/content/docs/references/automation/mapping.mdx +++ b/content/docs/references/automation/mapping.mdx @@ -3,9 +3,6 @@ title: Mapping description: Mapping protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Mapping diff --git a/content/docs/references/automation/sync.mdx b/content/docs/references/automation/sync.mdx index cf7af8ae7..89a4a0762 100644 --- a/content/docs/references/automation/sync.mdx +++ b/content/docs/references/automation/sync.mdx @@ -3,9 +3,6 @@ title: Sync description: Sync protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Sync diff --git a/content/docs/references/automation/webhook.mdx b/content/docs/references/automation/webhook.mdx index 982a8dcc7..b157665f8 100644 --- a/content/docs/references/automation/webhook.mdx +++ b/content/docs/references/automation/webhook.mdx @@ -3,9 +3,6 @@ title: Webhook description: Webhook protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Webhook diff --git a/content/docs/references/automation/workflow.mdx b/content/docs/references/automation/workflow.mdx index 4713b8040..38fee5ddd 100644 --- a/content/docs/references/automation/workflow.mdx +++ b/content/docs/references/automation/workflow.mdx @@ -3,9 +3,6 @@ title: Workflow description: Workflow protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Workflow diff --git a/content/docs/references/data/dataset.mdx b/content/docs/references/data/dataset.mdx index 6d0a4a18e..0cf6ae1da 100644 --- a/content/docs/references/data/dataset.mdx +++ b/content/docs/references/data/dataset.mdx @@ -3,9 +3,6 @@ title: Dataset description: Dataset protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Dataset diff --git a/content/docs/references/data/field.mdx b/content/docs/references/data/field.mdx index 7789d5b43..1a9c5ae5c 100644 --- a/content/docs/references/data/field.mdx +++ b/content/docs/references/data/field.mdx @@ -3,9 +3,6 @@ title: Field description: Field protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Field diff --git a/content/docs/references/data/filter.mdx b/content/docs/references/data/filter.mdx index dbdf337a6..3a8afbc3c 100644 --- a/content/docs/references/data/filter.mdx +++ b/content/docs/references/data/filter.mdx @@ -3,9 +3,6 @@ title: Filter description: Filter protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Filter diff --git a/content/docs/references/data/hook.mdx b/content/docs/references/data/hook.mdx index 028c09e74..3a4e856a9 100644 --- a/content/docs/references/data/hook.mdx +++ b/content/docs/references/data/hook.mdx @@ -3,9 +3,6 @@ title: Hook description: Hook protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Hook diff --git a/content/docs/references/data/index.mdx b/content/docs/references/data/index.mdx index eac4e1038..a91672d32 100644 --- a/content/docs/references/data/index.mdx +++ b/content/docs/references/data/index.mdx @@ -3,8 +3,6 @@ title: Data Protocol Overview description: Complete reference for all data protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # Data Protocol This section contains all protocol schemas for the data layer of ObjectStack. diff --git a/content/docs/references/data/object.mdx b/content/docs/references/data/object.mdx index 125fc1ad2..6ed03fba6 100644 --- a/content/docs/references/data/object.mdx +++ b/content/docs/references/data/object.mdx @@ -3,9 +3,6 @@ title: Object description: Object protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Object diff --git a/content/docs/references/data/query.mdx b/content/docs/references/data/query.mdx index 6756c9e9f..aabc1e68b 100644 --- a/content/docs/references/data/query.mdx +++ b/content/docs/references/data/query.mdx @@ -3,9 +3,6 @@ title: Query description: Query protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Query diff --git a/content/docs/references/data/validation.mdx b/content/docs/references/data/validation.mdx index 8a8e8bd4f..ebcf1cdb8 100644 --- a/content/docs/references/data/validation.mdx +++ b/content/docs/references/data/validation.mdx @@ -3,9 +3,6 @@ title: Validation description: Validation protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Validation diff --git a/content/docs/references/hub/composer.mdx b/content/docs/references/hub/composer.mdx index 0e2234d22..089e9a160 100644 --- a/content/docs/references/hub/composer.mdx +++ b/content/docs/references/hub/composer.mdx @@ -3,9 +3,6 @@ title: Composer description: Composer protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Composer diff --git a/content/docs/references/hub/index.mdx b/content/docs/references/hub/index.mdx index ba3601706..a2bcf34f2 100644 --- a/content/docs/references/hub/index.mdx +++ b/content/docs/references/hub/index.mdx @@ -3,8 +3,6 @@ title: Hub Protocol Overview description: Complete reference for all hub protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # Hub Protocol This section contains all protocol schemas for the hub layer of ObjectStack. diff --git a/content/docs/references/hub/license.mdx b/content/docs/references/hub/license.mdx index 901ba7e7a..d91295909 100644 --- a/content/docs/references/hub/license.mdx +++ b/content/docs/references/hub/license.mdx @@ -3,9 +3,6 @@ title: License description: License protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # License diff --git a/content/docs/references/hub/marketplace.mdx b/content/docs/references/hub/marketplace.mdx index 00d9c4143..ebebeb7bf 100644 --- a/content/docs/references/hub/marketplace.mdx +++ b/content/docs/references/hub/marketplace.mdx @@ -3,9 +3,6 @@ title: Marketplace description: Marketplace protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Marketplace diff --git a/content/docs/references/hub/space.mdx b/content/docs/references/hub/space.mdx index bf1602a56..7c6311eca 100644 --- a/content/docs/references/hub/space.mdx +++ b/content/docs/references/hub/space.mdx @@ -3,9 +3,6 @@ title: Space description: Space protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Space diff --git a/content/docs/references/hub/tenant.mdx b/content/docs/references/hub/tenant.mdx index 0fd5de31d..5db39df9e 100644 --- a/content/docs/references/hub/tenant.mdx +++ b/content/docs/references/hub/tenant.mdx @@ -3,9 +3,6 @@ title: Tenant description: Tenant protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Tenant diff --git a/content/docs/references/permission/index.mdx b/content/docs/references/permission/index.mdx index a5af9e05b..75cb1db05 100644 --- a/content/docs/references/permission/index.mdx +++ b/content/docs/references/permission/index.mdx @@ -3,8 +3,6 @@ title: Permission Protocol Overview description: Complete reference for all permission protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # Permission Protocol This section contains all protocol schemas for the permission layer of ObjectStack. diff --git a/content/docs/references/permission/permission.mdx b/content/docs/references/permission/permission.mdx index 1c512a83f..f60179db2 100644 --- a/content/docs/references/permission/permission.mdx +++ b/content/docs/references/permission/permission.mdx @@ -3,9 +3,6 @@ title: Permission description: Permission protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Permission diff --git a/content/docs/references/permission/rls.mdx b/content/docs/references/permission/rls.mdx index 337b1b9bc..1b342f563 100644 --- a/content/docs/references/permission/rls.mdx +++ b/content/docs/references/permission/rls.mdx @@ -3,9 +3,6 @@ title: Rls description: Rls protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Rls diff --git a/content/docs/references/permission/sharing.mdx b/content/docs/references/permission/sharing.mdx index c68eba07e..c3beba1d8 100644 --- a/content/docs/references/permission/sharing.mdx +++ b/content/docs/references/permission/sharing.mdx @@ -3,9 +3,6 @@ title: Sharing description: Sharing protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Sharing diff --git a/content/docs/references/permission/territory.mdx b/content/docs/references/permission/territory.mdx index fa3a8ab1d..62cf01120 100644 --- a/content/docs/references/permission/territory.mdx +++ b/content/docs/references/permission/territory.mdx @@ -3,9 +3,6 @@ title: Territory description: Territory protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Territory diff --git a/content/docs/references/shared/identifiers.mdx b/content/docs/references/shared/identifiers.mdx index 85b56afda..766dcdbcd 100644 --- a/content/docs/references/shared/identifiers.mdx +++ b/content/docs/references/shared/identifiers.mdx @@ -3,9 +3,6 @@ title: Identifiers description: Identifiers protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Identifiers diff --git a/content/docs/references/shared/index.mdx b/content/docs/references/shared/index.mdx index 4e800c507..8824ca8b8 100644 --- a/content/docs/references/shared/index.mdx +++ b/content/docs/references/shared/index.mdx @@ -3,8 +3,6 @@ title: Shared Protocol Overview description: Complete reference for all shared protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # Shared Protocol This section contains all protocol schemas for the shared layer of ObjectStack. diff --git a/content/docs/references/system/audit.mdx b/content/docs/references/system/audit.mdx index dd1672996..fc5a5fb02 100644 --- a/content/docs/references/system/audit.mdx +++ b/content/docs/references/system/audit.mdx @@ -3,9 +3,6 @@ title: Audit description: Audit protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Audit diff --git a/content/docs/references/system/context.mdx b/content/docs/references/system/context.mdx index 8349bb6c9..0911bc9ef 100644 --- a/content/docs/references/system/context.mdx +++ b/content/docs/references/system/context.mdx @@ -3,9 +3,6 @@ title: Context description: Context protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Context diff --git a/content/docs/references/system/datasource.mdx b/content/docs/references/system/datasource.mdx index f572bcfc5..a908b2864 100644 --- a/content/docs/references/system/datasource.mdx +++ b/content/docs/references/system/datasource.mdx @@ -3,9 +3,6 @@ title: Datasource description: Datasource protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Datasource diff --git a/content/docs/references/system/driver.mdx b/content/docs/references/system/driver.mdx index 770841d59..c6cc834e4 100644 --- a/content/docs/references/system/driver.mdx +++ b/content/docs/references/system/driver.mdx @@ -3,9 +3,6 @@ title: Driver description: Driver protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Driver diff --git a/content/docs/references/system/events.mdx b/content/docs/references/system/events.mdx index 4eb939738..a977a90a7 100644 --- a/content/docs/references/system/events.mdx +++ b/content/docs/references/system/events.mdx @@ -3,9 +3,6 @@ title: Events description: Events protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Events diff --git a/content/docs/references/system/feature.mdx b/content/docs/references/system/feature.mdx index 731a9a638..9c6c36b6b 100644 --- a/content/docs/references/system/feature.mdx +++ b/content/docs/references/system/feature.mdx @@ -3,9 +3,6 @@ title: Feature description: Feature protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Feature diff --git a/content/docs/references/system/index.mdx b/content/docs/references/system/index.mdx index a2fab13dc..fa6bcc251 100644 --- a/content/docs/references/system/index.mdx +++ b/content/docs/references/system/index.mdx @@ -3,8 +3,6 @@ title: System Protocol Overview description: Complete reference for all system protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # System Protocol This section contains all protocol schemas for the system layer of ObjectStack. diff --git a/content/docs/references/system/job.mdx b/content/docs/references/system/job.mdx index 8625ccb55..7eb0d5740 100644 --- a/content/docs/references/system/job.mdx +++ b/content/docs/references/system/job.mdx @@ -3,9 +3,6 @@ title: Job description: Job protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Job diff --git a/content/docs/references/system/logger.mdx b/content/docs/references/system/logger.mdx index b058456f5..f96d47863 100644 --- a/content/docs/references/system/logger.mdx +++ b/content/docs/references/system/logger.mdx @@ -3,9 +3,6 @@ title: Logger description: Logger protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Logger diff --git a/content/docs/references/system/manifest.mdx b/content/docs/references/system/manifest.mdx index 69791a918..eaad56655 100644 --- a/content/docs/references/system/manifest.mdx +++ b/content/docs/references/system/manifest.mdx @@ -3,9 +3,6 @@ title: Manifest description: Manifest protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Manifest diff --git a/content/docs/references/system/misc.mdx b/content/docs/references/system/misc.mdx index 844724f6d..a7e0b7ff2 100644 --- a/content/docs/references/system/misc.mdx +++ b/content/docs/references/system/misc.mdx @@ -3,9 +3,6 @@ title: Misc description: Misc protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Misc diff --git a/content/docs/references/system/plugin.mdx b/content/docs/references/system/plugin.mdx index 1d3ac9dfd..78c0b5f99 100644 --- a/content/docs/references/system/plugin.mdx +++ b/content/docs/references/system/plugin.mdx @@ -3,9 +3,6 @@ title: Plugin description: Plugin protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Plugin diff --git a/content/docs/references/system/scoped-storage.mdx b/content/docs/references/system/scoped-storage.mdx index abeab1d25..71e455bd8 100644 --- a/content/docs/references/system/scoped-storage.mdx +++ b/content/docs/references/system/scoped-storage.mdx @@ -3,9 +3,6 @@ title: Scoped Storage description: Scoped Storage protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Scoped Storage diff --git a/content/docs/references/system/translation.mdx b/content/docs/references/system/translation.mdx index 015e5f4fb..62690d173 100644 --- a/content/docs/references/system/translation.mdx +++ b/content/docs/references/system/translation.mdx @@ -3,9 +3,6 @@ title: Translation description: Translation protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Translation diff --git a/content/docs/references/ui/action.mdx b/content/docs/references/ui/action.mdx index 682665aa1..6f3f3c03b 100644 --- a/content/docs/references/ui/action.mdx +++ b/content/docs/references/ui/action.mdx @@ -3,9 +3,6 @@ title: Action description: Action protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Action diff --git a/content/docs/references/ui/app.mdx b/content/docs/references/ui/app.mdx index 36d340c32..1ba2822e1 100644 --- a/content/docs/references/ui/app.mdx +++ b/content/docs/references/ui/app.mdx @@ -3,9 +3,6 @@ title: App description: App protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # App diff --git a/content/docs/references/ui/component.mdx b/content/docs/references/ui/component.mdx index 61ef8296e..0a963db76 100644 --- a/content/docs/references/ui/component.mdx +++ b/content/docs/references/ui/component.mdx @@ -3,9 +3,6 @@ title: Component description: Component protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Component diff --git a/content/docs/references/ui/dashboard.mdx b/content/docs/references/ui/dashboard.mdx index 5556f8b3f..7b537a8c6 100644 --- a/content/docs/references/ui/dashboard.mdx +++ b/content/docs/references/ui/dashboard.mdx @@ -3,9 +3,6 @@ title: Dashboard description: Dashboard protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Dashboard diff --git a/content/docs/references/ui/index.mdx b/content/docs/references/ui/index.mdx index 52ba18c52..301673298 100644 --- a/content/docs/references/ui/index.mdx +++ b/content/docs/references/ui/index.mdx @@ -3,8 +3,6 @@ title: UI Protocol Overview description: Complete reference for all ui protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; - # UI Protocol This section contains all protocol schemas for the ui layer of ObjectStack. diff --git a/content/docs/references/ui/page.mdx b/content/docs/references/ui/page.mdx index 4813fcfad..3f31fe1b1 100644 --- a/content/docs/references/ui/page.mdx +++ b/content/docs/references/ui/page.mdx @@ -3,9 +3,6 @@ title: Page description: Page protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Page diff --git a/content/docs/references/ui/report.mdx b/content/docs/references/ui/report.mdx index 95557aee5..fdaffbbc4 100644 --- a/content/docs/references/ui/report.mdx +++ b/content/docs/references/ui/report.mdx @@ -3,9 +3,6 @@ title: Report description: Report protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Report diff --git a/content/docs/references/ui/theme.mdx b/content/docs/references/ui/theme.mdx index d79985533..451f790ab 100644 --- a/content/docs/references/ui/theme.mdx +++ b/content/docs/references/ui/theme.mdx @@ -3,9 +3,6 @@ title: Theme description: Theme protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Theme diff --git a/content/docs/references/ui/view.mdx b/content/docs/references/ui/view.mdx index 28e3d074d..5c7b8ca23 100644 --- a/content/docs/references/ui/view.mdx +++ b/content/docs/references/ui/view.mdx @@ -3,9 +3,6 @@ title: View description: View protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # View diff --git a/content/docs/references/ui/widget.mdx b/content/docs/references/ui/widget.mdx index cb65563af..912693ec1 100644 --- a/content/docs/references/ui/widget.mdx +++ b/content/docs/references/ui/widget.mdx @@ -3,9 +3,6 @@ title: Widget description: Widget protocol schemas --- -import { Card, Cards } from 'fumadocs-ui/components/card'; -import { Callout } from 'fumadocs-ui/components/callout'; - # Widget diff --git a/packages/spec/scripts/build-docs.ts b/packages/spec/scripts/build-docs.ts index d13e0b3ec..32b485e3d 100644 --- a/packages/spec/scripts/build-docs.ts +++ b/packages/spec/scripts/build-docs.ts @@ -143,9 +143,6 @@ function generateZodFileMarkdown(zodFile: string, schemas: Array<{name: string, md += `description: ${zodTitle} protocol schemas\n`; md += `---\n\n`; - md += `import { Card, Cards } from 'fumadocs-ui/components/card';\n`; - md += `import { Callout } from 'fumadocs-ui/components/callout';\n\n`; - md += `# ${zodTitle}\n\n`; // Add source reference @@ -283,7 +280,6 @@ Object.entries(CATEGORIES).forEach(([category, title]) => { if (zodFiles.size === 0) return; let overviewMd = `---\ntitle: ${title} Overview\ndescription: Complete reference for all ${title.toLowerCase()} schemas\n---\n\n`; - overviewMd += `import { Card, Cards } from 'fumadocs-ui/components/card';\n\n`; overviewMd += `# ${title}\n\n`; overviewMd += `This section contains all protocol schemas for the ${category} layer of ObjectStack.\n\n`;