effect 4.0.0-beta.100 → 4.0.0-beta.102
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Array.d.ts.map +1 -1
- package/dist/Array.js +81 -5
- package/dist/Array.js.map +1 -1
- package/dist/Channel.d.ts.map +1 -1
- package/dist/Channel.js +27 -9
- package/dist/Channel.js.map +1 -1
- package/dist/Config.d.ts +1 -1
- package/dist/Config.d.ts.map +1 -1
- package/dist/Config.js +6 -5
- package/dist/Config.js.map +1 -1
- package/dist/ConfigProvider.js +7 -7
- package/dist/ConfigProvider.js.map +1 -1
- package/dist/Data.d.ts.map +1 -1
- package/dist/Data.js +2 -1
- package/dist/Data.js.map +1 -1
- package/dist/Effect.d.ts +61 -100
- package/dist/Effect.d.ts.map +1 -1
- package/dist/Effect.js +66 -39
- package/dist/Effect.js.map +1 -1
- package/dist/FiberHandle.d.ts.map +1 -1
- package/dist/FiberHandle.js +3 -2
- package/dist/FiberHandle.js.map +1 -1
- package/dist/Iterable.d.ts.map +1 -1
- package/dist/Iterable.js +2 -1
- package/dist/Iterable.js.map +1 -1
- package/dist/JsonPatch.d.ts.map +1 -1
- package/dist/JsonPatch.js +4 -3
- package/dist/JsonPatch.js.map +1 -1
- package/dist/JsonSchema.d.ts.map +1 -1
- package/dist/JsonSchema.js +9 -11
- package/dist/JsonSchema.js.map +1 -1
- package/dist/Logger.d.ts.map +1 -1
- package/dist/Logger.js +3 -2
- package/dist/Logger.js.map +1 -1
- package/dist/ManagedRuntime.d.ts +9 -0
- package/dist/ManagedRuntime.d.ts.map +1 -1
- package/dist/ManagedRuntime.js +3 -0
- package/dist/ManagedRuntime.js.map +1 -1
- package/dist/Metric.d.ts.map +1 -1
- package/dist/Metric.js +4 -3
- package/dist/Metric.js.map +1 -1
- package/dist/MutableList.d.ts.map +1 -1
- package/dist/MutableList.js +4 -0
- package/dist/MutableList.js.map +1 -1
- package/dist/Optic.d.ts.map +1 -1
- package/dist/Optic.js +5 -4
- package/dist/Optic.js.map +1 -1
- package/dist/Option.d.ts.map +1 -1
- package/dist/Option.js +2 -1
- package/dist/Option.js.map +1 -1
- package/dist/PartitionedSemaphore.d.ts.map +1 -1
- package/dist/PartitionedSemaphore.js +1 -4
- package/dist/PartitionedSemaphore.js.map +1 -1
- package/dist/Record.d.ts +93 -1
- package/dist/Record.d.ts.map +1 -1
- package/dist/Record.js +57 -19
- package/dist/Record.js.map +1 -1
- package/dist/References.d.ts +0 -45
- package/dist/References.d.ts.map +1 -1
- package/dist/References.js +0 -45
- package/dist/References.js.map +1 -1
- package/dist/Request.d.ts.map +1 -1
- package/dist/Request.js +9 -6
- package/dist/Request.js.map +1 -1
- package/dist/Result.d.ts.map +1 -1
- package/dist/Result.js +2 -1
- package/dist/Result.js.map +1 -1
- package/dist/Schema.d.ts +1269 -496
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +2308 -614
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts +2 -2
- package/dist/SchemaAST.d.ts.map +1 -1
- package/dist/SchemaAST.js +189 -130
- package/dist/SchemaAST.js.map +1 -1
- package/dist/SchemaError.js +1 -1
- package/dist/SchemaError.js.map +1 -1
- package/dist/SchemaGetter.d.ts +13 -11
- package/dist/SchemaGetter.d.ts.map +1 -1
- package/dist/SchemaGetter.js +34 -24
- package/dist/SchemaGetter.js.map +1 -1
- package/dist/SchemaIssue.js +1 -1
- package/dist/SchemaIssue.js.map +1 -1
- package/dist/SchemaParser.d.ts.map +1 -1
- package/dist/SchemaParser.js +1 -12
- package/dist/SchemaParser.js.map +1 -1
- package/dist/SchemaRepresentation.d.ts +403 -1504
- package/dist/SchemaRepresentation.d.ts.map +1 -1
- package/dist/SchemaRepresentation.js +294 -2852
- package/dist/SchemaRepresentation.js.map +1 -1
- package/dist/SchemaTransformation.d.ts +2 -2
- package/dist/SchemaTransformation.js +3 -3
- package/dist/SchemaTransformation.js.map +1 -1
- package/dist/Semaphore.d.ts +5 -3
- package/dist/Semaphore.d.ts.map +1 -1
- package/dist/Semaphore.js.map +1 -1
- package/dist/Stream.d.ts +15 -9
- package/dist/Stream.d.ts.map +1 -1
- package/dist/Stream.js +46 -16
- package/dist/Stream.js.map +1 -1
- package/dist/Struct.d.ts.map +1 -1
- package/dist/Struct.js +5 -4
- package/dist/Struct.js.map +1 -1
- package/dist/Types.d.ts +1 -3
- package/dist/Types.d.ts.map +1 -1
- package/dist/index.d.ts +0 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -4
- package/dist/index.js.map +1 -1
- package/dist/internal/core.js +3 -2
- package/dist/internal/core.js.map +1 -1
- package/dist/internal/effect.js +119 -53
- package/dist/internal/effect.js.map +1 -1
- package/dist/internal/matcher.js +1 -1
- package/dist/internal/matcher.js.map +1 -1
- package/dist/internal/record.d.ts +0 -3
- package/dist/internal/record.d.ts.map +1 -1
- package/dist/internal/record.js +10 -5
- package/dist/internal/record.js.map +1 -1
- package/dist/internal/references.js +0 -4
- package/dist/internal/references.js.map +1 -1
- package/dist/internal/schema/annotations.js +12 -0
- package/dist/internal/schema/annotations.js.map +1 -1
- package/dist/internal/schema/fromJsonSchemaDocument.d.ts +2 -0
- package/dist/internal/schema/fromJsonSchemaDocument.d.ts.map +1 -0
- package/dist/internal/schema/fromJsonSchemaDocument.js +743 -0
- package/dist/internal/schema/fromJsonSchemaDocument.js.map +1 -0
- package/dist/internal/schema/fromRepresentation.d.ts +2 -0
- package/dist/internal/schema/fromRepresentation.d.ts.map +1 -0
- package/dist/internal/schema/fromRepresentation.js +252 -0
- package/dist/internal/schema/fromRepresentation.js.map +1 -0
- package/dist/internal/schema/schema.js +28 -40
- package/dist/internal/schema/schema.js.map +1 -1
- package/dist/internal/schema/{arbitrary.d.ts → toArbitrary.d.ts} +1 -1
- package/dist/internal/schema/toArbitrary.d.ts.map +1 -0
- package/dist/internal/schema/{arbitrary.js → toArbitrary.js} +8 -9
- package/dist/internal/schema/toArbitrary.js.map +1 -0
- package/dist/internal/schema/toCodeDocument.d.ts +2 -0
- package/dist/internal/schema/toCodeDocument.d.ts.map +1 -0
- package/dist/internal/schema/toCodeDocument.js +438 -0
- package/dist/internal/schema/toCodeDocument.js.map +1 -0
- package/dist/internal/schema/toEquivalence.d.ts +2 -0
- package/dist/internal/schema/toEquivalence.d.ts.map +1 -0
- package/dist/internal/schema/{equivalence.js → toEquivalence.js} +15 -13
- package/dist/internal/schema/toEquivalence.js.map +1 -0
- package/dist/internal/schema/toJsonSchemaDocument.d.ts +2 -0
- package/dist/internal/schema/toJsonSchemaDocument.d.ts.map +1 -0
- package/dist/internal/schema/toJsonSchemaDocument.js +466 -0
- package/dist/internal/schema/toJsonSchemaDocument.js.map +1 -0
- package/dist/internal/schema/toRepresentation.d.ts +2 -0
- package/dist/internal/schema/toRepresentation.d.ts.map +1 -0
- package/dist/internal/schema/toRepresentation.js +369 -0
- package/dist/internal/schema/toRepresentation.js.map +1 -0
- package/dist/internal/stackTraceLimit.js +3 -6
- package/dist/internal/stackTraceLimit.js.map +1 -1
- package/dist/testing/TestClock.js +4 -1
- package/dist/testing/TestClock.js.map +1 -1
- package/dist/unstable/ai/AiError.d.ts +26 -26
- package/dist/unstable/ai/AiError.d.ts.map +1 -1
- package/dist/unstable/ai/AiError.js +5 -4
- package/dist/unstable/ai/AiError.js.map +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.d.ts +21 -6
- package/dist/unstable/ai/AnthropicStructuredOutput.d.ts.map +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.js +86 -316
- package/dist/unstable/ai/AnthropicStructuredOutput.js.map +1 -1
- package/dist/unstable/ai/EmbeddingModel.d.ts +1 -1
- package/dist/unstable/ai/EmbeddingModel.js +1 -1
- package/dist/unstable/ai/EmbeddingModel.js.map +1 -1
- package/dist/unstable/ai/LanguageModel.d.ts +4 -1
- package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
- package/dist/unstable/ai/LanguageModel.js +19 -17
- package/dist/unstable/ai/LanguageModel.js.map +1 -1
- package/dist/unstable/ai/McpSchema.d.ts +197 -197
- package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
- package/dist/unstable/ai/McpSchema.js +13 -13
- package/dist/unstable/ai/McpSchema.js.map +1 -1
- package/dist/unstable/ai/McpServer.d.ts +4 -4
- package/dist/unstable/ai/McpServer.d.ts.map +1 -1
- package/dist/unstable/ai/McpServer.js +116 -49
- package/dist/unstable/ai/McpServer.js.map +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.d.ts +32 -10
- package/dist/unstable/ai/OpenAiStructuredOutput.d.ts.map +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.js +193 -377
- package/dist/unstable/ai/OpenAiStructuredOutput.js.map +1 -1
- package/dist/unstable/ai/Response.d.ts +19 -19
- package/dist/unstable/ai/Response.d.ts.map +1 -1
- package/dist/unstable/ai/Response.js +14 -14
- package/dist/unstable/ai/Response.js.map +1 -1
- package/dist/unstable/ai/Tool.d.ts +4 -0
- package/dist/unstable/ai/Tool.d.ts.map +1 -1
- package/dist/unstable/ai/Tool.js +11 -3
- package/dist/unstable/ai/Tool.js.map +1 -1
- package/dist/unstable/ai/Toolkit.d.ts +9 -1
- package/dist/unstable/ai/Toolkit.d.ts.map +1 -1
- package/dist/unstable/ai/Toolkit.js +14 -10
- package/dist/unstable/ai/Toolkit.js.map +1 -1
- package/dist/unstable/ai/internal/codec-transformer.js +15 -12
- package/dist/unstable/ai/internal/codec-transformer.js.map +1 -1
- package/dist/unstable/ai/internal/structured-output.d.ts +2 -0
- package/dist/unstable/ai/internal/structured-output.d.ts.map +1 -0
- package/dist/unstable/ai/internal/structured-output.js +316 -0
- package/dist/unstable/ai/internal/structured-output.js.map +1 -0
- package/dist/unstable/cli/CliError.d.ts +40 -2
- package/dist/unstable/cli/CliError.d.ts.map +1 -1
- package/dist/unstable/cli/CliError.js +45 -6
- package/dist/unstable/cli/CliError.js.map +1 -1
- package/dist/unstable/cli/Command.js +14 -5
- package/dist/unstable/cli/Command.js.map +1 -1
- package/dist/unstable/cli/Param.js +3 -3
- package/dist/unstable/cli/Param.js.map +1 -1
- package/dist/unstable/cli/Primitive.js +1 -1
- package/dist/unstable/cli/Primitive.js.map +1 -1
- package/dist/unstable/cli/internal/command.d.ts +3 -1
- package/dist/unstable/cli/internal/command.d.ts.map +1 -1
- package/dist/unstable/cli/internal/command.js +11 -4
- package/dist/unstable/cli/internal/command.js.map +1 -1
- package/dist/unstable/cli/internal/config.d.ts +0 -48
- package/dist/unstable/cli/internal/config.d.ts.map +1 -1
- package/dist/unstable/cli/internal/config.js +8 -10
- package/dist/unstable/cli/internal/config.js.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
- package/dist/unstable/cluster/Entity.js +1 -1
- package/dist/unstable/cluster/Entity.js.map +1 -1
- package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
- package/dist/unstable/cluster/Envelope.js +2 -1
- package/dist/unstable/cluster/Envelope.js.map +1 -1
- package/dist/unstable/cluster/Reply.js +1 -1
- package/dist/unstable/cluster/Reply.js.map +1 -1
- package/dist/unstable/cluster/Runner.d.ts +1 -1
- package/dist/unstable/cluster/Runner.js +1 -1
- package/dist/unstable/cluster/Runner.js.map +1 -1
- package/dist/unstable/cluster/RunnerAddress.d.ts +1 -1
- package/dist/unstable/cluster/RunnerAddress.js +1 -1
- package/dist/unstable/cluster/RunnerAddress.js.map +1 -1
- package/dist/unstable/cluster/ShardId.js +1 -1
- package/dist/unstable/cluster/ShardId.js.map +1 -1
- package/dist/unstable/cluster/Sharding.d.ts.map +1 -1
- package/dist/unstable/cluster/Sharding.js +125 -24
- package/dist/unstable/cluster/Sharding.js.map +1 -1
- package/dist/unstable/cluster/ShardingConfig.d.ts +10 -2
- package/dist/unstable/cluster/ShardingConfig.d.ts.map +1 -1
- package/dist/unstable/cluster/ShardingConfig.js.map +1 -1
- package/dist/unstable/cluster/SingleRunner.d.ts +4 -2
- package/dist/unstable/cluster/SingleRunner.d.ts.map +1 -1
- package/dist/unstable/cluster/SingleRunner.js +2 -1
- package/dist/unstable/cluster/SingleRunner.js.map +1 -1
- package/dist/unstable/cluster/SqlMessageStorage.d.ts +7 -4
- package/dist/unstable/cluster/SqlMessageStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/SqlMessageStorage.js +55 -24
- package/dist/unstable/cluster/SqlMessageStorage.js.map +1 -1
- package/dist/unstable/cluster/SqlRunnerStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/SqlRunnerStorage.js +109 -62
- package/dist/unstable/cluster/SqlRunnerStorage.js.map +1 -1
- package/dist/unstable/cluster/internal/entityManager.js +19 -7
- package/dist/unstable/cluster/internal/entityManager.js.map +1 -1
- package/dist/unstable/cluster/internal/shardLock.d.ts +2 -0
- package/dist/unstable/cluster/internal/shardLock.d.ts.map +1 -0
- package/dist/unstable/cluster/internal/shardLock.js +4 -0
- package/dist/unstable/cluster/internal/shardLock.js.map +1 -0
- package/dist/unstable/devtools/DevToolsSchema.d.ts +20 -20
- package/dist/unstable/devtools/DevToolsSchema.d.ts.map +1 -1
- package/dist/unstable/devtools/DevToolsSchema.js +8 -5
- package/dist/unstable/devtools/DevToolsSchema.js.map +1 -1
- package/dist/unstable/eventlog/EventJournal.d.ts +1 -1
- package/dist/unstable/eventlog/EventJournal.js +1 -1
- package/dist/unstable/eventlog/EventJournal.js.map +1 -1
- package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLog.js +15 -11
- package/dist/unstable/eventlog/EventLog.js.map +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.js +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
- package/dist/unstable/eventlog/EventLogMessage.d.ts +26 -26
- package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogMessage.js +8 -3
- package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
- package/dist/unstable/eventlog/EventLogRemote.d.ts +1 -1
- package/dist/unstable/eventlog/SqlEventJournal.js +2 -2
- package/dist/unstable/eventlog/SqlEventJournal.js.map +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js.map +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js +3 -3
- package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js.map +1 -1
- package/dist/unstable/http/Cookies.d.ts.map +1 -1
- package/dist/unstable/http/Cookies.js +24 -22
- package/dist/unstable/http/Cookies.js.map +1 -1
- package/dist/unstable/http/Headers.js +8 -8
- package/dist/unstable/http/Headers.js.map +1 -1
- package/dist/unstable/http/HttpClientRequest.d.ts +44 -0
- package/dist/unstable/http/HttpClientRequest.d.ts.map +1 -1
- package/dist/unstable/http/HttpClientRequest.js +14 -0
- package/dist/unstable/http/HttpClientRequest.js.map +1 -1
- package/dist/unstable/http/HttpRouter.d.ts +2 -2
- package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
- package/dist/unstable/http/HttpRouter.js.map +1 -1
- package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerRequest.js +5 -4
- package/dist/unstable/http/HttpServerRequest.js.map +1 -1
- package/dist/unstable/http/Multipart.d.ts.map +1 -1
- package/dist/unstable/http/Multipart.js +17 -15
- package/dist/unstable/http/Multipart.js.map +1 -1
- package/dist/unstable/http/Template.js +1 -1
- package/dist/unstable/http/Template.js.map +1 -1
- package/dist/unstable/http/UrlParams.d.ts.map +1 -1
- package/dist/unstable/http/UrlParams.js +17 -14
- package/dist/unstable/http/UrlParams.js.map +1 -1
- package/dist/unstable/httpapi/HttpApi.js +3 -3
- package/dist/unstable/httpapi/HttpApi.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.js +5 -5
- package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.js +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.js.map +1 -1
- package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
- package/dist/unstable/httpapi/OpenApi.js +37 -24
- package/dist/unstable/httpapi/OpenApi.js.map +1 -1
- package/dist/unstable/observability/OtlpExporter.d.ts +72 -1
- package/dist/unstable/observability/OtlpExporter.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpExporter.js +69 -4
- package/dist/unstable/observability/OtlpExporter.js.map +1 -1
- package/dist/unstable/observability/OtlpLogger.d.ts +4 -3
- package/dist/unstable/observability/OtlpLogger.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpLogger.js +2 -2
- package/dist/unstable/observability/OtlpLogger.js.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.d.ts +7 -3
- package/dist/unstable/observability/OtlpMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.js +5 -2
- package/dist/unstable/observability/OtlpMetrics.js.map +1 -1
- package/dist/unstable/observability/OtlpTracer.d.ts +4 -3
- package/dist/unstable/observability/OtlpTracer.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpTracer.js +2 -2
- package/dist/unstable/observability/OtlpTracer.js.map +1 -1
- package/dist/unstable/persistence/Persistable.d.ts.map +1 -1
- package/dist/unstable/persistence/Persistable.js +2 -1
- package/dist/unstable/persistence/Persistable.js.map +1 -1
- package/dist/unstable/persistence/RateLimiter.d.ts +2 -2
- package/dist/unstable/persistence/RateLimiter.js +2 -2
- package/dist/unstable/persistence/RateLimiter.js.map +1 -1
- package/dist/unstable/persistence/Redis.d.ts.map +1 -1
- package/dist/unstable/persistence/Redis.js +2 -2
- package/dist/unstable/persistence/Redis.js.map +1 -1
- package/dist/unstable/process/ChildProcessSpawner.js +3 -1
- package/dist/unstable/process/ChildProcessSpawner.js.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.js +4 -3
- package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
- package/dist/unstable/reactivity/Atom.d.ts +83 -0
- package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
- package/dist/unstable/reactivity/Atom.js +31 -0
- package/dist/unstable/reactivity/Atom.js.map +1 -1
- package/dist/unstable/reactivity/AtomRegistry.js +1 -1
- package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
- package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcClient.js +2 -1
- package/dist/unstable/rpc/RpcClient.js.map +1 -1
- package/dist/unstable/schema/VariantSchema.d.ts +1 -2
- package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
- package/dist/unstable/schema/VariantSchema.js +13 -10
- package/dist/unstable/schema/VariantSchema.js.map +1 -1
- package/dist/unstable/socket/Socket.d.ts +1 -1
- package/dist/unstable/socket/Socket.js +1 -1
- package/dist/unstable/socket/Socket.js.map +1 -1
- package/dist/unstable/sql/SqlError.d.ts +2 -2
- package/dist/unstable/sql/SqlError.js +2 -2
- package/dist/unstable/sql/SqlError.js.map +1 -1
- package/dist/unstable/sql/Statement.d.ts.map +1 -1
- package/dist/unstable/sql/Statement.js +7 -6
- package/dist/unstable/sql/Statement.js.map +1 -1
- package/package.json +1 -1
- package/src/Array.ts +86 -25
- package/src/Channel.ts +32 -14
- package/src/Config.ts +6 -5
- package/src/ConfigProvider.ts +7 -7
- package/src/Data.ts +3 -2
- package/src/Effect.ts +70 -116
- package/src/FiberHandle.ts +3 -2
- package/src/Iterable.ts +2 -1
- package/src/JsonPatch.ts +4 -3
- package/src/JsonSchema.ts +9 -11
- package/src/Logger.ts +3 -2
- package/src/ManagedRuntime.ts +13 -0
- package/src/Metric.ts +4 -3
- package/src/MutableList.ts +4 -0
- package/src/Optic.ts +5 -4
- package/src/Option.ts +2 -1
- package/src/PartitionedSemaphore.ts +1 -4
- package/src/Record.ts +119 -22
- package/src/References.ts +0 -46
- package/src/Request.ts +5 -7
- package/src/Result.ts +2 -1
- package/src/Schema.ts +2538 -987
- package/src/SchemaAST.ts +228 -149
- package/src/SchemaError.ts +1 -1
- package/src/SchemaGetter.ts +36 -29
- package/src/SchemaIssue.ts +1 -1
- package/src/SchemaParser.ts +1 -25
- package/src/SchemaRepresentation.ts +697 -3398
- package/src/SchemaTransformation.ts +3 -3
- package/src/Semaphore.ts +5 -3
- package/src/Stream.ts +63 -19
- package/src/Struct.ts +5 -4
- package/src/Types.ts +1 -3
- package/src/index.ts +0 -5
- package/src/internal/core.ts +4 -3
- package/src/internal/effect.ts +132 -70
- package/src/internal/matcher.ts +1 -1
- package/src/internal/record.ts +11 -7
- package/src/internal/references.ts +0 -5
- package/src/internal/schema/annotations.ts +44 -0
- package/src/internal/schema/fromJsonSchemaDocument.ts +957 -0
- package/src/internal/schema/fromRepresentation.ts +345 -0
- package/src/internal/schema/schema.ts +45 -46
- package/src/internal/schema/{arbitrary.ts → toArbitrary.ts} +8 -10
- package/src/internal/schema/toCodeDocument.ts +572 -0
- package/src/internal/schema/{equivalence.ts → toEquivalence.ts} +12 -7
- package/src/internal/schema/toJsonSchemaDocument.ts +475 -0
- package/src/internal/schema/toRepresentation.ts +401 -0
- package/src/internal/stackTraceLimit.ts +3 -7
- package/src/testing/TestClock.ts +1 -1
- package/src/unstable/ai/AiError.ts +5 -4
- package/src/unstable/ai/AnthropicStructuredOutput.ts +102 -333
- package/src/unstable/ai/EmbeddingModel.ts +1 -1
- package/src/unstable/ai/LanguageModel.ts +30 -28
- package/src/unstable/ai/McpSchema.ts +15 -15
- package/src/unstable/ai/McpServer.ts +172 -56
- package/src/unstable/ai/OpenAiStructuredOutput.ts +230 -395
- package/src/unstable/ai/Response.ts +24 -24
- package/src/unstable/ai/Tool.ts +22 -4
- package/src/unstable/ai/Toolkit.ts +19 -7
- package/src/unstable/ai/internal/codec-transformer.ts +13 -7
- package/src/unstable/ai/internal/structured-output.ts +458 -0
- package/src/unstable/cli/CliError.ts +51 -5
- package/src/unstable/cli/Command.ts +4 -4
- package/src/unstable/cli/Param.ts +3 -3
- package/src/unstable/cli/Primitive.ts +1 -1
- package/src/unstable/cli/internal/command.ts +13 -5
- package/src/unstable/cli/internal/config.ts +8 -10
- package/src/unstable/cluster/ClusterWorkflowEngine.ts +3 -3
- package/src/unstable/cluster/Entity.ts +1 -1
- package/src/unstable/cluster/Envelope.ts +2 -1
- package/src/unstable/cluster/Reply.ts +1 -1
- package/src/unstable/cluster/Runner.ts +1 -1
- package/src/unstable/cluster/RunnerAddress.ts +1 -1
- package/src/unstable/cluster/ShardId.ts +1 -1
- package/src/unstable/cluster/Sharding.ts +161 -34
- package/src/unstable/cluster/ShardingConfig.ts +5 -1
- package/src/unstable/cluster/SingleRunner.ts +4 -2
- package/src/unstable/cluster/SqlMessageStorage.ts +83 -35
- package/src/unstable/cluster/SqlRunnerStorage.ts +186 -116
- package/src/unstable/cluster/internal/entityManager.ts +31 -10
- package/src/unstable/cluster/internal/shardLock.ts +9 -0
- package/src/unstable/devtools/DevToolsSchema.ts +10 -5
- package/src/unstable/eventlog/EventJournal.ts +1 -1
- package/src/unstable/eventlog/EventLog.ts +21 -11
- package/src/unstable/eventlog/EventLogEncryption.ts +1 -1
- package/src/unstable/eventlog/EventLogMessage.ts +10 -3
- package/src/unstable/eventlog/SqlEventJournal.ts +2 -2
- package/src/unstable/eventlog/SqlEventLogServerEncrypted.ts +1 -1
- package/src/unstable/eventlog/SqlEventLogServerUnencrypted.ts +6 -3
- package/src/unstable/http/Cookies.ts +29 -24
- package/src/unstable/http/Headers.ts +8 -8
- package/src/unstable/http/HttpClientRequest.ts +57 -0
- package/src/unstable/http/HttpRouter.ts +6 -3
- package/src/unstable/http/HttpServerRequest.ts +5 -4
- package/src/unstable/http/Multipart.ts +16 -13
- package/src/unstable/http/Template.ts +1 -1
- package/src/unstable/http/UrlParams.ts +17 -14
- package/src/unstable/httpapi/HttpApi.ts +3 -3
- package/src/unstable/httpapi/HttpApiClient.ts +5 -5
- package/src/unstable/httpapi/HttpApiGroup.ts +1 -1
- package/src/unstable/httpapi/OpenApi.ts +52 -28
- package/src/unstable/observability/OtlpExporter.ts +109 -5
- package/src/unstable/observability/OtlpLogger.ts +5 -5
- package/src/unstable/observability/OtlpMetrics.ts +8 -4
- package/src/unstable/observability/OtlpTracer.ts +8 -4
- package/src/unstable/persistence/Persistable.ts +3 -2
- package/src/unstable/persistence/RateLimiter.ts +2 -2
- package/src/unstable/persistence/Redis.ts +2 -2
- package/src/unstable/process/ChildProcessSpawner.ts +1 -1
- package/src/unstable/reactivity/AsyncResult.ts +4 -3
- package/src/unstable/reactivity/Atom.ts +92 -0
- package/src/unstable/reactivity/AtomRegistry.ts +1 -1
- package/src/unstable/rpc/RpcClient.ts +2 -1
- package/src/unstable/schema/VariantSchema.ts +14 -24
- package/src/unstable/socket/Socket.ts +1 -1
- package/src/unstable/sql/SqlError.ts +2 -2
- package/src/unstable/sql/Statement.ts +7 -6
- package/dist/SchemaUtils.d.ts +0 -28
- package/dist/SchemaUtils.d.ts.map +0 -1
- package/dist/SchemaUtils.js +0 -45
- package/dist/SchemaUtils.js.map +0 -1
- package/dist/internal/schema/arbitrary.d.ts.map +0 -1
- package/dist/internal/schema/arbitrary.js.map +0 -1
- package/dist/internal/schema/equivalence.d.ts +0 -2
- package/dist/internal/schema/equivalence.d.ts.map +0 -1
- package/dist/internal/schema/equivalence.js.map +0 -1
- package/dist/internal/schema/representation.d.ts +0 -2
- package/dist/internal/schema/representation.d.ts.map +0 -1
- package/dist/internal/schema/representation.js +0 -865
- package/dist/internal/schema/representation.js.map +0 -1
- package/src/SchemaUtils.ts +0 -51
- package/src/internal/schema/representation.ts +0 -795
|
@@ -1,3031 +1,473 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* `Representation` is not the original `Schema` object; it is a JSON-friendly
|
|
4
|
-
* description of the schema's types, fields, unions, checks, annotations, and
|
|
5
|
-
* references.
|
|
6
|
-
*
|
|
7
|
-
* This module defines the representation node types, document types, and
|
|
8
|
-
* codecs used to validate those documents. It can build representation
|
|
9
|
-
* documents from schema ASTs, turn representation documents back into schemas,
|
|
10
|
-
* convert them to and from JSON Schema documents, and generate TypeScript code
|
|
11
|
-
* artifacts for schema definitions.
|
|
2
|
+
* Open, compiler-extensible representation of Effect schemas.
|
|
12
3
|
*
|
|
13
4
|
* @since 4.0.0
|
|
14
5
|
*/
|
|
15
|
-
import * as
|
|
16
|
-
import
|
|
17
|
-
import
|
|
18
|
-
import * as
|
|
19
|
-
import
|
|
20
|
-
import
|
|
6
|
+
import * as InternalRecord from "./internal/record.js";
|
|
7
|
+
import * as InternalFromJsonSchemaDocument from "./internal/schema/fromJsonSchemaDocument.js";
|
|
8
|
+
import * as InternalFromRepresentation from "./internal/schema/fromRepresentation.js";
|
|
9
|
+
import * as InternalSchema from "./internal/schema/schema.js";
|
|
10
|
+
import * as InternalToCodeDocument from "./internal/schema/toCodeDocument.js";
|
|
11
|
+
import * as InternalToJsonSchemaDocument from "./internal/schema/toJsonSchemaDocument.js";
|
|
12
|
+
import * as InternalToRepresentation from "./internal/schema/toRepresentation.js";
|
|
21
13
|
import * as Option from "./Option.js";
|
|
22
|
-
import * as Predicate from "./Predicate.js";
|
|
23
|
-
import * as Rec from "./Record.js";
|
|
24
14
|
import * as Schema from "./Schema.js";
|
|
25
15
|
import * as SchemaAST from "./SchemaAST.js";
|
|
26
16
|
import * as SchemaGetter from "./SchemaGetter.js";
|
|
27
|
-
// -----------------------------------------------------------------------------
|
|
28
|
-
// schemas
|
|
29
|
-
// -----------------------------------------------------------------------------
|
|
30
|
-
const Representation$ref = /*#__PURE__*/Schema.suspend(() => $Representation);
|
|
31
|
-
const toJsonAnnotationsBlacklist = /*#__PURE__*/new Set([...InternalRepresentation.fromASTBlacklist, "expected", "contentMediaType", "contentSchema"]);
|
|
32
|
-
/**
|
|
33
|
-
* Schema for {@link PrimitiveTree}.
|
|
34
|
-
*
|
|
35
|
-
* **When to use**
|
|
36
|
-
*
|
|
37
|
-
* Use to validate recursive annotation metadata trees whose leaves are `null`,
|
|
38
|
-
* `number`, `boolean`, `bigint`, `symbol`, or `string`.
|
|
39
|
-
*
|
|
40
|
-
* @see {@link PrimitiveTree} for the recursive tree type accepted by this codec
|
|
41
|
-
* @see {@link $Annotations} for the annotation codec that filters values through this codec
|
|
42
|
-
*
|
|
43
|
-
* @category schemas
|
|
44
|
-
* @since 4.0.0
|
|
45
|
-
*/
|
|
46
|
-
export const $PrimitiveTree = /*#__PURE__*/Schema.Tree(/*#__PURE__*/Schema.Union([Schema.Null, Schema.Number,
|
|
47
|
-
// allows NaN, Infinity, -Infinity
|
|
48
|
-
Schema.Boolean, Schema.BigInt, Schema.Symbol, Schema.String]));
|
|
49
|
-
const isPrimitiveTree = /*#__PURE__*/Schema.is($PrimitiveTree);
|
|
50
|
-
/**
|
|
51
|
-
* Schema for serializing public `Schema.Annotations.Annotations` values. It
|
|
52
|
-
* filters out internal annotation keys and non-primitive values during
|
|
53
|
-
* encoding.
|
|
54
|
-
*
|
|
55
|
-
* **When to use**
|
|
56
|
-
*
|
|
57
|
-
* Use to serialize schema annotations in representation schemas while retaining
|
|
58
|
-
* only primitive-tree metadata.
|
|
59
|
-
*
|
|
60
|
-
* **Details**
|
|
61
|
-
*
|
|
62
|
-
* Decoding is passthrough. Encoding removes internal annotation keys and values
|
|
63
|
-
* that are not accepted by `$PrimitiveTree`.
|
|
64
|
-
*
|
|
65
|
-
* @see {@link $PrimitiveTree} for the codec used to filter annotation values
|
|
66
|
-
*
|
|
67
|
-
* @category schemas
|
|
68
|
-
* @since 4.0.0
|
|
69
|
-
*/
|
|
70
|
-
export const $Annotations = /*#__PURE__*/Schema.Record(Schema.String, Schema.Unknown).pipe(Schema.encodeTo(Schema.Record(Schema.String, $PrimitiveTree), {
|
|
71
|
-
decode: SchemaGetter.passthrough(),
|
|
72
|
-
encode: SchemaGetter.transformOptional(Option.flatMap(r => {
|
|
73
|
-
const out = {};
|
|
74
|
-
for (const [k, v] of Object.entries(r)) {
|
|
75
|
-
if (!toJsonAnnotationsBlacklist.has(k) && isPrimitiveTree(v)) {
|
|
76
|
-
out[k] = v;
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
return Rec.isEmptyRecord(out) ? Option.none() : Option.some(out);
|
|
80
|
-
}))
|
|
81
|
-
})).annotate({
|
|
82
|
-
identifier: "Annotations"
|
|
83
|
-
});
|
|
84
17
|
/**
|
|
85
|
-
*
|
|
18
|
+
* Creates a declaration reviver while inferring its payload type from `payloadSchema`.
|
|
86
19
|
*
|
|
87
|
-
* @category
|
|
20
|
+
* @category constructors
|
|
88
21
|
* @since 4.0.0
|
|
89
22
|
*/
|
|
90
|
-
export const
|
|
91
|
-
_tag: Schema.tag("Null"),
|
|
92
|
-
annotations: Schema.optional($Annotations)
|
|
93
|
-
}).annotate({
|
|
94
|
-
identifier: "Null"
|
|
95
|
-
});
|
|
23
|
+
export const makeDeclarationReviver = InternalSchema.makeDeclarationReviver;
|
|
96
24
|
/**
|
|
97
|
-
*
|
|
25
|
+
* Creates a filter reviver while inferring its payload type from `payloadSchema`.
|
|
98
26
|
*
|
|
99
|
-
* @category
|
|
27
|
+
* @category constructors
|
|
100
28
|
* @since 4.0.0
|
|
101
29
|
*/
|
|
102
|
-
export const
|
|
103
|
-
_tag: Schema.tag("Undefined"),
|
|
104
|
-
annotations: Schema.optional($Annotations)
|
|
105
|
-
}).annotate({
|
|
106
|
-
identifier: "Undefined"
|
|
107
|
-
});
|
|
30
|
+
export const makeFilterReviver = InternalSchema.makeFilterReviver;
|
|
108
31
|
/**
|
|
109
|
-
*
|
|
32
|
+
* Creates a filter group reviver while inferring its payload type from `payloadSchema`.
|
|
110
33
|
*
|
|
111
|
-
* @category
|
|
34
|
+
* @category constructors
|
|
112
35
|
* @since 4.0.0
|
|
113
36
|
*/
|
|
114
|
-
export const
|
|
115
|
-
_tag: Schema.tag("Void"),
|
|
116
|
-
annotations: Schema.optional($Annotations)
|
|
117
|
-
}).annotate({
|
|
118
|
-
identifier: "Void"
|
|
119
|
-
});
|
|
37
|
+
export const makeFilterGroupReviver = InternalSchema.makeFilterGroupReviver;
|
|
120
38
|
/**
|
|
121
|
-
*
|
|
39
|
+
* Creates generated runtime and TypeScript source strings for a schema.
|
|
122
40
|
*
|
|
123
|
-
* @category
|
|
41
|
+
* @category constructors
|
|
124
42
|
* @since 4.0.0
|
|
125
43
|
*/
|
|
126
|
-
export const
|
|
127
|
-
_tag: Schema.tag("Never"),
|
|
128
|
-
annotations: Schema.optional($Annotations)
|
|
129
|
-
}).annotate({
|
|
130
|
-
identifier: "Never"
|
|
131
|
-
});
|
|
44
|
+
export const makeCode = InternalToCodeDocument.makeCode;
|
|
132
45
|
/**
|
|
133
|
-
*
|
|
46
|
+
* Lowers the encoded side of an AST to a live representation document.
|
|
134
47
|
*
|
|
135
|
-
*
|
|
136
|
-
* @since 4.0.0
|
|
137
|
-
*/
|
|
138
|
-
export const $Unknown = /*#__PURE__*/Schema.Struct({
|
|
139
|
-
_tag: Schema.tag("Unknown"),
|
|
140
|
-
annotations: Schema.optional($Annotations)
|
|
141
|
-
}).annotate({
|
|
142
|
-
identifier: "Unknown"
|
|
143
|
-
});
|
|
144
|
-
/**
|
|
145
|
-
* Schema for the {@link Any} representation node.
|
|
48
|
+
* **Details**
|
|
146
49
|
*
|
|
147
|
-
*
|
|
148
|
-
* @since 4.0.0
|
|
149
|
-
*/
|
|
150
|
-
export const $Any = /*#__PURE__*/Schema.Struct({
|
|
151
|
-
_tag: Schema.tag("Any"),
|
|
152
|
-
annotations: Schema.optional($Annotations)
|
|
153
|
-
}).annotate({
|
|
154
|
-
identifier: "Any"
|
|
155
|
-
});
|
|
156
|
-
const $IsStringFinite = /*#__PURE__*/Schema.Struct({
|
|
157
|
-
_tag: Schema.tag("isStringFinite"),
|
|
158
|
-
regExp: Schema.RegExp
|
|
159
|
-
}).annotate({
|
|
160
|
-
identifier: "IsStringFinite"
|
|
161
|
-
});
|
|
162
|
-
const $IsStringBigInt = /*#__PURE__*/Schema.Struct({
|
|
163
|
-
_tag: Schema.tag("isStringBigInt"),
|
|
164
|
-
regExp: Schema.RegExp
|
|
165
|
-
}).annotate({
|
|
166
|
-
identifier: "IsStringBigInt"
|
|
167
|
-
});
|
|
168
|
-
const $IsStringSymbol = /*#__PURE__*/Schema.Struct({
|
|
169
|
-
_tag: Schema.tag("isStringSymbol"),
|
|
170
|
-
regExp: Schema.RegExp
|
|
171
|
-
}).annotate({
|
|
172
|
-
identifier: "IsStringSymbol"
|
|
173
|
-
});
|
|
174
|
-
const $IsTrimmed = /*#__PURE__*/Schema.Struct({
|
|
175
|
-
_tag: Schema.tag("isTrimmed"),
|
|
176
|
-
regExp: Schema.RegExp
|
|
177
|
-
}).annotate({
|
|
178
|
-
identifier: "IsTrimmed"
|
|
179
|
-
});
|
|
180
|
-
const $IsUUID = /*#__PURE__*/Schema.Struct({
|
|
181
|
-
_tag: Schema.tag("isUUID"),
|
|
182
|
-
regExp: Schema.RegExp,
|
|
183
|
-
version: Schema.UndefinedOr(Schema.Literals([1, 2, 3, 4, 5, 6, 7, 8]))
|
|
184
|
-
}).annotate({
|
|
185
|
-
identifier: "IsUUID"
|
|
186
|
-
});
|
|
187
|
-
const $IsGUID = /*#__PURE__*/Schema.Struct({
|
|
188
|
-
_tag: Schema.tag("isGUID"),
|
|
189
|
-
regExp: Schema.RegExp
|
|
190
|
-
}).annotate({
|
|
191
|
-
identifier: "IsGUID"
|
|
192
|
-
});
|
|
193
|
-
const $IsULID = /*#__PURE__*/Schema.Struct({
|
|
194
|
-
_tag: Schema.tag("isULID"),
|
|
195
|
-
regExp: Schema.RegExp
|
|
196
|
-
}).annotate({
|
|
197
|
-
identifier: "IsULID"
|
|
198
|
-
});
|
|
199
|
-
const $IsBase64 = /*#__PURE__*/Schema.Struct({
|
|
200
|
-
_tag: Schema.tag("isBase64"),
|
|
201
|
-
regExp: Schema.RegExp
|
|
202
|
-
}).annotate({
|
|
203
|
-
identifier: "IsBase64"
|
|
204
|
-
});
|
|
205
|
-
const $IsBase64Url = /*#__PURE__*/Schema.Struct({
|
|
206
|
-
_tag: Schema.tag("isBase64Url"),
|
|
207
|
-
regExp: Schema.RegExp
|
|
208
|
-
}).annotate({
|
|
209
|
-
identifier: "IsBase64Url"
|
|
210
|
-
});
|
|
211
|
-
const $IsStartsWith = /*#__PURE__*/Schema.Struct({
|
|
212
|
-
_tag: Schema.tag("isStartsWith"),
|
|
213
|
-
startsWith: Schema.String,
|
|
214
|
-
regExp: Schema.RegExp
|
|
215
|
-
}).annotate({
|
|
216
|
-
identifier: "IsStartsWith"
|
|
217
|
-
});
|
|
218
|
-
const $IsEndsWith = /*#__PURE__*/Schema.Struct({
|
|
219
|
-
_tag: Schema.tag("isEndsWith"),
|
|
220
|
-
endsWith: Schema.String,
|
|
221
|
-
regExp: Schema.RegExp
|
|
222
|
-
}).annotate({
|
|
223
|
-
identifier: "IsEndsWith"
|
|
224
|
-
});
|
|
225
|
-
const $IsIncludes = /*#__PURE__*/Schema.Struct({
|
|
226
|
-
_tag: Schema.tag("isIncludes"),
|
|
227
|
-
includes: Schema.String,
|
|
228
|
-
regExp: Schema.RegExp
|
|
229
|
-
}).annotate({
|
|
230
|
-
identifier: "IsIncludes"
|
|
231
|
-
});
|
|
232
|
-
const $IsUppercased = /*#__PURE__*/Schema.Struct({
|
|
233
|
-
_tag: Schema.tag("isUppercased"),
|
|
234
|
-
regExp: Schema.RegExp
|
|
235
|
-
}).annotate({
|
|
236
|
-
identifier: "IsUppercased"
|
|
237
|
-
});
|
|
238
|
-
const $IsLowercased = /*#__PURE__*/Schema.Struct({
|
|
239
|
-
_tag: Schema.tag("isLowercased"),
|
|
240
|
-
regExp: Schema.RegExp
|
|
241
|
-
}).annotate({
|
|
242
|
-
identifier: "IsLowercased"
|
|
243
|
-
});
|
|
244
|
-
const $IsCapitalized = /*#__PURE__*/Schema.Struct({
|
|
245
|
-
_tag: Schema.tag("isCapitalized"),
|
|
246
|
-
regExp: Schema.RegExp
|
|
247
|
-
}).annotate({
|
|
248
|
-
identifier: "IsCapitalized"
|
|
249
|
-
});
|
|
250
|
-
const $IsUncapitalized = /*#__PURE__*/Schema.Struct({
|
|
251
|
-
_tag: Schema.tag("isUncapitalized"),
|
|
252
|
-
regExp: Schema.RegExp
|
|
253
|
-
}).annotate({
|
|
254
|
-
identifier: "IsUncapitalized"
|
|
255
|
-
});
|
|
256
|
-
const NonNegativeInt = /*#__PURE__*/Schema.Int.check(/*#__PURE__*/Schema.isGreaterThanOrEqualTo(0));
|
|
257
|
-
const $IsMinLength = /*#__PURE__*/Schema.Struct({
|
|
258
|
-
_tag: Schema.tag("isMinLength"),
|
|
259
|
-
minLength: NonNegativeInt
|
|
260
|
-
}).annotate({
|
|
261
|
-
identifier: "IsMinLength"
|
|
262
|
-
});
|
|
263
|
-
const $IsMaxLength = /*#__PURE__*/Schema.Struct({
|
|
264
|
-
_tag: Schema.tag("isMaxLength"),
|
|
265
|
-
maxLength: NonNegativeInt
|
|
266
|
-
}).annotate({
|
|
267
|
-
identifier: "IsMaxLength"
|
|
268
|
-
});
|
|
269
|
-
const $IsLengthBetween = /*#__PURE__*/Schema.Struct({
|
|
270
|
-
_tag: Schema.tag("isLengthBetween"),
|
|
271
|
-
minimum: NonNegativeInt,
|
|
272
|
-
maximum: NonNegativeInt
|
|
273
|
-
}).annotate({
|
|
274
|
-
identifier: "IsLengthBetween"
|
|
275
|
-
});
|
|
276
|
-
const $IsPattern = /*#__PURE__*/Schema.Struct({
|
|
277
|
-
_tag: Schema.tag("isPattern"),
|
|
278
|
-
regExp: Schema.RegExp
|
|
279
|
-
}).annotate({
|
|
280
|
-
identifier: "IsPattern"
|
|
281
|
-
});
|
|
282
|
-
/**
|
|
283
|
-
* Schema for {@link StringMeta}.
|
|
50
|
+
* Apply `SchemaAST.toType` to the AST first to lower its type side instead.
|
|
284
51
|
*
|
|
285
|
-
* @category
|
|
52
|
+
* @category constructors
|
|
286
53
|
* @since 4.0.0
|
|
287
54
|
*/
|
|
288
|
-
export
|
|
289
|
-
|
|
290
|
-
});
|
|
291
|
-
function makeCheck(meta, identifier) {
|
|
292
|
-
const Check$ref = Schema.suspend(() => Check);
|
|
293
|
-
const Check = Schema.Union([Schema.Struct({
|
|
294
|
-
_tag: Schema.tag("Filter"),
|
|
295
|
-
annotations: Schema.optional($Annotations),
|
|
296
|
-
meta
|
|
297
|
-
}).annotate({
|
|
298
|
-
identifier: `${identifier}Filter`
|
|
299
|
-
}), Schema.Struct({
|
|
300
|
-
_tag: Schema.tag("FilterGroup"),
|
|
301
|
-
annotations: Schema.optional($Annotations),
|
|
302
|
-
checks: Schema.NonEmptyArray(Check$ref)
|
|
303
|
-
}).annotate({
|
|
304
|
-
identifier: `${identifier}FilterGroup`
|
|
305
|
-
})]).annotate({
|
|
306
|
-
identifier: `${identifier}Check`
|
|
307
|
-
});
|
|
308
|
-
return Check;
|
|
55
|
+
export function toRepresentation(ast) {
|
|
56
|
+
return InternalToRepresentation.toRepresentation(ast);
|
|
309
57
|
}
|
|
310
58
|
/**
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
* @category schemas
|
|
314
|
-
* @since 4.0.0
|
|
315
|
-
*/
|
|
316
|
-
export const $String = /*#__PURE__*/Schema.Struct({
|
|
317
|
-
_tag: Schema.tag("String"),
|
|
318
|
-
annotations: Schema.optional($Annotations),
|
|
319
|
-
checks: Schema.Array(makeCheck($StringMeta, "String")),
|
|
320
|
-
contentMediaType: Schema.optional(Schema.String),
|
|
321
|
-
contentSchema: Schema.optional(Representation$ref)
|
|
322
|
-
}).annotate({
|
|
323
|
-
identifier: "String"
|
|
324
|
-
});
|
|
325
|
-
const $IsInt = /*#__PURE__*/Schema.Struct({
|
|
326
|
-
_tag: Schema.tag("isInt")
|
|
327
|
-
}).annotate({
|
|
328
|
-
identifier: "IsInt"
|
|
329
|
-
});
|
|
330
|
-
const $IsMultipleOf = /*#__PURE__*/Schema.Struct({
|
|
331
|
-
_tag: Schema.tag("isMultipleOf"),
|
|
332
|
-
divisor: Schema.Finite
|
|
333
|
-
}).annotate({
|
|
334
|
-
identifier: "IsMultipleOf"
|
|
335
|
-
});
|
|
336
|
-
const $IsFinite = /*#__PURE__*/Schema.Struct({
|
|
337
|
-
_tag: Schema.tag("isFinite")
|
|
338
|
-
}).annotate({
|
|
339
|
-
identifier: "IsFinite"
|
|
340
|
-
});
|
|
341
|
-
const $IsGreaterThan = /*#__PURE__*/Schema.Struct({
|
|
342
|
-
_tag: Schema.tag("isGreaterThan"),
|
|
343
|
-
exclusiveMinimum: Schema.Finite
|
|
344
|
-
}).annotate({
|
|
345
|
-
identifier: "IsGreaterThan"
|
|
346
|
-
});
|
|
347
|
-
const $IsGreaterThanOrEqualTo = /*#__PURE__*/Schema.Struct({
|
|
348
|
-
_tag: Schema.tag("isGreaterThanOrEqualTo"),
|
|
349
|
-
minimum: Schema.Finite
|
|
350
|
-
}).annotate({
|
|
351
|
-
identifier: "IsGreaterThanOrEqualTo"
|
|
352
|
-
});
|
|
353
|
-
const $IsLessThan = /*#__PURE__*/Schema.Struct({
|
|
354
|
-
_tag: Schema.tag("isLessThan"),
|
|
355
|
-
exclusiveMaximum: Schema.Finite
|
|
356
|
-
}).annotate({
|
|
357
|
-
identifier: "IsLessThan"
|
|
358
|
-
});
|
|
359
|
-
const $IsLessThanOrEqualTo = /*#__PURE__*/Schema.Struct({
|
|
360
|
-
_tag: Schema.tag("isLessThanOrEqualTo"),
|
|
361
|
-
maximum: Schema.Finite
|
|
362
|
-
}).annotate({
|
|
363
|
-
identifier: "IsLessThanOrEqualTo"
|
|
364
|
-
});
|
|
365
|
-
const $IsBetween = /*#__PURE__*/Schema.Struct({
|
|
366
|
-
_tag: Schema.tag("isBetween"),
|
|
367
|
-
minimum: Schema.Finite,
|
|
368
|
-
maximum: Schema.Finite,
|
|
369
|
-
exclusiveMinimum: Schema.optional(Schema.Boolean),
|
|
370
|
-
exclusiveMaximum: Schema.optional(Schema.Boolean)
|
|
371
|
-
}).annotate({
|
|
372
|
-
identifier: "IsBetween"
|
|
373
|
-
});
|
|
374
|
-
/**
|
|
375
|
-
* Schema for {@link NumberMeta}.
|
|
376
|
-
*
|
|
377
|
-
* @category schemas
|
|
378
|
-
* @since 4.0.0
|
|
379
|
-
*/
|
|
380
|
-
export const $NumberMeta = /*#__PURE__*/Schema.Union([$IsInt, $IsMultipleOf, $IsFinite, $IsGreaterThan, $IsGreaterThanOrEqualTo, $IsLessThan, $IsLessThanOrEqualTo, $IsBetween]).annotate({
|
|
381
|
-
identifier: "NumberMeta"
|
|
382
|
-
});
|
|
383
|
-
/**
|
|
384
|
-
* Schema for the {@link Number} representation node.
|
|
385
|
-
*
|
|
386
|
-
* @category schemas
|
|
387
|
-
* @since 4.0.0
|
|
388
|
-
*/
|
|
389
|
-
export const $Number = /*#__PURE__*/Schema.Struct({
|
|
390
|
-
_tag: Schema.tag("Number"),
|
|
391
|
-
annotations: Schema.optional($Annotations),
|
|
392
|
-
checks: Schema.Array(makeCheck($NumberMeta, "Number"))
|
|
393
|
-
}).annotate({
|
|
394
|
-
identifier: "Number"
|
|
395
|
-
});
|
|
396
|
-
/**
|
|
397
|
-
* Schema for the {@link Boolean} representation node.
|
|
398
|
-
*
|
|
399
|
-
* @category schemas
|
|
400
|
-
* @since 4.0.0
|
|
401
|
-
*/
|
|
402
|
-
export const $Boolean = /*#__PURE__*/Schema.Struct({
|
|
403
|
-
_tag: Schema.tag("Boolean"),
|
|
404
|
-
annotations: Schema.optional($Annotations)
|
|
405
|
-
}).annotate({
|
|
406
|
-
identifier: "Boolean"
|
|
407
|
-
});
|
|
408
|
-
const $IsGreaterThanBigInt = /*#__PURE__*/Schema.Struct({
|
|
409
|
-
_tag: Schema.tag("isGreaterThanBigInt"),
|
|
410
|
-
exclusiveMinimum: Schema.BigInt
|
|
411
|
-
}).annotate({
|
|
412
|
-
identifier: "IsGreaterThanBigInt"
|
|
413
|
-
});
|
|
414
|
-
const $IsGreaterThanOrEqualToBigInt = /*#__PURE__*/Schema.Struct({
|
|
415
|
-
_tag: Schema.tag("isGreaterThanOrEqualToBigInt"),
|
|
416
|
-
minimum: Schema.BigInt
|
|
417
|
-
}).annotate({
|
|
418
|
-
identifier: "IsGreaterThanOrEqualToBigInt"
|
|
419
|
-
});
|
|
420
|
-
const $IsLessThanBigInt = /*#__PURE__*/Schema.Struct({
|
|
421
|
-
_tag: Schema.tag("isLessThanBigInt"),
|
|
422
|
-
exclusiveMaximum: Schema.BigInt
|
|
423
|
-
}).annotate({
|
|
424
|
-
identifier: "IsLessThanBigInt"
|
|
425
|
-
});
|
|
426
|
-
const $IsLessThanOrEqualToBigInt = /*#__PURE__*/Schema.Struct({
|
|
427
|
-
_tag: Schema.tag("isLessThanOrEqualToBigInt"),
|
|
428
|
-
maximum: Schema.BigInt
|
|
429
|
-
}).annotate({
|
|
430
|
-
identifier: "IsLessThanOrEqualToBigInt"
|
|
431
|
-
});
|
|
432
|
-
const $IsBetweenBigInt = /*#__PURE__*/Schema.Struct({
|
|
433
|
-
_tag: Schema.tag("isBetweenBigInt"),
|
|
434
|
-
minimum: Schema.BigInt,
|
|
435
|
-
maximum: Schema.BigInt,
|
|
436
|
-
exclusiveMinimum: Schema.optional(Schema.Boolean),
|
|
437
|
-
exclusiveMaximum: Schema.optional(Schema.Boolean)
|
|
438
|
-
}).annotate({
|
|
439
|
-
identifier: "IsBetweenBigInt"
|
|
440
|
-
});
|
|
441
|
-
const $BigIntMeta = /*#__PURE__*/Schema.Union([$IsGreaterThanBigInt, $IsGreaterThanOrEqualToBigInt, $IsLessThanBigInt, $IsLessThanOrEqualToBigInt, $IsBetweenBigInt]).annotate({
|
|
442
|
-
identifier: "BigIntMeta"
|
|
443
|
-
});
|
|
444
|
-
/**
|
|
445
|
-
* Schema for the {@link BigInt} representation node.
|
|
446
|
-
*
|
|
447
|
-
* **When to use**
|
|
448
|
-
*
|
|
449
|
-
* Use to encode, decode, or validate serialized `BigInt` representation nodes,
|
|
450
|
-
* not application `bigint` values.
|
|
59
|
+
* Lowers one or more AST encoded sides in a shared reference environment.
|
|
451
60
|
*
|
|
452
61
|
* **Details**
|
|
453
62
|
*
|
|
454
|
-
*
|
|
455
|
-
* and bigint-specific validation metadata in `checks`.
|
|
456
|
-
*
|
|
457
|
-
* @see {@link BigIntMeta} for the metadata accepted by the `checks` array
|
|
458
|
-
*
|
|
459
|
-
* @category schemas
|
|
460
|
-
* @since 4.0.0
|
|
461
|
-
*/
|
|
462
|
-
export const $BigInt = /*#__PURE__*/Schema.Struct({
|
|
463
|
-
_tag: Schema.tag("BigInt"),
|
|
464
|
-
annotations: Schema.optional($Annotations),
|
|
465
|
-
checks: Schema.Array(makeCheck($BigIntMeta, "BigInt"))
|
|
466
|
-
}).annotate({
|
|
467
|
-
identifier: "BigInt"
|
|
468
|
-
});
|
|
469
|
-
/**
|
|
470
|
-
* Schema for the {@link Symbol} representation node.
|
|
471
|
-
*
|
|
472
|
-
* @category schemas
|
|
473
|
-
* @since 4.0.0
|
|
474
|
-
*/
|
|
475
|
-
export const $Symbol = /*#__PURE__*/Schema.Struct({
|
|
476
|
-
_tag: Schema.tag("Symbol"),
|
|
477
|
-
annotations: Schema.optional($Annotations)
|
|
478
|
-
}).annotate({
|
|
479
|
-
identifier: "Symbol"
|
|
480
|
-
});
|
|
481
|
-
/**
|
|
482
|
-
* Schema for the literal value types allowed in a {@link Literal} node
|
|
483
|
-
* (string, finite number, boolean, or bigint).
|
|
484
|
-
*
|
|
485
|
-
* @category schemas
|
|
486
|
-
* @since 4.0.0
|
|
487
|
-
*/
|
|
488
|
-
export const $LiteralValue = /*#__PURE__*/Schema.Union([Schema.String, Schema.Finite, Schema.Boolean, Schema.BigInt]).annotate({
|
|
489
|
-
identifier: "LiteralValue"
|
|
490
|
-
});
|
|
491
|
-
/**
|
|
492
|
-
* Schema for the {@link Literal} representation node.
|
|
493
|
-
*
|
|
494
|
-
* @category schemas
|
|
495
|
-
* @since 4.0.0
|
|
496
|
-
*/
|
|
497
|
-
export const $Literal = /*#__PURE__*/Schema.Struct({
|
|
498
|
-
_tag: Schema.tag("Literal"),
|
|
499
|
-
annotations: Schema.optional($Annotations),
|
|
500
|
-
literal: $LiteralValue
|
|
501
|
-
}).annotate({
|
|
502
|
-
identifier: "Literal"
|
|
503
|
-
});
|
|
504
|
-
/**
|
|
505
|
-
* Schema for the {@link UniqueSymbol} representation node.
|
|
506
|
-
*
|
|
507
|
-
* @category schemas
|
|
508
|
-
* @since 4.0.0
|
|
509
|
-
*/
|
|
510
|
-
export const $UniqueSymbol = /*#__PURE__*/Schema.Struct({
|
|
511
|
-
_tag: Schema.tag("UniqueSymbol"),
|
|
512
|
-
annotations: Schema.optional($Annotations),
|
|
513
|
-
symbol: Schema.Symbol
|
|
514
|
-
}).annotate({
|
|
515
|
-
identifier: "UniqueSymbol"
|
|
516
|
-
});
|
|
517
|
-
/**
|
|
518
|
-
* Schema for the {@link ObjectKeyword} representation node.
|
|
63
|
+
* Apply `SchemaAST.toType` to an AST first to lower its type side instead.
|
|
519
64
|
*
|
|
520
|
-
* @category
|
|
521
|
-
* @since 4.0.0
|
|
522
|
-
*/
|
|
523
|
-
export const $ObjectKeyword = /*#__PURE__*/Schema.Struct({
|
|
524
|
-
_tag: Schema.tag("ObjectKeyword"),
|
|
525
|
-
annotations: Schema.optional($Annotations)
|
|
526
|
-
}).annotate({
|
|
527
|
-
identifier: "ObjectKeyword"
|
|
528
|
-
});
|
|
529
|
-
/**
|
|
530
|
-
* Schema for the {@link Enum} representation node.
|
|
531
|
-
*
|
|
532
|
-
* @category schemas
|
|
533
|
-
* @since 4.0.0
|
|
534
|
-
*/
|
|
535
|
-
export const $Enum = /*#__PURE__*/Schema.Struct({
|
|
536
|
-
_tag: Schema.tag("Enum"),
|
|
537
|
-
annotations: Schema.optional($Annotations),
|
|
538
|
-
enums: Schema.Array(Schema.Tuple([Schema.String, Schema.Union([Schema.String, Schema.Number // NaN, Infinity, -Infinity are allowed enum values
|
|
539
|
-
])]))
|
|
540
|
-
}).annotate({
|
|
541
|
-
identifier: "Enum"
|
|
542
|
-
});
|
|
543
|
-
/**
|
|
544
|
-
* Schema for the {@link TemplateLiteral} representation node.
|
|
545
|
-
*
|
|
546
|
-
* @category schemas
|
|
547
|
-
* @since 4.0.0
|
|
548
|
-
*/
|
|
549
|
-
export const $TemplateLiteral = /*#__PURE__*/Schema.Struct({
|
|
550
|
-
_tag: Schema.tag("TemplateLiteral"),
|
|
551
|
-
annotations: Schema.optional($Annotations),
|
|
552
|
-
parts: Schema.Array(Representation$ref)
|
|
553
|
-
}).annotate({
|
|
554
|
-
identifier: "TemplateLiteral"
|
|
555
|
-
});
|
|
556
|
-
/**
|
|
557
|
-
* Schema for the {@link Element} type (positional tuple element).
|
|
558
|
-
*
|
|
559
|
-
* @category schemas
|
|
560
|
-
* @since 4.0.0
|
|
561
|
-
*/
|
|
562
|
-
export const $Element = /*#__PURE__*/Schema.Struct({
|
|
563
|
-
isOptional: Schema.Boolean,
|
|
564
|
-
type: Representation$ref,
|
|
565
|
-
annotations: Schema.optional($Annotations)
|
|
566
|
-
}).annotate({
|
|
567
|
-
identifier: "Element"
|
|
568
|
-
});
|
|
569
|
-
const $IsUnique = /*#__PURE__*/Schema.Struct({
|
|
570
|
-
_tag: Schema.tag("isUnique")
|
|
571
|
-
}).annotate({
|
|
572
|
-
identifier: "IsUnique"
|
|
573
|
-
});
|
|
574
|
-
const $ArraysMeta = /*#__PURE__*/Schema.Union([$IsMinLength, $IsMaxLength, $IsLengthBetween, $IsUnique]).annotate({
|
|
575
|
-
identifier: "ArraysMeta"
|
|
576
|
-
});
|
|
577
|
-
/**
|
|
578
|
-
* Schema for the {@link Arrays} representation node.
|
|
579
|
-
*
|
|
580
|
-
* @category schemas
|
|
581
|
-
* @since 4.0.0
|
|
582
|
-
*/
|
|
583
|
-
export const $Arrays = /*#__PURE__*/Schema.Struct({
|
|
584
|
-
_tag: Schema.tag("Arrays"),
|
|
585
|
-
annotations: Schema.optional($Annotations),
|
|
586
|
-
elements: Schema.Array($Element),
|
|
587
|
-
rest: Schema.Array(Representation$ref),
|
|
588
|
-
checks: Schema.Array(makeCheck($ArraysMeta, "Arrays"))
|
|
589
|
-
}).annotate({
|
|
590
|
-
identifier: "Arrays"
|
|
591
|
-
});
|
|
592
|
-
/**
|
|
593
|
-
* Schema for the {@link PropertySignature} type.
|
|
594
|
-
*
|
|
595
|
-
* @category schemas
|
|
596
|
-
* @since 4.0.0
|
|
597
|
-
*/
|
|
598
|
-
export const $PropertySignature = /*#__PURE__*/Schema.Struct({
|
|
599
|
-
annotations: Schema.optional($Annotations),
|
|
600
|
-
name: Schema.PropertyKey,
|
|
601
|
-
type: Representation$ref,
|
|
602
|
-
isOptional: Schema.Boolean,
|
|
603
|
-
isMutable: Schema.Boolean
|
|
604
|
-
}).annotate({
|
|
605
|
-
identifier: "PropertySignature"
|
|
606
|
-
});
|
|
607
|
-
/**
|
|
608
|
-
* Schema for the {@link IndexSignature} type.
|
|
609
|
-
*
|
|
610
|
-
* @category schemas
|
|
611
|
-
* @since 4.0.0
|
|
612
|
-
*/
|
|
613
|
-
export const $IndexSignature = /*#__PURE__*/Schema.Struct({
|
|
614
|
-
parameter: Representation$ref,
|
|
615
|
-
type: Representation$ref
|
|
616
|
-
}).annotate({
|
|
617
|
-
identifier: "IndexSignature"
|
|
618
|
-
});
|
|
619
|
-
const $IsMinProperties = /*#__PURE__*/Schema.Struct({
|
|
620
|
-
_tag: Schema.tag("isMinProperties"),
|
|
621
|
-
minProperties: NonNegativeInt
|
|
622
|
-
}).annotate({
|
|
623
|
-
identifier: "IsMinProperties"
|
|
624
|
-
});
|
|
625
|
-
const $IsMaxProperties = /*#__PURE__*/Schema.Struct({
|
|
626
|
-
_tag: Schema.tag("isMaxProperties"),
|
|
627
|
-
maxProperties: NonNegativeInt
|
|
628
|
-
}).annotate({
|
|
629
|
-
identifier: "IsMaxProperties"
|
|
630
|
-
});
|
|
631
|
-
const $IsPropertiesLengthBetween = /*#__PURE__*/Schema.Struct({
|
|
632
|
-
_tag: Schema.tag("isPropertiesLengthBetween"),
|
|
633
|
-
minimum: NonNegativeInt,
|
|
634
|
-
maximum: NonNegativeInt
|
|
635
|
-
}).annotate({
|
|
636
|
-
identifier: "IsPropertiesLengthBetween"
|
|
637
|
-
});
|
|
638
|
-
const $IsPropertyNames = /*#__PURE__*/Schema.Struct({
|
|
639
|
-
_tag: Schema.tag("isPropertyNames"),
|
|
640
|
-
propertyNames: Representation$ref
|
|
641
|
-
}).annotate({
|
|
642
|
-
identifier: "IsPropertyNames"
|
|
643
|
-
});
|
|
644
|
-
/**
|
|
645
|
-
* Schema for {@link ObjectsMeta}.
|
|
646
|
-
*
|
|
647
|
-
* @category schemas
|
|
65
|
+
* @category constructors
|
|
648
66
|
* @since 4.0.0
|
|
649
67
|
*/
|
|
650
|
-
export
|
|
651
|
-
|
|
652
|
-
}
|
|
68
|
+
export function toRepresentations(asts) {
|
|
69
|
+
return InternalToRepresentation.toRepresentations(asts);
|
|
70
|
+
}
|
|
653
71
|
/**
|
|
654
|
-
*
|
|
72
|
+
* Converts live schemas and their named definitions to a shared representation document.
|
|
655
73
|
*
|
|
656
|
-
*
|
|
657
|
-
* @since 4.0.0
|
|
658
|
-
*/
|
|
659
|
-
export const $Objects = /*#__PURE__*/Schema.Struct({
|
|
660
|
-
_tag: Schema.tag("Objects"),
|
|
661
|
-
annotations: Schema.optional($Annotations),
|
|
662
|
-
propertySignatures: Schema.Array($PropertySignature),
|
|
663
|
-
indexSignatures: Schema.Array($IndexSignature),
|
|
664
|
-
checks: Schema.Array(makeCheck($ObjectsMeta, "Objects"))
|
|
665
|
-
}).annotate({
|
|
666
|
-
identifier: "Objects"
|
|
667
|
-
});
|
|
668
|
-
/**
|
|
669
|
-
* Schema for the {@link Union} representation node.
|
|
74
|
+
* **When to use**
|
|
670
75
|
*
|
|
671
|
-
*
|
|
672
|
-
* @since 4.0.0
|
|
673
|
-
*/
|
|
674
|
-
export const $Union = /*#__PURE__*/Schema.Struct({
|
|
675
|
-
_tag: Schema.tag("Union"),
|
|
676
|
-
annotations: Schema.optional($Annotations),
|
|
677
|
-
types: Schema.Array(Representation$ref),
|
|
678
|
-
mode: Schema.Literals(["anyOf", "oneOf"])
|
|
679
|
-
}).annotate({
|
|
680
|
-
identifier: "Union"
|
|
681
|
-
});
|
|
682
|
-
/**
|
|
683
|
-
* Schema for the {@link Reference} representation node.
|
|
76
|
+
* Use when schemas with shared or unreachable definitions must be passed to representation compilers such as `toCodeDocument`.
|
|
684
77
|
*
|
|
685
|
-
*
|
|
686
|
-
* @since 4.0.0
|
|
687
|
-
*/
|
|
688
|
-
export const $Reference = /*#__PURE__*/Schema.Struct({
|
|
689
|
-
_tag: Schema.tag("Reference"),
|
|
690
|
-
$ref: Schema.String
|
|
691
|
-
}).annotate({
|
|
692
|
-
identifier: "Reference"
|
|
693
|
-
});
|
|
694
|
-
const $IsDateValid = /*#__PURE__*/Schema.Struct({
|
|
695
|
-
_tag: Schema.tag("isDateValid")
|
|
696
|
-
}).annotate({
|
|
697
|
-
identifier: "IsDateValid"
|
|
698
|
-
});
|
|
699
|
-
const $IsGreaterThanDate = /*#__PURE__*/Schema.Struct({
|
|
700
|
-
_tag: Schema.tag("isGreaterThanDate"),
|
|
701
|
-
exclusiveMinimum: Schema.Date
|
|
702
|
-
}).annotate({
|
|
703
|
-
identifier: "IsGreaterThanDate"
|
|
704
|
-
});
|
|
705
|
-
const $IsGreaterThanOrEqualToDate = /*#__PURE__*/Schema.Struct({
|
|
706
|
-
_tag: Schema.tag("isGreaterThanOrEqualToDate"),
|
|
707
|
-
minimum: Schema.Date
|
|
708
|
-
}).annotate({
|
|
709
|
-
identifier: "IsGreaterThanOrEqualToDate"
|
|
710
|
-
});
|
|
711
|
-
const $IsLessThanDate = /*#__PURE__*/Schema.Struct({
|
|
712
|
-
_tag: Schema.tag("isLessThanDate"),
|
|
713
|
-
exclusiveMaximum: Schema.Date
|
|
714
|
-
}).annotate({
|
|
715
|
-
identifier: "IsLessThanDate"
|
|
716
|
-
});
|
|
717
|
-
const $IsLessThanOrEqualToDate = /*#__PURE__*/Schema.Struct({
|
|
718
|
-
_tag: Schema.tag("isLessThanOrEqualToDate"),
|
|
719
|
-
maximum: Schema.Date
|
|
720
|
-
}).annotate({
|
|
721
|
-
identifier: "IsLessThanOrEqualToDate"
|
|
722
|
-
});
|
|
723
|
-
const $IsBetweenDate = /*#__PURE__*/Schema.Struct({
|
|
724
|
-
_tag: Schema.tag("isBetweenDate"),
|
|
725
|
-
minimum: Schema.Date,
|
|
726
|
-
maximum: Schema.Date,
|
|
727
|
-
exclusiveMinimum: Schema.optional(Schema.Boolean),
|
|
728
|
-
exclusiveMaximum: Schema.optional(Schema.Boolean)
|
|
729
|
-
}).annotate({
|
|
730
|
-
identifier: "IsBetweenDate"
|
|
731
|
-
});
|
|
732
|
-
/**
|
|
733
|
-
* Schema for {@link DateMeta}.
|
|
78
|
+
* **Gotchas**
|
|
734
79
|
*
|
|
735
|
-
*
|
|
736
|
-
* @since 4.0.0
|
|
737
|
-
*/
|
|
738
|
-
export const $DateMeta = /*#__PURE__*/Schema.Union([$IsDateValid, $IsGreaterThanDate, $IsGreaterThanOrEqualToDate, $IsLessThanDate, $IsLessThanOrEqualToDate, $IsBetweenDate]).annotate({
|
|
739
|
-
identifier: "DateMeta"
|
|
740
|
-
});
|
|
741
|
-
const $IsMinSize = /*#__PURE__*/Schema.Struct({
|
|
742
|
-
_tag: Schema.tag("isMinSize"),
|
|
743
|
-
minSize: NonNegativeInt
|
|
744
|
-
}).annotate({
|
|
745
|
-
identifier: "IsMinSize"
|
|
746
|
-
});
|
|
747
|
-
const $IsMaxSize = /*#__PURE__*/Schema.Struct({
|
|
748
|
-
_tag: Schema.tag("isMaxSize"),
|
|
749
|
-
maxSize: NonNegativeInt
|
|
750
|
-
}).annotate({
|
|
751
|
-
identifier: "IsMaxSize"
|
|
752
|
-
});
|
|
753
|
-
const $IsSizeBetween = /*#__PURE__*/Schema.Struct({
|
|
754
|
-
_tag: Schema.tag("isSizeBetween"),
|
|
755
|
-
minimum: NonNegativeInt,
|
|
756
|
-
maximum: NonNegativeInt
|
|
757
|
-
}).annotate({
|
|
758
|
-
identifier: "IsSizeBetween"
|
|
759
|
-
});
|
|
760
|
-
/**
|
|
761
|
-
* Schema for {@link SizeMeta}.
|
|
80
|
+
* Every schema is projected to its encoded side. Definitions are preserved even when no root reaches them.
|
|
762
81
|
*
|
|
763
|
-
* @
|
|
764
|
-
* @
|
|
765
|
-
*/
|
|
766
|
-
export const $SizeMeta = /*#__PURE__*/Schema.Union([$IsMinSize, $IsMaxSize, $IsSizeBetween]).annotate({
|
|
767
|
-
identifier: "SizeMeta"
|
|
768
|
-
});
|
|
769
|
-
/**
|
|
770
|
-
* Schema for {@link DeclarationMeta}.
|
|
82
|
+
* @see {@link toRepresentations} for converting AST roots without an explicit definition map
|
|
83
|
+
* @see {@link toCodeDocument} for generating code from the result
|
|
771
84
|
*
|
|
772
|
-
* @category
|
|
85
|
+
* @category constructors
|
|
773
86
|
* @since 4.0.0
|
|
774
87
|
*/
|
|
775
|
-
export
|
|
776
|
-
|
|
777
|
-
}
|
|
88
|
+
export function fromSchemaMultiDocument(document) {
|
|
89
|
+
return InternalToRepresentation.fromSchemaMultiDocument(document);
|
|
90
|
+
}
|
|
778
91
|
/**
|
|
779
|
-
*
|
|
92
|
+
* Wraps a single representation document as a multi-document with one root.
|
|
780
93
|
*
|
|
781
|
-
*
|
|
782
|
-
* @since 4.0.0
|
|
783
|
-
*/
|
|
784
|
-
export const $Declaration = /*#__PURE__*/Schema.Struct({
|
|
785
|
-
_tag: Schema.tag("Declaration"),
|
|
786
|
-
annotations: Schema.optional($Annotations),
|
|
787
|
-
typeParameters: Schema.Array(Representation$ref),
|
|
788
|
-
checks: Schema.Array(makeCheck($DeclarationMeta, "Declaration")),
|
|
789
|
-
encodedSchema: Representation$ref
|
|
790
|
-
}).annotate({
|
|
791
|
-
identifier: "Declaration"
|
|
792
|
-
});
|
|
793
|
-
/**
|
|
794
|
-
* Schema for the {@link Suspend} representation node.
|
|
94
|
+
* **When to use**
|
|
795
95
|
*
|
|
796
|
-
*
|
|
797
|
-
* @since 4.0.0
|
|
798
|
-
*/
|
|
799
|
-
export const $Suspend = /*#__PURE__*/Schema.Struct({
|
|
800
|
-
_tag: Schema.tag("Suspend"),
|
|
801
|
-
annotations: Schema.optional($Annotations),
|
|
802
|
-
checks: Schema.Tuple([]),
|
|
803
|
-
thunk: Representation$ref
|
|
804
|
-
}).annotate({
|
|
805
|
-
identifier: "Suspend"
|
|
806
|
-
});
|
|
807
|
-
/**
|
|
808
|
-
* Schema for the full {@link Representation} union. It recursively validates
|
|
809
|
-
* and encodes any representation node.
|
|
96
|
+
* Use when an API such as `toCodeDocument` requires a `MultiDocument`.
|
|
810
97
|
*
|
|
811
|
-
* @category
|
|
98
|
+
* @category transforming
|
|
812
99
|
* @since 4.0.0
|
|
813
100
|
*/
|
|
814
|
-
export
|
|
815
|
-
|
|
816
|
-
|
|
101
|
+
export function toMultiDocument(document) {
|
|
102
|
+
return {
|
|
103
|
+
representations: [document.representation],
|
|
104
|
+
references: document.references
|
|
105
|
+
};
|
|
106
|
+
}
|
|
817
107
|
/**
|
|
818
|
-
* Schema
|
|
108
|
+
* Compiles a live representation document to JSON Schema Draft 2020-12.
|
|
819
109
|
*
|
|
820
110
|
* **When to use**
|
|
821
111
|
*
|
|
822
|
-
* Use
|
|
823
|
-
* `Schema.decodeUnknownSync` or `Schema.encodeSync`.
|
|
112
|
+
* Use when you need JSON Schema output from a representation whose checks carry compiler annotations.
|
|
824
113
|
*
|
|
825
114
|
* **Gotchas**
|
|
826
115
|
*
|
|
827
|
-
*
|
|
828
|
-
* against `references`.
|
|
829
|
-
*
|
|
830
|
-
* @see {@link DocumentFromJson} for the JSON-string codec wrapper
|
|
831
|
-
* @see {@link $MultiDocument} for validating documents with multiple root representations
|
|
116
|
+
* Opaque declarations are represented by an unconstrained JSON Schema. Check callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
832
117
|
*
|
|
833
|
-
* @
|
|
834
|
-
* @since 4.0.0
|
|
835
|
-
*/
|
|
836
|
-
export const $Document = /*#__PURE__*/Schema.Struct({
|
|
837
|
-
representation: $Representation,
|
|
838
|
-
references: Schema.Record(Schema.String, $Representation)
|
|
839
|
-
}).annotate({
|
|
840
|
-
identifier: "Document"
|
|
841
|
-
});
|
|
842
|
-
/**
|
|
843
|
-
* Schema for {@link MultiDocument}.
|
|
118
|
+
* @see {@link toJsonSchemaMultiDocument} for multiple roots sharing definitions
|
|
844
119
|
*
|
|
845
|
-
* @category
|
|
120
|
+
* @category transforming
|
|
846
121
|
* @since 4.0.0
|
|
847
122
|
*/
|
|
848
|
-
export
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
}).annotate({
|
|
852
|
-
identifier: "MultiDocument"
|
|
853
|
-
});
|
|
854
|
-
// -----------------------------------------------------------------------------
|
|
855
|
-
// APIs
|
|
856
|
-
// -----------------------------------------------------------------------------
|
|
123
|
+
export function toJsonSchemaDocument(document, options) {
|
|
124
|
+
return InternalToJsonSchemaDocument.toJsonSchemaDocument(document, options);
|
|
125
|
+
}
|
|
857
126
|
/**
|
|
858
|
-
*
|
|
127
|
+
* Compiles multiple live representations to a shared JSON Schema Draft 2020-12 document.
|
|
859
128
|
*
|
|
860
129
|
* **When to use**
|
|
861
130
|
*
|
|
862
|
-
* Use when
|
|
863
|
-
* document.
|
|
864
|
-
*
|
|
865
|
-
* **Details**
|
|
866
|
-
*
|
|
867
|
-
* Shared/recursive sub-schemas are extracted into the `references` map.
|
|
868
|
-
*
|
|
869
|
-
* **Example** (Converting a Schema to a Document)
|
|
870
|
-
*
|
|
871
|
-
* ```ts
|
|
872
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
131
|
+
* Use when several representation roots must share the same JSON Schema definitions.
|
|
873
132
|
*
|
|
874
|
-
*
|
|
875
|
-
* name: Schema.String,
|
|
876
|
-
* age: Schema.Number
|
|
877
|
-
* })
|
|
133
|
+
* **Gotchas**
|
|
878
134
|
*
|
|
879
|
-
*
|
|
880
|
-
* console.log(doc.representation._tag)
|
|
881
|
-
* // "Objects"
|
|
882
|
-
* ```
|
|
135
|
+
* Every definition is compiled, including definitions that are not reachable from a root.
|
|
883
136
|
*
|
|
884
|
-
* @see {@link
|
|
885
|
-
* @see {@link fromASTs}
|
|
137
|
+
* @see {@link toJsonSchemaDocument} for a single root
|
|
886
138
|
*
|
|
887
|
-
* @category
|
|
139
|
+
* @category transforming
|
|
888
140
|
* @since 4.0.0
|
|
889
141
|
*/
|
|
890
|
-
export
|
|
142
|
+
export function toJsonSchemaMultiDocument(document, options) {
|
|
143
|
+
return InternalToJsonSchemaDocument.toJsonSchemaMultiDocument(document, options);
|
|
144
|
+
}
|
|
891
145
|
/**
|
|
892
|
-
*
|
|
146
|
+
* Generates TypeScript source for live schema representations and their definitions.
|
|
893
147
|
*
|
|
894
148
|
* **When to use**
|
|
895
149
|
*
|
|
896
|
-
* Use when
|
|
897
|
-
* `MultiDocument` with shared references.
|
|
150
|
+
* Use when custom declarations and checks provide `toCode` callbacks and must be emitted without a central handler registry.
|
|
898
151
|
*
|
|
899
|
-
* **
|
|
900
|
-
*
|
|
901
|
-
* All schemas share a single `references` map.
|
|
152
|
+
* **Gotchas**
|
|
902
153
|
*
|
|
903
|
-
*
|
|
904
|
-
* @see {@link fromAST}
|
|
154
|
+
* Opaque declarations and leaf checks require `toCode` callbacks. Callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
905
155
|
*
|
|
906
|
-
* @category
|
|
156
|
+
* @category transforming
|
|
907
157
|
* @since 4.0.0
|
|
908
158
|
*/
|
|
909
|
-
export
|
|
910
|
-
|
|
911
|
-
|
|
159
|
+
export function toCodeDocument(document) {
|
|
160
|
+
return InternalToCodeDocument.toCodeDocument(document);
|
|
161
|
+
}
|
|
162
|
+
const RepresentationSchema = /*#__PURE__*/Schema.suspend(() => RepresentationUnion);
|
|
163
|
+
const RepresentationsSchema = /*#__PURE__*/Schema.Array(RepresentationSchema);
|
|
164
|
+
const RepresentationAnnotationSchema = /*#__PURE__*/Schema.Struct({
|
|
165
|
+
id: Schema.NonEmptyString,
|
|
166
|
+
payload: Schema.Json
|
|
167
|
+
});
|
|
168
|
+
const CheckRepresentationAnnotationSchema = /*#__PURE__*/Schema.Struct({
|
|
169
|
+
...RepresentationAnnotationSchema.fields,
|
|
170
|
+
schemas: /*#__PURE__*/Schema.optional(RepresentationsSchema)
|
|
171
|
+
});
|
|
172
|
+
const LiveAnnotationsSchema = /*#__PURE__*/Schema.Record(Schema.String, Schema.Unknown);
|
|
173
|
+
const JsonAnnotationsSchema = /*#__PURE__*/Schema.Record(Schema.String, Schema.Json);
|
|
174
|
+
function pruneAnnotations(annotations) {
|
|
175
|
+
const out = {};
|
|
176
|
+
for (const [key, value] of Object.entries(annotations)) {
|
|
177
|
+
if (SchemaAST.isJson(value)) {
|
|
178
|
+
InternalRecord.assignProperty(out, key, value);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
return Object.keys(out).length === 0 ? Option.none() : Option.some(out);
|
|
182
|
+
}
|
|
183
|
+
const AnnotationsSchema = /*#__PURE__*/Schema.optional(LiveAnnotationsSchema).pipe(/*#__PURE__*/Schema.encodeTo(/*#__PURE__*/Schema.optionalKey(JsonAnnotationsSchema), {
|
|
184
|
+
decode: /*#__PURE__*/SchemaGetter.passthroughSubtype(),
|
|
185
|
+
encode: /*#__PURE__*/SchemaGetter.transformOptional(annotations => Option.isNone(annotations) || annotations.value === undefined ? Option.none() : pruneAnnotations(annotations.value))
|
|
186
|
+
}));
|
|
187
|
+
const CheckSchema = /*#__PURE__*/Schema.suspend(() => CheckUnion);
|
|
188
|
+
const ChecksSchema = /*#__PURE__*/Schema.Array(CheckSchema);
|
|
189
|
+
const KeywordFields = {
|
|
190
|
+
annotations: AnnotationsSchema,
|
|
191
|
+
checks: ChecksSchema
|
|
192
|
+
};
|
|
193
|
+
const FilterSchema = /*#__PURE__*/Schema.Struct({
|
|
194
|
+
_tag: /*#__PURE__*/Schema.tag("Filter"),
|
|
195
|
+
representation: CheckRepresentationAnnotationSchema,
|
|
196
|
+
annotations: AnnotationsSchema,
|
|
197
|
+
aborted: Schema.Boolean
|
|
198
|
+
});
|
|
199
|
+
const FilterGroupSchema = /*#__PURE__*/Schema.Struct({
|
|
200
|
+
_tag: /*#__PURE__*/Schema.tag("FilterGroup"),
|
|
201
|
+
representation: /*#__PURE__*/Schema.optional(CheckRepresentationAnnotationSchema),
|
|
202
|
+
annotations: AnnotationsSchema,
|
|
203
|
+
checks: /*#__PURE__*/Schema.NonEmptyArray(CheckSchema)
|
|
204
|
+
});
|
|
205
|
+
const CheckUnion = /*#__PURE__*/Schema.Union([FilterSchema, FilterGroupSchema]);
|
|
206
|
+
function makeKeywordSchema(tag) {
|
|
207
|
+
return Schema.Struct({
|
|
208
|
+
_tag: Schema.tag(tag),
|
|
209
|
+
...KeywordFields
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
const DeclarationSchema = /*#__PURE__*/Schema.Struct({
|
|
213
|
+
_tag: /*#__PURE__*/Schema.tag("Declaration"),
|
|
214
|
+
representation: RepresentationAnnotationSchema,
|
|
215
|
+
annotations: AnnotationsSchema,
|
|
216
|
+
typeParameters: RepresentationsSchema,
|
|
217
|
+
checks: ChecksSchema
|
|
218
|
+
});
|
|
219
|
+
const SuspendSchema = /*#__PURE__*/Schema.Struct({
|
|
220
|
+
_tag: /*#__PURE__*/Schema.tag("Suspend"),
|
|
221
|
+
annotations: AnnotationsSchema,
|
|
222
|
+
checks: /*#__PURE__*/Schema.Tuple([]),
|
|
223
|
+
thunk: RepresentationSchema
|
|
224
|
+
});
|
|
225
|
+
function makeValueSchema(type, value) {
|
|
226
|
+
return value.pipe(Schema.encodeTo(Schema.Struct({
|
|
227
|
+
type: Schema.tag(type),
|
|
228
|
+
value
|
|
229
|
+
}), {
|
|
230
|
+
decode: SchemaGetter.transform(encoded => encoded.value),
|
|
231
|
+
encode: SchemaGetter.transform(value => ({
|
|
232
|
+
type,
|
|
233
|
+
value
|
|
234
|
+
}))
|
|
235
|
+
}));
|
|
236
|
+
}
|
|
237
|
+
const StringValueCodec = /*#__PURE__*/makeValueSchema("string", Schema.String);
|
|
238
|
+
const NumberValueCodec = /*#__PURE__*/makeValueSchema("number", Schema.Number);
|
|
239
|
+
const LiteralSchema = /*#__PURE__*/Schema.Struct({
|
|
240
|
+
_tag: /*#__PURE__*/Schema.tag("Literal"),
|
|
241
|
+
...KeywordFields,
|
|
242
|
+
literal: /*#__PURE__*/Schema.Union([StringValueCodec, /*#__PURE__*/makeValueSchema("number", Schema.Finite), /*#__PURE__*/makeValueSchema("bigint", Schema.BigInt), /*#__PURE__*/makeValueSchema("boolean", Schema.Boolean)])
|
|
243
|
+
});
|
|
244
|
+
const UniqueSymbolSchema = /*#__PURE__*/Schema.Struct({
|
|
245
|
+
_tag: /*#__PURE__*/Schema.tag("UniqueSymbol"),
|
|
246
|
+
...KeywordFields,
|
|
247
|
+
symbol: Schema.Symbol
|
|
248
|
+
});
|
|
249
|
+
const EnumSchema = /*#__PURE__*/Schema.Struct({
|
|
250
|
+
_tag: /*#__PURE__*/Schema.tag("Enum"),
|
|
251
|
+
...KeywordFields,
|
|
252
|
+
enums: /*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Tuple([Schema.String, /*#__PURE__*/Schema.Union([StringValueCodec, NumberValueCodec])]))
|
|
253
|
+
});
|
|
254
|
+
const TemplateLiteralSchema = /*#__PURE__*/Schema.Struct({
|
|
255
|
+
_tag: /*#__PURE__*/Schema.tag("TemplateLiteral"),
|
|
256
|
+
...KeywordFields,
|
|
257
|
+
parts: RepresentationsSchema
|
|
258
|
+
});
|
|
259
|
+
const ElementSchema = /*#__PURE__*/Schema.Struct({
|
|
260
|
+
isOptional: Schema.Boolean,
|
|
261
|
+
type: RepresentationSchema,
|
|
262
|
+
annotations: AnnotationsSchema
|
|
263
|
+
});
|
|
264
|
+
const ArraysSchema = /*#__PURE__*/Schema.Struct({
|
|
265
|
+
_tag: /*#__PURE__*/Schema.tag("Arrays"),
|
|
266
|
+
...KeywordFields,
|
|
267
|
+
elements: /*#__PURE__*/Schema.Array(ElementSchema),
|
|
268
|
+
rest: RepresentationsSchema
|
|
269
|
+
});
|
|
270
|
+
const PropertySignatureSchema = /*#__PURE__*/Schema.Struct({
|
|
271
|
+
name: /*#__PURE__*/Schema.Union([StringValueCodec, NumberValueCodec, /*#__PURE__*/makeValueSchema("symbol", Schema.Symbol)]),
|
|
272
|
+
type: RepresentationSchema,
|
|
273
|
+
isOptional: Schema.Boolean,
|
|
274
|
+
isMutable: Schema.Boolean,
|
|
275
|
+
annotations: AnnotationsSchema
|
|
276
|
+
});
|
|
277
|
+
const IndexSignatureSchema = /*#__PURE__*/Schema.Struct({
|
|
278
|
+
parameter: RepresentationSchema,
|
|
279
|
+
type: RepresentationSchema
|
|
280
|
+
});
|
|
281
|
+
const ObjectsSchema = /*#__PURE__*/Schema.Struct({
|
|
282
|
+
_tag: /*#__PURE__*/Schema.tag("Objects"),
|
|
283
|
+
...KeywordFields,
|
|
284
|
+
propertySignatures: /*#__PURE__*/Schema.Array(PropertySignatureSchema),
|
|
285
|
+
indexSignatures: /*#__PURE__*/Schema.Array(IndexSignatureSchema)
|
|
286
|
+
});
|
|
287
|
+
const UnionSchema = /*#__PURE__*/Schema.Struct({
|
|
288
|
+
_tag: /*#__PURE__*/Schema.tag("Union"),
|
|
289
|
+
...KeywordFields,
|
|
290
|
+
types: RepresentationsSchema,
|
|
291
|
+
mode: /*#__PURE__*/Schema.Literals(["anyOf", "oneOf"])
|
|
292
|
+
});
|
|
293
|
+
const ReferenceSchema = /*#__PURE__*/Schema.Struct({
|
|
294
|
+
_tag: /*#__PURE__*/Schema.tag("Reference"),
|
|
295
|
+
$ref: Schema.NonEmptyString
|
|
296
|
+
});
|
|
297
|
+
const RepresentationUnion = /*#__PURE__*/Schema.Union([DeclarationSchema, ReferenceSchema, SuspendSchema, /*#__PURE__*/makeKeywordSchema("Null"), /*#__PURE__*/makeKeywordSchema("Undefined"), /*#__PURE__*/makeKeywordSchema("Void"), /*#__PURE__*/makeKeywordSchema("Never"), /*#__PURE__*/makeKeywordSchema("Unknown"), /*#__PURE__*/makeKeywordSchema("Any"), /*#__PURE__*/makeKeywordSchema("String"), /*#__PURE__*/makeKeywordSchema("Number"), /*#__PURE__*/makeKeywordSchema("Boolean"), /*#__PURE__*/makeKeywordSchema("BigInt"), /*#__PURE__*/makeKeywordSchema("Symbol"), /*#__PURE__*/makeKeywordSchema("ObjectKeyword"), LiteralSchema, UniqueSymbolSchema, EnumSchema, TemplateLiteralSchema, ArraysSchema, ObjectsSchema, UnionSchema]);
|
|
298
|
+
const ReferencesSchema = /*#__PURE__*/Schema.Record(Schema.String, RepresentationSchema);
|
|
299
|
+
const DocumentFromJson = /*#__PURE__*/Schema.toCodecJson(/*#__PURE__*/Schema.Struct({
|
|
300
|
+
representation: RepresentationSchema,
|
|
301
|
+
references: ReferencesSchema
|
|
302
|
+
}));
|
|
303
|
+
const MultiDocumentFromJson = /*#__PURE__*/Schema.toCodecJson(/*#__PURE__*/Schema.Struct({
|
|
304
|
+
representations: /*#__PURE__*/Schema.NonEmptyArray(RepresentationSchema),
|
|
305
|
+
references: ReferencesSchema
|
|
306
|
+
}));
|
|
307
|
+
const encodeDocument = /*#__PURE__*/Schema.encodeSync(DocumentFromJson);
|
|
308
|
+
const encodeMultiDocument = /*#__PURE__*/Schema.encodeSync(MultiDocumentFromJson);
|
|
309
|
+
const decodeDocument = /*#__PURE__*/Schema.decodeSync(DocumentFromJson);
|
|
310
|
+
const decodeMultiDocument = /*#__PURE__*/Schema.decodeSync(MultiDocumentFromJson);
|
|
311
|
+
/**
|
|
312
|
+
* Projects a live single-root representation document and encodes it as JSON.
|
|
912
313
|
*
|
|
913
314
|
* **When to use**
|
|
914
315
|
*
|
|
915
|
-
* Use when you need a JSON
|
|
916
|
-
* `Schema.decodeUnknownSync` or `Schema.encodeSync`.
|
|
917
|
-
*
|
|
918
|
-
* **Example** (Round-tripping a Document through JSON)
|
|
919
|
-
*
|
|
920
|
-
* ```ts
|
|
921
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
316
|
+
* Use when you need a stable JSON value for storage or transport after calling `toRepresentation`.
|
|
922
317
|
*
|
|
923
|
-
*
|
|
924
|
-
* const json = Schema.encodeSync(SchemaRepresentation.DocumentFromJson)(doc)
|
|
925
|
-
* const back = Schema.decodeUnknownSync(SchemaRepresentation.DocumentFromJson)(json)
|
|
926
|
-
* ```
|
|
927
|
-
*
|
|
928
|
-
* @see {@link $Document}
|
|
929
|
-
* @see {@link MultiDocumentFromJson}
|
|
930
|
-
*
|
|
931
|
-
* @category schemas
|
|
932
|
-
* @since 4.0.0
|
|
933
|
-
*/
|
|
934
|
-
export const DocumentFromJson = /*#__PURE__*/Schema.toCodecJson($Document);
|
|
935
|
-
/**
|
|
936
|
-
* Schema for `MultiDocument` values encoded as JSON.
|
|
937
|
-
*
|
|
938
|
-
* @see {@link $MultiDocument}
|
|
939
|
-
* @see {@link DocumentFromJson}
|
|
940
|
-
*
|
|
941
|
-
* @category schemas
|
|
942
|
-
* @since 4.0.0
|
|
943
|
-
*/
|
|
944
|
-
export const MultiDocumentFromJson = /*#__PURE__*/Schema.toCodecJson($MultiDocument);
|
|
945
|
-
/**
|
|
946
|
-
* Wraps a single {@link Document} as a {@link MultiDocument} with one
|
|
947
|
-
* representation.
|
|
948
|
-
*
|
|
949
|
-
* **When to use**
|
|
318
|
+
* **Gotchas**
|
|
950
319
|
*
|
|
951
|
-
*
|
|
952
|
-
* API expects a `MultiDocument`.
|
|
320
|
+
* Generic annotations that are not JSON are omitted. Invalid persistence identities and unsupported structural values throw an `Error` containing their representation path.
|
|
953
321
|
*
|
|
954
|
-
* @see {@link
|
|
955
|
-
* @see {@link
|
|
322
|
+
* @see {@link toRepresentation} for constructing the live document
|
|
323
|
+
* @see {@link toJsonMultiDocument} for documents with multiple roots
|
|
956
324
|
*
|
|
957
|
-
* @category
|
|
325
|
+
* @category encoding
|
|
958
326
|
* @since 4.0.0
|
|
959
327
|
*/
|
|
960
|
-
export function
|
|
961
|
-
return
|
|
962
|
-
representations: [document.representation],
|
|
963
|
-
references: document.references
|
|
964
|
-
};
|
|
328
|
+
export function toJson(document) {
|
|
329
|
+
return encodeDocument(document);
|
|
965
330
|
}
|
|
966
331
|
/**
|
|
967
|
-
*
|
|
968
|
-
* types, including Option, Result, Redacted, Cause, Exit, ReadonlyMap, HashMap,
|
|
969
|
-
* ReadonlySet, Date, Duration, URL, and RegExp.
|
|
332
|
+
* Projects a live multi-root representation document and encodes it as JSON.
|
|
970
333
|
*
|
|
971
334
|
* **When to use**
|
|
972
335
|
*
|
|
973
|
-
* Use when you need
|
|
974
|
-
* reconstruct runtime schemas for built-in Effect declarations.
|
|
336
|
+
* Use when you need one JSON value for multiple live roots that share a reference environment.
|
|
975
337
|
*
|
|
976
|
-
* **
|
|
338
|
+
* **Gotchas**
|
|
977
339
|
*
|
|
978
|
-
* The
|
|
979
|
-
* fallback to `encodedSchema`.
|
|
340
|
+
* The root order and shared reference keys are preserved, while non-JSON generic annotations are omitted.
|
|
980
341
|
*
|
|
981
|
-
* @see {@link
|
|
982
|
-
* @see {@link
|
|
342
|
+
* @see {@link toRepresentations} for constructing the live multi-document
|
|
343
|
+
* @see {@link toJson} for a single-root document
|
|
983
344
|
*
|
|
984
|
-
* @category
|
|
345
|
+
* @category encoding
|
|
985
346
|
* @since 4.0.0
|
|
986
347
|
*/
|
|
987
|
-
export
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
const typeParameters = s.typeParameters.map(recur);
|
|
991
|
-
switch (typeConstructor._tag) {
|
|
992
|
-
// built-in types
|
|
993
|
-
case "Date":
|
|
994
|
-
return Schema.Date;
|
|
995
|
-
case "Error":
|
|
996
|
-
return Schema.Error(typeConstructor.options);
|
|
997
|
-
case "File":
|
|
998
|
-
return Schema.File;
|
|
999
|
-
case "FormData":
|
|
1000
|
-
return Schema.FormData;
|
|
1001
|
-
case "ReadonlyMap":
|
|
1002
|
-
return Schema.ReadonlyMap(typeParameters[0], typeParameters[1]);
|
|
1003
|
-
case "ReadonlySet":
|
|
1004
|
-
return Schema.ReadonlySet(typeParameters[0]);
|
|
1005
|
-
case "RegExp":
|
|
1006
|
-
return Schema.RegExp;
|
|
1007
|
-
case "Uint8Array":
|
|
1008
|
-
return Schema.Uint8Array;
|
|
1009
|
-
case "URL":
|
|
1010
|
-
return Schema.URL;
|
|
1011
|
-
case "URLSearchParams":
|
|
1012
|
-
return Schema.URLSearchParams;
|
|
1013
|
-
// effect types
|
|
1014
|
-
case "effect/Option":
|
|
1015
|
-
return Schema.Option(typeParameters[0]);
|
|
1016
|
-
case "effect/Result":
|
|
1017
|
-
return Schema.Result(typeParameters[0], typeParameters[1]);
|
|
1018
|
-
case "effect/Redacted":
|
|
1019
|
-
return Schema.Redacted(typeParameters[0], typeConstructor.options);
|
|
1020
|
-
case "effect/DateTime.TimeZone":
|
|
1021
|
-
return Schema.TimeZone;
|
|
1022
|
-
case "effect/DateTime.TimeZone.Named":
|
|
1023
|
-
return Schema.TimeZoneNamed;
|
|
1024
|
-
case "effect/DateTime.TimeZone.Offset":
|
|
1025
|
-
return Schema.TimeZoneOffset;
|
|
1026
|
-
case "effect/DateTime.Utc":
|
|
1027
|
-
return Schema.DateTimeUtc;
|
|
1028
|
-
case "effect/DateTime.Zoned":
|
|
1029
|
-
return Schema.DateTimeZoned;
|
|
1030
|
-
case "effect/BigDecimal":
|
|
1031
|
-
return Schema.BigDecimal;
|
|
1032
|
-
case "effect/Chunk":
|
|
1033
|
-
return Schema.Chunk(typeParameters[0]);
|
|
1034
|
-
case "effect/Cause":
|
|
1035
|
-
return Schema.Cause(typeParameters[0], typeParameters[1]);
|
|
1036
|
-
case "effect/Cause/Failure":
|
|
1037
|
-
return Schema.CauseReason(typeParameters[0], typeParameters[1]);
|
|
1038
|
-
case "effect/Duration":
|
|
1039
|
-
return Schema.Duration;
|
|
1040
|
-
case "effect/Exit":
|
|
1041
|
-
return Schema.Exit(typeParameters[0], typeParameters[1], typeParameters[2]);
|
|
1042
|
-
case "effect/Json":
|
|
1043
|
-
return Schema.Json;
|
|
1044
|
-
case "effect/MutableJson":
|
|
1045
|
-
return Schema.MutableJson;
|
|
1046
|
-
case "effect/HashMap":
|
|
1047
|
-
return Schema.HashMap(typeParameters[0], typeParameters[1]);
|
|
1048
|
-
case "effect/HashSet":
|
|
1049
|
-
return Schema.HashSet(typeParameters[0]);
|
|
1050
|
-
}
|
|
1051
|
-
}
|
|
1052
|
-
};
|
|
348
|
+
export function toJsonMultiDocument(document) {
|
|
349
|
+
return encodeMultiDocument(document);
|
|
350
|
+
}
|
|
1053
351
|
/**
|
|
1054
|
-
*
|
|
352
|
+
* Decodes a persisted single-root representation document from JSON.
|
|
1055
353
|
*
|
|
1056
354
|
* **When to use**
|
|
1057
355
|
*
|
|
1058
|
-
* Use when
|
|
1059
|
-
* need a runtime Schema for decoding/encoding.
|
|
1060
|
-
*
|
|
1061
|
-
* **Details**
|
|
1062
|
-
*
|
|
1063
|
-
* Pass `options.reviver`, such as {@link toSchemaDefaultReviver}, to handle
|
|
1064
|
-
* {@link Declaration} nodes for types like `Date` and `Option`. Without a
|
|
1065
|
-
* reviver, declarations fall back to their `encodedSchema`. Circular references
|
|
1066
|
-
* are handled via lazy `Schema.suspend`.
|
|
356
|
+
* Use when reading a representation document from storage or transport before inspecting it or passing it to `fromRepresentation`.
|
|
1067
357
|
*
|
|
1068
358
|
* **Gotchas**
|
|
1069
359
|
*
|
|
1070
|
-
*
|
|
1071
|
-
*
|
|
1072
|
-
* **Example** (Reconstructing a Schema)
|
|
1073
|
-
*
|
|
1074
|
-
* ```ts
|
|
1075
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
1076
|
-
*
|
|
1077
|
-
* const doc = SchemaRepresentation.fromAST(
|
|
1078
|
-
* Schema.Struct({ name: Schema.String }).ast
|
|
1079
|
-
* )
|
|
360
|
+
* Invalid documents throw a schema decoding error. Decoding does not reconstruct runtime callbacks.
|
|
1080
361
|
*
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
*
|
|
362
|
+
* @see {@link toJson} for encoding a document
|
|
363
|
+
* @see {@link fromRepresentation} for reconstructing a runtime schema
|
|
364
|
+
* @see {@link fromJsonMultiDocument} for multiple roots sharing references
|
|
1084
365
|
*
|
|
1085
|
-
* @
|
|
1086
|
-
* @see {@link Reviver}
|
|
1087
|
-
* @see {@link toSchemaDefaultReviver}
|
|
1088
|
-
*
|
|
1089
|
-
* @category Runtime Generation
|
|
366
|
+
* @category decoding
|
|
1090
367
|
* @since 4.0.0
|
|
1091
368
|
*/
|
|
1092
|
-
export function
|
|
1093
|
-
|
|
1094
|
-
return recur(document.representation);
|
|
1095
|
-
function recur(r) {
|
|
1096
|
-
let out = on(r);
|
|
1097
|
-
if ("annotations" in r && r.annotations) out = out.annotate(r.annotations);
|
|
1098
|
-
out = toSchemaChecks(out, r);
|
|
1099
|
-
return out;
|
|
1100
|
-
}
|
|
1101
|
-
function getSlot(identifier) {
|
|
1102
|
-
const existing = slots.get(identifier);
|
|
1103
|
-
if (existing) return existing;
|
|
1104
|
-
// Create the slot *before* resolving, so self-references can see it.
|
|
1105
|
-
const slot = {
|
|
1106
|
-
state: 0,
|
|
1107
|
-
value: undefined,
|
|
1108
|
-
ref: Schema.suspend(() => {
|
|
1109
|
-
if (slot.value === undefined) {
|
|
1110
|
-
return Schema.Unknown;
|
|
1111
|
-
}
|
|
1112
|
-
return slot.value;
|
|
1113
|
-
})
|
|
1114
|
-
};
|
|
1115
|
-
slots.set(identifier, slot);
|
|
1116
|
-
return slot;
|
|
1117
|
-
}
|
|
1118
|
-
function resolveReference($ref) {
|
|
1119
|
-
const definition = document.references[$ref];
|
|
1120
|
-
if (definition === undefined) {
|
|
1121
|
-
throw new Error(`Reference ${$ref} not found`);
|
|
1122
|
-
}
|
|
1123
|
-
const slot = getSlot($ref);
|
|
1124
|
-
if (slot.state === 2) {
|
|
1125
|
-
// Already built: return the built schema directly
|
|
1126
|
-
return slot.value;
|
|
1127
|
-
}
|
|
1128
|
-
if (slot.state === 1) {
|
|
1129
|
-
// Circular: we're currently building this identifier.
|
|
1130
|
-
return slot.ref;
|
|
1131
|
-
}
|
|
1132
|
-
// First time: build it.
|
|
1133
|
-
slot.state = 1;
|
|
1134
|
-
try {
|
|
1135
|
-
slot.value = recur(definition);
|
|
1136
|
-
slot.state = 2;
|
|
1137
|
-
return slot.value;
|
|
1138
|
-
} catch (e) {
|
|
1139
|
-
// Leave the slot in a safe state so future thunks don't silently succeed.
|
|
1140
|
-
slot.state = 0;
|
|
1141
|
-
slot.value = undefined;
|
|
1142
|
-
throw e;
|
|
1143
|
-
}
|
|
1144
|
-
}
|
|
1145
|
-
function on(r) {
|
|
1146
|
-
switch (r._tag) {
|
|
1147
|
-
case "Declaration":
|
|
1148
|
-
return options?.reviver?.(r, recur) ?? recur(r.encodedSchema);
|
|
1149
|
-
case "Reference":
|
|
1150
|
-
return resolveReference(r.$ref);
|
|
1151
|
-
case "Suspend":
|
|
1152
|
-
return recur(r.thunk);
|
|
1153
|
-
case "Null":
|
|
1154
|
-
return Schema.Null;
|
|
1155
|
-
case "Undefined":
|
|
1156
|
-
return Schema.Undefined;
|
|
1157
|
-
case "Void":
|
|
1158
|
-
return Schema.Void;
|
|
1159
|
-
case "Never":
|
|
1160
|
-
return Schema.Never;
|
|
1161
|
-
case "Unknown":
|
|
1162
|
-
return Schema.Unknown;
|
|
1163
|
-
case "Any":
|
|
1164
|
-
return Schema.Any;
|
|
1165
|
-
case "String":
|
|
1166
|
-
{
|
|
1167
|
-
const contentMediaType = r.contentMediaType;
|
|
1168
|
-
const contentSchema = r.contentSchema;
|
|
1169
|
-
if (contentMediaType === "application/json" && contentSchema !== undefined) {
|
|
1170
|
-
return Schema.fromJsonString(recur(contentSchema));
|
|
1171
|
-
}
|
|
1172
|
-
return Schema.String;
|
|
1173
|
-
}
|
|
1174
|
-
case "Number":
|
|
1175
|
-
return Schema.Number;
|
|
1176
|
-
case "Boolean":
|
|
1177
|
-
return Schema.Boolean;
|
|
1178
|
-
case "BigInt":
|
|
1179
|
-
return Schema.BigInt;
|
|
1180
|
-
case "Symbol":
|
|
1181
|
-
return Schema.Symbol;
|
|
1182
|
-
case "Literal":
|
|
1183
|
-
return Schema.Literal(r.literal);
|
|
1184
|
-
case "UniqueSymbol":
|
|
1185
|
-
return Schema.UniqueSymbol(r.symbol);
|
|
1186
|
-
case "ObjectKeyword":
|
|
1187
|
-
return Schema.ObjectKeyword;
|
|
1188
|
-
case "Enum":
|
|
1189
|
-
return Schema.Enum(Object.fromEntries(r.enums));
|
|
1190
|
-
case "TemplateLiteral":
|
|
1191
|
-
{
|
|
1192
|
-
const parts = r.parts.map(recur);
|
|
1193
|
-
return Schema.TemplateLiteral(parts);
|
|
1194
|
-
}
|
|
1195
|
-
case "Arrays":
|
|
1196
|
-
{
|
|
1197
|
-
const elements = r.elements.map(e => {
|
|
1198
|
-
const s = recur(e.type);
|
|
1199
|
-
return e.isOptional ? Schema.optionalKey(s) : s;
|
|
1200
|
-
});
|
|
1201
|
-
const rest = r.rest.map(recur);
|
|
1202
|
-
if (Arr.isArrayNonEmpty(rest)) {
|
|
1203
|
-
if (r.elements.length === 0 && r.rest.length === 1) {
|
|
1204
|
-
return Schema.Array(rest[0]);
|
|
1205
|
-
}
|
|
1206
|
-
return Schema.TupleWithRest(Schema.Tuple(elements), rest);
|
|
1207
|
-
}
|
|
1208
|
-
return Schema.Tuple(elements);
|
|
1209
|
-
}
|
|
1210
|
-
case "Objects":
|
|
1211
|
-
{
|
|
1212
|
-
const fields = {};
|
|
1213
|
-
for (const ps of r.propertySignatures) {
|
|
1214
|
-
const s = recur(ps.type);
|
|
1215
|
-
const withOptional = ps.isOptional ? Schema.optionalKey(s) : s;
|
|
1216
|
-
fields[ps.name] = ps.isMutable ? Schema.mutableKey(withOptional) : withOptional;
|
|
1217
|
-
}
|
|
1218
|
-
const indexSignatures = r.indexSignatures.map(is => Schema.Record(recur(is.parameter), recur(is.type)));
|
|
1219
|
-
if (Arr.isArrayNonEmpty(indexSignatures)) {
|
|
1220
|
-
if (r.propertySignatures.length === 0 && indexSignatures.length === 1) {
|
|
1221
|
-
return indexSignatures[0];
|
|
1222
|
-
}
|
|
1223
|
-
return Schema.StructWithRest(Schema.Struct(fields), indexSignatures);
|
|
1224
|
-
}
|
|
1225
|
-
return Schema.Struct(fields);
|
|
1226
|
-
}
|
|
1227
|
-
case "Union":
|
|
1228
|
-
{
|
|
1229
|
-
if (r.types.length === 0) return Schema.Never;
|
|
1230
|
-
if (r.types.every(t => t._tag === "Literal")) {
|
|
1231
|
-
if (r.types.length === 1) {
|
|
1232
|
-
return Schema.Literal(r.types[0].literal);
|
|
1233
|
-
}
|
|
1234
|
-
return Schema.Literals(r.types.map(t => t.literal));
|
|
1235
|
-
}
|
|
1236
|
-
return Schema.Union(r.types.map(recur), {
|
|
1237
|
-
mode: r.mode
|
|
1238
|
-
});
|
|
1239
|
-
}
|
|
1240
|
-
}
|
|
1241
|
-
}
|
|
1242
|
-
function toSchemaChecks(top, schema) {
|
|
1243
|
-
switch (schema._tag) {
|
|
1244
|
-
default:
|
|
1245
|
-
return top;
|
|
1246
|
-
case "String":
|
|
1247
|
-
case "Number":
|
|
1248
|
-
case "BigInt":
|
|
1249
|
-
case "Arrays":
|
|
1250
|
-
case "Objects":
|
|
1251
|
-
case "Declaration":
|
|
1252
|
-
{
|
|
1253
|
-
const checks = schema.checks.map(toSchemaCheck);
|
|
1254
|
-
return Arr.isArrayNonEmpty(checks) ? top.check(...checks) : top;
|
|
1255
|
-
}
|
|
1256
|
-
}
|
|
1257
|
-
}
|
|
1258
|
-
function toSchemaCheck(check) {
|
|
1259
|
-
switch (check._tag) {
|
|
1260
|
-
case "Filter":
|
|
1261
|
-
return toSchemaFilter(check);
|
|
1262
|
-
case "FilterGroup":
|
|
1263
|
-
{
|
|
1264
|
-
return Schema.makeFilterGroup(Arr.map(check.checks, toSchemaCheck), check.annotations);
|
|
1265
|
-
}
|
|
1266
|
-
}
|
|
1267
|
-
}
|
|
1268
|
-
function toSchemaFilter(filter) {
|
|
1269
|
-
const a = filter.annotations;
|
|
1270
|
-
switch (filter.meta._tag) {
|
|
1271
|
-
// String Meta
|
|
1272
|
-
case "isStringFinite":
|
|
1273
|
-
return Schema.isStringFinite(a);
|
|
1274
|
-
case "isStringBigInt":
|
|
1275
|
-
return Schema.isStringBigInt(a);
|
|
1276
|
-
case "isStringSymbol":
|
|
1277
|
-
return Schema.isStringSymbol(a);
|
|
1278
|
-
case "isMinLength":
|
|
1279
|
-
return Schema.isMinLength(filter.meta.minLength, a);
|
|
1280
|
-
case "isMaxLength":
|
|
1281
|
-
return Schema.isMaxLength(filter.meta.maxLength, a);
|
|
1282
|
-
case "isLengthBetween":
|
|
1283
|
-
return Schema.isLengthBetween(filter.meta.minimum, filter.meta.maximum, a);
|
|
1284
|
-
case "isPattern":
|
|
1285
|
-
return Schema.isPattern(filter.meta.regExp, a);
|
|
1286
|
-
case "isTrimmed":
|
|
1287
|
-
return Schema.isTrimmed(a);
|
|
1288
|
-
case "isUUID":
|
|
1289
|
-
return Schema.isUUID(filter.meta.version, a);
|
|
1290
|
-
case "isGUID":
|
|
1291
|
-
return Schema.isGUID(a);
|
|
1292
|
-
case "isULID":
|
|
1293
|
-
return Schema.isULID(a);
|
|
1294
|
-
case "isBase64":
|
|
1295
|
-
return Schema.isBase64(a);
|
|
1296
|
-
case "isBase64Url":
|
|
1297
|
-
return Schema.isBase64Url(a);
|
|
1298
|
-
case "isStartsWith":
|
|
1299
|
-
return Schema.isStartsWith(filter.meta.startsWith, a);
|
|
1300
|
-
case "isEndsWith":
|
|
1301
|
-
return Schema.isEndsWith(filter.meta.endsWith, a);
|
|
1302
|
-
case "isIncludes":
|
|
1303
|
-
return Schema.isIncludes(filter.meta.includes, a);
|
|
1304
|
-
case "isUppercased":
|
|
1305
|
-
return Schema.isUppercased(a);
|
|
1306
|
-
case "isLowercased":
|
|
1307
|
-
return Schema.isLowercased(a);
|
|
1308
|
-
case "isCapitalized":
|
|
1309
|
-
return Schema.isCapitalized(a);
|
|
1310
|
-
case "isUncapitalized":
|
|
1311
|
-
return Schema.isUncapitalized(a);
|
|
1312
|
-
// Number Meta
|
|
1313
|
-
case "isFinite":
|
|
1314
|
-
return Schema.isFinite(a);
|
|
1315
|
-
case "isInt":
|
|
1316
|
-
return Schema.isInt(a);
|
|
1317
|
-
case "isMultipleOf":
|
|
1318
|
-
return Schema.isMultipleOf(filter.meta.divisor, a);
|
|
1319
|
-
case "isGreaterThan":
|
|
1320
|
-
return Schema.isGreaterThan(filter.meta.exclusiveMinimum, a);
|
|
1321
|
-
case "isGreaterThanOrEqualTo":
|
|
1322
|
-
return Schema.isGreaterThanOrEqualTo(filter.meta.minimum, a);
|
|
1323
|
-
case "isLessThan":
|
|
1324
|
-
return Schema.isLessThan(filter.meta.exclusiveMaximum, a);
|
|
1325
|
-
case "isLessThanOrEqualTo":
|
|
1326
|
-
return Schema.isLessThanOrEqualTo(filter.meta.maximum, a);
|
|
1327
|
-
case "isBetween":
|
|
1328
|
-
return Schema.isBetween(filter.meta, a);
|
|
1329
|
-
// BigInt Meta
|
|
1330
|
-
case "isGreaterThanBigInt":
|
|
1331
|
-
return Schema.isGreaterThanBigInt(filter.meta.exclusiveMinimum, a);
|
|
1332
|
-
case "isGreaterThanOrEqualToBigInt":
|
|
1333
|
-
return Schema.isGreaterThanOrEqualToBigInt(filter.meta.minimum, a);
|
|
1334
|
-
case "isLessThanBigInt":
|
|
1335
|
-
return Schema.isLessThanBigInt(filter.meta.exclusiveMaximum, a);
|
|
1336
|
-
case "isLessThanOrEqualToBigInt":
|
|
1337
|
-
return Schema.isLessThanOrEqualToBigInt(filter.meta.maximum, a);
|
|
1338
|
-
case "isBetweenBigInt":
|
|
1339
|
-
return Schema.isBetweenBigInt(filter.meta, a);
|
|
1340
|
-
// Object Meta
|
|
1341
|
-
case "isMinProperties":
|
|
1342
|
-
return Schema.isMinProperties(filter.meta.minProperties, a);
|
|
1343
|
-
case "isMaxProperties":
|
|
1344
|
-
return Schema.isMaxProperties(filter.meta.maxProperties, a);
|
|
1345
|
-
case "isPropertiesLengthBetween":
|
|
1346
|
-
return Schema.isPropertiesLengthBetween(filter.meta.minimum, filter.meta.maximum, a);
|
|
1347
|
-
case "isPropertyNames":
|
|
1348
|
-
return Schema.isPropertyNames(recur(filter.meta.propertyNames), a);
|
|
1349
|
-
// Arrays Meta
|
|
1350
|
-
case "isUnique":
|
|
1351
|
-
return Schema.isUnique(a);
|
|
1352
|
-
// Date Meta
|
|
1353
|
-
case "isDateValid":
|
|
1354
|
-
return Schema.isDateValid(a);
|
|
1355
|
-
case "isGreaterThanDate":
|
|
1356
|
-
return Schema.isGreaterThanDate(filter.meta.exclusiveMinimum, a);
|
|
1357
|
-
case "isGreaterThanOrEqualToDate":
|
|
1358
|
-
return Schema.isGreaterThanOrEqualToDate(filter.meta.minimum, a);
|
|
1359
|
-
case "isLessThanDate":
|
|
1360
|
-
return Schema.isLessThanDate(filter.meta.exclusiveMaximum, a);
|
|
1361
|
-
case "isLessThanOrEqualToDate":
|
|
1362
|
-
return Schema.isLessThanOrEqualToDate(filter.meta.maximum, a);
|
|
1363
|
-
case "isBetweenDate":
|
|
1364
|
-
return Schema.isBetweenDate(filter.meta, a);
|
|
1365
|
-
// Size Meta
|
|
1366
|
-
case "isMinSize":
|
|
1367
|
-
return Schema.isMinSize(filter.meta.minSize, a);
|
|
1368
|
-
case "isMaxSize":
|
|
1369
|
-
return Schema.isMaxSize(filter.meta.maxSize, a);
|
|
1370
|
-
case "isSizeBetween":
|
|
1371
|
-
return Schema.isSizeBetween(filter.meta.minimum, filter.meta.maximum, a);
|
|
1372
|
-
}
|
|
1373
|
-
}
|
|
369
|
+
export function fromJson(input) {
|
|
370
|
+
return decodeDocument(input);
|
|
1374
371
|
}
|
|
1375
372
|
/**
|
|
1376
|
-
*
|
|
373
|
+
* Decodes a persisted multi-root representation document from JSON.
|
|
1377
374
|
*
|
|
1378
375
|
* **When to use**
|
|
1379
376
|
*
|
|
1380
|
-
* Use when
|
|
1381
|
-
* representation `Document`.
|
|
377
|
+
* Use when reading multiple representation roots that share references before inspecting them or passing them to `fromRepresentations`.
|
|
1382
378
|
*
|
|
1383
379
|
* **Gotchas**
|
|
1384
380
|
*
|
|
1385
|
-
*
|
|
1386
|
-
* semantics cannot be represented exactly in JSON Schema, and importing an
|
|
1387
|
-
* emitted JSON Schema may produce an equivalent approximation rather than the
|
|
1388
|
-
* original representation shape.
|
|
1389
|
-
*
|
|
1390
|
-
* **Example** (Generating JSON Schema)
|
|
1391
|
-
*
|
|
1392
|
-
* ```ts
|
|
1393
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
1394
|
-
*
|
|
1395
|
-
* const doc = SchemaRepresentation.fromAST(Schema.String.ast)
|
|
1396
|
-
* const jsonSchema = SchemaRepresentation.toJsonSchemaDocument(doc)
|
|
1397
|
-
* console.log(jsonSchema.schema.type)
|
|
1398
|
-
* // "string"
|
|
1399
|
-
* ```
|
|
381
|
+
* Invalid documents throw a schema decoding error. Decoding does not reconstruct runtime callbacks.
|
|
1400
382
|
*
|
|
1401
|
-
* @see {@link
|
|
1402
|
-
* @see {@link
|
|
1403
|
-
* @see {@link
|
|
383
|
+
* @see {@link toJsonMultiDocument} for encoding a multi-document
|
|
384
|
+
* @see {@link fromRepresentations} for reconstructing runtime schemas
|
|
385
|
+
* @see {@link fromJson} for a single root
|
|
1404
386
|
*
|
|
1405
|
-
* @category
|
|
387
|
+
* @category decoding
|
|
1406
388
|
* @since 4.0.0
|
|
1407
389
|
*/
|
|
1408
|
-
export
|
|
390
|
+
export function fromJsonMultiDocument(input) {
|
|
391
|
+
return decodeMultiDocument(input);
|
|
392
|
+
}
|
|
1409
393
|
/**
|
|
1410
|
-
*
|
|
1411
|
-
* multi-document.
|
|
394
|
+
* Reconstructs a runtime schema from a representation document.
|
|
1412
395
|
*
|
|
1413
396
|
* **When to use**
|
|
1414
397
|
*
|
|
1415
|
-
* Use when you
|
|
1416
|
-
* so shared definitions stay in multi-document JSON Schema form.
|
|
398
|
+
* Use when you have decoded or constructed a document whose declaration and check annotations may require revivers.
|
|
1417
399
|
*
|
|
1418
400
|
* **Gotchas**
|
|
1419
401
|
*
|
|
1420
|
-
*
|
|
1421
|
-
* semantics cannot be represented exactly in JSON Schema, and importing an
|
|
1422
|
-
* emitted JSON Schema may produce equivalent approximations rather than the
|
|
1423
|
-
* original representation shapes.
|
|
402
|
+
* Revivers are resolved locally by `id`; none are installed implicitly. Reviver results are used directly, and exceptions raised by a reviver pass through unchanged.
|
|
1424
403
|
*
|
|
1425
|
-
* @see {@link
|
|
1426
|
-
* @see {@link
|
|
1427
|
-
* @see {@link fromJsonSchemaMultiDocument}
|
|
404
|
+
* @see {@link fromJson} for decoding a persisted document
|
|
405
|
+
* @see {@link fromRepresentations} for multiple roots sharing references
|
|
1428
406
|
*
|
|
1429
407
|
* @category transforming
|
|
1430
408
|
* @since 4.0.0
|
|
1431
409
|
*/
|
|
1432
|
-
export
|
|
1433
|
-
|
|
1434
|
-
* Constructs a {@link Code} value from a runtime expression string and a
|
|
1435
|
-
* TypeScript type string.
|
|
1436
|
-
*
|
|
1437
|
-
* @see {@link Code}
|
|
1438
|
-
*
|
|
1439
|
-
* @category Code Generation
|
|
1440
|
-
* @since 4.0.0
|
|
1441
|
-
*/
|
|
1442
|
-
export function makeCode(runtime, Type) {
|
|
1443
|
-
return {
|
|
1444
|
-
runtime,
|
|
1445
|
-
Type
|
|
1446
|
-
};
|
|
410
|
+
export function fromRepresentation(document, options) {
|
|
411
|
+
return InternalFromRepresentation.fromRepresentation(document, options.revivers);
|
|
1447
412
|
}
|
|
1448
413
|
/**
|
|
1449
|
-
*
|
|
414
|
+
* Reconstructs multiple runtime schemas and their shared definitions from a representation multi-document.
|
|
1450
415
|
*
|
|
1451
416
|
* **When to use**
|
|
1452
417
|
*
|
|
1453
|
-
* Use when
|
|
1454
|
-
* schema representation `MultiDocument`.
|
|
1455
|
-
*
|
|
1456
|
-
* **Details**
|
|
1457
|
-
*
|
|
1458
|
-
* `options.reviver` can customize code generation for {@link Declaration}
|
|
1459
|
-
* nodes. Return `undefined` to fall back to the default logic, which uses
|
|
1460
|
-
* `generation` annotations or the encoded schema. References are
|
|
1461
|
-
* topologically sorted so non-recursive definitions are emitted before their
|
|
1462
|
-
* dependents. `$ref` keys are converted to sanitized JavaScript identifiers.
|
|
418
|
+
* Use when every root and named definition must be rebuilt in one shared reference environment.
|
|
1463
419
|
*
|
|
1464
|
-
* **
|
|
1465
|
-
*
|
|
1466
|
-
* ```ts
|
|
1467
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
1468
|
-
*
|
|
1469
|
-
* const Person = Schema.Struct({
|
|
1470
|
-
* name: Schema.String,
|
|
1471
|
-
* age: Schema.Int
|
|
1472
|
-
* })
|
|
420
|
+
* **Gotchas**
|
|
1473
421
|
*
|
|
1474
|
-
*
|
|
1475
|
-
* SchemaRepresentation.fromAST(Person.ast)
|
|
1476
|
-
* )
|
|
1477
|
-
* const codeDoc = SchemaRepresentation.toCodeDocument(multi)
|
|
1478
|
-
* console.log(codeDoc.codes[0].runtime)
|
|
1479
|
-
* // Schema.Struct({ ... })
|
|
1480
|
-
* ```
|
|
422
|
+
* Every definition is revived, including definitions not reachable from a root. Revivers are resolved locally by `id`; none are installed implicitly.
|
|
1481
423
|
*
|
|
1482
|
-
* @see {@link
|
|
1483
|
-
* @see {@link
|
|
1484
|
-
* @see {@link Reviver}
|
|
424
|
+
* @see {@link fromJsonMultiDocument} for decoding a persisted multi-document
|
|
425
|
+
* @see {@link fromRepresentation} for a single root
|
|
1485
426
|
*
|
|
1486
|
-
* @category
|
|
427
|
+
* @category transforming
|
|
1487
428
|
* @since 4.0.0
|
|
1488
429
|
*/
|
|
1489
|
-
export function
|
|
1490
|
-
|
|
1491
|
-
const ts = topologicalSort(multiDocument.references);
|
|
1492
|
-
// Phase 1: Build sanitization map with collision handling
|
|
1493
|
-
const sanitizedReferenceMap = new Map();
|
|
1494
|
-
const uniqueSanitizedReferences = new Set();
|
|
1495
|
-
const referenceCount = new Map();
|
|
1496
|
-
// Process all references first to build the map
|
|
1497
|
-
const allRefs = [...ts.nonRecursives.map(({
|
|
1498
|
-
$ref
|
|
1499
|
-
}) => $ref), ...Object.keys(ts.recursives)];
|
|
1500
|
-
for (const ref of allRefs) {
|
|
1501
|
-
ensureUniqueSanitized(ref);
|
|
1502
|
-
}
|
|
1503
|
-
// Phase 2: Use the map when processing references
|
|
1504
|
-
const nonRecursives = ts.nonRecursives.map(({
|
|
1505
|
-
$ref,
|
|
1506
|
-
representation
|
|
1507
|
-
}) => ({
|
|
1508
|
-
$ref: sanitizedReferenceMap.get($ref),
|
|
1509
|
-
code: recur(representation)
|
|
1510
|
-
}));
|
|
1511
|
-
const recursives = Rec.mapEntries(ts.recursives, (representation, $ref) => [sanitizedReferenceMap.get($ref), recur(representation)]);
|
|
1512
|
-
const codes = multiDocument.representations.map(recur);
|
|
1513
|
-
return {
|
|
1514
|
-
codes,
|
|
1515
|
-
references: {
|
|
1516
|
-
nonRecursives: nonRecursives.filter(({
|
|
1517
|
-
$ref
|
|
1518
|
-
}) => (referenceCount.get($ref) ?? 0) > 0),
|
|
1519
|
-
recursives: Rec.filter(recursives, (_, $ref) => (referenceCount.get($ref) ?? 0) > 0)
|
|
1520
|
-
},
|
|
1521
|
-
artifacts
|
|
1522
|
-
};
|
|
1523
|
-
function ensureUniqueSanitized(originalRef) {
|
|
1524
|
-
// Check if already mapped (consistency)
|
|
1525
|
-
const sanitized = sanitizedReferenceMap.get(originalRef);
|
|
1526
|
-
if (sanitized !== undefined) {
|
|
1527
|
-
return sanitized;
|
|
1528
|
-
}
|
|
1529
|
-
// Find unique sanitized name
|
|
1530
|
-
const seed = sanitizeJavaScriptIdentifier(originalRef);
|
|
1531
|
-
let candidate = seed;
|
|
1532
|
-
let suffix = 0;
|
|
1533
|
-
while (uniqueSanitizedReferences.has(candidate)) {
|
|
1534
|
-
candidate = `${seed}${++suffix}`;
|
|
1535
|
-
}
|
|
1536
|
-
uniqueSanitizedReferences.add(candidate);
|
|
1537
|
-
sanitizedReferenceMap.set(originalRef, candidate);
|
|
1538
|
-
return candidate;
|
|
1539
|
-
}
|
|
1540
|
-
function addSymbol(s) {
|
|
1541
|
-
const identifier = ensureUniqueSanitized("_symbol");
|
|
1542
|
-
const key = globalThis.Symbol.keyFor(s);
|
|
1543
|
-
const description = s.description;
|
|
1544
|
-
const generation = key === undefined ? makeCode(`Symbol(${description === undefined ? "" : format(description)})`, `typeof ${identifier}`) : makeCode(`Symbol.for(${format(key)})`, `typeof ${identifier}`);
|
|
1545
|
-
artifacts.push({
|
|
1546
|
-
_tag: "Symbol",
|
|
1547
|
-
identifier,
|
|
1548
|
-
generation
|
|
1549
|
-
});
|
|
1550
|
-
return identifier;
|
|
1551
|
-
}
|
|
1552
|
-
function addEnum(s) {
|
|
1553
|
-
const identifier = ensureUniqueSanitized("_Enum");
|
|
1554
|
-
artifacts.push({
|
|
1555
|
-
_tag: "Enum",
|
|
1556
|
-
identifier,
|
|
1557
|
-
generation: makeCode(`enum ${identifier} { ${s.enums.map(([name, value]) => `${format(name)}: ${format(value)}`).join(", ")} }`, `typeof ${identifier}`)
|
|
1558
|
-
});
|
|
1559
|
-
return identifier;
|
|
1560
|
-
}
|
|
1561
|
-
function addImport(importDeclaration) {
|
|
1562
|
-
if (!artifacts.some(a => a._tag === "Import" && a.importDeclaration === importDeclaration)) {
|
|
1563
|
-
artifacts.push({
|
|
1564
|
-
_tag: "Import",
|
|
1565
|
-
importDeclaration
|
|
1566
|
-
});
|
|
1567
|
-
}
|
|
1568
|
-
}
|
|
1569
|
-
function recur(s) {
|
|
1570
|
-
const g = on(s);
|
|
1571
|
-
switch (s._tag) {
|
|
1572
|
-
default:
|
|
1573
|
-
return makeCode(g.runtime + toRuntimeAnnotate(s.annotations) + toRuntimeBrand(s.annotations), g.Type + toTypeBrand(s.annotations));
|
|
1574
|
-
case "Reference":
|
|
1575
|
-
return g;
|
|
1576
|
-
case "Declaration":
|
|
1577
|
-
case "String":
|
|
1578
|
-
case "Number":
|
|
1579
|
-
case "BigInt":
|
|
1580
|
-
case "Arrays":
|
|
1581
|
-
case "Objects":
|
|
1582
|
-
case "Suspend":
|
|
1583
|
-
return makeCode(g.runtime + toRuntimeAnnotate(s.annotations) + toRuntimeBrand(s.annotations) + toRuntimeChecks(s.checks), g.Type + toTypeBrand(s.annotations) + toTypeChecks(s.checks));
|
|
1584
|
-
}
|
|
1585
|
-
}
|
|
1586
|
-
function on(s) {
|
|
1587
|
-
switch (s._tag) {
|
|
1588
|
-
case "Declaration":
|
|
1589
|
-
{
|
|
1590
|
-
// if there is a reviver, use it to generate the generation
|
|
1591
|
-
if (options?.reviver !== undefined) {
|
|
1592
|
-
// the reviver can return `undefined` to indicate that the generation should be generated by the default logic
|
|
1593
|
-
const out = options.reviver(s, recur);
|
|
1594
|
-
if (out !== undefined) {
|
|
1595
|
-
return out;
|
|
1596
|
-
}
|
|
1597
|
-
}
|
|
1598
|
-
// otherwise, use the generation from the annotations
|
|
1599
|
-
const generation = s.annotations?.generation;
|
|
1600
|
-
if (Predicate.isObject(generation) && typeof generation.runtime === "string" && typeof generation.Type === "string") {
|
|
1601
|
-
const typeParameters = s.typeParameters.map(recur);
|
|
1602
|
-
if (typeof generation.importDeclaration === "string") {
|
|
1603
|
-
addImport(generation.importDeclaration);
|
|
1604
|
-
}
|
|
1605
|
-
return makeCode(replacePlaceholders(generation.runtime, typeParameters.map(p => p.runtime)), replacePlaceholders(generation.Type, typeParameters.map(p => p.Type)));
|
|
1606
|
-
}
|
|
1607
|
-
// otherwise, use the generation from the encoded schema
|
|
1608
|
-
return recur(s.encodedSchema);
|
|
1609
|
-
}
|
|
1610
|
-
case "Reference":
|
|
1611
|
-
{
|
|
1612
|
-
const sanitized = ensureUniqueSanitized(s.$ref);
|
|
1613
|
-
referenceCount.set(sanitized, (referenceCount.get(sanitized) ?? 0) + 1);
|
|
1614
|
-
return makeCode(sanitized, sanitized);
|
|
1615
|
-
}
|
|
1616
|
-
case "Suspend":
|
|
1617
|
-
{
|
|
1618
|
-
const thunk = recur(s.thunk);
|
|
1619
|
-
return makeCode(`Schema.suspend((): Schema.Codec<${thunk.Type}> => ${thunk.runtime})`, thunk.Type);
|
|
1620
|
-
}
|
|
1621
|
-
case "Null":
|
|
1622
|
-
return makeCode(`Schema.Null`, "null");
|
|
1623
|
-
case "Undefined":
|
|
1624
|
-
return makeCode(`Schema.Undefined`, "undefined");
|
|
1625
|
-
case "Void":
|
|
1626
|
-
return makeCode(`Schema.Void`, "void");
|
|
1627
|
-
case "Never":
|
|
1628
|
-
return makeCode(`Schema.Never`, "never");
|
|
1629
|
-
case "Unknown":
|
|
1630
|
-
return makeCode(`Schema.Unknown`, "unknown");
|
|
1631
|
-
case "Any":
|
|
1632
|
-
return makeCode(`Schema.Any`, "any");
|
|
1633
|
-
case "Number":
|
|
1634
|
-
return makeCode(`Schema.Number`, "number");
|
|
1635
|
-
case "Boolean":
|
|
1636
|
-
return makeCode(`Schema.Boolean`, "boolean");
|
|
1637
|
-
case "BigInt":
|
|
1638
|
-
return makeCode(`Schema.BigInt`, "bigint");
|
|
1639
|
-
case "Symbol":
|
|
1640
|
-
return makeCode(`Schema.Symbol`, "symbol");
|
|
1641
|
-
case "String":
|
|
1642
|
-
{
|
|
1643
|
-
const contentMediaType = s.contentMediaType;
|
|
1644
|
-
const contentSchema = s.contentSchema;
|
|
1645
|
-
if (contentMediaType === "application/json" && contentSchema !== undefined) {
|
|
1646
|
-
return makeCode(`Schema.fromJsonString(${recur(contentSchema)})`, "string");
|
|
1647
|
-
} else {
|
|
1648
|
-
return makeCode(`Schema.String`, "string");
|
|
1649
|
-
}
|
|
1650
|
-
}
|
|
1651
|
-
case "Literal":
|
|
1652
|
-
{
|
|
1653
|
-
const literal = format(s.literal);
|
|
1654
|
-
return makeCode(`Schema.Literal(${literal})`, literal);
|
|
1655
|
-
}
|
|
1656
|
-
case "UniqueSymbol":
|
|
1657
|
-
{
|
|
1658
|
-
const identifier = addSymbol(s.symbol);
|
|
1659
|
-
return makeCode(`Schema.UniqueSymbol(${identifier})`, `typeof ${identifier}`);
|
|
1660
|
-
}
|
|
1661
|
-
case "ObjectKeyword":
|
|
1662
|
-
return makeCode(`Schema.ObjectKeyword`, "object");
|
|
1663
|
-
case "Enum":
|
|
1664
|
-
{
|
|
1665
|
-
const identifier = addEnum(s);
|
|
1666
|
-
return makeCode(`Schema.Enum(${identifier})`, `typeof ${identifier}`);
|
|
1667
|
-
}
|
|
1668
|
-
case "TemplateLiteral":
|
|
1669
|
-
{
|
|
1670
|
-
const parts = s.parts.map(recur);
|
|
1671
|
-
const type = toTypeParts(s.parts).map(p => "`" + p + "`").join(" | ");
|
|
1672
|
-
return makeCode(`Schema.TemplateLiteral([${parts.map(p => p.runtime).join(", ")}])`, type);
|
|
1673
|
-
}
|
|
1674
|
-
case "Arrays":
|
|
1675
|
-
{
|
|
1676
|
-
const elements = s.elements.map(e => {
|
|
1677
|
-
return {
|
|
1678
|
-
isOptional: e.isOptional,
|
|
1679
|
-
type: recur(e.type),
|
|
1680
|
-
annotations: e.annotations
|
|
1681
|
-
};
|
|
1682
|
-
});
|
|
1683
|
-
const rest = s.rest.map(recur);
|
|
1684
|
-
if (Arr.isArrayNonEmpty(rest)) {
|
|
1685
|
-
const item = rest[0];
|
|
1686
|
-
if (elements.length === 0 && rest.length === 1) {
|
|
1687
|
-
return makeCode(`Schema.Array(${item.runtime})`, `ReadonlyArray<${item.Type}>`);
|
|
1688
|
-
}
|
|
1689
|
-
const post = rest.slice(1);
|
|
1690
|
-
return makeCode(`Schema.TupleWithRest(Schema.Tuple([${elements.map(e => toRuntimeIsOptional(e.isOptional, e.type.runtime) + toRuntimeAnnotateKey(e.annotations)).join(", ")}]), [${rest.map(r => r.runtime).join(", ")}])`, `readonly [${elements.map(e => toTypeIsOptional(e.isOptional, e.type.Type)).join(", ")}, ...Array<${item.Type}>${post.length > 0 ? `, ${post.map(p => p.Type).join(", ")}` : ""}]`);
|
|
1691
|
-
}
|
|
1692
|
-
return makeCode(`Schema.Tuple([${elements.map(e => toRuntimeIsOptional(e.isOptional, e.type.runtime) + toRuntimeAnnotateKey(e.annotations)).join(", ")}])`, `readonly [${elements.map(e => toTypeIsOptional(e.isOptional, e.type.Type)).join(", ")}]`);
|
|
1693
|
-
}
|
|
1694
|
-
case "Objects":
|
|
1695
|
-
{
|
|
1696
|
-
const pss = s.propertySignatures.map(p => {
|
|
1697
|
-
const isSymbol = typeof p.name === "symbol";
|
|
1698
|
-
const name = isSymbol ? addSymbol(p.name) : formatPropertyKey(p.name);
|
|
1699
|
-
const nameType = toTypeIsOptional(p.isOptional, toTypeIsMutable(p.isMutable, isSymbol ? `[typeof ${name}]` : name));
|
|
1700
|
-
const type = recur(p.type);
|
|
1701
|
-
return makeCode(`${isSymbol ? `[${name}]` : name}: ${toRuntimeIsOptional(p.isOptional, toRuntimeIsMutable(p.isMutable, type.runtime))}` + toRuntimeAnnotateKey(p.annotations), `${nameType}: ${type.Type}`);
|
|
1702
|
-
});
|
|
1703
|
-
const iss = s.indexSignatures.map(is => {
|
|
1704
|
-
return {
|
|
1705
|
-
parameter: recur(is.parameter),
|
|
1706
|
-
type: recur(is.type)
|
|
1707
|
-
};
|
|
1708
|
-
});
|
|
1709
|
-
if (iss.length === 0) {
|
|
1710
|
-
// 1) Only properties -> Struct
|
|
1711
|
-
return makeCode(`Schema.Struct({ ${pss.map(p => p.runtime).join(", ")} })`, `{ ${pss.map(p => p.Type).join(", ")} }`);
|
|
1712
|
-
} else if (pss.length === 0 && iss.length === 1) {
|
|
1713
|
-
// 2) Only one index signature and no properties -> Record
|
|
1714
|
-
return makeCode(`Schema.Record(${iss[0].parameter.runtime}, ${iss[0].type.runtime})`, `{ readonly [x: ${iss[0].parameter.Type}]: ${iss[0].type.Type} }`);
|
|
1715
|
-
} else {
|
|
1716
|
-
// 3) Properties + index signatures -> StructWithRest
|
|
1717
|
-
return makeCode(`Schema.StructWithRest(Schema.Struct({ ${pss.map(p => p.runtime).join(", ")} }), [${iss.map(is => `Schema.Record(${is.parameter.runtime}, ${is.type.runtime})`).join(", ")}])`, `{ ${pss.map(p => p.Type).join(", ")}, ${iss.map(is => `readonly [x: ${is.parameter.Type}]: ${is.type.Type}`).join(", ")} }`);
|
|
1718
|
-
}
|
|
1719
|
-
}
|
|
1720
|
-
case "Union":
|
|
1721
|
-
{
|
|
1722
|
-
if (s.types.length === 0) {
|
|
1723
|
-
return makeCode("Schema.Never", "never");
|
|
1724
|
-
}
|
|
1725
|
-
if (s.types.every(t => t._tag === "Literal")) {
|
|
1726
|
-
const literals = s.types.map(l => format(l.literal));
|
|
1727
|
-
if (literals.length === 1) {
|
|
1728
|
-
return makeCode(`Schema.Literal(${literals[0]})`, literals[0]);
|
|
1729
|
-
}
|
|
1730
|
-
return makeCode(`Schema.Literals([${literals.join(", ")}])`, literals.join(" | "));
|
|
1731
|
-
}
|
|
1732
|
-
const mode = s.mode === "anyOf" ? "" : `, { mode: "oneOf" }`;
|
|
1733
|
-
const types = s.types.map(t => recur(t));
|
|
1734
|
-
return makeCode(`Schema.Union([${types.map(t => t.runtime).join(", ")}]${mode})`, types.map(t => t.Type).join(" | "));
|
|
1735
|
-
}
|
|
1736
|
-
}
|
|
1737
|
-
}
|
|
1738
|
-
function toTypeBrand(annotations) {
|
|
1739
|
-
const brands = collectBrands(annotations);
|
|
1740
|
-
if (brands.length === 0) return "";
|
|
1741
|
-
addImport(`import type * as Brand from "effect/Brand"`);
|
|
1742
|
-
return brands.map(b => ` & Brand.Brand<${format(b)}>`).join("");
|
|
1743
|
-
}
|
|
1744
|
-
function toTypeChecks(checks) {
|
|
1745
|
-
return checks.map(c => toTypeCheck(c)).join("");
|
|
1746
|
-
}
|
|
1747
|
-
function toTypeCheck(check) {
|
|
1748
|
-
switch (check._tag) {
|
|
1749
|
-
case "Filter":
|
|
1750
|
-
return toTypeBrand(check.annotations);
|
|
1751
|
-
case "FilterGroup":
|
|
1752
|
-
{
|
|
1753
|
-
return toTypeChecks(check.checks);
|
|
1754
|
-
}
|
|
1755
|
-
}
|
|
1756
|
-
}
|
|
1757
|
-
function toRuntimeChecks(checks) {
|
|
1758
|
-
return checks.map(c => `.check(${toRuntimeCheck(c)})` + toRuntimeBrand(c.annotations)).join("");
|
|
1759
|
-
}
|
|
1760
|
-
function toRuntimeCheck(check) {
|
|
1761
|
-
switch (check._tag) {
|
|
1762
|
-
case "Filter":
|
|
1763
|
-
return toRuntimeFilter(check);
|
|
1764
|
-
case "FilterGroup":
|
|
1765
|
-
{
|
|
1766
|
-
const a = toRuntimeAnnotations(check.annotations);
|
|
1767
|
-
const ca = a === "" ? "" : `, ${a}`;
|
|
1768
|
-
return `Schema.makeFilterGroup([${check.checks.map(c => toRuntimeCheck(c)).join(", ")}]${ca})`;
|
|
1769
|
-
}
|
|
1770
|
-
}
|
|
1771
|
-
}
|
|
1772
|
-
function toRuntimeFilter(filter) {
|
|
1773
|
-
const a = toRuntimeAnnotations(filter.annotations);
|
|
1774
|
-
const ca = a === "" ? "" : `, ${a}`;
|
|
1775
|
-
switch (filter.meta._tag) {
|
|
1776
|
-
case "isTrimmed":
|
|
1777
|
-
case "isGUID":
|
|
1778
|
-
case "isULID":
|
|
1779
|
-
case "isBase64":
|
|
1780
|
-
case "isBase64Url":
|
|
1781
|
-
case "isUppercased":
|
|
1782
|
-
case "isLowercased":
|
|
1783
|
-
case "isCapitalized":
|
|
1784
|
-
case "isUncapitalized":
|
|
1785
|
-
case "isFinite":
|
|
1786
|
-
case "isInt":
|
|
1787
|
-
case "isUnique":
|
|
1788
|
-
case "isDateValid":
|
|
1789
|
-
return `Schema.${filter.meta._tag}(${a})`;
|
|
1790
|
-
case "isStringFinite":
|
|
1791
|
-
case "isStringBigInt":
|
|
1792
|
-
case "isStringSymbol":
|
|
1793
|
-
case "isPattern":
|
|
1794
|
-
return `Schema.${filter.meta._tag}(${toRuntimeRegExp(filter.meta.regExp)}${ca})`;
|
|
1795
|
-
case "isMinLength":
|
|
1796
|
-
return `Schema.isMinLength(${filter.meta.minLength}${ca})`;
|
|
1797
|
-
case "isMaxLength":
|
|
1798
|
-
return `Schema.isMaxLength(${filter.meta.maxLength}${ca})`;
|
|
1799
|
-
case "isLengthBetween":
|
|
1800
|
-
return `Schema.isLengthBetween(${filter.meta.minimum}, ${filter.meta.maximum}${ca})`;
|
|
1801
|
-
case "isUUID":
|
|
1802
|
-
return `Schema.isUUID(${filter.meta.version}${ca})`;
|
|
1803
|
-
case "isStartsWith":
|
|
1804
|
-
return `Schema.isStartsWith(${format(filter.meta.startsWith)}${ca})`;
|
|
1805
|
-
case "isEndsWith":
|
|
1806
|
-
return `Schema.isEndsWith(${format(filter.meta.endsWith)}${ca})`;
|
|
1807
|
-
case "isIncludes":
|
|
1808
|
-
return `Schema.isIncludes(${format(filter.meta.includes)}${ca})`;
|
|
1809
|
-
case "isGreaterThan":
|
|
1810
|
-
case "isGreaterThanBigInt":
|
|
1811
|
-
case "isGreaterThanDate":
|
|
1812
|
-
return `Schema.${filter.meta._tag}(${toRuntimeValue(filter.meta.exclusiveMinimum)}${ca})`;
|
|
1813
|
-
case "isGreaterThanOrEqualTo":
|
|
1814
|
-
case "isGreaterThanOrEqualToBigInt":
|
|
1815
|
-
case "isGreaterThanOrEqualToDate":
|
|
1816
|
-
return `Schema.${filter.meta._tag}(${toRuntimeValue(filter.meta.minimum)}${ca})`;
|
|
1817
|
-
case "isLessThan":
|
|
1818
|
-
case "isLessThanBigInt":
|
|
1819
|
-
case "isLessThanDate":
|
|
1820
|
-
return `Schema.${filter.meta._tag}(${toRuntimeValue(filter.meta.exclusiveMaximum)}${ca})`;
|
|
1821
|
-
case "isLessThanOrEqualTo":
|
|
1822
|
-
case "isLessThanOrEqualToBigInt":
|
|
1823
|
-
case "isLessThanOrEqualToDate":
|
|
1824
|
-
return `Schema.${filter.meta._tag}(${toRuntimeValue(filter.meta.maximum)}${ca})`;
|
|
1825
|
-
case "isBetween":
|
|
1826
|
-
case "isBetweenBigInt":
|
|
1827
|
-
case "isBetweenDate":
|
|
1828
|
-
return `Schema.${filter.meta._tag}({ minimum: ${toRuntimeValue(filter.meta.minimum)}, maximum: ${toRuntimeValue(filter.meta.maximum)}, exclusiveMinimum: ${toRuntimeValue(filter.meta.exclusiveMinimum)}, exclusiveMaximum: ${toRuntimeValue(filter.meta.exclusiveMaximum)}${ca})`;
|
|
1829
|
-
case "isMultipleOf":
|
|
1830
|
-
return `Schema.isMultipleOf(${filter.meta.divisor}${ca})`;
|
|
1831
|
-
case "isMinProperties":
|
|
1832
|
-
return `Schema.isMinProperties(${filter.meta.minProperties}${ca})`;
|
|
1833
|
-
case "isMaxProperties":
|
|
1834
|
-
return `Schema.isMaxProperties(${filter.meta.maxProperties}${ca})`;
|
|
1835
|
-
case "isPropertiesLengthBetween":
|
|
1836
|
-
return `Schema.isPropertiesLengthBetween(${filter.meta.minimum}, ${filter.meta.maximum}${ca})`;
|
|
1837
|
-
case "isPropertyNames":
|
|
1838
|
-
return `Schema.isPropertyNames(${recur(filter.meta.propertyNames).runtime}${ca})`;
|
|
1839
|
-
case "isMinSize":
|
|
1840
|
-
return `Schema.isMinSize(${filter.meta.minSize}${ca})`;
|
|
1841
|
-
case "isMaxSize":
|
|
1842
|
-
return `Schema.isMaxSize(${filter.meta.maxSize}${ca})`;
|
|
1843
|
-
case "isSizeBetween":
|
|
1844
|
-
return `Schema.isSizeBetween(${filter.meta.minimum}, ${filter.meta.maximum}${ca})`;
|
|
1845
|
-
}
|
|
1846
|
-
}
|
|
430
|
+
export function fromRepresentations(document, options) {
|
|
431
|
+
return InternalFromRepresentation.fromRepresentations(document, options.revivers);
|
|
1847
432
|
}
|
|
1848
|
-
const VALID_ASCII_UPPER_JAVASCRIPT_IDENTIFIER_REGEXP = /^[A-Z_$][A-Za-z0-9_$]*$/;
|
|
1849
433
|
/**
|
|
1850
|
-
*
|
|
1851
|
-
* starting with an uppercase letter, `$`, or `_`.
|
|
1852
|
-
*
|
|
1853
|
-
* - Replaces invalid identifier characters with `_`
|
|
1854
|
-
* - Uppercases a leading ASCII letter
|
|
1855
|
-
* - If the first character is a digit, prefixes `_`
|
|
1856
|
-
* - Empty input becomes `_`
|
|
1857
|
-
*
|
|
1858
|
-
* @internal
|
|
1859
|
-
*/
|
|
1860
|
-
export function sanitizeJavaScriptIdentifier(s) {
|
|
1861
|
-
if (s.length === 0) return "_";
|
|
1862
|
-
if (VALID_ASCII_UPPER_JAVASCRIPT_IDENTIFIER_REGEXP.test(s)) return s;
|
|
1863
|
-
const out = [];
|
|
1864
|
-
let needsPrefix = false;
|
|
1865
|
-
let i = 0;
|
|
1866
|
-
for (const ch of s) {
|
|
1867
|
-
if (i === 0) {
|
|
1868
|
-
if (ch === "_" || ch === "$" || ch >= "A" && ch <= "Z") {
|
|
1869
|
-
out.push(ch);
|
|
1870
|
-
} else if (ch >= "a" && ch <= "z") {
|
|
1871
|
-
out.push(ch.toUpperCase());
|
|
1872
|
-
} else if (ch >= "0" && ch <= "9") {
|
|
1873
|
-
out.push(ch);
|
|
1874
|
-
needsPrefix = true;
|
|
1875
|
-
} else {
|
|
1876
|
-
out.push("_");
|
|
1877
|
-
}
|
|
1878
|
-
} else {
|
|
1879
|
-
out.push(isAsciiIdPart(ch) ? ch : "_");
|
|
1880
|
-
}
|
|
1881
|
-
i++;
|
|
1882
|
-
}
|
|
1883
|
-
return needsPrefix ? "_" + out.join("") : out.join("");
|
|
1884
|
-
}
|
|
1885
|
-
function isAsciiIdStart(ch) {
|
|
1886
|
-
return ch === "_" || ch === "$" || ch >= "A" && ch <= "Z" || ch >= "a" && ch <= "z";
|
|
1887
|
-
}
|
|
1888
|
-
function isAsciiIdPart(ch) {
|
|
1889
|
-
return isAsciiIdStart(ch) || ch >= "0" && ch <= "9";
|
|
1890
|
-
}
|
|
1891
|
-
function replacePlaceholders(template, items) {
|
|
1892
|
-
let i = 0;
|
|
1893
|
-
return template.replace(/\?/g, () => items[i++]);
|
|
1894
|
-
}
|
|
1895
|
-
function toTypeParts(parts) {
|
|
1896
|
-
if (parts.length === 0) {
|
|
1897
|
-
return [""];
|
|
1898
|
-
}
|
|
1899
|
-
const [first, ...rest] = parts;
|
|
1900
|
-
const restPatterns = toTypeParts(rest);
|
|
1901
|
-
return toTypePart(first).flatMap(f => restPatterns.map(r => f + r));
|
|
1902
|
-
}
|
|
1903
|
-
function toTypePart(r) {
|
|
1904
|
-
switch (r._tag) {
|
|
1905
|
-
case "Literal":
|
|
1906
|
-
return [globalThis.String(r.literal)];
|
|
1907
|
-
case "String":
|
|
1908
|
-
return ["${string}"];
|
|
1909
|
-
case "Number":
|
|
1910
|
-
return ["${number}"];
|
|
1911
|
-
case "BigInt":
|
|
1912
|
-
return ["${bigint}"];
|
|
1913
|
-
case "TemplateLiteral":
|
|
1914
|
-
return toTypeParts(r.parts);
|
|
1915
|
-
case "Union":
|
|
1916
|
-
return r.types.flatMap(toTypePart);
|
|
1917
|
-
default:
|
|
1918
|
-
return [];
|
|
1919
|
-
}
|
|
1920
|
-
}
|
|
1921
|
-
const toCodeAnnotationsBlacklist = /*#__PURE__*/new Set([...toJsonAnnotationsBlacklist, "typeConstructor", "generation", "brands"]);
|
|
1922
|
-
function toRuntimeAnnotations(annotations) {
|
|
1923
|
-
if (!annotations) return "";
|
|
1924
|
-
const entries = [];
|
|
1925
|
-
for (const [key, value] of Object.entries(annotations)) {
|
|
1926
|
-
if (toCodeAnnotationsBlacklist.has(key)) continue;
|
|
1927
|
-
entries.push(`${formatPropertyKey(key)}: ${format(value)}`);
|
|
1928
|
-
}
|
|
1929
|
-
if (entries.length === 0) return "";
|
|
1930
|
-
return `{ ${entries.join(", ")} }`;
|
|
1931
|
-
}
|
|
1932
|
-
function toRuntimeBrand(annotations) {
|
|
1933
|
-
const brands = collectBrands(annotations);
|
|
1934
|
-
return brands.length > 0 ? `.pipe(${brands.map(b => `Schema.brand(${format(b)})`).join(", ")})` : "";
|
|
1935
|
-
}
|
|
1936
|
-
function toRuntimeAnnotate(annotations) {
|
|
1937
|
-
const s = toRuntimeAnnotations(annotations);
|
|
1938
|
-
return s === "" ? "" : `.annotate(${s})`;
|
|
1939
|
-
}
|
|
1940
|
-
function toRuntimeAnnotateKey(annotations) {
|
|
1941
|
-
const s = toRuntimeAnnotations(annotations);
|
|
1942
|
-
return s === "" ? "" : `.annotateKey(${s})`;
|
|
1943
|
-
}
|
|
1944
|
-
function toRuntimeIsOptional(isOptional, runtime) {
|
|
1945
|
-
return isOptional ? `Schema.optionalKey(${runtime})` : runtime;
|
|
1946
|
-
}
|
|
1947
|
-
function toTypeIsOptional(isOptional, type) {
|
|
1948
|
-
return isOptional ? `${type}?` : type;
|
|
1949
|
-
}
|
|
1950
|
-
function toRuntimeIsMutable(isMutable, runtime) {
|
|
1951
|
-
return isMutable ? `Schema.mutableKey(${runtime})` : runtime;
|
|
1952
|
-
}
|
|
1953
|
-
function toTypeIsMutable(isMutable, type) {
|
|
1954
|
-
return isMutable ? type : `readonly ${type}`;
|
|
1955
|
-
}
|
|
1956
|
-
function toRuntimeValue(value) {
|
|
1957
|
-
if (value instanceof Date) {
|
|
1958
|
-
return `new Date(${value.getTime()})`;
|
|
1959
|
-
}
|
|
1960
|
-
return format(value);
|
|
1961
|
-
}
|
|
1962
|
-
function toRuntimeRegExp(regExp) {
|
|
1963
|
-
const args = [format(regExp.source)];
|
|
1964
|
-
const flags = regExp.flags.trim();
|
|
1965
|
-
if (flags !== "") {
|
|
1966
|
-
args.push(format(flags));
|
|
1967
|
-
}
|
|
1968
|
-
return `new RegExp(${args.join(", ")})`;
|
|
1969
|
-
}
|
|
1970
|
-
/**
|
|
1971
|
-
* Parses a Draft 2020-12 JSON Schema document into a {@link Document}.
|
|
434
|
+
* Imports a JSON Schema Draft 2020-12 document as a runtime schema.
|
|
1972
435
|
*
|
|
1973
436
|
* **When to use**
|
|
1974
437
|
*
|
|
1975
|
-
* Use when you need to
|
|
1976
|
-
* Effect schema representation system.
|
|
1977
|
-
*
|
|
1978
|
-
* **Details**
|
|
1979
|
-
*
|
|
1980
|
-
* `options.onEnter` is an optional hook called on each JSON Schema node before
|
|
1981
|
-
* processing, allowing pre-transformation.
|
|
438
|
+
* Use when you need to validate or transform values described by an external JSON Schema document.
|
|
1982
439
|
*
|
|
1983
440
|
* **Gotchas**
|
|
1984
441
|
*
|
|
1985
|
-
*
|
|
1986
|
-
* exactly to Effect schema representations, and importing a schema previously
|
|
1987
|
-
* emitted by `toJsonSchemaDocument` may produce an equivalent approximation
|
|
1988
|
-
* rather than the original representation shape.
|
|
442
|
+
* Import is best-effort. Built-in declarations and checks are reconstructed with importer-owned revivers. Callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
1989
443
|
*
|
|
1990
|
-
*
|
|
1991
|
-
*
|
|
1992
|
-
*
|
|
1993
|
-
* @see {@link Document}
|
|
1994
|
-
* @see {@link toJsonSchemaDocument}
|
|
1995
|
-
* @see {@link fromJsonSchemaMultiDocument}
|
|
444
|
+
* @see {@link fromJsonSchemaMultiDocument} for multiple roots sharing definitions
|
|
445
|
+
* @see {@link toRepresentation} for converting the result to a representation document
|
|
1996
446
|
*
|
|
1997
447
|
* @category constructors
|
|
1998
448
|
* @since 4.0.0
|
|
1999
449
|
*/
|
|
2000
450
|
export function fromJsonSchemaDocument(document, options) {
|
|
2001
|
-
|
|
2002
|
-
references,
|
|
2003
|
-
representations: schemas
|
|
2004
|
-
} = fromJsonSchemaMultiDocument({
|
|
2005
|
-
dialect: document.dialect,
|
|
2006
|
-
schemas: [document.schema],
|
|
2007
|
-
definitions: document.definitions
|
|
2008
|
-
}, options);
|
|
2009
|
-
return {
|
|
2010
|
-
representation: schemas[0],
|
|
2011
|
-
references
|
|
2012
|
-
};
|
|
451
|
+
return InternalFromJsonSchemaDocument.fromJsonSchemaDocument(document, options);
|
|
2013
452
|
}
|
|
2014
453
|
/**
|
|
2015
|
-
*
|
|
2016
|
-
* {@link MultiDocument}.
|
|
454
|
+
* Imports multiple JSON Schema Draft 2020-12 roots as runtime schemas with shared definitions.
|
|
2017
455
|
*
|
|
2018
456
|
* **When to use**
|
|
2019
457
|
*
|
|
2020
|
-
* Use when
|
|
2021
|
-
* schemas share definitions.
|
|
2022
|
-
*
|
|
2023
|
-
* **Details**
|
|
2024
|
-
*
|
|
2025
|
-
* `options.onEnter` is an optional hook called on each JSON Schema node before
|
|
2026
|
-
* processing.
|
|
458
|
+
* Use when multiple imported roots must preserve shared definitions, aliases, and recursion.
|
|
2027
459
|
*
|
|
2028
460
|
* **Gotchas**
|
|
2029
461
|
*
|
|
2030
|
-
*
|
|
2031
|
-
* exactly to Effect schema representations, and importing schemas previously
|
|
2032
|
-
* emitted by `toJsonSchemaMultiDocument` may produce equivalent approximations
|
|
2033
|
-
* rather than the original representation shapes.
|
|
462
|
+
* Every definition is translated, including definitions that no root references. Callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
2034
463
|
*
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2037
|
-
* @see {@link MultiDocument}
|
|
2038
|
-
* @see {@link toJsonSchemaMultiDocument}
|
|
2039
|
-
* @see {@link fromJsonSchemaDocument}
|
|
464
|
+
* @see {@link fromJsonSchemaDocument} for a single root
|
|
465
|
+
* @see {@link fromSchemaMultiDocument} for converting the result to a representation document
|
|
2040
466
|
*
|
|
2041
467
|
* @category constructors
|
|
2042
468
|
* @since 4.0.0
|
|
2043
469
|
*/
|
|
2044
470
|
export function fromJsonSchemaMultiDocument(document, options) {
|
|
2045
|
-
|
|
2046
|
-
const references = {};
|
|
2047
|
-
const resolvedReferences = new Map();
|
|
2048
|
-
function resolveReference($ref) {
|
|
2049
|
-
const definition = document.definitions[$ref];
|
|
2050
|
-
if (definition === undefined) {
|
|
2051
|
-
throw new Error(`Reference ${$ref} not found`);
|
|
2052
|
-
}
|
|
2053
|
-
const resolved = resolvedReferences.get($ref);
|
|
2054
|
-
if (resolved === null) {
|
|
2055
|
-
throw new Error(`Circular reference detected: ${$ref}`);
|
|
2056
|
-
}
|
|
2057
|
-
if (resolved !== undefined) return resolved;
|
|
2058
|
-
resolvedReferences.set($ref, null);
|
|
2059
|
-
const value = recur(definition);
|
|
2060
|
-
const out = value._tag === "Reference" ? resolveReference(value.$ref) : value;
|
|
2061
|
-
resolvedReferences.set($ref, out);
|
|
2062
|
-
return out;
|
|
2063
|
-
}
|
|
2064
|
-
for (const [identifier, definition] of Object.entries(document.definitions)) {
|
|
2065
|
-
definitionIdentifier = identifier;
|
|
2066
|
-
references[identifier] = unknownToJson(recur(definition));
|
|
2067
|
-
}
|
|
2068
|
-
definitionIdentifier = undefined;
|
|
2069
|
-
const representations = Arr.map(document.schemas, schema => unknownToJson(recur(schema)));
|
|
2070
|
-
return {
|
|
2071
|
-
representations,
|
|
2072
|
-
references
|
|
2073
|
-
};
|
|
2074
|
-
function recur(u) {
|
|
2075
|
-
if (u === false) return never;
|
|
2076
|
-
if (!Predicate.isObject(u)) return unknown;
|
|
2077
|
-
let js = options?.onEnter?.(u) ?? u;
|
|
2078
|
-
if (Array.isArray(js.type)) {
|
|
2079
|
-
if (js.type.every(isType)) {
|
|
2080
|
-
const {
|
|
2081
|
-
type,
|
|
2082
|
-
...rest
|
|
2083
|
-
} = js;
|
|
2084
|
-
js = {
|
|
2085
|
-
anyOf: type.map(type => ({
|
|
2086
|
-
type
|
|
2087
|
-
})),
|
|
2088
|
-
...rest
|
|
2089
|
-
};
|
|
2090
|
-
} else {
|
|
2091
|
-
js = {};
|
|
2092
|
-
}
|
|
2093
|
-
}
|
|
2094
|
-
let out = on(js);
|
|
2095
|
-
const annotations = collectAnnotations(js);
|
|
2096
|
-
if (annotations !== undefined) {
|
|
2097
|
-
out = combine(out, {
|
|
2098
|
-
_tag: "Unknown",
|
|
2099
|
-
annotations
|
|
2100
|
-
});
|
|
2101
|
-
}
|
|
2102
|
-
if (Array.isArray(js.allOf)) {
|
|
2103
|
-
out = js.allOf.reduce((acc, curr) => combine(acc, recur(curr)), out);
|
|
2104
|
-
}
|
|
2105
|
-
if (Array.isArray(js.anyOf)) {
|
|
2106
|
-
out = combine({
|
|
2107
|
-
_tag: "Union",
|
|
2108
|
-
types: js.anyOf.map(type => recur(type)),
|
|
2109
|
-
mode: "anyOf"
|
|
2110
|
-
}, out);
|
|
2111
|
-
}
|
|
2112
|
-
if (Array.isArray(js.oneOf)) {
|
|
2113
|
-
out = combine({
|
|
2114
|
-
_tag: "Union",
|
|
2115
|
-
types: js.oneOf.map(type => recur(type)),
|
|
2116
|
-
mode: "oneOf"
|
|
2117
|
-
}, out);
|
|
2118
|
-
}
|
|
2119
|
-
return out;
|
|
2120
|
-
}
|
|
2121
|
-
function on(js) {
|
|
2122
|
-
if (typeof js.$ref === "string") {
|
|
2123
|
-
const $ref = js.$ref.slice(2).split("/").at(-1);
|
|
2124
|
-
if ($ref !== undefined) {
|
|
2125
|
-
const reference = {
|
|
2126
|
-
_tag: "Reference",
|
|
2127
|
-
$ref: unescapeToken($ref)
|
|
2128
|
-
};
|
|
2129
|
-
if (definitionIdentifier === $ref) {
|
|
2130
|
-
return {
|
|
2131
|
-
_tag: "Suspend",
|
|
2132
|
-
thunk: reference,
|
|
2133
|
-
checks: []
|
|
2134
|
-
};
|
|
2135
|
-
} else {
|
|
2136
|
-
return reference;
|
|
2137
|
-
}
|
|
2138
|
-
}
|
|
2139
|
-
} else if ("const" in js) {
|
|
2140
|
-
if (isLiteralValue(js.const)) {
|
|
2141
|
-
return {
|
|
2142
|
-
_tag: "Literal",
|
|
2143
|
-
literal: js.const
|
|
2144
|
-
};
|
|
2145
|
-
} else if (js.const === null) {
|
|
2146
|
-
return null_;
|
|
2147
|
-
}
|
|
2148
|
-
} else if (Array.isArray(js.enum)) {
|
|
2149
|
-
const types = [];
|
|
2150
|
-
for (const e of js.enum) {
|
|
2151
|
-
if (isLiteralValue(e)) {
|
|
2152
|
-
types.push({
|
|
2153
|
-
_tag: "Literal",
|
|
2154
|
-
literal: e
|
|
2155
|
-
});
|
|
2156
|
-
} else if (e === null) {
|
|
2157
|
-
types.push(null_);
|
|
2158
|
-
} else {
|
|
2159
|
-
types.push(recur(e));
|
|
2160
|
-
}
|
|
2161
|
-
}
|
|
2162
|
-
if (types.length === 1) {
|
|
2163
|
-
return types[0];
|
|
2164
|
-
} else {
|
|
2165
|
-
return {
|
|
2166
|
-
_tag: "Union",
|
|
2167
|
-
types,
|
|
2168
|
-
mode: "anyOf"
|
|
2169
|
-
};
|
|
2170
|
-
}
|
|
2171
|
-
}
|
|
2172
|
-
const type = isType(js.type) ? js.type : getType(js);
|
|
2173
|
-
if (type !== undefined) {
|
|
2174
|
-
switch (type) {
|
|
2175
|
-
case "null":
|
|
2176
|
-
return null_;
|
|
2177
|
-
case "string":
|
|
2178
|
-
{
|
|
2179
|
-
const checks = collectStringChecks(js);
|
|
2180
|
-
if (checks.length > 0) {
|
|
2181
|
-
return {
|
|
2182
|
-
...string,
|
|
2183
|
-
checks
|
|
2184
|
-
};
|
|
2185
|
-
}
|
|
2186
|
-
return string;
|
|
2187
|
-
}
|
|
2188
|
-
case "number":
|
|
2189
|
-
return {
|
|
2190
|
-
_tag: "Number",
|
|
2191
|
-
checks: [{
|
|
2192
|
-
_tag: "Filter",
|
|
2193
|
-
meta: {
|
|
2194
|
-
_tag: "isFinite"
|
|
2195
|
-
}
|
|
2196
|
-
}, ...collectNumberChecks(js)]
|
|
2197
|
-
};
|
|
2198
|
-
case "integer":
|
|
2199
|
-
return {
|
|
2200
|
-
_tag: "Number",
|
|
2201
|
-
checks: [{
|
|
2202
|
-
_tag: "Filter",
|
|
2203
|
-
meta: {
|
|
2204
|
-
_tag: "isInt"
|
|
2205
|
-
}
|
|
2206
|
-
}, ...collectNumberChecks(js)]
|
|
2207
|
-
};
|
|
2208
|
-
case "boolean":
|
|
2209
|
-
return boolean;
|
|
2210
|
-
case "array":
|
|
2211
|
-
{
|
|
2212
|
-
const minItems = typeof js.minItems === "number" ? js.minItems : 0;
|
|
2213
|
-
const elements = (Array.isArray(js.prefixItems) ? js.prefixItems : []).map((e, i) => ({
|
|
2214
|
-
isOptional: i + 1 > minItems,
|
|
2215
|
-
type: recur(e)
|
|
2216
|
-
}));
|
|
2217
|
-
const rest = js.items !== undefined ? [recur(js.items)] : js.prefixItems !== undefined && typeof js.maxItems === "number" ? [] : [unknown];
|
|
2218
|
-
return {
|
|
2219
|
-
_tag: "Arrays",
|
|
2220
|
-
elements,
|
|
2221
|
-
rest,
|
|
2222
|
-
checks: collectArraysChecks(js)
|
|
2223
|
-
};
|
|
2224
|
-
}
|
|
2225
|
-
case "object":
|
|
2226
|
-
{
|
|
2227
|
-
return {
|
|
2228
|
-
_tag: "Objects",
|
|
2229
|
-
propertySignatures: collectProperties(js),
|
|
2230
|
-
indexSignatures: collectIndexSignatures(js),
|
|
2231
|
-
checks: collectObjectsChecks(js)
|
|
2232
|
-
};
|
|
2233
|
-
}
|
|
2234
|
-
}
|
|
2235
|
-
}
|
|
2236
|
-
return {
|
|
2237
|
-
_tag: "Unknown"
|
|
2238
|
-
};
|
|
2239
|
-
}
|
|
2240
|
-
function collectObjectsChecks(js) {
|
|
2241
|
-
const checks = [];
|
|
2242
|
-
if (typeof js.minProperties === "number") {
|
|
2243
|
-
checks.push({
|
|
2244
|
-
_tag: "Filter",
|
|
2245
|
-
meta: {
|
|
2246
|
-
_tag: "isMinProperties",
|
|
2247
|
-
minProperties: js.minProperties
|
|
2248
|
-
}
|
|
2249
|
-
});
|
|
2250
|
-
}
|
|
2251
|
-
if (typeof js.maxProperties === "number") {
|
|
2252
|
-
checks.push({
|
|
2253
|
-
_tag: "Filter",
|
|
2254
|
-
meta: {
|
|
2255
|
-
_tag: "isMaxProperties",
|
|
2256
|
-
maxProperties: js.maxProperties
|
|
2257
|
-
}
|
|
2258
|
-
});
|
|
2259
|
-
}
|
|
2260
|
-
if (js.propertyNames !== undefined) {
|
|
2261
|
-
const propertyNames = recur(js.propertyNames);
|
|
2262
|
-
checks.push({
|
|
2263
|
-
_tag: "Filter",
|
|
2264
|
-
meta: {
|
|
2265
|
-
_tag: "isPropertyNames",
|
|
2266
|
-
propertyNames
|
|
2267
|
-
}
|
|
2268
|
-
});
|
|
2269
|
-
}
|
|
2270
|
-
return checks;
|
|
2271
|
-
}
|
|
2272
|
-
function combine(a, b) {
|
|
2273
|
-
switch (a._tag) {
|
|
2274
|
-
default:
|
|
2275
|
-
return never;
|
|
2276
|
-
case "Reference":
|
|
2277
|
-
return combine(resolveReference(a.$ref), b);
|
|
2278
|
-
case "Never":
|
|
2279
|
-
return a;
|
|
2280
|
-
case "Unknown":
|
|
2281
|
-
{
|
|
2282
|
-
const resolved = b._tag === "Reference" ? resolveReference(b.$ref) : b;
|
|
2283
|
-
return {
|
|
2284
|
-
...resolved,
|
|
2285
|
-
...combineAnnotations(a.annotations, resolved.annotations)
|
|
2286
|
-
};
|
|
2287
|
-
}
|
|
2288
|
-
case "Null":
|
|
2289
|
-
case "String":
|
|
2290
|
-
case "Number":
|
|
2291
|
-
case "Boolean":
|
|
2292
|
-
case "Literal":
|
|
2293
|
-
case "Arrays":
|
|
2294
|
-
case "Objects":
|
|
2295
|
-
case "Union":
|
|
2296
|
-
break;
|
|
2297
|
-
}
|
|
2298
|
-
if (b._tag === "Reference") {
|
|
2299
|
-
return combine(a, resolveReference(b.$ref));
|
|
2300
|
-
}
|
|
2301
|
-
if (b._tag === "Unknown") {
|
|
2302
|
-
return {
|
|
2303
|
-
...a,
|
|
2304
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2305
|
-
};
|
|
2306
|
-
}
|
|
2307
|
-
if (a._tag === "Union") {
|
|
2308
|
-
const types = a.types.map(s => combine(s, b)).filter(s => s !== never);
|
|
2309
|
-
if (types.length === 0) return never;
|
|
2310
|
-
return {
|
|
2311
|
-
_tag: "Union",
|
|
2312
|
-
types,
|
|
2313
|
-
mode: a.mode,
|
|
2314
|
-
...makeAnnotations(a.annotations)
|
|
2315
|
-
};
|
|
2316
|
-
}
|
|
2317
|
-
if (b._tag === "Union") {
|
|
2318
|
-
return combine(b, a);
|
|
2319
|
-
}
|
|
2320
|
-
switch (a._tag) {
|
|
2321
|
-
case "Null":
|
|
2322
|
-
return b._tag === "Null" ? {
|
|
2323
|
-
...a,
|
|
2324
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2325
|
-
} : never;
|
|
2326
|
-
case "String":
|
|
2327
|
-
{
|
|
2328
|
-
if (b._tag === "Literal") {
|
|
2329
|
-
return satisfiesLiteral(a, b) ? {
|
|
2330
|
-
...b,
|
|
2331
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2332
|
-
} : never;
|
|
2333
|
-
}
|
|
2334
|
-
if (b._tag !== "String") return never;
|
|
2335
|
-
const checks = combineChecks(a.checks, b.checks, b.annotations);
|
|
2336
|
-
return {
|
|
2337
|
-
_tag: "String",
|
|
2338
|
-
checks: checks ?? a.checks,
|
|
2339
|
-
...combineAnnotations(a.annotations, checks ? undefined : b.annotations)
|
|
2340
|
-
};
|
|
2341
|
-
}
|
|
2342
|
-
case "Number":
|
|
2343
|
-
{
|
|
2344
|
-
if (b._tag === "Literal") {
|
|
2345
|
-
return satisfiesLiteral(a, b) ? {
|
|
2346
|
-
...b,
|
|
2347
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2348
|
-
} : never;
|
|
2349
|
-
}
|
|
2350
|
-
if (b._tag !== "Number") return never;
|
|
2351
|
-
const checks = combineNumberChecks(a.checks, b.checks, b.annotations);
|
|
2352
|
-
return {
|
|
2353
|
-
_tag: "Number",
|
|
2354
|
-
checks: checks ?? a.checks,
|
|
2355
|
-
...combineAnnotations(a.annotations, checks ? undefined : b.annotations)
|
|
2356
|
-
};
|
|
2357
|
-
}
|
|
2358
|
-
case "Boolean":
|
|
2359
|
-
if (b._tag === "Boolean") {
|
|
2360
|
-
return {
|
|
2361
|
-
_tag: "Boolean",
|
|
2362
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2363
|
-
};
|
|
2364
|
-
}
|
|
2365
|
-
return b._tag === "Literal" && typeof b.literal === "boolean" ? {
|
|
2366
|
-
...b,
|
|
2367
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2368
|
-
} : never;
|
|
2369
|
-
case "Literal":
|
|
2370
|
-
switch (b._tag) {
|
|
2371
|
-
case "Literal":
|
|
2372
|
-
return a.literal === b.literal ? {
|
|
2373
|
-
...a,
|
|
2374
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2375
|
-
} : never;
|
|
2376
|
-
case "String":
|
|
2377
|
-
case "Number":
|
|
2378
|
-
return satisfiesLiteral(b, a) ? {
|
|
2379
|
-
...a,
|
|
2380
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2381
|
-
} : never;
|
|
2382
|
-
case "Boolean":
|
|
2383
|
-
return typeof a.literal === "boolean" ? {
|
|
2384
|
-
...a,
|
|
2385
|
-
...combineAnnotations(a.annotations, b.annotations)
|
|
2386
|
-
} : never;
|
|
2387
|
-
default:
|
|
2388
|
-
return never;
|
|
2389
|
-
}
|
|
2390
|
-
case "Arrays":
|
|
2391
|
-
{
|
|
2392
|
-
if (b._tag !== "Arrays") return never;
|
|
2393
|
-
const arrays = combineArrays(a, b);
|
|
2394
|
-
if (arrays === undefined) return never;
|
|
2395
|
-
const checks = combineArraysChecks(a.checks, b.checks, b.annotations);
|
|
2396
|
-
return {
|
|
2397
|
-
_tag: "Arrays",
|
|
2398
|
-
elements: arrays.elements,
|
|
2399
|
-
rest: arrays.rest,
|
|
2400
|
-
checks: checks ?? a.checks,
|
|
2401
|
-
...combineAnnotations(a.annotations, checks ? undefined : b.annotations)
|
|
2402
|
-
};
|
|
2403
|
-
}
|
|
2404
|
-
case "Objects":
|
|
2405
|
-
{
|
|
2406
|
-
if (b._tag !== "Objects") return never;
|
|
2407
|
-
const checks = combineChecks(a.checks, b.checks, b.annotations);
|
|
2408
|
-
return {
|
|
2409
|
-
_tag: "Objects",
|
|
2410
|
-
propertySignatures: combinePropertySignatures(a.propertySignatures, b.propertySignatures),
|
|
2411
|
-
indexSignatures: combineIndexSignatures(a.indexSignatures, b.indexSignatures),
|
|
2412
|
-
checks: checks ?? a.checks,
|
|
2413
|
-
...combineAnnotations(a.annotations, checks ? undefined : b.annotations)
|
|
2414
|
-
};
|
|
2415
|
-
}
|
|
2416
|
-
default:
|
|
2417
|
-
return never;
|
|
2418
|
-
}
|
|
2419
|
-
}
|
|
2420
|
-
function satisfiesPrimitiveCheck(check, value) {
|
|
2421
|
-
if (check._tag === "FilterGroup") {
|
|
2422
|
-
return check.checks.every(check => satisfiesPrimitiveCheck(check, value));
|
|
2423
|
-
}
|
|
2424
|
-
const meta = check.meta;
|
|
2425
|
-
switch (meta._tag) {
|
|
2426
|
-
case "isMinLength":
|
|
2427
|
-
return typeof value === "string" && value.length >= meta.minLength;
|
|
2428
|
-
case "isMaxLength":
|
|
2429
|
-
return typeof value === "string" && value.length <= meta.maxLength;
|
|
2430
|
-
case "isPattern":
|
|
2431
|
-
return typeof value === "string" && meta.regExp.test(value);
|
|
2432
|
-
case "isFinite":
|
|
2433
|
-
return typeof value === "number" && globalThis.Number.isFinite(value);
|
|
2434
|
-
case "isInt":
|
|
2435
|
-
return typeof value === "number" && globalThis.Number.isSafeInteger(value);
|
|
2436
|
-
case "isMultipleOf":
|
|
2437
|
-
return typeof value === "number" && remainder(value, meta.divisor) === 0;
|
|
2438
|
-
case "isGreaterThan":
|
|
2439
|
-
return typeof value === "number" && value > meta.exclusiveMinimum;
|
|
2440
|
-
case "isGreaterThanOrEqualTo":
|
|
2441
|
-
return typeof value === "number" && value >= meta.minimum;
|
|
2442
|
-
case "isLessThan":
|
|
2443
|
-
return typeof value === "number" && value < meta.exclusiveMaximum;
|
|
2444
|
-
case "isLessThanOrEqualTo":
|
|
2445
|
-
return typeof value === "number" && value <= meta.maximum;
|
|
2446
|
-
default:
|
|
2447
|
-
return false;
|
|
2448
|
-
}
|
|
2449
|
-
}
|
|
2450
|
-
function satisfiesLiteral(type, literal) {
|
|
2451
|
-
const value = literal.literal;
|
|
2452
|
-
if (type._tag === "String" ? typeof value !== "string" : typeof value !== "number") {
|
|
2453
|
-
return false;
|
|
2454
|
-
}
|
|
2455
|
-
return type.checks.every(check => satisfiesPrimitiveCheck(check, value));
|
|
2456
|
-
}
|
|
2457
|
-
function collectProperties(js) {
|
|
2458
|
-
const properties = Predicate.isObject(js.properties) ? js.properties : {};
|
|
2459
|
-
const required = Array.isArray(js.required) ? js.required : [];
|
|
2460
|
-
required.forEach(key => {
|
|
2461
|
-
if (!Object.hasOwn(properties, key)) {
|
|
2462
|
-
properties[key] = {};
|
|
2463
|
-
}
|
|
2464
|
-
});
|
|
2465
|
-
return Object.entries(properties).map(([key, v]) => ({
|
|
2466
|
-
name: key,
|
|
2467
|
-
type: recur(v),
|
|
2468
|
-
isOptional: !required.includes(key),
|
|
2469
|
-
isMutable: false
|
|
2470
|
-
}));
|
|
2471
|
-
}
|
|
2472
|
-
function collectIndexSignatures(js) {
|
|
2473
|
-
const out = [];
|
|
2474
|
-
if (Predicate.isObject(js.patternProperties)) {
|
|
2475
|
-
for (const [pattern, value] of Object.entries(js.patternProperties)) {
|
|
2476
|
-
out.push({
|
|
2477
|
-
parameter: recur({
|
|
2478
|
-
pattern
|
|
2479
|
-
}),
|
|
2480
|
-
type: recur(value)
|
|
2481
|
-
});
|
|
2482
|
-
}
|
|
2483
|
-
}
|
|
2484
|
-
if (js.additionalProperties === undefined || js.additionalProperties === true) {
|
|
2485
|
-
out.push({
|
|
2486
|
-
parameter: string,
|
|
2487
|
-
type: unknown
|
|
2488
|
-
});
|
|
2489
|
-
} else if (Predicate.isObject(js.additionalProperties)) {
|
|
2490
|
-
out.push({
|
|
2491
|
-
parameter: string,
|
|
2492
|
-
type: recur(js.additionalProperties)
|
|
2493
|
-
});
|
|
2494
|
-
}
|
|
2495
|
-
return out;
|
|
2496
|
-
}
|
|
2497
|
-
function combineArrays(a, b) {
|
|
2498
|
-
const elements = [];
|
|
2499
|
-
const len = Math.max(a.elements.length, b.elements.length);
|
|
2500
|
-
for (let i = 0; i < len; i++) {
|
|
2501
|
-
const ae = a.elements[i];
|
|
2502
|
-
const be = b.elements[i];
|
|
2503
|
-
const isOptional = ae?.isOptional !== false && be?.isOptional !== false;
|
|
2504
|
-
const at = ae?.type ?? a.rest[0];
|
|
2505
|
-
const bt = be?.type ?? b.rest[0];
|
|
2506
|
-
if (at === undefined || bt === undefined) {
|
|
2507
|
-
return isOptional ? {
|
|
2508
|
-
elements,
|
|
2509
|
-
rest: []
|
|
2510
|
-
} : undefined;
|
|
2511
|
-
}
|
|
2512
|
-
const type = combine(at, bt);
|
|
2513
|
-
if (type === never) {
|
|
2514
|
-
return isOptional ? {
|
|
2515
|
-
elements,
|
|
2516
|
-
rest: []
|
|
2517
|
-
} : undefined;
|
|
2518
|
-
}
|
|
2519
|
-
elements.push({
|
|
2520
|
-
isOptional,
|
|
2521
|
-
type
|
|
2522
|
-
});
|
|
2523
|
-
}
|
|
2524
|
-
const ar = a.rest[0];
|
|
2525
|
-
const br = b.rest[0];
|
|
2526
|
-
if (ar === undefined || br === undefined) {
|
|
2527
|
-
return {
|
|
2528
|
-
elements,
|
|
2529
|
-
rest: []
|
|
2530
|
-
};
|
|
2531
|
-
}
|
|
2532
|
-
const rest = combine(ar, br);
|
|
2533
|
-
return {
|
|
2534
|
-
elements,
|
|
2535
|
-
rest: rest === never ? [] : [rest]
|
|
2536
|
-
};
|
|
2537
|
-
}
|
|
2538
|
-
function combinePropertySignatures(a, b) {
|
|
2539
|
-
const propertySignatures = [];
|
|
2540
|
-
const thatPropertiesMap = {};
|
|
2541
|
-
for (const p of b) {
|
|
2542
|
-
thatPropertiesMap[p.name] = p;
|
|
2543
|
-
}
|
|
2544
|
-
const keys = new Set();
|
|
2545
|
-
for (const p of a) {
|
|
2546
|
-
keys.add(p.name);
|
|
2547
|
-
const thatp = thatPropertiesMap[p.name];
|
|
2548
|
-
if (thatp) {
|
|
2549
|
-
propertySignatures.push({
|
|
2550
|
-
name: p.name,
|
|
2551
|
-
type: combine(p.type, thatp.type),
|
|
2552
|
-
isOptional: p.isOptional && thatp.isOptional,
|
|
2553
|
-
isMutable: p.isMutable
|
|
2554
|
-
});
|
|
2555
|
-
} else {
|
|
2556
|
-
propertySignatures.push(p);
|
|
2557
|
-
}
|
|
2558
|
-
}
|
|
2559
|
-
for (const p of b) {
|
|
2560
|
-
if (!keys.has(p.name)) propertySignatures.push(p);
|
|
2561
|
-
}
|
|
2562
|
-
return propertySignatures;
|
|
2563
|
-
}
|
|
2564
|
-
function combineIndexSignatures(a, b) {
|
|
2565
|
-
if (a.length === 0 || b.length === 0) return [];
|
|
2566
|
-
const out = [...a];
|
|
2567
|
-
for (const is of b) {
|
|
2568
|
-
if (is.parameter === string) {
|
|
2569
|
-
const i = a.findIndex(is => is.parameter === string);
|
|
2570
|
-
if (i !== -1) {
|
|
2571
|
-
out[i] = {
|
|
2572
|
-
parameter: string,
|
|
2573
|
-
type: combine(a[i].type, is.type)
|
|
2574
|
-
};
|
|
2575
|
-
} else {
|
|
2576
|
-
out.push(is);
|
|
2577
|
-
}
|
|
2578
|
-
} else {
|
|
2579
|
-
out.push(is);
|
|
2580
|
-
}
|
|
2581
|
-
}
|
|
2582
|
-
return out;
|
|
2583
|
-
}
|
|
2584
|
-
function unknownToJson(representation) {
|
|
2585
|
-
switch (representation._tag) {
|
|
2586
|
-
case "Unknown":
|
|
2587
|
-
return representation.annotations === undefined ? json : {
|
|
2588
|
-
...json,
|
|
2589
|
-
annotations: {
|
|
2590
|
-
...json.annotations,
|
|
2591
|
-
...representation.annotations
|
|
2592
|
-
}
|
|
2593
|
-
};
|
|
2594
|
-
case "Suspend":
|
|
2595
|
-
{
|
|
2596
|
-
const thunk = unknownToJson(representation.thunk);
|
|
2597
|
-
return thunk === representation.thunk ? representation : {
|
|
2598
|
-
...representation,
|
|
2599
|
-
thunk
|
|
2600
|
-
};
|
|
2601
|
-
}
|
|
2602
|
-
case "String":
|
|
2603
|
-
{
|
|
2604
|
-
if (representation.contentSchema === undefined) return representation;
|
|
2605
|
-
const contentSchema = unknownToJson(representation.contentSchema);
|
|
2606
|
-
return contentSchema === representation.contentSchema ? representation : {
|
|
2607
|
-
...representation,
|
|
2608
|
-
contentSchema
|
|
2609
|
-
};
|
|
2610
|
-
}
|
|
2611
|
-
case "Arrays":
|
|
2612
|
-
{
|
|
2613
|
-
const elements = SchemaAST.mapOrSame(representation.elements, element => {
|
|
2614
|
-
const type = unknownToJson(element.type);
|
|
2615
|
-
return type === element.type ? element : {
|
|
2616
|
-
...element,
|
|
2617
|
-
type
|
|
2618
|
-
};
|
|
2619
|
-
});
|
|
2620
|
-
const rest = SchemaAST.mapOrSame(representation.rest, unknownToJson);
|
|
2621
|
-
return elements === representation.elements && rest === representation.rest ? representation : {
|
|
2622
|
-
...representation,
|
|
2623
|
-
elements,
|
|
2624
|
-
rest
|
|
2625
|
-
};
|
|
2626
|
-
}
|
|
2627
|
-
case "Objects":
|
|
2628
|
-
{
|
|
2629
|
-
const propertySignatures = SchemaAST.mapOrSame(representation.propertySignatures, propertySignature => {
|
|
2630
|
-
const type = unknownToJson(propertySignature.type);
|
|
2631
|
-
return type === propertySignature.type ? propertySignature : {
|
|
2632
|
-
...propertySignature,
|
|
2633
|
-
type
|
|
2634
|
-
};
|
|
2635
|
-
});
|
|
2636
|
-
const indexSignatures = SchemaAST.mapOrSame(representation.indexSignatures, indexSignature => {
|
|
2637
|
-
const type = unknownToJson(indexSignature.type);
|
|
2638
|
-
return type === indexSignature.type ? indexSignature : {
|
|
2639
|
-
...indexSignature,
|
|
2640
|
-
type
|
|
2641
|
-
};
|
|
2642
|
-
});
|
|
2643
|
-
return propertySignatures === representation.propertySignatures && indexSignatures === representation.indexSignatures ? representation : {
|
|
2644
|
-
...representation,
|
|
2645
|
-
propertySignatures,
|
|
2646
|
-
indexSignatures
|
|
2647
|
-
};
|
|
2648
|
-
}
|
|
2649
|
-
case "Union":
|
|
2650
|
-
{
|
|
2651
|
-
const types = SchemaAST.mapOrSame(representation.types, unknownToJson);
|
|
2652
|
-
return types === representation.types ? representation : {
|
|
2653
|
-
...representation,
|
|
2654
|
-
types
|
|
2655
|
-
};
|
|
2656
|
-
}
|
|
2657
|
-
default:
|
|
2658
|
-
return representation;
|
|
2659
|
-
}
|
|
2660
|
-
}
|
|
2661
|
-
}
|
|
2662
|
-
function asChecks(checks, annotations) {
|
|
2663
|
-
if (Arr.isReadonlyArrayNonEmpty(checks)) {
|
|
2664
|
-
if (annotations !== undefined) {
|
|
2665
|
-
if (checks.length === 1) {
|
|
2666
|
-
const check = checks[0];
|
|
2667
|
-
if (check.annotations === undefined) {
|
|
2668
|
-
return [{
|
|
2669
|
-
...check,
|
|
2670
|
-
annotations
|
|
2671
|
-
}];
|
|
2672
|
-
} else {
|
|
2673
|
-
return [{
|
|
2674
|
-
_tag: "FilterGroup",
|
|
2675
|
-
checks,
|
|
2676
|
-
annotations
|
|
2677
|
-
}];
|
|
2678
|
-
}
|
|
2679
|
-
} else {
|
|
2680
|
-
return [{
|
|
2681
|
-
_tag: "FilterGroup",
|
|
2682
|
-
checks,
|
|
2683
|
-
annotations
|
|
2684
|
-
}];
|
|
2685
|
-
}
|
|
2686
|
-
}
|
|
2687
|
-
return checks;
|
|
2688
|
-
}
|
|
2689
|
-
}
|
|
2690
|
-
function combineChecks(a, b, annotations) {
|
|
2691
|
-
const checks = asChecks(b, annotations);
|
|
2692
|
-
if (checks) {
|
|
2693
|
-
return [...a, ...checks];
|
|
2694
|
-
}
|
|
2695
|
-
}
|
|
2696
|
-
function combineNumberChecks(a, b, annotations) {
|
|
2697
|
-
if (a.some(c => c._tag === "Filter" && c.meta._tag === "isFinite")) {
|
|
2698
|
-
b = b.filter(c => c._tag !== "Filter" || c.meta._tag !== "isFinite");
|
|
2699
|
-
}
|
|
2700
|
-
if (a.some(c => c._tag === "Filter" && c.meta._tag === "isInt")) {
|
|
2701
|
-
b = b.filter(c => c._tag !== "Filter" || c.meta._tag !== "isInt");
|
|
2702
|
-
}
|
|
2703
|
-
return combineChecks(a, b, annotations);
|
|
2704
|
-
}
|
|
2705
|
-
function combineArraysChecks(a, b, annotations) {
|
|
2706
|
-
if (a.some(c => c._tag === "Filter" && c.meta._tag === "isUnique")) {
|
|
2707
|
-
b = b.filter(c => c._tag !== "Filter" || c.meta._tag !== "isUnique");
|
|
2708
|
-
}
|
|
2709
|
-
return combineChecks(a, b, annotations);
|
|
2710
|
-
}
|
|
2711
|
-
function makeAnnotations(annotations) {
|
|
2712
|
-
return annotations ? {
|
|
2713
|
-
annotations
|
|
2714
|
-
} : undefined;
|
|
2715
|
-
}
|
|
2716
|
-
function combineAnnotations(a, b) {
|
|
2717
|
-
if (a === undefined) return makeAnnotations(b);
|
|
2718
|
-
if (b === undefined) return makeAnnotations(a);
|
|
2719
|
-
return {
|
|
2720
|
-
annotations: {
|
|
2721
|
-
...a,
|
|
2722
|
-
...b
|
|
2723
|
-
}
|
|
2724
|
-
}; // TODO: better merge
|
|
2725
|
-
}
|
|
2726
|
-
function collectStringChecks(js) {
|
|
2727
|
-
const checks = [];
|
|
2728
|
-
if (typeof js.minLength === "number") {
|
|
2729
|
-
checks.push({
|
|
2730
|
-
_tag: "Filter",
|
|
2731
|
-
meta: {
|
|
2732
|
-
_tag: "isMinLength",
|
|
2733
|
-
minLength: js.minLength
|
|
2734
|
-
}
|
|
2735
|
-
});
|
|
2736
|
-
}
|
|
2737
|
-
if (typeof js.maxLength === "number") {
|
|
2738
|
-
checks.push({
|
|
2739
|
-
_tag: "Filter",
|
|
2740
|
-
meta: {
|
|
2741
|
-
_tag: "isMaxLength",
|
|
2742
|
-
maxLength: js.maxLength
|
|
2743
|
-
}
|
|
2744
|
-
});
|
|
2745
|
-
}
|
|
2746
|
-
if (typeof js.pattern === "string") {
|
|
2747
|
-
checks.push({
|
|
2748
|
-
_tag: "Filter",
|
|
2749
|
-
meta: {
|
|
2750
|
-
_tag: "isPattern",
|
|
2751
|
-
regExp: new RegExp(js.pattern)
|
|
2752
|
-
}
|
|
2753
|
-
});
|
|
2754
|
-
}
|
|
2755
|
-
return checks;
|
|
2756
|
-
}
|
|
2757
|
-
function collectNumberChecks(js) {
|
|
2758
|
-
const checks = [];
|
|
2759
|
-
if (typeof js.minimum === "number") {
|
|
2760
|
-
checks.push({
|
|
2761
|
-
_tag: "Filter",
|
|
2762
|
-
meta: {
|
|
2763
|
-
_tag: "isGreaterThanOrEqualTo",
|
|
2764
|
-
minimum: js.minimum
|
|
2765
|
-
}
|
|
2766
|
-
});
|
|
2767
|
-
}
|
|
2768
|
-
if (typeof js.maximum === "number") {
|
|
2769
|
-
checks.push({
|
|
2770
|
-
_tag: "Filter",
|
|
2771
|
-
meta: {
|
|
2772
|
-
_tag: "isLessThanOrEqualTo",
|
|
2773
|
-
maximum: js.maximum
|
|
2774
|
-
}
|
|
2775
|
-
});
|
|
2776
|
-
}
|
|
2777
|
-
if (typeof js.exclusiveMinimum === "number") {
|
|
2778
|
-
checks.push({
|
|
2779
|
-
_tag: "Filter",
|
|
2780
|
-
meta: {
|
|
2781
|
-
_tag: "isGreaterThan",
|
|
2782
|
-
exclusiveMinimum: js.exclusiveMinimum
|
|
2783
|
-
}
|
|
2784
|
-
});
|
|
2785
|
-
}
|
|
2786
|
-
if (typeof js.exclusiveMaximum === "number") {
|
|
2787
|
-
checks.push({
|
|
2788
|
-
_tag: "Filter",
|
|
2789
|
-
meta: {
|
|
2790
|
-
_tag: "isLessThan",
|
|
2791
|
-
exclusiveMaximum: js.exclusiveMaximum
|
|
2792
|
-
}
|
|
2793
|
-
});
|
|
2794
|
-
}
|
|
2795
|
-
if (typeof js.multipleOf === "number") {
|
|
2796
|
-
checks.push({
|
|
2797
|
-
_tag: "Filter",
|
|
2798
|
-
meta: {
|
|
2799
|
-
_tag: "isMultipleOf",
|
|
2800
|
-
divisor: js.multipleOf
|
|
2801
|
-
}
|
|
2802
|
-
});
|
|
2803
|
-
}
|
|
2804
|
-
return checks;
|
|
2805
|
-
}
|
|
2806
|
-
function collectArraysChecks(js) {
|
|
2807
|
-
const checks = [];
|
|
2808
|
-
if (js.prefixItems === undefined) {
|
|
2809
|
-
if (typeof js.minItems === "number") {
|
|
2810
|
-
checks.push({
|
|
2811
|
-
_tag: "Filter",
|
|
2812
|
-
meta: {
|
|
2813
|
-
_tag: "isMinLength",
|
|
2814
|
-
minLength: js.minItems
|
|
2815
|
-
}
|
|
2816
|
-
});
|
|
2817
|
-
}
|
|
2818
|
-
if (typeof js.maxItems === "number") {
|
|
2819
|
-
checks.push({
|
|
2820
|
-
_tag: "Filter",
|
|
2821
|
-
meta: {
|
|
2822
|
-
_tag: "isMaxLength",
|
|
2823
|
-
maxLength: js.maxItems
|
|
2824
|
-
}
|
|
2825
|
-
});
|
|
2826
|
-
}
|
|
2827
|
-
}
|
|
2828
|
-
if (typeof js.uniqueItems === "boolean") {
|
|
2829
|
-
checks.push({
|
|
2830
|
-
_tag: "Filter",
|
|
2831
|
-
meta: {
|
|
2832
|
-
_tag: "isUnique"
|
|
2833
|
-
}
|
|
2834
|
-
});
|
|
2835
|
-
}
|
|
2836
|
-
return checks;
|
|
2837
|
-
}
|
|
2838
|
-
const unknown = {
|
|
2839
|
-
_tag: "Unknown"
|
|
2840
|
-
};
|
|
2841
|
-
const json = {
|
|
2842
|
-
_tag: "Declaration",
|
|
2843
|
-
annotations: {
|
|
2844
|
-
expected: "JSON value",
|
|
2845
|
-
generation: {
|
|
2846
|
-
Type: "Schema.Json",
|
|
2847
|
-
runtime: "Schema.Json"
|
|
2848
|
-
},
|
|
2849
|
-
typeConstructor: {
|
|
2850
|
-
_tag: "effect/Json"
|
|
2851
|
-
}
|
|
2852
|
-
},
|
|
2853
|
-
checks: [],
|
|
2854
|
-
encodedSchema: unknown,
|
|
2855
|
-
typeParameters: []
|
|
2856
|
-
};
|
|
2857
|
-
const never = {
|
|
2858
|
-
_tag: "Never"
|
|
2859
|
-
};
|
|
2860
|
-
const null_ = {
|
|
2861
|
-
_tag: "Null"
|
|
2862
|
-
};
|
|
2863
|
-
const string = {
|
|
2864
|
-
_tag: "String",
|
|
2865
|
-
checks: []
|
|
2866
|
-
};
|
|
2867
|
-
const boolean = {
|
|
2868
|
-
_tag: "Boolean"
|
|
2869
|
-
};
|
|
2870
|
-
function collectAnnotations(schema) {
|
|
2871
|
-
const as = {};
|
|
2872
|
-
if (typeof schema.title === "string") as.title = schema.title;
|
|
2873
|
-
if (typeof schema.description === "string") as.description = schema.description;
|
|
2874
|
-
if (schema.default !== undefined) as.default = schema.default;
|
|
2875
|
-
if (Array.isArray(schema.examples)) as.examples = schema.examples;
|
|
2876
|
-
if (typeof schema.readOnly === "boolean") as.readOnly = schema.readOnly;
|
|
2877
|
-
if (typeof schema.writeOnly === "boolean") as.writeOnly = schema.writeOnly;
|
|
2878
|
-
if (typeof schema.format === "string") as.format = schema.format;
|
|
2879
|
-
if (typeof schema.contentEncoding === "string") as.contentEncoding = schema.contentEncoding;
|
|
2880
|
-
if (typeof schema.contentMediaType === "string") as.contentMediaType = schema.contentMediaType;
|
|
2881
|
-
return Rec.isEmptyRecord(as) ? undefined : as;
|
|
2882
|
-
}
|
|
2883
|
-
function isLiteralValue(value) {
|
|
2884
|
-
return typeof value === "string" || typeof value === "number" || typeof value === "boolean";
|
|
2885
|
-
}
|
|
2886
|
-
const stringKeys = ["minLength", "maxLength", "pattern", "format", "contentMediaType", "contentSchema"];
|
|
2887
|
-
const numberKeys = ["minimum", "maximum", "exclusiveMinimum", "exclusiveMaximum", "multipleOf"];
|
|
2888
|
-
const objectKeys = ["properties", "required", "additionalProperties", "patternProperties", "propertyNames", "minProperties", "maxProperties"];
|
|
2889
|
-
const arrayKeys = ["items", "prefixItems", "additionalItems", "minItems", "maxItems", "uniqueItems"];
|
|
2890
|
-
function getType(js) {
|
|
2891
|
-
if (stringKeys.some(key => js[key] !== undefined)) {
|
|
2892
|
-
return "string";
|
|
2893
|
-
}
|
|
2894
|
-
if (numberKeys.some(key => js[key] !== undefined)) {
|
|
2895
|
-
return "number";
|
|
2896
|
-
}
|
|
2897
|
-
if (objectKeys.some(key => js[key] !== undefined)) {
|
|
2898
|
-
return "object";
|
|
2899
|
-
}
|
|
2900
|
-
if (arrayKeys.some(key => js[key] !== undefined)) {
|
|
2901
|
-
return "array";
|
|
2902
|
-
}
|
|
2903
|
-
}
|
|
2904
|
-
const types = ["null", "string", "number", "integer", "boolean", "object", "array"];
|
|
2905
|
-
function isType(type) {
|
|
2906
|
-
return typeof type === "string" && types.includes(type);
|
|
2907
|
-
}
|
|
2908
|
-
/** @internal */
|
|
2909
|
-
export function topologicalSort(references) {
|
|
2910
|
-
const identifiers = Object.keys(references);
|
|
2911
|
-
const identifierSet = new Set(identifiers);
|
|
2912
|
-
const collectRefs = root => {
|
|
2913
|
-
const refs = new Set();
|
|
2914
|
-
const visited = new WeakSet();
|
|
2915
|
-
const stack = [root];
|
|
2916
|
-
while (stack.length > 0) {
|
|
2917
|
-
const r = stack.pop();
|
|
2918
|
-
if (visited.has(r)) continue;
|
|
2919
|
-
visited.add(r);
|
|
2920
|
-
if (r._tag === "Reference") {
|
|
2921
|
-
if (identifierSet.has(r.$ref)) {
|
|
2922
|
-
refs.add(r.$ref);
|
|
2923
|
-
}
|
|
2924
|
-
}
|
|
2925
|
-
// Push nested Representation schemas onto the stack
|
|
2926
|
-
switch (r._tag) {
|
|
2927
|
-
case "Declaration":
|
|
2928
|
-
for (const typeParam of r.typeParameters) stack.push(typeParam);
|
|
2929
|
-
stack.push(r.encodedSchema);
|
|
2930
|
-
break;
|
|
2931
|
-
case "Suspend":
|
|
2932
|
-
stack.push(r.thunk);
|
|
2933
|
-
break;
|
|
2934
|
-
case "String":
|
|
2935
|
-
if (r.contentSchema !== undefined) stack.push(r.contentSchema);
|
|
2936
|
-
break;
|
|
2937
|
-
case "TemplateLiteral":
|
|
2938
|
-
for (const part of r.parts) stack.push(part);
|
|
2939
|
-
break;
|
|
2940
|
-
case "Arrays":
|
|
2941
|
-
for (const element of r.elements) stack.push(element.type);
|
|
2942
|
-
for (const rest of r.rest) stack.push(rest);
|
|
2943
|
-
break;
|
|
2944
|
-
case "Objects":
|
|
2945
|
-
for (const propertySignature of r.propertySignatures) stack.push(propertySignature.type);
|
|
2946
|
-
for (const indexSignature of r.indexSignatures) {
|
|
2947
|
-
stack.push(indexSignature.parameter);
|
|
2948
|
-
stack.push(indexSignature.type);
|
|
2949
|
-
}
|
|
2950
|
-
break;
|
|
2951
|
-
case "Union":
|
|
2952
|
-
for (const type of r.types) stack.push(type);
|
|
2953
|
-
break;
|
|
2954
|
-
}
|
|
2955
|
-
}
|
|
2956
|
-
return refs;
|
|
2957
|
-
};
|
|
2958
|
-
// identifier -> internal identifiers it depends on
|
|
2959
|
-
const dependencies = new Map(identifiers.map(id => [id, collectRefs(references[id])]));
|
|
2960
|
-
// Mark only nodes that are part of cycles
|
|
2961
|
-
const recursive = new Set();
|
|
2962
|
-
const state = new Map(); // 0 = new, 1 = visiting, 2 = done
|
|
2963
|
-
const stack = [];
|
|
2964
|
-
const indexInStack = new Map();
|
|
2965
|
-
const dfs = id => {
|
|
2966
|
-
const s = state.get(id) ?? 0;
|
|
2967
|
-
if (s === 1) {
|
|
2968
|
-
const start = indexInStack.get(id);
|
|
2969
|
-
if (start !== undefined) {
|
|
2970
|
-
for (let i = start; i < stack.length; i++) {
|
|
2971
|
-
recursive.add(stack[i]);
|
|
2972
|
-
}
|
|
2973
|
-
}
|
|
2974
|
-
return;
|
|
2975
|
-
}
|
|
2976
|
-
if (s === 2) return;
|
|
2977
|
-
state.set(id, 1);
|
|
2978
|
-
indexInStack.set(id, stack.length);
|
|
2979
|
-
stack.push(id);
|
|
2980
|
-
for (const dep of dependencies.get(id) ?? []) {
|
|
2981
|
-
dfs(dep);
|
|
2982
|
-
}
|
|
2983
|
-
stack.pop();
|
|
2984
|
-
indexInStack.delete(id);
|
|
2985
|
-
state.set(id, 2);
|
|
2986
|
-
};
|
|
2987
|
-
for (const id of identifiers) dfs(id);
|
|
2988
|
-
// Topologically sort the non-recursive nodes (ignoring edges to recursive nodes)
|
|
2989
|
-
const inDegree = new Map();
|
|
2990
|
-
const dependents = new Map(); // dep -> nodes that depend on it
|
|
2991
|
-
for (const id of identifiers) {
|
|
2992
|
-
if (!recursive.has(id)) {
|
|
2993
|
-
inDegree.set(id, 0);
|
|
2994
|
-
dependents.set(id, new Set());
|
|
2995
|
-
}
|
|
2996
|
-
}
|
|
2997
|
-
for (const [id, deps] of dependencies) {
|
|
2998
|
-
if (recursive.has(id)) continue;
|
|
2999
|
-
for (const dep of deps) {
|
|
3000
|
-
if (recursive.has(dep)) continue;
|
|
3001
|
-
inDegree.set(id, (inDegree.get(id) ?? 0) + 1);
|
|
3002
|
-
dependents.get(dep)?.add(id);
|
|
3003
|
-
}
|
|
3004
|
-
}
|
|
3005
|
-
const queue = [];
|
|
3006
|
-
for (const [id, deg] of inDegree) {
|
|
3007
|
-
if (deg === 0) queue.push(id);
|
|
3008
|
-
}
|
|
3009
|
-
const nonRecursives = [];
|
|
3010
|
-
for (let i = 0; i < queue.length; i++) {
|
|
3011
|
-
const $ref = queue[i];
|
|
3012
|
-
nonRecursives.push({
|
|
3013
|
-
$ref,
|
|
3014
|
-
representation: references[$ref]
|
|
3015
|
-
});
|
|
3016
|
-
for (const next of dependents.get($ref) ?? []) {
|
|
3017
|
-
const deg = (inDegree.get(next) ?? 0) - 1;
|
|
3018
|
-
inDegree.set(next, deg);
|
|
3019
|
-
if (deg === 0) queue.push(next);
|
|
3020
|
-
}
|
|
3021
|
-
}
|
|
3022
|
-
const recursives = {};
|
|
3023
|
-
for (const $ref of recursive) {
|
|
3024
|
-
recursives[$ref] = references[$ref];
|
|
3025
|
-
}
|
|
3026
|
-
return {
|
|
3027
|
-
nonRecursives,
|
|
3028
|
-
recursives
|
|
3029
|
-
};
|
|
471
|
+
return InternalFromJsonSchemaDocument.fromJsonSchemaMultiDocument(document, options);
|
|
3030
472
|
}
|
|
3031
473
|
//# sourceMappingURL=SchemaRepresentation.js.map
|