effect 4.0.0-beta.101 → 4.0.0-beta.103
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 +971 -1037
- package/dist/Array.d.ts.map +1 -1
- package/dist/Array.js +462 -412
- package/dist/Array.js.map +1 -1
- package/dist/BigDecimal.d.ts +433 -756
- package/dist/BigDecimal.d.ts.map +1 -1
- package/dist/BigDecimal.js +200 -325
- package/dist/BigDecimal.js.map +1 -1
- package/dist/BigInt.d.ts +207 -267
- package/dist/BigInt.d.ts.map +1 -1
- package/dist/BigInt.js +107 -135
- package/dist/BigInt.js.map +1 -1
- package/dist/Boolean.d.ts +146 -188
- package/dist/Boolean.d.ts.map +1 -1
- package/dist/Boolean.js +64 -84
- package/dist/Boolean.js.map +1 -1
- package/dist/Brand.js.map +1 -1
- package/dist/Cache.d.ts +405 -254
- package/dist/Cache.d.ts.map +1 -1
- package/dist/Cache.js +166 -101
- package/dist/Cache.js.map +1 -1
- package/dist/Cause.d.ts +167 -277
- package/dist/Cause.d.ts.map +1 -1
- package/dist/Cause.js +122 -176
- package/dist/Cause.js.map +1 -1
- package/dist/Channel.d.ts +729 -768
- package/dist/Channel.d.ts.map +1 -1
- package/dist/Channel.js +541 -449
- package/dist/Channel.js.map +1 -1
- package/dist/ChannelSchema.d.ts +1 -1
- package/dist/ChannelSchema.d.ts.map +1 -1
- package/dist/ChannelSchema.js.map +1 -1
- package/dist/Chunk.d.ts +834 -1173
- package/dist/Chunk.d.ts.map +1 -1
- package/dist/Chunk.js +326 -439
- package/dist/Chunk.js.map +1 -1
- package/dist/Clock.d.ts +180 -49
- package/dist/Clock.d.ts.map +1 -1
- package/dist/Clock.js +96 -31
- package/dist/Clock.js.map +1 -1
- package/dist/Combiner.d.ts +20 -33
- package/dist/Combiner.d.ts.map +1 -1
- package/dist/Combiner.js +18 -30
- package/dist/Combiner.js.map +1 -1
- package/dist/Config.d.ts +226 -174
- package/dist/Config.d.ts.map +1 -1
- package/dist/Config.js +339 -267
- package/dist/Config.js.map +1 -1
- package/dist/ConfigProvider.d.ts +194 -68
- package/dist/ConfigProvider.d.ts.map +1 -1
- package/dist/ConfigProvider.js +122 -87
- package/dist/ConfigProvider.js.map +1 -1
- package/dist/Console.d.ts +233 -33
- package/dist/Console.d.ts.map +1 -1
- package/dist/Console.js +232 -32
- package/dist/Console.js.map +1 -1
- package/dist/Context.d.ts +151 -274
- package/dist/Context.d.ts.map +1 -1
- package/dist/Context.js +171 -214
- package/dist/Context.js.map +1 -1
- package/dist/Cron.d.ts +68 -77
- package/dist/Cron.d.ts.map +1 -1
- package/dist/Cron.js +57 -66
- package/dist/Cron.js.map +1 -1
- package/dist/Crypto.d.ts +13 -15
- package/dist/Crypto.d.ts.map +1 -1
- package/dist/Crypto.js +9 -10
- package/dist/Crypto.js.map +1 -1
- package/dist/Data.d.ts +60 -80
- package/dist/Data.d.ts.map +1 -1
- package/dist/Data.js +18 -24
- package/dist/Data.js.map +1 -1
- package/dist/DateTime.d.ts +562 -660
- package/dist/DateTime.d.ts.map +1 -1
- package/dist/DateTime.js +307 -362
- package/dist/DateTime.js.map +1 -1
- package/dist/Deferred.d.ts +253 -256
- package/dist/Deferred.d.ts.map +1 -1
- package/dist/Deferred.js +104 -96
- package/dist/Deferred.js.map +1 -1
- package/dist/Duration.d.ts +216 -308
- package/dist/Duration.d.ts.map +1 -1
- package/dist/Duration.js +132 -186
- package/dist/Duration.js.map +1 -1
- package/dist/Effect.d.ts +2897 -3342
- package/dist/Effect.d.ts.map +1 -1
- package/dist/Effect.js +1383 -1580
- package/dist/Effect.js.map +1 -1
- package/dist/Effectable.js.map +1 -1
- package/dist/Encoding.d.ts +22 -40
- package/dist/Encoding.d.ts.map +1 -1
- package/dist/Encoding.js +22 -40
- package/dist/Encoding.js.map +1 -1
- package/dist/Equal.d.ts +33 -37
- package/dist/Equal.d.ts.map +1 -1
- package/dist/Equal.js +29 -21
- package/dist/Equal.js.map +1 -1
- package/dist/Equivalence.d.ts +103 -105
- package/dist/Equivalence.d.ts.map +1 -1
- package/dist/Equivalence.js +77 -79
- package/dist/Equivalence.js.map +1 -1
- package/dist/ErrorReporter.d.ts +51 -27
- package/dist/ErrorReporter.d.ts.map +1 -1
- package/dist/ErrorReporter.js +50 -26
- package/dist/ErrorReporter.js.map +1 -1
- package/dist/ExecutionPlan.d.ts +13 -55
- package/dist/ExecutionPlan.d.ts.map +1 -1
- package/dist/ExecutionPlan.js +7 -28
- package/dist/ExecutionPlan.js.map +1 -1
- package/dist/Exit.d.ts +116 -192
- package/dist/Exit.d.ts.map +1 -1
- package/dist/Exit.js +82 -130
- package/dist/Exit.js.map +1 -1
- package/dist/Fiber.d.ts +82 -146
- package/dist/Fiber.d.ts.map +1 -1
- package/dist/Fiber.js +48 -87
- package/dist/Fiber.js.map +1 -1
- package/dist/FiberHandle.d.ts +152 -105
- package/dist/FiberHandle.d.ts.map +1 -1
- package/dist/FiberHandle.js +109 -75
- package/dist/FiberHandle.js.map +1 -1
- package/dist/FiberMap.d.ts +213 -168
- package/dist/FiberMap.d.ts.map +1 -1
- package/dist/FiberMap.js +114 -89
- package/dist/FiberMap.js.map +1 -1
- package/dist/FiberSet.d.ts +123 -81
- package/dist/FiberSet.d.ts.map +1 -1
- package/dist/FiberSet.js +85 -59
- package/dist/FiberSet.js.map +1 -1
- package/dist/FileSystem.d.ts +153 -264
- package/dist/FileSystem.d.ts.map +1 -1
- package/dist/FileSystem.js +42 -147
- package/dist/FileSystem.js.map +1 -1
- package/dist/Filter.d.ts +61 -33
- package/dist/Filter.d.ts.map +1 -1
- package/dist/Filter.js +26 -15
- package/dist/Filter.js.map +1 -1
- package/dist/Formatter.d.ts +25 -33
- package/dist/Formatter.d.ts.map +1 -1
- package/dist/Formatter.js +48 -49
- package/dist/Formatter.js.map +1 -1
- package/dist/Function.d.ts +76 -145
- package/dist/Function.d.ts.map +1 -1
- package/dist/Function.js +40 -57
- package/dist/Function.js.map +1 -1
- package/dist/Graph.d.ts +360 -714
- package/dist/Graph.d.ts.map +1 -1
- package/dist/Graph.js +168 -297
- package/dist/Graph.js.map +1 -1
- package/dist/HKT.d.ts +12 -6
- package/dist/HKT.d.ts.map +1 -1
- package/dist/Hash.d.ts +47 -83
- package/dist/Hash.d.ts.map +1 -1
- package/dist/Hash.js +46 -68
- package/dist/Hash.js.map +1 -1
- package/dist/HashMap.d.ts +319 -411
- package/dist/HashMap.d.ts.map +1 -1
- package/dist/HashMap.js +122 -166
- package/dist/HashMap.js.map +1 -1
- package/dist/HashRing.d.ts.map +1 -1
- package/dist/HashRing.js +1 -0
- package/dist/HashRing.js.map +1 -1
- package/dist/HashSet.d.ts +177 -284
- package/dist/HashSet.d.ts.map +1 -1
- package/dist/HashSet.js +68 -109
- package/dist/HashSet.js.map +1 -1
- package/dist/Inspectable.d.ts +12 -12
- package/dist/Inspectable.js +8 -8
- package/dist/Inspectable.js.map +1 -1
- package/dist/Iterable.d.ts +620 -786
- package/dist/Iterable.d.ts.map +1 -1
- package/dist/Iterable.js +230 -307
- package/dist/Iterable.js.map +1 -1
- package/dist/JsonPatch.d.ts +11 -13
- package/dist/JsonPatch.d.ts.map +1 -1
- package/dist/JsonPatch.js +46 -103
- package/dist/JsonPatch.js.map +1 -1
- package/dist/JsonPointer.d.ts +8 -8
- package/dist/JsonPointer.js +8 -8
- package/dist/JsonPointer.js.map +1 -1
- package/dist/JsonSchema.d.ts +98 -44
- package/dist/JsonSchema.d.ts.map +1 -1
- package/dist/JsonSchema.js +300 -239
- package/dist/JsonSchema.js.map +1 -1
- package/dist/Latch.d.ts +23 -35
- package/dist/Latch.d.ts.map +1 -1
- package/dist/Latch.js +16 -28
- package/dist/Latch.js.map +1 -1
- package/dist/Layer.d.ts +359 -260
- package/dist/Layer.d.ts.map +1 -1
- package/dist/Layer.js +195 -175
- package/dist/Layer.js.map +1 -1
- package/dist/LayerMap.d.ts +42 -29
- package/dist/LayerMap.d.ts.map +1 -1
- package/dist/LayerMap.js +31 -21
- package/dist/LayerMap.js.map +1 -1
- package/dist/LayerRef.d.ts +6 -2
- package/dist/LayerRef.d.ts.map +1 -1
- package/dist/LayerRef.js +6 -2
- package/dist/LayerRef.js.map +1 -1
- package/dist/LogLevel.d.ts +114 -214
- package/dist/LogLevel.d.ts.map +1 -1
- package/dist/LogLevel.js +41 -76
- package/dist/LogLevel.js.map +1 -1
- package/dist/Logger.d.ts +218 -467
- package/dist/Logger.d.ts.map +1 -1
- package/dist/Logger.js +207 -452
- package/dist/Logger.js.map +1 -1
- package/dist/ManagedRuntime.d.ts +16 -5
- package/dist/ManagedRuntime.d.ts.map +1 -1
- package/dist/ManagedRuntime.js +10 -5
- package/dist/ManagedRuntime.js.map +1 -1
- package/dist/Match.d.ts +217 -252
- package/dist/Match.d.ts.map +1 -1
- package/dist/Match.js +150 -183
- package/dist/Match.js.map +1 -1
- package/dist/Metric.d.ts +442 -993
- package/dist/Metric.d.ts.map +1 -1
- package/dist/Metric.js +202 -645
- package/dist/Metric.js.map +1 -1
- package/dist/MutableHashMap.d.ts +144 -173
- package/dist/MutableHashMap.d.ts.map +1 -1
- package/dist/MutableHashMap.js +68 -79
- package/dist/MutableHashMap.js.map +1 -1
- package/dist/MutableHashSet.d.ts +84 -89
- package/dist/MutableHashSet.d.ts.map +1 -1
- package/dist/MutableHashSet.js +44 -47
- package/dist/MutableHashSet.js.map +1 -1
- package/dist/MutableList.d.ts +71 -370
- package/dist/MutableList.d.ts.map +1 -1
- package/dist/MutableList.js +59 -284
- package/dist/MutableList.js.map +1 -1
- package/dist/MutableRef.d.ts +420 -243
- package/dist/MutableRef.d.ts.map +1 -1
- package/dist/MutableRef.js +209 -120
- package/dist/MutableRef.js.map +1 -1
- package/dist/Newtype.d.ts +21 -14
- package/dist/Newtype.d.ts.map +1 -1
- package/dist/Newtype.js +15 -13
- package/dist/Newtype.js.map +1 -1
- package/dist/NonEmptyIterable.d.ts +7 -137
- package/dist/NonEmptyIterable.d.ts.map +1 -1
- package/dist/NonEmptyIterable.js +5 -93
- package/dist/NonEmptyIterable.js.map +1 -1
- package/dist/Number.d.ts +196 -233
- package/dist/Number.d.ts.map +1 -1
- package/dist/Number.js +90 -109
- package/dist/Number.js.map +1 -1
- package/dist/Optic.d.ts +97 -189
- package/dist/Optic.d.ts.map +1 -1
- package/dist/Optic.js +190 -292
- package/dist/Optic.js.map +1 -1
- package/dist/Option.d.ts +447 -812
- package/dist/Option.d.ts.map +1 -1
- package/dist/Option.js +213 -393
- package/dist/Option.js.map +1 -1
- package/dist/Order.d.ts +109 -109
- package/dist/Order.js +91 -91
- package/dist/Order.js.map +1 -1
- package/dist/Ordering.d.ts +20 -23
- package/dist/Ordering.d.ts.map +1 -1
- package/dist/Ordering.js +8 -9
- package/dist/Ordering.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/Path.d.ts +38 -41
- package/dist/Path.d.ts.map +1 -1
- package/dist/Path.js +3 -4
- package/dist/Path.js.map +1 -1
- package/dist/Pipeable.d.ts +6 -5
- package/dist/Pipeable.d.ts.map +1 -1
- package/dist/Pipeable.js +2 -2
- package/dist/Pipeable.js.map +1 -1
- package/dist/PlatformError.d.ts +4 -4
- package/dist/PlatformError.js +3 -3
- package/dist/PlatformError.js.map +1 -1
- package/dist/Pool.d.ts +4 -2
- package/dist/Pool.d.ts.map +1 -1
- package/dist/Pool.js +4 -2
- package/dist/Pool.js.map +1 -1
- package/dist/Predicate.d.ts +200 -181
- package/dist/Predicate.d.ts.map +1 -1
- package/dist/Predicate.js +100 -108
- package/dist/Predicate.js.map +1 -1
- package/dist/PrimaryKey.d.ts +7 -7
- package/dist/PrimaryKey.js +5 -5
- package/dist/PrimaryKey.js.map +1 -1
- package/dist/PubSub.d.ts +425 -494
- package/dist/PubSub.d.ts.map +1 -1
- package/dist/PubSub.js +373 -362
- package/dist/PubSub.js.map +1 -1
- package/dist/Pull.d.ts +24 -18
- package/dist/Pull.d.ts.map +1 -1
- package/dist/Pull.js +11 -9
- package/dist/Pull.js.map +1 -1
- package/dist/Queue.d.ts +200 -159
- package/dist/Queue.d.ts.map +1 -1
- package/dist/Queue.js +162 -132
- package/dist/Queue.js.map +1 -1
- package/dist/Random.d.ts +49 -74
- package/dist/Random.d.ts.map +1 -1
- package/dist/Random.js +35 -54
- package/dist/Random.js.map +1 -1
- package/dist/RcMap.d.ts +121 -63
- package/dist/RcMap.d.ts.map +1 -1
- package/dist/RcMap.js +42 -21
- package/dist/RcMap.js.map +1 -1
- package/dist/RcRef.d.ts +24 -13
- package/dist/RcRef.d.ts.map +1 -1
- package/dist/RcRef.js +15 -9
- package/dist/RcRef.js.map +1 -1
- package/dist/Record.d.ts +361 -466
- package/dist/Record.d.ts.map +1 -1
- package/dist/Record.js +163 -216
- package/dist/Record.js.map +1 -1
- package/dist/Redactable.d.ts +6 -2
- package/dist/Redactable.d.ts.map +1 -1
- package/dist/Redactable.js +7 -2
- package/dist/Redactable.js.map +1 -1
- package/dist/Redacted.d.ts +25 -25
- package/dist/Redacted.d.ts.map +1 -1
- package/dist/Redacted.js +19 -20
- package/dist/Redacted.js.map +1 -1
- package/dist/Reducer.d.ts +8 -15
- package/dist/Reducer.d.ts.map +1 -1
- package/dist/Reducer.js +6 -12
- package/dist/Reducer.js.map +1 -1
- package/dist/Ref.d.ts +95 -165
- package/dist/Ref.d.ts.map +1 -1
- package/dist/Ref.js +75 -122
- package/dist/Ref.js.map +1 -1
- package/dist/References.d.ts +102 -213
- package/dist/References.d.ts.map +1 -1
- package/dist/References.js +102 -213
- package/dist/References.js.map +1 -1
- package/dist/RegExp.d.ts +10 -14
- package/dist/RegExp.d.ts.map +1 -1
- package/dist/RegExp.js +10 -14
- package/dist/RegExp.js.map +1 -1
- package/dist/Request.d.ts +31 -21
- package/dist/Request.d.ts.map +1 -1
- package/dist/Request.js +25 -19
- package/dist/Request.js.map +1 -1
- package/dist/RequestResolver.d.ts +201 -90
- package/dist/RequestResolver.d.ts.map +1 -1
- package/dist/RequestResolver.js +87 -41
- package/dist/RequestResolver.js.map +1 -1
- package/dist/Resource.js.map +1 -1
- package/dist/Result.d.ts +302 -470
- package/dist/Result.d.ts.map +1 -1
- package/dist/Result.js +135 -218
- package/dist/Result.js.map +1 -1
- package/dist/Runtime.d.ts +50 -75
- package/dist/Runtime.d.ts.map +1 -1
- package/dist/Runtime.js +39 -60
- package/dist/Runtime.js.map +1 -1
- package/dist/Schedule.d.ts +290 -1636
- package/dist/Schedule.d.ts.map +1 -1
- package/dist/Schedule.js +162 -803
- package/dist/Schedule.js.map +1 -1
- package/dist/Scheduler.d.ts +5 -5
- package/dist/Scheduler.d.ts.map +1 -1
- package/dist/Scheduler.js +18 -6
- package/dist/Scheduler.js.map +1 -1
- package/dist/Schema.d.ts +1835 -1060
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +2708 -1050
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts +29 -52
- package/dist/SchemaAST.d.ts.map +1 -1
- package/dist/SchemaAST.js +537 -391
- package/dist/SchemaAST.js.map +1 -1
- package/dist/SchemaError.d.ts +7 -6
- package/dist/SchemaError.d.ts.map +1 -1
- package/dist/SchemaError.js +8 -7
- package/dist/SchemaError.js.map +1 -1
- package/dist/SchemaGetter.d.ts +230 -185
- package/dist/SchemaGetter.d.ts.map +1 -1
- package/dist/SchemaGetter.js +252 -209
- package/dist/SchemaGetter.js.map +1 -1
- package/dist/SchemaIssue.d.ts +62 -190
- package/dist/SchemaIssue.d.ts.map +1 -1
- package/dist/SchemaIssue.js +74 -266
- package/dist/SchemaIssue.js.map +1 -1
- package/dist/SchemaParser.d.ts +2 -2
- package/dist/SchemaParser.d.ts.map +1 -1
- package/dist/SchemaParser.js +123 -86
- package/dist/SchemaParser.js.map +1 -1
- package/dist/SchemaRepresentation.d.ts +398 -1513
- package/dist/SchemaRepresentation.d.ts.map +1 -1
- package/dist/SchemaRepresentation.js +290 -2854
- package/dist/SchemaRepresentation.js.map +1 -1
- package/dist/SchemaTransformation.d.ts +116 -76
- package/dist/SchemaTransformation.d.ts.map +1 -1
- package/dist/SchemaTransformation.js +123 -88
- package/dist/SchemaTransformation.js.map +1 -1
- package/dist/Scope.d.ts +123 -151
- package/dist/Scope.d.ts.map +1 -1
- package/dist/Scope.js +72 -92
- package/dist/Scope.js.map +1 -1
- package/dist/ScopedCache.js.map +1 -1
- package/dist/ScopedRef.d.ts +3 -3
- package/dist/ScopedRef.js +2 -2
- package/dist/ScopedRef.js.map +1 -1
- package/dist/Semaphore.d.ts +101 -13
- package/dist/Semaphore.d.ts.map +1 -1
- package/dist/Semaphore.js +78 -39
- package/dist/Semaphore.js.map +1 -1
- package/dist/Sink.d.ts +117 -107
- package/dist/Sink.d.ts.map +1 -1
- package/dist/Sink.js +107 -100
- package/dist/Sink.js.map +1 -1
- package/dist/Stdio.d.ts +1 -1
- package/dist/Stdio.js.map +1 -1
- package/dist/Stream.d.ts +2430 -2958
- package/dist/Stream.d.ts.map +1 -1
- package/dist/Stream.js +1124 -1397
- package/dist/Stream.js.map +1 -1
- package/dist/String.d.ts +262 -308
- package/dist/String.d.ts.map +1 -1
- package/dist/String.js +184 -215
- package/dist/String.js.map +1 -1
- package/dist/Struct.d.ts +109 -114
- package/dist/Struct.d.ts.map +1 -1
- package/dist/Struct.js +46 -54
- package/dist/Struct.js.map +1 -1
- package/dist/SubscriptionRef.d.ts +282 -250
- package/dist/SubscriptionRef.d.ts.map +1 -1
- package/dist/SubscriptionRef.js +104 -92
- package/dist/SubscriptionRef.js.map +1 -1
- package/dist/Symbol.d.ts +3 -3
- package/dist/Symbol.js +3 -3
- package/dist/Symbol.js.map +1 -1
- package/dist/SynchronizedRef.js.map +1 -1
- package/dist/Take.js.map +1 -1
- package/dist/Terminal.d.ts +2 -2
- package/dist/Terminal.js +1 -1
- package/dist/Terminal.js.map +1 -1
- package/dist/Tracer.d.ts +100 -54
- package/dist/Tracer.d.ts.map +1 -1
- package/dist/Tracer.js +41 -24
- package/dist/Tracer.js.map +1 -1
- package/dist/Trie.d.ts +287 -679
- package/dist/Trie.d.ts.map +1 -1
- package/dist/Trie.js +109 -251
- package/dist/Trie.js.map +1 -1
- package/dist/Tuple.d.ts +92 -127
- package/dist/Tuple.d.ts.map +1 -1
- package/dist/Tuple.js +42 -57
- package/dist/Tuple.js.map +1 -1
- package/dist/TxChunk.d.ts +201 -121
- package/dist/TxChunk.d.ts.map +1 -1
- package/dist/TxChunk.js +85 -56
- package/dist/TxChunk.js.map +1 -1
- package/dist/TxDeferred.d.ts +62 -46
- package/dist/TxDeferred.d.ts.map +1 -1
- package/dist/TxDeferred.js +30 -22
- package/dist/TxDeferred.js.map +1 -1
- package/dist/TxHashMap.d.ts +631 -779
- package/dist/TxHashMap.d.ts.map +1 -1
- package/dist/TxHashMap.js +268 -330
- package/dist/TxHashMap.js.map +1 -1
- package/dist/TxHashSet.d.ts +297 -236
- package/dist/TxHashSet.d.ts.map +1 -1
- package/dist/TxHashSet.js +130 -100
- package/dist/TxHashSet.js.map +1 -1
- package/dist/TxPriorityQueue.d.ts +126 -95
- package/dist/TxPriorityQueue.d.ts.map +1 -1
- package/dist/TxPriorityQueue.js +74 -56
- package/dist/TxPriorityQueue.js.map +1 -1
- package/dist/TxPubSub.d.ts +101 -88
- package/dist/TxPubSub.d.ts.map +1 -1
- package/dist/TxPubSub.js +87 -66
- package/dist/TxPubSub.js.map +1 -1
- package/dist/TxQueue.d.ts +200 -180
- package/dist/TxQueue.d.ts.map +1 -1
- package/dist/TxQueue.js +160 -136
- package/dist/TxQueue.js.map +1 -1
- package/dist/TxReentrantLock.d.ts +97 -66
- package/dist/TxReentrantLock.d.ts.map +1 -1
- package/dist/TxReentrantLock.js +67 -45
- package/dist/TxReentrantLock.js.map +1 -1
- package/dist/TxRef.d.ts +51 -32
- package/dist/TxRef.d.ts.map +1 -1
- package/dist/TxRef.js +23 -15
- package/dist/TxRef.js.map +1 -1
- package/dist/TxSemaphore.d.ts +129 -95
- package/dist/TxSemaphore.d.ts.map +1 -1
- package/dist/TxSemaphore.js +85 -70
- package/dist/TxSemaphore.js.map +1 -1
- package/dist/TxSubscriptionRef.d.ts +97 -70
- package/dist/TxSubscriptionRef.d.ts.map +1 -1
- package/dist/TxSubscriptionRef.js +44 -34
- package/dist/TxSubscriptionRef.js.map +1 -1
- package/dist/Types.d.ts +127 -70
- package/dist/Types.d.ts.map +1 -1
- package/dist/UndefinedOr.js.map +1 -1
- package/dist/Unify.d.ts +45 -65
- package/dist/Unify.d.ts.map +1 -1
- package/dist/Unify.js +6 -9
- package/dist/Unify.js.map +1 -1
- package/dist/Utils.d.ts +23 -16
- package/dist/Utils.d.ts.map +1 -1
- package/dist/Utils.js +3 -7
- package/dist/Utils.js.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/array.js.map +1 -1
- package/dist/internal/core.js +3 -2
- package/dist/internal/core.js.map +1 -1
- package/dist/internal/dateTime.js +4 -0
- package/dist/internal/dateTime.js.map +1 -1
- package/dist/internal/doNotation.js.map +1 -1
- package/dist/internal/effect.js +141 -61
- package/dist/internal/effect.js.map +1 -1
- package/dist/internal/equal.js.map +1 -1
- package/dist/internal/errors.js.map +1 -1
- package/dist/internal/executionPlan.js.map +1 -1
- package/dist/internal/hashMap.js.map +1 -1
- package/dist/internal/hashSet.js.map +1 -1
- package/dist/internal/layer.js.map +1 -1
- package/dist/internal/matcher.js +1 -1
- package/dist/internal/matcher.js.map +1 -1
- package/dist/internal/metric.js.map +1 -1
- package/dist/internal/option.js.map +1 -1
- package/dist/internal/persistence.d.ts +2 -0
- package/dist/internal/persistence.d.ts.map +1 -0
- package/dist/internal/persistence.js +3 -0
- package/dist/internal/persistence.js.map +1 -0
- package/dist/internal/random.js.map +1 -1
- package/dist/internal/rcRef.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/redacted.js.map +1 -1
- package/dist/internal/references.js +3 -4
- package/dist/internal/references.js.map +1 -1
- package/dist/internal/request.js.map +1 -1
- package/dist/internal/result.js.map +1 -1
- package/dist/internal/schedule.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/cause.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 +745 -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 +245 -0
- package/dist/internal/schema/fromRepresentation.js.map +1 -0
- package/dist/internal/schema/parser.d.ts +14 -0
- package/dist/internal/schema/parser.d.ts.map +1 -0
- package/dist/internal/schema/parser.js +13 -0
- package/dist/internal/schema/parser.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 +508 -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 +349 -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/internal/stream.js.map +1 -1
- package/dist/internal/tracer.js.map +1 -1
- package/dist/internal/trie.js +13 -9
- package/dist/internal/trie.js.map +1 -1
- package/dist/testing/FastCheck.d.ts +8 -7
- package/dist/testing/FastCheck.d.ts.map +1 -1
- package/dist/testing/FastCheck.js +8 -7
- package/dist/testing/FastCheck.js.map +1 -1
- package/dist/testing/TestClock.d.ts +57 -28
- package/dist/testing/TestClock.d.ts.map +1 -1
- package/dist/testing/TestClock.js +54 -19
- package/dist/testing/TestClock.js.map +1 -1
- package/dist/testing/TestConsole.d.ts +32 -31
- package/dist/testing/TestConsole.d.ts.map +1 -1
- package/dist/testing/TestConsole.js +24 -22
- package/dist/testing/TestConsole.js.map +1 -1
- package/dist/testing/TestSchema.d.ts +29 -29
- package/dist/testing/TestSchema.js +25 -25
- package/dist/testing/TestSchema.js.map +1 -1
- package/dist/testing/index.js.map +1 -1
- package/dist/unstable/ai/AiError.d.ts +121 -144
- package/dist/unstable/ai/AiError.d.ts.map +1 -1
- package/dist/unstable/ai/AiError.js +99 -121
- package/dist/unstable/ai/AiError.js.map +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.d.ts +22 -7
- package/dist/unstable/ai/AnthropicStructuredOutput.d.ts.map +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.js +87 -317
- package/dist/unstable/ai/AnthropicStructuredOutput.js.map +1 -1
- package/dist/unstable/ai/Chat.d.ts +132 -97
- package/dist/unstable/ai/Chat.d.ts.map +1 -1
- package/dist/unstable/ai/Chat.js +55 -51
- package/dist/unstable/ai/Chat.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/IdGenerator.d.ts +32 -28
- package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
- package/dist/unstable/ai/IdGenerator.js +26 -21
- package/dist/unstable/ai/IdGenerator.js.map +1 -1
- package/dist/unstable/ai/LanguageModel.d.ts +111 -68
- package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
- package/dist/unstable/ai/LanguageModel.js +123 -81
- package/dist/unstable/ai/LanguageModel.js.map +1 -1
- package/dist/unstable/ai/McpProtocol.d.ts +30 -0
- package/dist/unstable/ai/McpProtocol.d.ts.map +1 -0
- package/dist/unstable/ai/McpProtocol.js +20 -0
- package/dist/unstable/ai/McpProtocol.js.map +1 -0
- package/dist/unstable/ai/McpSchema.d.ts +316 -250
- package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
- package/dist/unstable/ai/McpSchema.js +71 -63
- package/dist/unstable/ai/McpSchema.js.map +1 -1
- package/dist/unstable/ai/McpServer.d.ts +71 -62
- package/dist/unstable/ai/McpServer.d.ts.map +1 -1
- package/dist/unstable/ai/McpServer.js +765 -245
- package/dist/unstable/ai/McpServer.js.map +1 -1
- package/dist/unstable/ai/Model.d.ts +8 -19
- package/dist/unstable/ai/Model.d.ts.map +1 -1
- package/dist/unstable/ai/Model.js +9 -20
- package/dist/unstable/ai/Model.js.map +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.d.ts +33 -11
- package/dist/unstable/ai/OpenAiStructuredOutput.d.ts.map +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.js +194 -378
- package/dist/unstable/ai/OpenAiStructuredOutput.js.map +1 -1
- package/dist/unstable/ai/Prompt.d.ts +112 -38
- package/dist/unstable/ai/Prompt.d.ts.map +1 -1
- package/dist/unstable/ai/Prompt.js +53 -17
- package/dist/unstable/ai/Prompt.js.map +1 -1
- package/dist/unstable/ai/Response.d.ts +47 -33
- package/dist/unstable/ai/Response.d.ts.map +1 -1
- package/dist/unstable/ai/Response.js +23 -18
- package/dist/unstable/ai/Response.js.map +1 -1
- package/dist/unstable/ai/ResponseIdTracker.js.map +1 -1
- package/dist/unstable/ai/Telemetry.d.ts +46 -13
- package/dist/unstable/ai/Telemetry.d.ts.map +1 -1
- package/dist/unstable/ai/Telemetry.js +18 -7
- package/dist/unstable/ai/Telemetry.js.map +1 -1
- package/dist/unstable/ai/Tokenizer.d.ts +14 -3
- package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
- package/dist/unstable/ai/Tokenizer.js +10 -2
- package/dist/unstable/ai/Tokenizer.js.map +1 -1
- package/dist/unstable/ai/Tool.d.ts +63 -44
- package/dist/unstable/ai/Tool.d.ts.map +1 -1
- package/dist/unstable/ai/Tool.js +59 -42
- package/dist/unstable/ai/Tool.js.map +1 -1
- package/dist/unstable/ai/Toolkit.d.ts +35 -9
- package/dist/unstable/ai/Toolkit.d.ts.map +1 -1
- package/dist/unstable/ai/Toolkit.js +32 -14
- package/dist/unstable/ai/Toolkit.js.map +1 -1
- package/dist/unstable/ai/index.d.ts +4 -0
- package/dist/unstable/ai/index.d.ts.map +1 -1
- package/dist/unstable/ai/index.js +4 -0
- package/dist/unstable/ai/index.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/mcpProtocol.d.ts +21 -0
- package/dist/unstable/ai/internal/mcpProtocol.d.ts.map +1 -0
- package/dist/unstable/ai/internal/mcpProtocol.js +22 -0
- package/dist/unstable/ai/internal/mcpProtocol.js.map +1 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.d.ts +2 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.d.ts.map +1 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.js +32 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.js.map +1 -0
- 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 +315 -0
- package/dist/unstable/ai/internal/structured-output.js.map +1 -0
- package/dist/unstable/cli/Argument.d.ts +273 -69
- package/dist/unstable/cli/Argument.d.ts.map +1 -1
- package/dist/unstable/cli/Argument.js +111 -33
- package/dist/unstable/cli/Argument.js.map +1 -1
- package/dist/unstable/cli/CliConfig.js.map +1 -1
- package/dist/unstable/cli/CliError.d.ts +105 -74
- package/dist/unstable/cli/CliError.d.ts.map +1 -1
- package/dist/unstable/cli/CliError.js +98 -63
- package/dist/unstable/cli/CliError.js.map +1 -1
- package/dist/unstable/cli/CliOutput.d.ts +35 -54
- package/dist/unstable/cli/CliOutput.d.ts.map +1 -1
- package/dist/unstable/cli/CliOutput.js +26 -42
- package/dist/unstable/cli/CliOutput.js.map +1 -1
- package/dist/unstable/cli/Command.d.ts +705 -107
- package/dist/unstable/cli/Command.d.ts.map +1 -1
- package/dist/unstable/cli/Command.js +252 -47
- package/dist/unstable/cli/Command.js.map +1 -1
- package/dist/unstable/cli/Completions.js.map +1 -1
- package/dist/unstable/cli/Flag.d.ts +418 -138
- package/dist/unstable/cli/Flag.d.ts.map +1 -1
- package/dist/unstable/cli/Flag.js +197 -71
- package/dist/unstable/cli/Flag.js.map +1 -1
- package/dist/unstable/cli/GlobalFlag.d.ts +1 -1
- package/dist/unstable/cli/GlobalFlag.js.map +1 -1
- package/dist/unstable/cli/HelpDoc.d.ts +12 -4
- package/dist/unstable/cli/HelpDoc.d.ts.map +1 -1
- package/dist/unstable/cli/Param.d.ts +292 -78
- package/dist/unstable/cli/Param.d.ts.map +1 -1
- package/dist/unstable/cli/Param.js +131 -49
- package/dist/unstable/cli/Param.js.map +1 -1
- package/dist/unstable/cli/Primitive.d.ts +370 -149
- package/dist/unstable/cli/Primitive.d.ts.map +1 -1
- package/dist/unstable/cli/Primitive.js +345 -137
- package/dist/unstable/cli/Primitive.js.map +1 -1
- package/dist/unstable/cli/Prompt.d.ts +23 -14
- package/dist/unstable/cli/Prompt.d.ts.map +1 -1
- package/dist/unstable/cli/Prompt.js +23 -14
- package/dist/unstable/cli/Prompt.js.map +1 -1
- package/dist/unstable/cli/index.js.map +1 -1
- package/dist/unstable/cli/internal/ansi.js.map +1 -1
- package/dist/unstable/cli/internal/auto-suggest.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/completions/bash.js.map +1 -1
- package/dist/unstable/cli/internal/completions/descriptor.js.map +1 -1
- package/dist/unstable/cli/internal/completions/fish.js.map +1 -1
- package/dist/unstable/cli/internal/completions/zsh.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/cli/internal/help.js.map +1 -1
- package/dist/unstable/cli/internal/lexer.js +17 -7
- package/dist/unstable/cli/internal/lexer.js.map +1 -1
- package/dist/unstable/cli/internal/parser.js +2 -2
- package/dist/unstable/cli/internal/parser.js.map +1 -1
- package/dist/unstable/cli/internal/wizard.js.map +1 -1
- package/dist/unstable/cluster/ClusterCron.js.map +1 -1
- package/dist/unstable/cluster/ClusterError.js.map +1 -1
- package/dist/unstable/cluster/ClusterMetrics.js.map +1 -1
- package/dist/unstable/cluster/ClusterSchema.d.ts +8 -8
- package/dist/unstable/cluster/ClusterSchema.js +8 -8
- package/dist/unstable/cluster/ClusterSchema.js.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js +6 -2
- package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
- package/dist/unstable/cluster/DeliverAt.js.map +1 -1
- package/dist/unstable/cluster/Entity.d.ts +10 -10
- package/dist/unstable/cluster/Entity.d.ts.map +1 -1
- package/dist/unstable/cluster/Entity.js +9 -9
- package/dist/unstable/cluster/Entity.js.map +1 -1
- package/dist/unstable/cluster/EntityAddress.js.map +1 -1
- package/dist/unstable/cluster/EntityId.js.map +1 -1
- package/dist/unstable/cluster/EntityProxy.d.ts +4 -2
- package/dist/unstable/cluster/EntityProxy.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxy.js +4 -2
- package/dist/unstable/cluster/EntityProxy.js.map +1 -1
- package/dist/unstable/cluster/EntityProxyServer.js.map +1 -1
- package/dist/unstable/cluster/EntityResource.d.ts +2 -2
- package/dist/unstable/cluster/EntityResource.js +2 -2
- package/dist/unstable/cluster/EntityResource.js.map +1 -1
- package/dist/unstable/cluster/EntityType.js.map +1 -1
- package/dist/unstable/cluster/Envelope.d.ts +3 -3
- package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
- package/dist/unstable/cluster/Envelope.js +5 -4
- package/dist/unstable/cluster/Envelope.js.map +1 -1
- package/dist/unstable/cluster/HttpRunner.d.ts +2 -2
- package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
- package/dist/unstable/cluster/HttpRunner.js +6 -4
- package/dist/unstable/cluster/HttpRunner.js.map +1 -1
- package/dist/unstable/cluster/K8sHttpClient.js.map +1 -1
- package/dist/unstable/cluster/MachineId.js.map +1 -1
- package/dist/unstable/cluster/Message.d.ts +9 -9
- package/dist/unstable/cluster/Message.js +6 -6
- package/dist/unstable/cluster/Message.js.map +1 -1
- package/dist/unstable/cluster/MessageStorage.d.ts +15 -15
- package/dist/unstable/cluster/MessageStorage.js +5 -5
- package/dist/unstable/cluster/MessageStorage.js.map +1 -1
- package/dist/unstable/cluster/Reply.d.ts.map +1 -1
- package/dist/unstable/cluster/Reply.js +5 -5
- 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/RunnerHealth.d.ts +1 -1
- package/dist/unstable/cluster/RunnerHealth.js +1 -1
- package/dist/unstable/cluster/RunnerHealth.js.map +1 -1
- package/dist/unstable/cluster/RunnerServer.d.ts +2 -1
- package/dist/unstable/cluster/RunnerServer.d.ts.map +1 -1
- package/dist/unstable/cluster/RunnerServer.js +16 -16
- package/dist/unstable/cluster/RunnerServer.js.map +1 -1
- package/dist/unstable/cluster/RunnerStorage.d.ts +2 -2
- package/dist/unstable/cluster/RunnerStorage.js +1 -1
- package/dist/unstable/cluster/RunnerStorage.js.map +1 -1
- package/dist/unstable/cluster/Runners.d.ts +6 -6
- package/dist/unstable/cluster/Runners.d.ts.map +1 -1
- package/dist/unstable/cluster/Runners.js +19 -10
- package/dist/unstable/cluster/Runners.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 +128 -26
- package/dist/unstable/cluster/Sharding.js.map +1 -1
- package/dist/unstable/cluster/ShardingConfig.d.ts +13 -5
- package/dist/unstable/cluster/ShardingConfig.d.ts.map +1 -1
- package/dist/unstable/cluster/ShardingConfig.js +3 -3
- package/dist/unstable/cluster/ShardingConfig.js.map +1 -1
- package/dist/unstable/cluster/ShardingRegistrationEvent.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/Singleton.js.map +1 -1
- package/dist/unstable/cluster/SingletonAddress.d.ts +1 -1
- package/dist/unstable/cluster/SingletonAddress.js +1 -1
- package/dist/unstable/cluster/SingletonAddress.js.map +1 -1
- package/dist/unstable/cluster/Snowflake.d.ts +8 -8
- package/dist/unstable/cluster/Snowflake.js +8 -8
- package/dist/unstable/cluster/Snowflake.js.map +1 -1
- package/dist/unstable/cluster/SocketRunner.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 +56 -25
- 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 +127 -65
- package/dist/unstable/cluster/SqlRunnerStorage.js.map +1 -1
- package/dist/unstable/cluster/TestRunner.js.map +1 -1
- package/dist/unstable/cluster/index.js.map +1 -1
- package/dist/unstable/cluster/internal/entityManager.js +24 -12
- package/dist/unstable/cluster/internal/entityManager.js.map +1 -1
- package/dist/unstable/cluster/internal/entityReaper.js.map +1 -1
- package/dist/unstable/cluster/internal/hash.js.map +1 -1
- package/dist/unstable/cluster/internal/interruptors.js.map +1 -1
- package/dist/unstable/cluster/internal/resourceMap.js.map +1 -1
- package/dist/unstable/cluster/internal/resourceRef.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/DevTools.js.map +1 -1
- package/dist/unstable/devtools/DevToolsClient.js.map +1 -1
- 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/devtools/DevToolsServer.js.map +1 -1
- package/dist/unstable/devtools/index.js.map +1 -1
- package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
- package/dist/unstable/encoding/Msgpack.js +6 -8
- package/dist/unstable/encoding/Msgpack.js.map +1 -1
- package/dist/unstable/encoding/Ndjson.js.map +1 -1
- package/dist/unstable/encoding/Sse.d.ts +72 -8
- package/dist/unstable/encoding/Sse.d.ts.map +1 -1
- package/dist/unstable/encoding/Sse.js +58 -8
- package/dist/unstable/encoding/Sse.js.map +1 -1
- package/dist/unstable/encoding/index.js.map +1 -1
- package/dist/unstable/eventlog/Event.d.ts +20 -20
- package/dist/unstable/eventlog/Event.js.map +1 -1
- package/dist/unstable/eventlog/EventGroup.d.ts +4 -4
- package/dist/unstable/eventlog/EventGroup.js.map +1 -1
- package/dist/unstable/eventlog/EventJournal.d.ts +16 -16
- package/dist/unstable/eventlog/EventJournal.js +14 -14
- package/dist/unstable/eventlog/EventJournal.js.map +1 -1
- package/dist/unstable/eventlog/EventLog.d.ts +3 -3
- package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLog.js +18 -14
- package/dist/unstable/eventlog/EventLog.js.map +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.d.ts +2 -2
- package/dist/unstable/eventlog/EventLogEncryption.js +2 -2
- package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
- package/dist/unstable/eventlog/EventLogMessage.d.ts +6 -6
- package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogMessage.js +9 -4
- package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
- package/dist/unstable/eventlog/EventLogRemote.d.ts +15 -15
- package/dist/unstable/eventlog/EventLogRemote.js +1 -1
- package/dist/unstable/eventlog/EventLogRemote.js.map +1 -1
- package/dist/unstable/eventlog/EventLogServer.d.ts +11 -2
- package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServer.js +45 -21
- package/dist/unstable/eventlog/EventLogServer.js.map +1 -1
- package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +4 -4
- package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServerEncrypted.js +13 -5
- package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +5 -5
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.js +14 -6
- package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.js +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.js.map +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/eventlog/index.js.map +1 -1
- package/dist/unstable/eventlog/internal/identityRootSecretDerivation.js.map +1 -1
- package/dist/unstable/http/Cookies.d.ts +2 -2
- package/dist/unstable/http/Cookies.d.ts.map +1 -1
- package/dist/unstable/http/Cookies.js +54 -40
- package/dist/unstable/http/Cookies.js.map +1 -1
- package/dist/unstable/http/Etag.d.ts +1 -1
- package/dist/unstable/http/Etag.js +1 -1
- package/dist/unstable/http/Etag.js.map +1 -1
- package/dist/unstable/http/FetchHttpClient.d.ts.map +1 -1
- package/dist/unstable/http/FetchHttpClient.js.map +1 -1
- package/dist/unstable/http/Headers.d.ts +2 -2
- package/dist/unstable/http/Headers.js +10 -10
- package/dist/unstable/http/Headers.js.map +1 -1
- package/dist/unstable/http/HttpBody.d.ts +5 -3
- package/dist/unstable/http/HttpBody.d.ts.map +1 -1
- package/dist/unstable/http/HttpBody.js +11 -5
- package/dist/unstable/http/HttpBody.js.map +1 -1
- package/dist/unstable/http/HttpClient.d.ts +51 -44
- package/dist/unstable/http/HttpClient.d.ts.map +1 -1
- package/dist/unstable/http/HttpClient.js +46 -17
- package/dist/unstable/http/HttpClient.js.map +1 -1
- package/dist/unstable/http/HttpClientError.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 +16 -0
- package/dist/unstable/http/HttpClientRequest.js.map +1 -1
- package/dist/unstable/http/HttpClientResponse.d.ts +4 -4
- package/dist/unstable/http/HttpClientResponse.js +2 -2
- package/dist/unstable/http/HttpClientResponse.js.map +1 -1
- package/dist/unstable/http/HttpEffect.d.ts +6 -6
- package/dist/unstable/http/HttpEffect.js +3 -3
- package/dist/unstable/http/HttpEffect.js.map +1 -1
- package/dist/unstable/http/HttpIncomingMessage.js.map +1 -1
- package/dist/unstable/http/HttpMethod.d.ts +6 -9
- package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
- package/dist/unstable/http/HttpMethod.js +6 -9
- package/dist/unstable/http/HttpMethod.js.map +1 -1
- package/dist/unstable/http/HttpMiddleware.d.ts +75 -9
- package/dist/unstable/http/HttpMiddleware.d.ts.map +1 -1
- package/dist/unstable/http/HttpMiddleware.js +164 -39
- package/dist/unstable/http/HttpMiddleware.js.map +1 -1
- package/dist/unstable/http/HttpPlatform.d.ts +76 -0
- package/dist/unstable/http/HttpPlatform.d.ts.map +1 -1
- package/dist/unstable/http/HttpPlatform.js +32 -0
- package/dist/unstable/http/HttpPlatform.js.map +1 -1
- package/dist/unstable/http/HttpRouter.d.ts +88 -89
- package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
- package/dist/unstable/http/HttpRouter.js +78 -79
- package/dist/unstable/http/HttpRouter.js.map +1 -1
- package/dist/unstable/http/HttpServer.d.ts +13 -13
- package/dist/unstable/http/HttpServer.js +6 -6
- package/dist/unstable/http/HttpServer.js.map +1 -1
- package/dist/unstable/http/HttpServerError.d.ts +2 -2
- package/dist/unstable/http/HttpServerError.js +2 -2
- package/dist/unstable/http/HttpServerError.js.map +1 -1
- package/dist/unstable/http/HttpServerRequest.d.ts +4 -4
- package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerRequest.js +9 -8
- package/dist/unstable/http/HttpServerRequest.js.map +1 -1
- package/dist/unstable/http/HttpServerRespondable.js.map +1 -1
- package/dist/unstable/http/HttpServerResponse.d.ts +22 -0
- package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerResponse.js +10 -0
- package/dist/unstable/http/HttpServerResponse.js.map +1 -1
- package/dist/unstable/http/HttpStaticServer.d.ts +35 -7
- package/dist/unstable/http/HttpStaticServer.d.ts.map +1 -1
- package/dist/unstable/http/HttpStaticServer.js +35 -7
- package/dist/unstable/http/HttpStaticServer.js.map +1 -1
- package/dist/unstable/http/HttpTraceContext.js.map +1 -1
- package/dist/unstable/http/Multipart.d.ts +6 -6
- package/dist/unstable/http/Multipart.d.ts.map +1 -1
- package/dist/unstable/http/Multipart.js +22 -20
- 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/Url.d.ts +33 -63
- package/dist/unstable/http/Url.d.ts.map +1 -1
- package/dist/unstable/http/Url.js +14 -28
- package/dist/unstable/http/Url.js.map +1 -1
- package/dist/unstable/http/UrlParams.d.ts +10 -18
- package/dist/unstable/http/UrlParams.d.ts.map +1 -1
- package/dist/unstable/http/UrlParams.js +26 -31
- package/dist/unstable/http/UrlParams.js.map +1 -1
- package/dist/unstable/http/index.js.map +1 -1
- package/dist/unstable/http/internal/compression.d.ts +2 -0
- package/dist/unstable/http/internal/compression.d.ts.map +1 -0
- package/dist/unstable/http/internal/compression.js +155 -0
- package/dist/unstable/http/internal/compression.js.map +1 -0
- package/dist/unstable/http/internal/preResponseHandler.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/HttpApiBuilder.d.ts +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.js +10 -11
- package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.d.ts +4 -5
- package/dist/unstable/httpapi/HttpApiClient.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.js +16 -18
- package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiEndpoint.d.ts +42 -42
- package/dist/unstable/httpapi/HttpApiEndpoint.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiError.d.ts +13 -13
- package/dist/unstable/httpapi/HttpApiError.js +13 -13
- package/dist/unstable/httpapi/HttpApiError.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.d.ts +15 -15
- package/dist/unstable/httpapi/HttpApiGroup.js +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +71 -24
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.js +57 -10
- package/dist/unstable/httpapi/HttpApiMiddleware.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.d.ts +0 -12
- package/dist/unstable/httpapi/HttpApiScalar.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSchema.d.ts +6 -6
- package/dist/unstable/httpapi/HttpApiSchema.js +4 -4
- package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiTest.js.map +1 -1
- package/dist/unstable/httpapi/OpenApi.d.ts +13 -13
- package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
- package/dist/unstable/httpapi/OpenApi.js +50 -37
- package/dist/unstable/httpapi/OpenApi.js.map +1 -1
- package/dist/unstable/httpapi/index.js.map +1 -1
- package/dist/unstable/httpapi/internal/html.js.map +1 -1
- package/dist/unstable/httpapi/internal/httpApiScalar.js.map +1 -1
- package/dist/unstable/httpapi/internal/httpApiSwagger.js.map +1 -1
- package/dist/unstable/httpapi/internal/mediaType.js.map +1 -1
- package/dist/unstable/observability/Otlp.js.map +1 -1
- package/dist/unstable/observability/OtlpExporter.d.ts +70 -1
- package/dist/unstable/observability/OtlpExporter.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpExporter.js +84 -6
- 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 +11 -4
- 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/OtlpResource.d.ts +16 -7
- package/dist/unstable/observability/OtlpResource.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpResource.js +21 -12
- package/dist/unstable/observability/OtlpResource.js.map +1 -1
- package/dist/unstable/observability/OtlpSerialization.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/observability/PrometheusMetrics.d.ts +13 -4
- package/dist/unstable/observability/PrometheusMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/PrometheusMetrics.js +10 -3
- package/dist/unstable/observability/PrometheusMetrics.js.map +1 -1
- package/dist/unstable/observability/index.js.map +1 -1
- package/dist/unstable/observability/internal/otlpEnv.js +1 -1
- package/dist/unstable/observability/internal/otlpEnv.js.map +1 -1
- package/dist/unstable/observability/internal/otlpProtobuf.js.map +1 -1
- package/dist/unstable/observability/internal/protobuf.js +3 -0
- package/dist/unstable/observability/internal/protobuf.js.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.d.ts +8 -3
- package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.js +22 -13
- package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
- package/dist/unstable/persistence/Persistable.d.ts +8 -8
- 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/PersistedCache.js.map +1 -1
- package/dist/unstable/persistence/PersistedQueue.d.ts +6 -6
- package/dist/unstable/persistence/PersistedQueue.js +6 -6
- package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
- package/dist/unstable/persistence/Persistence.d.ts +3 -3
- package/dist/unstable/persistence/Persistence.d.ts.map +1 -1
- package/dist/unstable/persistence/Persistence.js +91 -15
- package/dist/unstable/persistence/Persistence.js.map +1 -1
- package/dist/unstable/persistence/RateLimiter.d.ts +28 -17
- package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
- package/dist/unstable/persistence/RateLimiter.js +26 -15
- package/dist/unstable/persistence/RateLimiter.js.map +1 -1
- package/dist/unstable/persistence/Redis.d.ts +2 -2
- package/dist/unstable/persistence/Redis.d.ts.map +1 -1
- package/dist/unstable/persistence/Redis.js +3 -3
- package/dist/unstable/persistence/Redis.js.map +1 -1
- package/dist/unstable/persistence/index.js.map +1 -1
- package/dist/unstable/process/ChildProcess.d.ts +64 -21
- package/dist/unstable/process/ChildProcess.d.ts.map +1 -1
- package/dist/unstable/process/ChildProcess.js +14 -5
- package/dist/unstable/process/ChildProcess.js.map +1 -1
- package/dist/unstable/process/ChildProcessSpawner.d.ts +21 -10
- package/dist/unstable/process/ChildProcessSpawner.d.ts.map +1 -1
- package/dist/unstable/process/ChildProcessSpawner.js +4 -2
- package/dist/unstable/process/ChildProcessSpawner.js.map +1 -1
- package/dist/unstable/process/index.js.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.d.ts +8 -8
- package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.js +14 -13
- package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
- package/dist/unstable/reactivity/Atom.d.ts +105 -19
- package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
- package/dist/unstable/reactivity/Atom.js +44 -12
- package/dist/unstable/reactivity/Atom.js.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.d.ts +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.js +4 -1
- package/dist/unstable/reactivity/AtomHttpApi.js.map +1 -1
- package/dist/unstable/reactivity/AtomRef.js.map +1 -1
- package/dist/unstable/reactivity/AtomRegistry.js +25 -4
- package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
- package/dist/unstable/reactivity/AtomRpc.d.ts +1 -1
- package/dist/unstable/reactivity/AtomRpc.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomRpc.js +4 -1
- package/dist/unstable/reactivity/AtomRpc.js.map +1 -1
- package/dist/unstable/reactivity/Hydration.d.ts +1 -1
- package/dist/unstable/reactivity/Hydration.js +1 -1
- package/dist/unstable/reactivity/Hydration.js.map +1 -1
- package/dist/unstable/reactivity/Reactivity.js.map +1 -1
- package/dist/unstable/reactivity/index.js.map +1 -1
- package/dist/unstable/rpc/Rpc.d.ts +35 -33
- package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
- package/dist/unstable/rpc/Rpc.js +4 -2
- package/dist/unstable/rpc/Rpc.js.map +1 -1
- package/dist/unstable/rpc/RpcClient.d.ts +12 -12
- package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcClient.js +14 -12
- package/dist/unstable/rpc/RpcClient.js.map +1 -1
- package/dist/unstable/rpc/RpcClientError.js.map +1 -1
- package/dist/unstable/rpc/RpcGroup.d.ts +8 -8
- package/dist/unstable/rpc/RpcGroup.js +1 -1
- package/dist/unstable/rpc/RpcGroup.js.map +1 -1
- package/dist/unstable/rpc/RpcMessage.d.ts +31 -30
- package/dist/unstable/rpc/RpcMessage.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcMessage.js +6 -6
- package/dist/unstable/rpc/RpcMessage.js.map +1 -1
- package/dist/unstable/rpc/RpcMiddleware.d.ts +10 -10
- package/dist/unstable/rpc/RpcMiddleware.js +1 -1
- package/dist/unstable/rpc/RpcMiddleware.js.map +1 -1
- package/dist/unstable/rpc/RpcSchema.d.ts +4 -4
- package/dist/unstable/rpc/RpcSchema.js +3 -3
- package/dist/unstable/rpc/RpcSchema.js.map +1 -1
- package/dist/unstable/rpc/RpcSerialization.d.ts +58 -7
- package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcSerialization.js +175 -96
- package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
- package/dist/unstable/rpc/RpcServer.d.ts +13 -13
- package/dist/unstable/rpc/RpcServer.js +17 -13
- package/dist/unstable/rpc/RpcServer.js.map +1 -1
- package/dist/unstable/rpc/RpcTest.js.map +1 -1
- package/dist/unstable/rpc/RpcWorker.d.ts +5 -5
- package/dist/unstable/rpc/RpcWorker.js +4 -4
- package/dist/unstable/rpc/RpcWorker.js.map +1 -1
- package/dist/unstable/rpc/Utils.js.map +1 -1
- package/dist/unstable/rpc/index.js.map +1 -1
- package/dist/unstable/schema/Model.d.ts +52 -50
- package/dist/unstable/schema/Model.d.ts.map +1 -1
- package/dist/unstable/schema/Model.js +35 -33
- package/dist/unstable/schema/Model.js.map +1 -1
- package/dist/unstable/schema/VariantSchema.d.ts +6 -7
- package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
- package/dist/unstable/schema/VariantSchema.js +15 -12
- package/dist/unstable/schema/VariantSchema.js.map +1 -1
- package/dist/unstable/schema/index.js.map +1 -1
- package/dist/unstable/socket/Socket.d.ts +12 -4
- package/dist/unstable/socket/Socket.d.ts.map +1 -1
- package/dist/unstable/socket/Socket.js +10 -5
- package/dist/unstable/socket/Socket.js.map +1 -1
- package/dist/unstable/socket/SocketServer.js.map +1 -1
- package/dist/unstable/socket/index.js.map +1 -1
- package/dist/unstable/sql/Migrator.js.map +1 -1
- package/dist/unstable/sql/SqlClient.d.ts +1 -1
- package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
- package/dist/unstable/sql/SqlClient.js +2 -2
- package/dist/unstable/sql/SqlClient.js.map +1 -1
- package/dist/unstable/sql/SqlConnection.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/SqlModel.d.ts +2 -2
- package/dist/unstable/sql/SqlModel.js +2 -2
- package/dist/unstable/sql/SqlModel.js.map +1 -1
- package/dist/unstable/sql/SqlResolver.d.ts +5 -5
- package/dist/unstable/sql/SqlResolver.js +2 -2
- package/dist/unstable/sql/SqlResolver.js.map +1 -1
- package/dist/unstable/sql/SqlSchema.js.map +1 -1
- package/dist/unstable/sql/SqlStream.js.map +1 -1
- package/dist/unstable/sql/Statement.d.ts +6 -6
- package/dist/unstable/sql/Statement.d.ts.map +1 -1
- package/dist/unstable/sql/Statement.js +22 -21
- package/dist/unstable/sql/Statement.js.map +1 -1
- package/dist/unstable/sql/index.js.map +1 -1
- package/dist/unstable/workers/Transferable.d.ts +1 -1
- package/dist/unstable/workers/Transferable.js +1 -1
- package/dist/unstable/workers/Transferable.js.map +1 -1
- package/dist/unstable/workers/Worker.d.ts +2 -2
- package/dist/unstable/workers/Worker.js +2 -2
- package/dist/unstable/workers/Worker.js.map +1 -1
- package/dist/unstable/workers/WorkerError.d.ts +7 -7
- package/dist/unstable/workers/WorkerError.js +6 -6
- package/dist/unstable/workers/WorkerError.js.map +1 -1
- package/dist/unstable/workers/WorkerRunner.d.ts +1 -1
- package/dist/unstable/workers/WorkerRunner.js +1 -1
- package/dist/unstable/workers/WorkerRunner.js.map +1 -1
- package/dist/unstable/workers/index.js.map +1 -1
- package/dist/unstable/workflow/Activity.d.ts +2 -2
- package/dist/unstable/workflow/Activity.js +2 -2
- package/dist/unstable/workflow/Activity.js.map +1 -1
- package/dist/unstable/workflow/DurableClock.d.ts +1 -1
- package/dist/unstable/workflow/DurableClock.js +1 -1
- package/dist/unstable/workflow/DurableClock.js.map +1 -1
- package/dist/unstable/workflow/DurableDeferred.d.ts +10 -10
- package/dist/unstable/workflow/DurableDeferred.js +5 -5
- package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
- package/dist/unstable/workflow/DurableQueue.d.ts +22 -20
- package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableQueue.js +22 -20
- package/dist/unstable/workflow/DurableQueue.js.map +1 -1
- package/dist/unstable/workflow/Workflow.d.ts +21 -21
- package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
- package/dist/unstable/workflow/Workflow.js +13 -14
- package/dist/unstable/workflow/Workflow.js.map +1 -1
- package/dist/unstable/workflow/WorkflowEngine.d.ts +1 -1
- package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
- package/dist/unstable/workflow/WorkflowProxy.d.ts +4 -2
- package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowProxy.js +4 -2
- package/dist/unstable/workflow/WorkflowProxy.js.map +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.js.map +1 -1
- package/dist/unstable/workflow/index.js.map +1 -1
- package/dist/unstable/workflow/internal/crypto.js.map +1 -1
- package/package.json +5 -6
- package/src/Array.ts +1068 -1070
- package/src/BigDecimal.ts +433 -756
- package/src/BigInt.ts +213 -269
- package/src/Boolean.ts +146 -188
- package/src/Cache.ts +409 -255
- package/src/Cause.ts +167 -277
- package/src/Channel.ts +923 -830
- package/src/ChannelSchema.ts +1 -1
- package/src/Chunk.ts +841 -1181
- package/src/Clock.ts +181 -49
- package/src/Combiner.ts +20 -33
- package/src/Config.ts +618 -334
- package/src/ConfigProvider.ts +221 -127
- package/src/Console.ts +289 -39
- package/src/Context.ts +319 -378
- package/src/Cron.ts +68 -77
- package/src/Crypto.ts +13 -15
- package/src/Data.ts +63 -82
- package/src/DateTime.ts +564 -660
- package/src/Deferred.ts +253 -256
- package/src/Duration.ts +216 -308
- package/src/Effect.ts +2958 -3390
- package/src/Encoding.ts +22 -40
- package/src/Equal.ts +49 -39
- package/src/Equivalence.ts +103 -105
- package/src/ErrorReporter.ts +51 -27
- package/src/ExecutionPlan.ts +13 -55
- package/src/Exit.ts +116 -192
- package/src/Fiber.ts +81 -148
- package/src/FiberHandle.ts +155 -107
- package/src/FiberMap.ts +225 -174
- package/src/FiberSet.ts +124 -82
- package/src/FileSystem.ts +155 -263
- package/src/Filter.ts +61 -33
- package/src/Formatter.ts +54 -56
- package/src/Function.ts +76 -145
- package/src/Graph.ts +416 -770
- package/src/HKT.ts +12 -6
- package/src/Hash.ts +52 -83
- package/src/HashMap.ts +319 -411
- package/src/HashRing.ts +1 -0
- package/src/HashSet.ts +177 -284
- package/src/Inspectable.ts +12 -12
- package/src/Iterable.ts +622 -787
- package/src/JsonPatch.ts +60 -113
- package/src/JsonPointer.ts +8 -8
- package/src/JsonSchema.ts +405 -249
- package/src/Latch.ts +23 -35
- package/src/Layer.ts +359 -260
- package/src/LayerMap.ts +49 -29
- package/src/LayerRef.ts +6 -2
- package/src/LogLevel.ts +114 -214
- package/src/Logger.ts +347 -699
- package/src/ManagedRuntime.ts +20 -5
- package/src/Match.ts +217 -252
- package/src/Metric.ts +520 -1092
- package/src/MutableHashMap.ts +218 -255
- package/src/MutableHashSet.ts +84 -89
- package/src/MutableList.ts +73 -370
- package/src/MutableRef.ts +420 -243
- package/src/Newtype.ts +21 -14
- package/src/NonEmptyIterable.ts +7 -137
- package/src/Number.ts +196 -233
- package/src/Optic.ts +246 -385
- package/src/Option.ts +449 -813
- package/src/Order.ts +109 -109
- package/src/Ordering.ts +20 -23
- package/src/PartitionedSemaphore.ts +1 -4
- package/src/Path.ts +38 -41
- package/src/Pipeable.ts +6 -5
- package/src/PlatformError.ts +4 -4
- package/src/Pool.ts +4 -2
- package/src/Predicate.ts +200 -181
- package/src/PrimaryKey.ts +7 -7
- package/src/PubSub.ts +526 -552
- package/src/Pull.ts +24 -18
- package/src/Queue.ts +200 -159
- package/src/Random.ts +49 -74
- package/src/RcMap.ts +121 -63
- package/src/RcRef.ts +24 -13
- package/src/Record.ts +387 -487
- package/src/Redactable.ts +10 -3
- package/src/Redacted.ts +25 -25
- package/src/Reducer.ts +8 -15
- package/src/Ref.ts +221 -361
- package/src/References.ts +102 -214
- package/src/RegExp.ts +10 -14
- package/src/Request.ts +36 -28
- package/src/RequestResolver.ts +202 -91
- package/src/Result.ts +314 -485
- package/src/Runtime.ts +50 -75
- package/src/Schedule.ts +308 -1734
- package/src/Scheduler.ts +20 -7
- package/src/Schema.ts +3156 -1634
- package/src/SchemaAST.ts +676 -489
- package/src/SchemaError.ts +8 -7
- package/src/SchemaGetter.ts +277 -218
- package/src/SchemaIssue.ts +90 -276
- package/src/SchemaParser.ts +179 -116
- package/src/SchemaRepresentation.ts +698 -3417
- package/src/SchemaTransformation.ts +132 -91
- package/src/Scope.ts +123 -151
- package/src/ScopedRef.ts +4 -4
- package/src/Semaphore.ts +157 -54
- package/src/Sink.ts +128 -113
- package/src/Stdio.ts +1 -1
- package/src/Stream.ts +2665 -3142
- package/src/String.ts +275 -312
- package/src/Struct.ts +114 -118
- package/src/SubscriptionRef.ts +284 -252
- package/src/Symbol.ts +3 -3
- package/src/Terminal.ts +2 -2
- package/src/Tracer.ts +102 -55
- package/src/Trie.ts +287 -679
- package/src/Tuple.ts +92 -127
- package/src/TxChunk.ts +201 -121
- package/src/TxDeferred.ts +62 -46
- package/src/TxHashMap.ts +645 -799
- package/src/TxHashSet.ts +443 -356
- package/src/TxPriorityQueue.ts +130 -98
- package/src/TxPubSub.ts +107 -80
- package/src/TxQueue.ts +214 -183
- package/src/TxReentrantLock.ts +97 -66
- package/src/TxRef.ts +51 -32
- package/src/TxSemaphore.ts +129 -95
- package/src/TxSubscriptionRef.ts +97 -70
- package/src/Types.ts +127 -70
- package/src/Unify.ts +45 -65
- package/src/Utils.ts +23 -16
- package/src/index.ts +0 -5
- package/src/internal/core.ts +5 -4
- package/src/internal/dateTime.ts +6 -0
- package/src/internal/effect.ts +160 -79
- package/src/internal/matcher.ts +1 -1
- package/src/internal/persistence.ts +2 -0
- package/src/internal/record.ts +11 -7
- package/src/internal/references.ts +3 -7
- package/src/internal/schema/annotations.ts +44 -0
- package/src/internal/schema/fromJsonSchemaDocument.ts +959 -0
- package/src/internal/schema/fromRepresentation.ts +339 -0
- package/src/internal/schema/parser.ts +22 -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 +529 -0
- package/src/internal/schema/toRepresentation.ts +386 -0
- package/src/internal/stackTraceLimit.ts +3 -7
- package/src/internal/trie.ts +10 -11
- package/src/testing/FastCheck.ts +8 -7
- package/src/testing/TestClock.ts +73 -31
- package/src/testing/TestConsole.ts +32 -31
- package/src/testing/TestSchema.ts +29 -29
- package/src/unstable/ai/AiError.ts +100 -122
- package/src/unstable/ai/AnthropicStructuredOutput.ts +103 -334
- package/src/unstable/ai/Chat.ts +132 -97
- package/src/unstable/ai/EmbeddingModel.ts +1 -1
- package/src/unstable/ai/IdGenerator.ts +32 -28
- package/src/unstable/ai/LanguageModel.ts +137 -95
- package/src/unstable/ai/McpProtocol.ts +48 -0
- package/src/unstable/ai/McpSchema.ts +75 -65
- package/src/unstable/ai/McpServer.ts +1045 -303
- package/src/unstable/ai/Model.ts +9 -20
- package/src/unstable/ai/OpenAiStructuredOutput.ts +231 -396
- package/src/unstable/ai/Prompt.ts +145 -43
- package/src/unstable/ai/Response.ts +52 -38
- package/src/unstable/ai/Telemetry.ts +46 -13
- package/src/unstable/ai/Tokenizer.ts +14 -3
- package/src/unstable/ai/Tool.ts +81 -48
- package/src/unstable/ai/Toolkit.ts +45 -15
- package/src/unstable/ai/index.ts +5 -0
- package/src/unstable/ai/internal/codec-transformer.ts +13 -7
- package/src/unstable/ai/internal/mcpProtocol.ts +85 -0
- package/src/unstable/ai/internal/mcpProtocolRegistry.ts +70 -0
- package/src/unstable/ai/internal/structured-output.ts +453 -0
- package/src/unstable/cli/Argument.ts +273 -69
- package/src/unstable/cli/CliError.ts +116 -77
- package/src/unstable/cli/CliOutput.ts +44 -58
- package/src/unstable/cli/Command.ts +709 -111
- package/src/unstable/cli/Flag.ts +418 -138
- package/src/unstable/cli/GlobalFlag.ts +1 -1
- package/src/unstable/cli/HelpDoc.ts +12 -4
- package/src/unstable/cli/Param.ts +295 -81
- package/src/unstable/cli/Primitive.ts +371 -150
- package/src/unstable/cli/Prompt.ts +28 -14
- package/src/unstable/cli/internal/command.ts +13 -5
- package/src/unstable/cli/internal/config.ts +8 -10
- package/src/unstable/cli/internal/lexer.ts +8 -2
- package/src/unstable/cli/internal/parser.ts +2 -2
- package/src/unstable/cluster/ClusterSchema.ts +8 -8
- package/src/unstable/cluster/ClusterWorkflowEngine.ts +8 -4
- package/src/unstable/cluster/Entity.ts +16 -17
- package/src/unstable/cluster/EntityProxy.ts +4 -2
- package/src/unstable/cluster/EntityResource.ts +2 -2
- package/src/unstable/cluster/Envelope.ts +5 -4
- package/src/unstable/cluster/HttpRunner.ts +6 -4
- package/src/unstable/cluster/Message.ts +9 -9
- package/src/unstable/cluster/MessageStorage.ts +15 -15
- package/src/unstable/cluster/Reply.ts +5 -7
- package/src/unstable/cluster/Runner.ts +1 -1
- package/src/unstable/cluster/RunnerAddress.ts +1 -1
- package/src/unstable/cluster/RunnerHealth.ts +1 -1
- package/src/unstable/cluster/RunnerServer.ts +41 -8
- package/src/unstable/cluster/RunnerStorage.ts +2 -2
- package/src/unstable/cluster/Runners.ts +23 -12
- package/src/unstable/cluster/ShardId.ts +1 -1
- package/src/unstable/cluster/Sharding.ts +168 -42
- package/src/unstable/cluster/ShardingConfig.ts +8 -4
- package/src/unstable/cluster/SingleRunner.ts +4 -2
- package/src/unstable/cluster/SingletonAddress.ts +1 -1
- package/src/unstable/cluster/Snowflake.ts +8 -8
- package/src/unstable/cluster/SqlMessageStorage.ts +84 -36
- package/src/unstable/cluster/SqlRunnerStorage.ts +205 -119
- package/src/unstable/cluster/internal/entityManager.ts +42 -25
- package/src/unstable/cluster/internal/shardLock.ts +9 -0
- package/src/unstable/devtools/DevToolsSchema.ts +10 -5
- package/src/unstable/encoding/Msgpack.ts +6 -8
- package/src/unstable/encoding/Sse.ts +98 -16
- package/src/unstable/eventlog/Event.ts +20 -20
- package/src/unstable/eventlog/EventGroup.ts +4 -4
- package/src/unstable/eventlog/EventJournal.ts +16 -16
- package/src/unstable/eventlog/EventLog.ts +24 -14
- package/src/unstable/eventlog/EventLogEncryption.ts +2 -2
- package/src/unstable/eventlog/EventLogMessage.ts +12 -5
- package/src/unstable/eventlog/EventLogRemote.ts +1 -1
- package/src/unstable/eventlog/EventLogServer.ts +41 -7
- package/src/unstable/eventlog/EventLogServerEncrypted.ts +13 -5
- package/src/unstable/eventlog/EventLogServerUnencrypted.ts +14 -6
- package/src/unstable/eventlog/EventLogSessionAuth.ts +1 -1
- 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 +64 -45
- package/src/unstable/http/Etag.ts +1 -1
- package/src/unstable/http/FetchHttpClient.ts +3 -1
- package/src/unstable/http/Headers.ts +10 -10
- package/src/unstable/http/HttpBody.ts +20 -5
- package/src/unstable/http/HttpClient.ts +83 -55
- package/src/unstable/http/HttpClientRequest.ts +59 -0
- package/src/unstable/http/HttpClientResponse.ts +4 -4
- package/src/unstable/http/HttpEffect.ts +8 -8
- package/src/unstable/http/HttpMethod.ts +6 -9
- package/src/unstable/http/HttpMiddleware.ts +202 -39
- package/src/unstable/http/HttpPlatform.ts +95 -0
- package/src/unstable/http/HttpRouter.ts +102 -98
- package/src/unstable/http/HttpServer.ts +13 -13
- package/src/unstable/http/HttpServerError.ts +2 -2
- package/src/unstable/http/HttpServerRequest.ts +9 -8
- package/src/unstable/http/HttpServerResponse.ts +30 -0
- package/src/unstable/http/HttpStaticServer.ts +35 -7
- package/src/unstable/http/Multipart.ts +22 -19
- package/src/unstable/http/Template.ts +1 -1
- package/src/unstable/http/Url.ts +33 -63
- package/src/unstable/http/UrlParams.ts +27 -32
- package/src/unstable/http/internal/compression.ts +196 -0
- package/src/unstable/httpapi/HttpApi.ts +3 -3
- package/src/unstable/httpapi/HttpApiBuilder.ts +10 -9
- package/src/unstable/httpapi/HttpApiClient.ts +19 -19
- package/src/unstable/httpapi/HttpApiEndpoint.ts +42 -42
- package/src/unstable/httpapi/HttpApiError.ts +13 -13
- package/src/unstable/httpapi/HttpApiGroup.ts +16 -16
- package/src/unstable/httpapi/HttpApiMiddleware.ts +71 -24
- package/src/unstable/httpapi/HttpApiScalar.ts +0 -12
- package/src/unstable/httpapi/HttpApiSchema.ts +6 -6
- package/src/unstable/httpapi/OpenApi.ts +65 -41
- package/src/unstable/observability/OtlpExporter.ts +126 -10
- package/src/unstable/observability/OtlpLogger.ts +5 -5
- package/src/unstable/observability/OtlpMetrics.ts +12 -5
- package/src/unstable/observability/OtlpResource.ts +26 -17
- package/src/unstable/observability/OtlpTracer.ts +8 -4
- package/src/unstable/observability/PrometheusMetrics.ts +13 -4
- package/src/unstable/observability/internal/otlpEnv.ts +1 -1
- package/src/unstable/observability/internal/protobuf.ts +3 -0
- package/src/unstable/persistence/KeyValueStore.ts +72 -49
- package/src/unstable/persistence/Persistable.ts +11 -10
- package/src/unstable/persistence/PersistedQueue.ts +6 -6
- package/src/unstable/persistence/Persistence.ts +126 -19
- package/src/unstable/persistence/RateLimiter.ts +28 -17
- package/src/unstable/persistence/Redis.ts +4 -4
- package/src/unstable/process/ChildProcess.ts +64 -21
- package/src/unstable/process/ChildProcessSpawner.ts +22 -11
- package/src/unstable/reactivity/AsyncResult.ts +16 -16
- package/src/unstable/reactivity/Atom.ts +117 -22
- package/src/unstable/reactivity/AtomHttpApi.ts +5 -4
- package/src/unstable/reactivity/AtomRegistry.ts +25 -4
- package/src/unstable/reactivity/AtomRpc.ts +5 -4
- package/src/unstable/reactivity/Hydration.ts +1 -1
- package/src/unstable/rpc/Rpc.ts +35 -33
- package/src/unstable/rpc/RpcClient.ts +18 -16
- package/src/unstable/rpc/RpcGroup.ts +8 -8
- package/src/unstable/rpc/RpcMessage.ts +31 -30
- package/src/unstable/rpc/RpcMiddleware.ts +10 -10
- package/src/unstable/rpc/RpcSchema.ts +4 -4
- package/src/unstable/rpc/RpcSerialization.ts +167 -68
- package/src/unstable/rpc/RpcServer.ts +18 -15
- package/src/unstable/rpc/RpcWorker.ts +5 -5
- package/src/unstable/schema/Model.ts +52 -50
- package/src/unstable/schema/VariantSchema.ts +19 -29
- package/src/unstable/socket/Socket.ts +18 -5
- package/src/unstable/sql/SqlClient.ts +5 -6
- package/src/unstable/sql/SqlError.ts +2 -2
- package/src/unstable/sql/SqlModel.ts +2 -2
- package/src/unstable/sql/SqlResolver.ts +5 -5
- package/src/unstable/sql/Statement.ts +31 -29
- package/src/unstable/workers/Transferable.ts +1 -1
- package/src/unstable/workers/Worker.ts +2 -2
- package/src/unstable/workers/WorkerError.ts +7 -7
- package/src/unstable/workers/WorkerRunner.ts +1 -1
- package/src/unstable/workflow/Activity.ts +2 -2
- package/src/unstable/workflow/DurableClock.ts +1 -1
- package/src/unstable/workflow/DurableDeferred.ts +10 -10
- package/src/unstable/workflow/DurableQueue.ts +22 -20
- package/src/unstable/workflow/Workflow.ts +23 -23
- package/src/unstable/workflow/WorkflowEngine.ts +1 -1
- package/src/unstable/workflow/WorkflowProxy.ts +4 -2
- 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/dist/internal/version.d.ts +0 -3
- package/dist/internal/version.d.ts.map +0 -1
- package/dist/internal/version.js +0 -2
- package/dist/internal/version.js.map +0 -1
- package/src/SchemaUtils.ts +0 -51
- package/src/internal/schema/representation.ts +0 -795
- package/src/internal/version.ts +0 -2
|
@@ -2,41 +2,123 @@ import type * as JsonSchema from "./JsonSchema.ts";
|
|
|
2
2
|
import * as Schema from "./Schema.ts";
|
|
3
3
|
import * as SchemaAST from "./SchemaAST.ts";
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Open persistence identity carried by declarations and opaque checks.
|
|
6
6
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
|
|
7
|
+
* @category annotations
|
|
8
|
+
* @since 4.0.0
|
|
9
|
+
*/
|
|
10
|
+
export interface RepresentationAnnotation {
|
|
11
|
+
readonly id: string;
|
|
12
|
+
readonly payload: Schema.Json;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Open persistence identity and schema dependencies carried by opaque checks.
|
|
10
16
|
*
|
|
11
|
-
*
|
|
17
|
+
* @category annotations
|
|
18
|
+
* @since 4.0.0
|
|
19
|
+
*/
|
|
20
|
+
export interface CheckRepresentationAnnotation<S> extends RepresentationAnnotation {
|
|
21
|
+
readonly schemas?: ReadonlyArray<S> | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Input passed to JSON Schema compiler annotations.
|
|
12
25
|
*
|
|
13
|
-
*
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
26
|
+
* @since 4.0.0
|
|
27
|
+
*/
|
|
28
|
+
export declare namespace ToJsonSchema {
|
|
29
|
+
/**
|
|
30
|
+
* Input for a check compiler.
|
|
31
|
+
*
|
|
32
|
+
* @category models
|
|
33
|
+
* @since 4.0.0
|
|
34
|
+
*/
|
|
35
|
+
interface CheckInput {
|
|
36
|
+
readonly type: JsonSchema.Type | undefined;
|
|
37
|
+
readonly schemas: ReadonlyArray<JsonSchema.JsonSchema>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* JSON Schema compiler for a check.
|
|
41
|
+
*
|
|
42
|
+
* @category models
|
|
43
|
+
* @since 4.0.0
|
|
44
|
+
*/
|
|
45
|
+
type Check = (input: CheckInput) => JsonSchema.JsonSchema;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Input and output contracts for code generation annotations.
|
|
17
49
|
*
|
|
18
|
-
* @
|
|
19
|
-
|
|
50
|
+
* @since 4.0.0
|
|
51
|
+
*/
|
|
52
|
+
export declare namespace Generation {
|
|
53
|
+
/**
|
|
54
|
+
* Input for declaration code generation.
|
|
55
|
+
*
|
|
56
|
+
* @category models
|
|
57
|
+
* @since 4.0.0
|
|
58
|
+
*/
|
|
59
|
+
interface DeclarationInput {
|
|
60
|
+
readonly typeParameters: ReadonlyArray<Code>;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Output of declaration code generation.
|
|
64
|
+
*
|
|
65
|
+
* @category models
|
|
66
|
+
* @since 4.0.0
|
|
67
|
+
*/
|
|
68
|
+
interface DeclarationOutput {
|
|
69
|
+
readonly runtime: string;
|
|
70
|
+
readonly Type: string;
|
|
71
|
+
readonly importDeclarations?: ReadonlyArray<string> | undefined;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Declaration code generator.
|
|
75
|
+
*
|
|
76
|
+
* @category models
|
|
77
|
+
* @since 4.0.0
|
|
78
|
+
*/
|
|
79
|
+
type Declaration = (input: DeclarationInput) => DeclarationOutput;
|
|
80
|
+
/**
|
|
81
|
+
* Input for check code generation.
|
|
82
|
+
*
|
|
83
|
+
* @category models
|
|
84
|
+
* @since 4.0.0
|
|
85
|
+
*/
|
|
86
|
+
interface CheckInput {
|
|
87
|
+
readonly schemas: ReadonlyArray<Code>;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Output of check code generation.
|
|
91
|
+
*
|
|
92
|
+
* @category models
|
|
93
|
+
* @since 4.0.0
|
|
94
|
+
*/
|
|
95
|
+
interface CheckOutput {
|
|
96
|
+
readonly runtime: string;
|
|
97
|
+
readonly importDeclarations?: ReadonlyArray<string> | undefined;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Check code generator.
|
|
101
|
+
*
|
|
102
|
+
* @category models
|
|
103
|
+
* @since 4.0.0
|
|
104
|
+
*/
|
|
105
|
+
type Check = (input: CheckInput) => CheckOutput;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* A custom opaque declaration.
|
|
20
109
|
*
|
|
21
110
|
* @category models
|
|
22
111
|
* @since 4.0.0
|
|
23
112
|
*/
|
|
24
113
|
export interface Declaration {
|
|
25
114
|
readonly _tag: "Declaration";
|
|
115
|
+
readonly representation?: RepresentationAnnotation | undefined;
|
|
26
116
|
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
27
117
|
readonly typeParameters: ReadonlyArray<Representation>;
|
|
28
|
-
readonly checks: ReadonlyArray<Check
|
|
29
|
-
readonly encodedSchema: Representation;
|
|
118
|
+
readonly checks: ReadonlyArray<Check>;
|
|
30
119
|
}
|
|
31
120
|
/**
|
|
32
|
-
* A lazily resolved representation
|
|
33
|
-
*
|
|
34
|
-
* **Details**
|
|
35
|
-
*
|
|
36
|
-
* `thunk` points to the actual representation, possibly via a
|
|
37
|
-
* {@link Reference}. `checks` is always empty on `Suspend` nodes.
|
|
38
|
-
*
|
|
39
|
-
* @see {@link Reference}
|
|
121
|
+
* A lazily resolved representation.
|
|
40
122
|
*
|
|
41
123
|
* @category models
|
|
42
124
|
* @since 4.0.0
|
|
@@ -48,25 +130,7 @@ export interface Suspend {
|
|
|
48
130
|
readonly thunk: Representation;
|
|
49
131
|
}
|
|
50
132
|
/**
|
|
51
|
-
* A named reference
|
|
52
|
-
*
|
|
53
|
-
* **When to use**
|
|
54
|
-
*
|
|
55
|
-
* Use when a representation should point to a named definition instead of
|
|
56
|
-
* embedding the definition inline.
|
|
57
|
-
*
|
|
58
|
-
* **Details**
|
|
59
|
-
*
|
|
60
|
-
* `$ref` is the key into `Document.references` or `MultiDocument.references`.
|
|
61
|
-
* References are resolved lazily by {@link toSchema} and
|
|
62
|
-
* {@link toCodeDocument}.
|
|
63
|
-
*
|
|
64
|
-
* **Gotchas**
|
|
65
|
-
*
|
|
66
|
-
* Resolution throws at runtime if the key is not found in the references map.
|
|
67
|
-
*
|
|
68
|
-
* @see {@link References}
|
|
69
|
-
* @see {@link Document}
|
|
133
|
+
* A named reference.
|
|
70
134
|
*
|
|
71
135
|
* @category models
|
|
72
136
|
* @since 4.0.0
|
|
@@ -75,227 +139,155 @@ export interface Reference {
|
|
|
75
139
|
readonly _tag: "Reference";
|
|
76
140
|
readonly $ref: string;
|
|
77
141
|
}
|
|
142
|
+
interface Keyword<Tag extends string> {
|
|
143
|
+
readonly _tag: Tag;
|
|
144
|
+
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
145
|
+
readonly checks: ReadonlyArray<Check>;
|
|
146
|
+
}
|
|
78
147
|
/**
|
|
79
|
-
* The
|
|
148
|
+
* The null keyword representation.
|
|
80
149
|
*
|
|
81
150
|
* @category models
|
|
82
151
|
* @since 4.0.0
|
|
83
152
|
*/
|
|
84
|
-
export interface Null {
|
|
85
|
-
readonly _tag: "Null";
|
|
86
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
153
|
+
export interface Null extends Keyword<"Null"> {
|
|
87
154
|
}
|
|
88
155
|
/**
|
|
89
|
-
* The
|
|
156
|
+
* The undefined keyword representation.
|
|
90
157
|
*
|
|
91
158
|
* @category models
|
|
92
159
|
* @since 4.0.0
|
|
93
160
|
*/
|
|
94
|
-
export interface Undefined {
|
|
95
|
-
readonly _tag: "Undefined";
|
|
96
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
161
|
+
export interface Undefined extends Keyword<"Undefined"> {
|
|
97
162
|
}
|
|
98
163
|
/**
|
|
99
|
-
* The
|
|
164
|
+
* The void keyword representation.
|
|
100
165
|
*
|
|
101
166
|
* @category models
|
|
102
167
|
* @since 4.0.0
|
|
103
168
|
*/
|
|
104
|
-
export interface Void {
|
|
105
|
-
readonly _tag: "Void";
|
|
106
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
169
|
+
export interface Void extends Keyword<"Void"> {
|
|
107
170
|
}
|
|
108
171
|
/**
|
|
109
|
-
* The
|
|
172
|
+
* The never keyword representation.
|
|
110
173
|
*
|
|
111
174
|
* @category models
|
|
112
175
|
* @since 4.0.0
|
|
113
176
|
*/
|
|
114
|
-
export interface Never {
|
|
115
|
-
readonly _tag: "Never";
|
|
116
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
177
|
+
export interface Never extends Keyword<"Never"> {
|
|
117
178
|
}
|
|
118
179
|
/**
|
|
119
|
-
* The
|
|
180
|
+
* The unknown keyword representation.
|
|
120
181
|
*
|
|
121
182
|
* @category models
|
|
122
183
|
* @since 4.0.0
|
|
123
184
|
*/
|
|
124
|
-
export interface Unknown {
|
|
125
|
-
readonly _tag: "Unknown";
|
|
126
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
185
|
+
export interface Unknown extends Keyword<"Unknown"> {
|
|
127
186
|
}
|
|
128
187
|
/**
|
|
129
|
-
* The
|
|
188
|
+
* The any keyword representation.
|
|
130
189
|
*
|
|
131
190
|
* @category models
|
|
132
191
|
* @since 4.0.0
|
|
133
192
|
*/
|
|
134
|
-
export interface Any {
|
|
135
|
-
readonly _tag: "Any";
|
|
136
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
193
|
+
export interface Any extends Keyword<"Any"> {
|
|
137
194
|
}
|
|
138
195
|
/**
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* **Details**
|
|
142
|
-
*
|
|
143
|
-
* `checks` holds string-specific constraints, such as min/max length, pattern,
|
|
144
|
-
* and UUID checks. `contentMediaType` and `contentSchema` indicate that the
|
|
145
|
-
* string contains encoded data, such as `"application/json"` with a nested
|
|
146
|
-
* schema.
|
|
147
|
-
*
|
|
148
|
-
* @see {@link StringMeta}
|
|
149
|
-
* @see {@link Check}
|
|
196
|
+
* A string representation.
|
|
150
197
|
*
|
|
151
198
|
* @category models
|
|
152
199
|
* @since 4.0.0
|
|
153
200
|
*/
|
|
154
|
-
export interface String {
|
|
155
|
-
readonly _tag: "String";
|
|
156
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
157
|
-
readonly checks: ReadonlyArray<Check<StringMeta>>;
|
|
158
|
-
readonly contentMediaType?: string | undefined;
|
|
159
|
-
readonly contentSchema?: Representation | undefined;
|
|
201
|
+
export interface String extends Keyword<"String"> {
|
|
160
202
|
}
|
|
161
203
|
/**
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
* **Details**
|
|
165
|
-
*
|
|
166
|
-
* `checks` holds number-specific constraints, such as int, finite, min, max,
|
|
167
|
-
* multipleOf, and between checks.
|
|
168
|
-
*
|
|
169
|
-
* @see {@link NumberMeta}
|
|
204
|
+
* A number representation.
|
|
170
205
|
*
|
|
171
206
|
* @category models
|
|
172
207
|
* @since 4.0.0
|
|
173
208
|
*/
|
|
174
|
-
export interface Number {
|
|
175
|
-
readonly _tag: "Number";
|
|
176
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
177
|
-
readonly checks: ReadonlyArray<Check<NumberMeta>>;
|
|
209
|
+
export interface Number extends Keyword<"Number"> {
|
|
178
210
|
}
|
|
179
211
|
/**
|
|
180
|
-
*
|
|
212
|
+
* A boolean representation.
|
|
181
213
|
*
|
|
182
214
|
* @category models
|
|
183
215
|
* @since 4.0.0
|
|
184
216
|
*/
|
|
185
|
-
export interface Boolean {
|
|
186
|
-
readonly _tag: "Boolean";
|
|
187
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
217
|
+
export interface Boolean extends Keyword<"Boolean"> {
|
|
188
218
|
}
|
|
189
219
|
/**
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* @see {@link BigIntMeta}
|
|
220
|
+
* A bigint representation.
|
|
193
221
|
*
|
|
194
222
|
* @category models
|
|
195
223
|
* @since 4.0.0
|
|
196
224
|
*/
|
|
197
|
-
export interface BigInt {
|
|
198
|
-
readonly _tag: "BigInt";
|
|
199
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
200
|
-
readonly checks: ReadonlyArray<Check<BigIntMeta>>;
|
|
225
|
+
export interface BigInt extends Keyword<"BigInt"> {
|
|
201
226
|
}
|
|
202
227
|
/**
|
|
203
|
-
*
|
|
228
|
+
* A symbol representation.
|
|
204
229
|
*
|
|
205
230
|
* @category models
|
|
206
231
|
* @since 4.0.0
|
|
207
232
|
*/
|
|
208
|
-
export interface Symbol {
|
|
209
|
-
readonly _tag: "Symbol";
|
|
210
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
233
|
+
export interface Symbol extends Keyword<"Symbol"> {
|
|
211
234
|
}
|
|
212
235
|
/**
|
|
213
|
-
* A
|
|
236
|
+
* A literal representation.
|
|
237
|
+
*
|
|
238
|
+
* **Details**
|
|
239
|
+
*
|
|
240
|
+
* The live representation stores the native literal value. Persistent codecs
|
|
241
|
+
* add an explicit type discriminator when encoding it.
|
|
214
242
|
*
|
|
215
243
|
* @category models
|
|
216
244
|
* @since 4.0.0
|
|
217
245
|
*/
|
|
218
|
-
export interface Literal {
|
|
219
|
-
readonly
|
|
220
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
221
|
-
readonly literal: string | number | boolean | bigint;
|
|
246
|
+
export interface Literal extends Keyword<"Literal"> {
|
|
247
|
+
readonly literal: SchemaAST.LiteralValue;
|
|
222
248
|
}
|
|
223
249
|
/**
|
|
224
|
-
* A
|
|
250
|
+
* A unique global symbol representation.
|
|
225
251
|
*
|
|
226
252
|
* @category models
|
|
227
253
|
* @since 4.0.0
|
|
228
254
|
*/
|
|
229
|
-
export interface UniqueSymbol {
|
|
230
|
-
readonly _tag: "UniqueSymbol";
|
|
231
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
255
|
+
export interface UniqueSymbol extends Keyword<"UniqueSymbol"> {
|
|
232
256
|
readonly symbol: symbol;
|
|
233
257
|
}
|
|
234
258
|
/**
|
|
235
|
-
* The
|
|
259
|
+
* The object keyword representation.
|
|
236
260
|
*
|
|
237
261
|
* @category models
|
|
238
262
|
* @since 4.0.0
|
|
239
263
|
*/
|
|
240
|
-
export interface ObjectKeyword {
|
|
241
|
-
readonly _tag: "ObjectKeyword";
|
|
242
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
264
|
+
export interface ObjectKeyword extends Keyword<"ObjectKeyword"> {
|
|
243
265
|
}
|
|
244
266
|
/**
|
|
245
|
-
*
|
|
267
|
+
* An enum representation.
|
|
268
|
+
*
|
|
269
|
+
* **Details**
|
|
270
|
+
*
|
|
271
|
+
* Enum members are stored as native string or number values. Persistent
|
|
272
|
+
* codecs add an explicit type discriminator when encoding them.
|
|
246
273
|
*
|
|
247
274
|
* @category models
|
|
248
275
|
* @since 4.0.0
|
|
249
276
|
*/
|
|
250
|
-
export interface Enum {
|
|
251
|
-
readonly _tag: "Enum";
|
|
252
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
277
|
+
export interface Enum extends Keyword<"Enum"> {
|
|
253
278
|
readonly enums: ReadonlyArray<readonly [string, string | number]>;
|
|
254
279
|
}
|
|
255
280
|
/**
|
|
256
|
-
* A template literal
|
|
257
|
-
* numbers, etc.).
|
|
281
|
+
* A template literal representation.
|
|
258
282
|
*
|
|
259
283
|
* @category models
|
|
260
284
|
* @since 4.0.0
|
|
261
285
|
*/
|
|
262
|
-
export interface TemplateLiteral {
|
|
263
|
-
readonly _tag: "TemplateLiteral";
|
|
264
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
286
|
+
export interface TemplateLiteral extends Keyword<"TemplateLiteral"> {
|
|
265
287
|
readonly parts: ReadonlyArray<Representation>;
|
|
266
288
|
}
|
|
267
289
|
/**
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
* **Details**
|
|
271
|
-
*
|
|
272
|
-
* `elements` are the fixed positional elements, or tuple prefix, and each may
|
|
273
|
-
* be optional. `rest` contains the variadic tail types; a single-element
|
|
274
|
-
* `rest` with no `elements` produces a plain `Array<T>`. `checks` holds
|
|
275
|
-
* array-specific constraints, such as minLength, maxLength, and unique checks.
|
|
276
|
-
*
|
|
277
|
-
* @see {@link Element}
|
|
278
|
-
* @see {@link ArraysMeta}
|
|
279
|
-
*
|
|
280
|
-
* @category models
|
|
281
|
-
* @since 4.0.0
|
|
282
|
-
*/
|
|
283
|
-
export interface Arrays {
|
|
284
|
-
readonly _tag: "Arrays";
|
|
285
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
286
|
-
readonly elements: ReadonlyArray<Element>;
|
|
287
|
-
readonly rest: ReadonlyArray<Representation>;
|
|
288
|
-
readonly checks: ReadonlyArray<Check<ArraysMeta>>;
|
|
289
|
-
}
|
|
290
|
-
/**
|
|
291
|
-
* A positional element within an {@link Arrays} tuple.
|
|
292
|
-
*
|
|
293
|
-
* **Details**
|
|
294
|
-
*
|
|
295
|
-
* `isOptional` indicates whether this element can be absent. `type` is the
|
|
296
|
-
* schema representation for this element's value.
|
|
297
|
-
*
|
|
298
|
-
* @see {@link Arrays}
|
|
290
|
+
* A tuple element.
|
|
299
291
|
*
|
|
300
292
|
* @category models
|
|
301
293
|
* @since 4.0.0
|
|
@@ -306,38 +298,27 @@ export interface Element {
|
|
|
306
298
|
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
307
299
|
}
|
|
308
300
|
/**
|
|
309
|
-
* An
|
|
310
|
-
*
|
|
311
|
-
* **Details**
|
|
312
|
-
*
|
|
313
|
-
* `propertySignatures` are the explicitly named fields. `indexSignatures`
|
|
314
|
-
* define catch-all key/value types, such as `Record<string, T>`. `checks`
|
|
315
|
-
* holds object-specific constraints, such as minProperties and maxProperties.
|
|
316
|
-
*
|
|
317
|
-
* @see {@link PropertySignature}
|
|
318
|
-
* @see {@link IndexSignature}
|
|
319
|
-
* @see {@link ObjectsMeta}
|
|
301
|
+
* An array or tuple representation.
|
|
320
302
|
*
|
|
321
303
|
* @category models
|
|
322
304
|
* @since 4.0.0
|
|
323
305
|
*/
|
|
324
|
-
export interface
|
|
325
|
-
readonly
|
|
326
|
-
readonly
|
|
327
|
-
readonly propertySignatures: ReadonlyArray<PropertySignature>;
|
|
328
|
-
readonly indexSignatures: ReadonlyArray<IndexSignature>;
|
|
329
|
-
readonly checks: ReadonlyArray<Check<ObjectsMeta>>;
|
|
306
|
+
export interface Arrays extends Keyword<"Arrays"> {
|
|
307
|
+
readonly elements: ReadonlyArray<Element>;
|
|
308
|
+
readonly rest: ReadonlyArray<Representation>;
|
|
330
309
|
}
|
|
331
310
|
/**
|
|
332
|
-
* A
|
|
311
|
+
* A property signature.
|
|
333
312
|
*
|
|
334
313
|
* **Details**
|
|
335
314
|
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
* whether the property is mutable rather than readonly.
|
|
315
|
+
* The live representation stores the native property key. Persistent codecs
|
|
316
|
+
* add an explicit type discriminator when encoding it.
|
|
339
317
|
*
|
|
340
|
-
*
|
|
318
|
+
* **Gotchas**
|
|
319
|
+
*
|
|
320
|
+
* Local symbols can be represented while the schema is live, but persistent
|
|
321
|
+
* codecs reject them because they cannot be reconstructed by identity.
|
|
341
322
|
*
|
|
342
323
|
* @category models
|
|
343
324
|
* @since 4.0.0
|
|
@@ -350,15 +331,7 @@ export interface PropertySignature {
|
|
|
350
331
|
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
351
332
|
}
|
|
352
333
|
/**
|
|
353
|
-
* An index signature
|
|
354
|
-
* {@link Objects}.
|
|
355
|
-
*
|
|
356
|
-
* **Details**
|
|
357
|
-
*
|
|
358
|
-
* `parameter` is the key type representation. `type` is the value type
|
|
359
|
-
* representation.
|
|
360
|
-
*
|
|
361
|
-
* @see {@link Objects}
|
|
334
|
+
* An index signature.
|
|
362
335
|
*
|
|
363
336
|
* @category models
|
|
364
337
|
* @since 4.0.0
|
|
@@ -368,1581 +341,493 @@ export interface IndexSignature {
|
|
|
368
341
|
readonly type: Representation;
|
|
369
342
|
}
|
|
370
343
|
/**
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
* **Details**
|
|
344
|
+
* An object representation.
|
|
374
345
|
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
346
|
+
* @category models
|
|
347
|
+
* @since 4.0.0
|
|
348
|
+
*/
|
|
349
|
+
export interface Objects extends Keyword<"Objects"> {
|
|
350
|
+
readonly propertySignatures: ReadonlyArray<PropertySignature>;
|
|
351
|
+
readonly indexSignatures: ReadonlyArray<IndexSignature>;
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* A union representation.
|
|
377
355
|
*
|
|
378
356
|
* @category models
|
|
379
357
|
* @since 4.0.0
|
|
380
358
|
*/
|
|
381
|
-
export interface Union {
|
|
382
|
-
readonly _tag: "Union";
|
|
383
|
-
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
359
|
+
export interface Union extends Keyword<"Union"> {
|
|
384
360
|
readonly types: ReadonlyArray<Representation>;
|
|
385
361
|
readonly mode: "anyOf" | "oneOf";
|
|
386
362
|
}
|
|
387
363
|
/**
|
|
388
|
-
* The
|
|
389
|
-
*
|
|
390
|
-
* **Details**
|
|
391
|
-
*
|
|
392
|
-
* Each variant has a `_tag` discriminator. Switch on `_tag` to handle each
|
|
393
|
-
* shape. Most variants carry optional `annotations` and some carry `checks`
|
|
394
|
-
* for validation constraints.
|
|
395
|
-
*
|
|
396
|
-
* @see {@link Document}
|
|
397
|
-
* @see {@link fromAST}
|
|
364
|
+
* The structural schema representation.
|
|
398
365
|
*
|
|
399
366
|
* @category models
|
|
400
367
|
* @since 4.0.0
|
|
401
368
|
*/
|
|
402
369
|
export type Representation = Declaration | Reference | Suspend | Null | Undefined | Void | Never | Unknown | Any | String | Number | Boolean | BigInt | Symbol | Literal | UniqueSymbol | ObjectKeyword | Enum | TemplateLiteral | Arrays | Objects | Union;
|
|
403
370
|
/**
|
|
404
|
-
* A
|
|
405
|
-
* or a {@link FilterGroup} combining multiple checks.
|
|
406
|
-
*
|
|
407
|
-
* @see {@link Filter}
|
|
408
|
-
* @see {@link FilterGroup}
|
|
371
|
+
* A structural check.
|
|
409
372
|
*
|
|
410
373
|
* @category models
|
|
411
374
|
* @since 4.0.0
|
|
412
375
|
*/
|
|
413
|
-
export type Check
|
|
376
|
+
export type Check = Filter | FilterGroup;
|
|
414
377
|
/**
|
|
415
|
-
*
|
|
416
|
-
* (e.g. `{ _tag: "isMinLength", minLength: 3 }`).
|
|
417
|
-
*
|
|
418
|
-
* @see {@link Check}
|
|
378
|
+
* An opaque leaf check.
|
|
419
379
|
*
|
|
420
380
|
* @category models
|
|
421
381
|
* @since 4.0.0
|
|
422
382
|
*/
|
|
423
|
-
export interface Filter
|
|
383
|
+
export interface Filter {
|
|
424
384
|
readonly _tag: "Filter";
|
|
425
|
-
readonly
|
|
426
|
-
readonly
|
|
385
|
+
readonly representation?: CheckRepresentationAnnotation<Representation> | undefined;
|
|
386
|
+
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
387
|
+
readonly aborted: boolean;
|
|
427
388
|
}
|
|
428
389
|
/**
|
|
429
|
-
* A group of
|
|
430
|
-
* at least one {@link Check}.
|
|
431
|
-
*
|
|
432
|
-
* @see {@link Check}
|
|
390
|
+
* A non-empty group of checks.
|
|
433
391
|
*
|
|
434
392
|
* @category models
|
|
435
393
|
* @since 4.0.0
|
|
436
394
|
*/
|
|
437
|
-
export interface FilterGroup
|
|
395
|
+
export interface FilterGroup {
|
|
438
396
|
readonly _tag: "FilterGroup";
|
|
439
|
-
readonly
|
|
440
|
-
readonly
|
|
397
|
+
readonly representation?: CheckRepresentationAnnotation<Representation> | undefined;
|
|
398
|
+
readonly annotations?: Schema.Annotations.Annotations | undefined;
|
|
399
|
+
readonly checks: readonly [Check, ...Array<Check>];
|
|
441
400
|
}
|
|
442
401
|
/**
|
|
443
|
-
*
|
|
444
|
-
* pattern, UUID, trimmed, etc.).
|
|
445
|
-
*
|
|
446
|
-
* @see {@link String}
|
|
447
|
-
* @see {@link Check}
|
|
402
|
+
* Named representation definitions.
|
|
448
403
|
*
|
|
449
404
|
* @category models
|
|
450
405
|
* @since 4.0.0
|
|
451
406
|
*/
|
|
452
|
-
export
|
|
407
|
+
export interface References {
|
|
408
|
+
readonly [$ref: string]: Representation;
|
|
409
|
+
}
|
|
453
410
|
/**
|
|
454
|
-
*
|
|
455
|
-
* min, max, multipleOf, between).
|
|
456
|
-
*
|
|
457
|
-
* @see {@link Number}
|
|
458
|
-
* @see {@link Check}
|
|
411
|
+
* A single representation and its definitions.
|
|
459
412
|
*
|
|
460
413
|
* @category models
|
|
461
414
|
* @since 4.0.0
|
|
462
415
|
*/
|
|
463
|
-
export
|
|
416
|
+
export interface Document {
|
|
417
|
+
readonly representation: Representation;
|
|
418
|
+
readonly references: References;
|
|
419
|
+
}
|
|
464
420
|
/**
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
* @see {@link BigInt}
|
|
468
|
-
* @see {@link Check}
|
|
421
|
+
* Multiple representations sharing definitions.
|
|
469
422
|
*
|
|
470
423
|
* @category models
|
|
471
424
|
* @since 4.0.0
|
|
472
425
|
*/
|
|
473
|
-
export
|
|
426
|
+
export interface MultiDocument {
|
|
427
|
+
readonly representations: readonly [Representation, ...Array<Representation>];
|
|
428
|
+
readonly references: References;
|
|
429
|
+
}
|
|
474
430
|
/**
|
|
475
|
-
*
|
|
476
|
-
* length, unique).
|
|
477
|
-
*
|
|
478
|
-
* @see {@link Arrays}
|
|
479
|
-
* @see {@link Check}
|
|
431
|
+
* Reviver for a declaration.
|
|
480
432
|
*
|
|
481
433
|
* @category models
|
|
482
434
|
* @since 4.0.0
|
|
483
435
|
*/
|
|
484
|
-
export
|
|
436
|
+
export interface DeclarationReviver<P> {
|
|
437
|
+
readonly id: string;
|
|
438
|
+
readonly payloadSchema: Schema.Decoder<P>;
|
|
439
|
+
readonly revive: (input: {
|
|
440
|
+
readonly payload: P;
|
|
441
|
+
readonly typeParameters: ReadonlyArray<Schema.Top>;
|
|
442
|
+
readonly annotations: Schema.Annotations.Annotations | undefined;
|
|
443
|
+
}) => Schema.Top;
|
|
444
|
+
}
|
|
485
445
|
/**
|
|
486
|
-
*
|
|
487
|
-
* maxProperties, propertiesLength, propertyNames).
|
|
488
|
-
*
|
|
489
|
-
* @see {@link Objects}
|
|
490
|
-
* @see {@link Check}
|
|
446
|
+
* Reviver for a leaf check.
|
|
491
447
|
*
|
|
492
448
|
* @category models
|
|
493
449
|
* @since 4.0.0
|
|
494
450
|
*/
|
|
495
|
-
export
|
|
496
|
-
readonly
|
|
497
|
-
readonly
|
|
498
|
-
|
|
451
|
+
export interface FilterReviver<P> {
|
|
452
|
+
readonly id: string;
|
|
453
|
+
readonly payloadSchema: Schema.Decoder<P>;
|
|
454
|
+
readonly revive: (input: {
|
|
455
|
+
readonly payload: P;
|
|
456
|
+
readonly schemas: ReadonlyArray<Schema.Top>;
|
|
457
|
+
readonly annotations: Schema.Annotations.Filter | undefined;
|
|
458
|
+
}) => SchemaAST.Filter<any>;
|
|
459
|
+
}
|
|
499
460
|
/**
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
* @see {@link Declaration}
|
|
503
|
-
* @see {@link DeclarationMeta}
|
|
461
|
+
* Reviver for a check group.
|
|
504
462
|
*
|
|
505
463
|
* @category models
|
|
506
464
|
* @since 4.0.0
|
|
507
465
|
*/
|
|
508
|
-
export
|
|
466
|
+
export interface FilterGroupReviver<P> {
|
|
467
|
+
readonly id: string;
|
|
468
|
+
readonly payloadSchema: Schema.Decoder<P>;
|
|
469
|
+
readonly revive: (input: {
|
|
470
|
+
readonly payload: P;
|
|
471
|
+
readonly schemas: ReadonlyArray<Schema.Top>;
|
|
472
|
+
readonly annotations: Schema.Annotations.Filter | undefined;
|
|
473
|
+
}) => SchemaAST.FilterGroup<any>;
|
|
474
|
+
}
|
|
509
475
|
/**
|
|
510
|
-
*
|
|
511
|
-
* Used for collection types like `Set`, `Map`.
|
|
512
|
-
*
|
|
513
|
-
* @see {@link Declaration}
|
|
514
|
-
* @see {@link DeclarationMeta}
|
|
476
|
+
* A check reviver.
|
|
515
477
|
*
|
|
516
478
|
* @category models
|
|
517
479
|
* @since 4.0.0
|
|
518
480
|
*/
|
|
519
|
-
export type
|
|
481
|
+
export type CheckReviver<P> = FilterReviver<P> | FilterGroupReviver<P>;
|
|
520
482
|
/**
|
|
521
|
-
*
|
|
522
|
-
* or {@link SizeMeta}.
|
|
483
|
+
* A typed reviver.
|
|
523
484
|
*
|
|
524
485
|
* @category models
|
|
525
486
|
* @since 4.0.0
|
|
526
487
|
*/
|
|
527
|
-
export type
|
|
488
|
+
export type Reviver<P> = DeclarationReviver<P> | CheckReviver<P>;
|
|
528
489
|
/**
|
|
529
|
-
* A
|
|
530
|
-
* {@link Document} and {@link MultiDocument} for `$ref` resolution (analogous
|
|
531
|
-
* to JSON Schema `$defs`).
|
|
532
|
-
*
|
|
533
|
-
* @see {@link Reference}
|
|
534
|
-
* @see {@link Document}
|
|
490
|
+
* A reviver erased only at collection boundaries.
|
|
535
491
|
*
|
|
536
492
|
* @category models
|
|
537
493
|
* @since 4.0.0
|
|
538
494
|
*/
|
|
539
|
-
export
|
|
540
|
-
readonly [$ref: string]: Representation;
|
|
541
|
-
}
|
|
495
|
+
export type AnyReviver = Reviver<any>;
|
|
542
496
|
/**
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
* **When to use**
|
|
497
|
+
* Creates a declaration reviver while inferring its payload type from `payloadSchema`.
|
|
546
498
|
*
|
|
547
|
-
*
|
|
548
|
-
* before reconstructing a runtime Schema, converting to JSON Schema, or
|
|
549
|
-
* wrapping it as a {@link MultiDocument}.
|
|
550
|
-
*
|
|
551
|
-
* @see {@link MultiDocument}
|
|
552
|
-
* @see {@link fromAST}
|
|
553
|
-
*
|
|
554
|
-
* @category models
|
|
499
|
+
* @category constructors
|
|
555
500
|
* @since 4.0.0
|
|
556
501
|
*/
|
|
557
|
-
export
|
|
558
|
-
readonly representation: Representation;
|
|
559
|
-
readonly references: References;
|
|
560
|
-
};
|
|
502
|
+
export declare const makeDeclarationReviver: <P>(id: string, payloadSchema: Schema.Decoder<P>, revive: DeclarationReviver<P>["revive"]) => DeclarationReviver<P>;
|
|
561
503
|
/**
|
|
562
|
-
*
|
|
563
|
-
*
|
|
564
|
-
* **When to use**
|
|
504
|
+
* Creates a filter reviver while inferring its payload type from `payloadSchema`.
|
|
565
505
|
*
|
|
566
|
-
*
|
|
567
|
-
* {@link toCodeDocument} to generate TypeScript code, and
|
|
568
|
-
* {@link toJsonSchemaMultiDocument} to convert to JSON Schema.
|
|
569
|
-
*
|
|
570
|
-
* @see {@link Document}
|
|
571
|
-
* @see {@link fromASTs}
|
|
572
|
-
*
|
|
573
|
-
* @category models
|
|
506
|
+
* @category constructors
|
|
574
507
|
* @since 4.0.0
|
|
575
508
|
*/
|
|
576
|
-
export
|
|
577
|
-
readonly representations: readonly [Representation, ...Array<Representation>];
|
|
578
|
-
readonly references: References;
|
|
579
|
-
};
|
|
509
|
+
export declare const makeFilterReviver: <P>(id: string, payloadSchema: Schema.Decoder<P>, revive: FilterReviver<P>["revive"]) => FilterReviver<P>;
|
|
580
510
|
/**
|
|
581
|
-
*
|
|
511
|
+
* Creates a filter group reviver while inferring its payload type from `payloadSchema`.
|
|
582
512
|
*
|
|
583
|
-
* @category
|
|
513
|
+
* @category constructors
|
|
584
514
|
* @since 4.0.0
|
|
585
515
|
*/
|
|
586
|
-
export
|
|
516
|
+
export declare const makeFilterGroupReviver: <P>(id: string, payloadSchema: Schema.Decoder<P>, revive: FilterGroupReviver<P>["revive"]) => FilterGroupReviver<P>;
|
|
587
517
|
/**
|
|
588
|
-
*
|
|
518
|
+
* Options for importing JSON Schema Draft 2020-12 documents.
|
|
589
519
|
*
|
|
590
520
|
* **When to use**
|
|
591
521
|
*
|
|
592
|
-
* Use
|
|
593
|
-
* `number`, `boolean`, `bigint`, `symbol`, or `string`.
|
|
522
|
+
* Use when each JSON Schema node must be transformed before it is translated.
|
|
594
523
|
*
|
|
595
|
-
*
|
|
596
|
-
* @see {@link $Annotations} for the annotation codec that filters values through this codec
|
|
524
|
+
* **Gotchas**
|
|
597
525
|
*
|
|
598
|
-
*
|
|
526
|
+
* `onEnter` must return a JSON Schema object. Its result is used directly, and exceptions raised by the callback pass through unchanged.
|
|
527
|
+
*
|
|
528
|
+
* @category models
|
|
599
529
|
* @since 4.0.0
|
|
600
530
|
*/
|
|
601
|
-
export
|
|
531
|
+
export interface FromJsonSchemaOptions {
|
|
532
|
+
readonly onEnter?: ((schema: JsonSchema.JsonSchema) => JsonSchema.JsonSchema) | undefined;
|
|
533
|
+
}
|
|
602
534
|
/**
|
|
603
|
-
*
|
|
604
|
-
* filters out internal annotation keys and non-primitive values during
|
|
605
|
-
* encoding.
|
|
606
|
-
*
|
|
607
|
-
* **When to use**
|
|
535
|
+
* Runtime and TypeScript source generated for one schema.
|
|
608
536
|
*
|
|
609
|
-
*
|
|
610
|
-
* only primitive-tree metadata.
|
|
611
|
-
*
|
|
612
|
-
* **Details**
|
|
613
|
-
*
|
|
614
|
-
* Decoding is passthrough. Encoding removes internal annotation keys and values
|
|
615
|
-
* that are not accepted by `$PrimitiveTree`.
|
|
616
|
-
*
|
|
617
|
-
* @see {@link $PrimitiveTree} for the codec used to filter annotation values
|
|
618
|
-
*
|
|
619
|
-
* @category schemas
|
|
537
|
+
* @category models
|
|
620
538
|
* @since 4.0.0
|
|
621
539
|
*/
|
|
622
|
-
export
|
|
540
|
+
export interface Code {
|
|
541
|
+
readonly runtime: string;
|
|
542
|
+
readonly Type: string;
|
|
543
|
+
}
|
|
623
544
|
/**
|
|
624
|
-
*
|
|
545
|
+
* Creates generated runtime and TypeScript source strings for a schema.
|
|
625
546
|
*
|
|
626
|
-
* @category
|
|
547
|
+
* @category constructors
|
|
627
548
|
* @since 4.0.0
|
|
628
549
|
*/
|
|
629
|
-
export declare const
|
|
630
|
-
readonly _tag: Schema.tag<"Null">;
|
|
631
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
632
|
-
}>;
|
|
550
|
+
export declare const makeCode: (runtime: string, Type: string) => Code;
|
|
633
551
|
/**
|
|
634
|
-
*
|
|
552
|
+
* Auxiliary source artifact emitted while generating schema code.
|
|
635
553
|
*
|
|
636
|
-
* @category
|
|
554
|
+
* @category models
|
|
637
555
|
* @since 4.0.0
|
|
638
556
|
*/
|
|
639
|
-
export
|
|
640
|
-
readonly _tag:
|
|
641
|
-
readonly
|
|
642
|
-
|
|
557
|
+
export type Artifact = {
|
|
558
|
+
readonly _tag: "Symbol";
|
|
559
|
+
readonly identifier: string;
|
|
560
|
+
readonly code: Code;
|
|
561
|
+
} | {
|
|
562
|
+
readonly _tag: "Enum";
|
|
563
|
+
readonly identifier: string;
|
|
564
|
+
readonly code: Code;
|
|
565
|
+
} | {
|
|
566
|
+
readonly _tag: "Import";
|
|
567
|
+
readonly importDeclaration: string;
|
|
568
|
+
};
|
|
643
569
|
/**
|
|
644
|
-
*
|
|
570
|
+
* Generated schema code together with named references and auxiliary artifacts.
|
|
645
571
|
*
|
|
646
|
-
* @category
|
|
572
|
+
* @category models
|
|
647
573
|
* @since 4.0.0
|
|
648
|
-
*/
|
|
649
|
-
export
|
|
650
|
-
readonly
|
|
651
|
-
readonly
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
readonly _tag: Schema.tag<"Never">;
|
|
661
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
662
|
-
}>;
|
|
574
|
+
*/
|
|
575
|
+
export interface CodeDocument {
|
|
576
|
+
readonly codes: ReadonlyArray<Code>;
|
|
577
|
+
readonly references: {
|
|
578
|
+
readonly nonRecursives: ReadonlyArray<{
|
|
579
|
+
readonly $ref: string;
|
|
580
|
+
readonly code: Code;
|
|
581
|
+
}>;
|
|
582
|
+
readonly recursives: Readonly<Record<string, Code>>;
|
|
583
|
+
};
|
|
584
|
+
readonly artifacts: ReadonlyArray<Artifact>;
|
|
585
|
+
}
|
|
663
586
|
/**
|
|
664
|
-
*
|
|
665
|
-
*
|
|
666
|
-
* @category schemas
|
|
667
|
-
* @since 4.0.0
|
|
668
|
-
*/
|
|
669
|
-
export declare const $Unknown: Schema.Struct<{
|
|
670
|
-
readonly _tag: Schema.tag<"Unknown">;
|
|
671
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
672
|
-
}>;
|
|
673
|
-
/**
|
|
674
|
-
* Schema for the {@link Any} representation node.
|
|
675
|
-
*
|
|
676
|
-
* @category schemas
|
|
677
|
-
* @since 4.0.0
|
|
678
|
-
*/
|
|
679
|
-
export declare const $Any: Schema.Struct<{
|
|
680
|
-
readonly _tag: Schema.tag<"Any">;
|
|
681
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
682
|
-
}>;
|
|
683
|
-
/**
|
|
684
|
-
* Schema for {@link StringMeta}.
|
|
685
|
-
*
|
|
686
|
-
* @category schemas
|
|
687
|
-
* @since 4.0.0
|
|
688
|
-
*/
|
|
689
|
-
export declare const $StringMeta: Schema.Union<readonly [Schema.Struct<{
|
|
690
|
-
readonly _tag: Schema.tag<"isStringFinite">;
|
|
691
|
-
readonly regExp: Schema.RegExp;
|
|
692
|
-
}>, Schema.Struct<{
|
|
693
|
-
readonly _tag: Schema.tag<"isStringBigInt">;
|
|
694
|
-
readonly regExp: Schema.RegExp;
|
|
695
|
-
}>, Schema.Struct<{
|
|
696
|
-
readonly _tag: Schema.tag<"isStringSymbol">;
|
|
697
|
-
readonly regExp: Schema.RegExp;
|
|
698
|
-
}>, Schema.Struct<{
|
|
699
|
-
readonly _tag: Schema.tag<"isTrimmed">;
|
|
700
|
-
readonly regExp: Schema.RegExp;
|
|
701
|
-
}>, Schema.Struct<{
|
|
702
|
-
readonly _tag: Schema.tag<"isUUID">;
|
|
703
|
-
readonly regExp: Schema.RegExp;
|
|
704
|
-
readonly version: Schema.UndefinedOr<Schema.Literals<readonly [1, 2, 3, 4, 5, 6, 7, 8]>>;
|
|
705
|
-
}>, Schema.Struct<{
|
|
706
|
-
readonly _tag: Schema.tag<"isGUID">;
|
|
707
|
-
readonly regExp: Schema.RegExp;
|
|
708
|
-
}>, Schema.Struct<{
|
|
709
|
-
readonly _tag: Schema.tag<"isULID">;
|
|
710
|
-
readonly regExp: Schema.RegExp;
|
|
711
|
-
}>, Schema.Struct<{
|
|
712
|
-
readonly _tag: Schema.tag<"isBase64">;
|
|
713
|
-
readonly regExp: Schema.RegExp;
|
|
714
|
-
}>, Schema.Struct<{
|
|
715
|
-
readonly _tag: Schema.tag<"isBase64Url">;
|
|
716
|
-
readonly regExp: Schema.RegExp;
|
|
717
|
-
}>, Schema.Struct<{
|
|
718
|
-
readonly _tag: Schema.tag<"isStartsWith">;
|
|
719
|
-
readonly startsWith: Schema.String;
|
|
720
|
-
readonly regExp: Schema.RegExp;
|
|
721
|
-
}>, Schema.Struct<{
|
|
722
|
-
readonly _tag: Schema.tag<"isEndsWith">;
|
|
723
|
-
readonly endsWith: Schema.String;
|
|
724
|
-
readonly regExp: Schema.RegExp;
|
|
725
|
-
}>, Schema.Struct<{
|
|
726
|
-
readonly _tag: Schema.tag<"isIncludes">;
|
|
727
|
-
readonly includes: Schema.String;
|
|
728
|
-
readonly regExp: Schema.RegExp;
|
|
729
|
-
}>, Schema.Struct<{
|
|
730
|
-
readonly _tag: Schema.tag<"isUppercased">;
|
|
731
|
-
readonly regExp: Schema.RegExp;
|
|
732
|
-
}>, Schema.Struct<{
|
|
733
|
-
readonly _tag: Schema.tag<"isLowercased">;
|
|
734
|
-
readonly regExp: Schema.RegExp;
|
|
735
|
-
}>, Schema.Struct<{
|
|
736
|
-
readonly _tag: Schema.tag<"isCapitalized">;
|
|
737
|
-
readonly regExp: Schema.RegExp;
|
|
738
|
-
}>, Schema.Struct<{
|
|
739
|
-
readonly _tag: Schema.tag<"isUncapitalized">;
|
|
740
|
-
readonly regExp: Schema.RegExp;
|
|
741
|
-
}>, Schema.Struct<{
|
|
742
|
-
readonly _tag: Schema.tag<"isMinLength">;
|
|
743
|
-
readonly minLength: Schema.Int;
|
|
744
|
-
}>, Schema.Struct<{
|
|
745
|
-
readonly _tag: Schema.tag<"isMaxLength">;
|
|
746
|
-
readonly maxLength: Schema.Int;
|
|
747
|
-
}>, Schema.Struct<{
|
|
748
|
-
readonly _tag: Schema.tag<"isPattern">;
|
|
749
|
-
readonly regExp: Schema.RegExp;
|
|
750
|
-
}>, Schema.Struct<{
|
|
751
|
-
readonly _tag: Schema.tag<"isLengthBetween">;
|
|
752
|
-
readonly minimum: Schema.Int;
|
|
753
|
-
readonly maximum: Schema.Int;
|
|
754
|
-
}>]>;
|
|
755
|
-
/**
|
|
756
|
-
* Schema for the {@link String} representation node.
|
|
757
|
-
*
|
|
758
|
-
* @category schemas
|
|
759
|
-
* @since 4.0.0
|
|
760
|
-
*/
|
|
761
|
-
export declare const $String: Schema.Struct<{
|
|
762
|
-
readonly _tag: Schema.tag<"String">;
|
|
763
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
764
|
-
readonly checks: Schema.$Array<Schema.Codec<Check<{
|
|
765
|
-
readonly _tag: "isStringFinite";
|
|
766
|
-
readonly regExp: RegExp;
|
|
767
|
-
} | {
|
|
768
|
-
readonly _tag: "isStringBigInt";
|
|
769
|
-
readonly regExp: RegExp;
|
|
770
|
-
} | {
|
|
771
|
-
readonly _tag: "isStringSymbol";
|
|
772
|
-
readonly regExp: RegExp;
|
|
773
|
-
} | {
|
|
774
|
-
readonly _tag: "isTrimmed";
|
|
775
|
-
readonly regExp: RegExp;
|
|
776
|
-
} | {
|
|
777
|
-
readonly _tag: "isUUID";
|
|
778
|
-
readonly regExp: RegExp;
|
|
779
|
-
readonly version: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | undefined;
|
|
780
|
-
} | {
|
|
781
|
-
readonly _tag: "isGUID";
|
|
782
|
-
readonly regExp: RegExp;
|
|
783
|
-
} | {
|
|
784
|
-
readonly _tag: "isULID";
|
|
785
|
-
readonly regExp: RegExp;
|
|
786
|
-
} | {
|
|
787
|
-
readonly _tag: "isBase64";
|
|
788
|
-
readonly regExp: RegExp;
|
|
789
|
-
} | {
|
|
790
|
-
readonly _tag: "isBase64Url";
|
|
791
|
-
readonly regExp: RegExp;
|
|
792
|
-
} | {
|
|
793
|
-
readonly _tag: "isStartsWith";
|
|
794
|
-
readonly startsWith: string;
|
|
795
|
-
readonly regExp: RegExp;
|
|
796
|
-
} | {
|
|
797
|
-
readonly _tag: "isEndsWith";
|
|
798
|
-
readonly endsWith: string;
|
|
799
|
-
readonly regExp: RegExp;
|
|
800
|
-
} | {
|
|
801
|
-
readonly _tag: "isIncludes";
|
|
802
|
-
readonly includes: string;
|
|
803
|
-
readonly regExp: RegExp;
|
|
804
|
-
} | {
|
|
805
|
-
readonly _tag: "isUppercased";
|
|
806
|
-
readonly regExp: RegExp;
|
|
807
|
-
} | {
|
|
808
|
-
readonly _tag: "isLowercased";
|
|
809
|
-
readonly regExp: RegExp;
|
|
810
|
-
} | {
|
|
811
|
-
readonly _tag: "isCapitalized";
|
|
812
|
-
readonly regExp: RegExp;
|
|
813
|
-
} | {
|
|
814
|
-
readonly _tag: "isUncapitalized";
|
|
815
|
-
readonly regExp: RegExp;
|
|
816
|
-
} | {
|
|
817
|
-
readonly _tag: "isMinLength";
|
|
818
|
-
readonly minLength: number;
|
|
819
|
-
} | {
|
|
820
|
-
readonly _tag: "isMaxLength";
|
|
821
|
-
readonly maxLength: number;
|
|
822
|
-
} | {
|
|
823
|
-
readonly _tag: "isPattern";
|
|
824
|
-
readonly regExp: RegExp;
|
|
825
|
-
} | {
|
|
826
|
-
readonly _tag: "isLengthBetween";
|
|
827
|
-
readonly minimum: number;
|
|
828
|
-
readonly maximum: number;
|
|
829
|
-
}>, Check<{
|
|
830
|
-
readonly _tag: "isStringFinite";
|
|
831
|
-
readonly regExp: RegExp;
|
|
832
|
-
} | {
|
|
833
|
-
readonly _tag: "isStringBigInt";
|
|
834
|
-
readonly regExp: RegExp;
|
|
835
|
-
} | {
|
|
836
|
-
readonly _tag: "isStringSymbol";
|
|
837
|
-
readonly regExp: RegExp;
|
|
838
|
-
} | {
|
|
839
|
-
readonly _tag: "isTrimmed";
|
|
840
|
-
readonly regExp: RegExp;
|
|
841
|
-
} | {
|
|
842
|
-
readonly _tag: "isUUID";
|
|
843
|
-
readonly regExp: RegExp;
|
|
844
|
-
readonly version: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | undefined;
|
|
845
|
-
} | {
|
|
846
|
-
readonly _tag: "isGUID";
|
|
847
|
-
readonly regExp: RegExp;
|
|
848
|
-
} | {
|
|
849
|
-
readonly _tag: "isULID";
|
|
850
|
-
readonly regExp: RegExp;
|
|
851
|
-
} | {
|
|
852
|
-
readonly _tag: "isBase64";
|
|
853
|
-
readonly regExp: RegExp;
|
|
854
|
-
} | {
|
|
855
|
-
readonly _tag: "isBase64Url";
|
|
856
|
-
readonly regExp: RegExp;
|
|
857
|
-
} | {
|
|
858
|
-
readonly _tag: "isStartsWith";
|
|
859
|
-
readonly startsWith: string;
|
|
860
|
-
readonly regExp: RegExp;
|
|
861
|
-
} | {
|
|
862
|
-
readonly _tag: "isEndsWith";
|
|
863
|
-
readonly endsWith: string;
|
|
864
|
-
readonly regExp: RegExp;
|
|
865
|
-
} | {
|
|
866
|
-
readonly _tag: "isIncludes";
|
|
867
|
-
readonly includes: string;
|
|
868
|
-
readonly regExp: RegExp;
|
|
869
|
-
} | {
|
|
870
|
-
readonly _tag: "isUppercased";
|
|
871
|
-
readonly regExp: RegExp;
|
|
872
|
-
} | {
|
|
873
|
-
readonly _tag: "isLowercased";
|
|
874
|
-
readonly regExp: RegExp;
|
|
875
|
-
} | {
|
|
876
|
-
readonly _tag: "isCapitalized";
|
|
877
|
-
readonly regExp: RegExp;
|
|
878
|
-
} | {
|
|
879
|
-
readonly _tag: "isUncapitalized";
|
|
880
|
-
readonly regExp: RegExp;
|
|
881
|
-
} | {
|
|
882
|
-
readonly _tag: "isMinLength";
|
|
883
|
-
readonly minLength: number;
|
|
884
|
-
} | {
|
|
885
|
-
readonly _tag: "isMaxLength";
|
|
886
|
-
readonly maxLength: number;
|
|
887
|
-
} | {
|
|
888
|
-
readonly _tag: "isPattern";
|
|
889
|
-
readonly regExp: RegExp;
|
|
890
|
-
} | {
|
|
891
|
-
readonly _tag: "isLengthBetween";
|
|
892
|
-
readonly minimum: number;
|
|
893
|
-
readonly maximum: number;
|
|
894
|
-
}>, never, never>>;
|
|
895
|
-
readonly contentMediaType: Schema.optional<Schema.String>;
|
|
896
|
-
readonly contentSchema: Schema.optional<Schema.suspend<$Representation>>;
|
|
897
|
-
}>;
|
|
898
|
-
/**
|
|
899
|
-
* Schema for {@link NumberMeta}.
|
|
900
|
-
*
|
|
901
|
-
* @category schemas
|
|
902
|
-
* @since 4.0.0
|
|
903
|
-
*/
|
|
904
|
-
export declare const $NumberMeta: Schema.Union<readonly [Schema.Struct<{
|
|
905
|
-
readonly _tag: Schema.tag<"isInt">;
|
|
906
|
-
}>, Schema.Struct<{
|
|
907
|
-
readonly _tag: Schema.tag<"isMultipleOf">;
|
|
908
|
-
readonly divisor: Schema.Finite;
|
|
909
|
-
}>, Schema.Struct<{
|
|
910
|
-
readonly _tag: Schema.tag<"isFinite">;
|
|
911
|
-
}>, Schema.Struct<{
|
|
912
|
-
readonly _tag: Schema.tag<"isGreaterThan">;
|
|
913
|
-
readonly exclusiveMinimum: Schema.Finite;
|
|
914
|
-
}>, Schema.Struct<{
|
|
915
|
-
readonly _tag: Schema.tag<"isGreaterThanOrEqualTo">;
|
|
916
|
-
readonly minimum: Schema.Finite;
|
|
917
|
-
}>, Schema.Struct<{
|
|
918
|
-
readonly _tag: Schema.tag<"isLessThan">;
|
|
919
|
-
readonly exclusiveMaximum: Schema.Finite;
|
|
920
|
-
}>, Schema.Struct<{
|
|
921
|
-
readonly _tag: Schema.tag<"isLessThanOrEqualTo">;
|
|
922
|
-
readonly maximum: Schema.Finite;
|
|
923
|
-
}>, Schema.Struct<{
|
|
924
|
-
readonly _tag: Schema.tag<"isBetween">;
|
|
925
|
-
readonly minimum: Schema.Finite;
|
|
926
|
-
readonly maximum: Schema.Finite;
|
|
927
|
-
readonly exclusiveMinimum: Schema.optional<Schema.Boolean>;
|
|
928
|
-
readonly exclusiveMaximum: Schema.optional<Schema.Boolean>;
|
|
929
|
-
}>]>;
|
|
930
|
-
/**
|
|
931
|
-
* Schema for the {@link Number} representation node.
|
|
932
|
-
*
|
|
933
|
-
* @category schemas
|
|
934
|
-
* @since 4.0.0
|
|
935
|
-
*/
|
|
936
|
-
export declare const $Number: Schema.Struct<{
|
|
937
|
-
readonly _tag: Schema.tag<"Number">;
|
|
938
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
939
|
-
readonly checks: Schema.$Array<Schema.Codec<Check<{
|
|
940
|
-
readonly _tag: "isInt";
|
|
941
|
-
} | {
|
|
942
|
-
readonly _tag: "isMultipleOf";
|
|
943
|
-
readonly divisor: number;
|
|
944
|
-
} | {
|
|
945
|
-
readonly _tag: "isFinite";
|
|
946
|
-
} | {
|
|
947
|
-
readonly _tag: "isGreaterThan";
|
|
948
|
-
readonly exclusiveMinimum: number;
|
|
949
|
-
} | {
|
|
950
|
-
readonly _tag: "isGreaterThanOrEqualTo";
|
|
951
|
-
readonly minimum: number;
|
|
952
|
-
} | {
|
|
953
|
-
readonly _tag: "isLessThan";
|
|
954
|
-
readonly exclusiveMaximum: number;
|
|
955
|
-
} | {
|
|
956
|
-
readonly _tag: "isLessThanOrEqualTo";
|
|
957
|
-
readonly maximum: number;
|
|
958
|
-
} | {
|
|
959
|
-
readonly _tag: "isBetween";
|
|
960
|
-
readonly minimum: number;
|
|
961
|
-
readonly maximum: number;
|
|
962
|
-
readonly exclusiveMinimum?: boolean | undefined;
|
|
963
|
-
readonly exclusiveMaximum?: boolean | undefined;
|
|
964
|
-
}>, Check<{
|
|
965
|
-
readonly _tag: "isInt";
|
|
966
|
-
} | {
|
|
967
|
-
readonly _tag: "isMultipleOf";
|
|
968
|
-
readonly divisor: number;
|
|
969
|
-
} | {
|
|
970
|
-
readonly _tag: "isFinite";
|
|
971
|
-
} | {
|
|
972
|
-
readonly _tag: "isGreaterThan";
|
|
973
|
-
readonly exclusiveMinimum: number;
|
|
974
|
-
} | {
|
|
975
|
-
readonly _tag: "isGreaterThanOrEqualTo";
|
|
976
|
-
readonly minimum: number;
|
|
977
|
-
} | {
|
|
978
|
-
readonly _tag: "isLessThan";
|
|
979
|
-
readonly exclusiveMaximum: number;
|
|
980
|
-
} | {
|
|
981
|
-
readonly _tag: "isLessThanOrEqualTo";
|
|
982
|
-
readonly maximum: number;
|
|
983
|
-
} | {
|
|
984
|
-
readonly _tag: "isBetween";
|
|
985
|
-
readonly minimum: number;
|
|
986
|
-
readonly maximum: number;
|
|
987
|
-
readonly exclusiveMinimum?: boolean | undefined;
|
|
988
|
-
readonly exclusiveMaximum?: boolean | undefined;
|
|
989
|
-
}>, never, never>>;
|
|
990
|
-
}>;
|
|
991
|
-
/**
|
|
992
|
-
* Schema for the {@link Boolean} representation node.
|
|
993
|
-
*
|
|
994
|
-
* @category schemas
|
|
995
|
-
* @since 4.0.0
|
|
996
|
-
*/
|
|
997
|
-
export declare const $Boolean: Schema.Struct<{
|
|
998
|
-
readonly _tag: Schema.tag<"Boolean">;
|
|
999
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1000
|
-
}>;
|
|
1001
|
-
/**
|
|
1002
|
-
* Schema for the {@link BigInt} representation node.
|
|
1003
|
-
*
|
|
1004
|
-
* **When to use**
|
|
1005
|
-
*
|
|
1006
|
-
* Use to encode, decode, or validate serialized `BigInt` representation nodes,
|
|
1007
|
-
* not application `bigint` values.
|
|
587
|
+
* Lowers the encoded side of an AST to a live representation document.
|
|
1008
588
|
*
|
|
1009
589
|
* **Details**
|
|
1010
590
|
*
|
|
1011
|
-
*
|
|
1012
|
-
* and bigint-specific validation metadata in `checks`.
|
|
591
|
+
* Apply `SchemaAST.toType` to the AST first to lower its type side instead.
|
|
1013
592
|
*
|
|
1014
|
-
* @
|
|
1015
|
-
*
|
|
1016
|
-
* @category schemas
|
|
1017
|
-
* @since 4.0.0
|
|
1018
|
-
*/
|
|
1019
|
-
export declare const $BigInt: Schema.Struct<{
|
|
1020
|
-
readonly _tag: Schema.tag<"BigInt">;
|
|
1021
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1022
|
-
readonly checks: Schema.$Array<Schema.Codec<Check<{
|
|
1023
|
-
readonly _tag: "isGreaterThanBigInt";
|
|
1024
|
-
readonly exclusiveMinimum: bigint;
|
|
1025
|
-
} | {
|
|
1026
|
-
readonly _tag: "isGreaterThanOrEqualToBigInt";
|
|
1027
|
-
readonly minimum: bigint;
|
|
1028
|
-
} | {
|
|
1029
|
-
readonly _tag: "isLessThanBigInt";
|
|
1030
|
-
readonly exclusiveMaximum: bigint;
|
|
1031
|
-
} | {
|
|
1032
|
-
readonly _tag: "isLessThanOrEqualToBigInt";
|
|
1033
|
-
readonly maximum: bigint;
|
|
1034
|
-
} | {
|
|
1035
|
-
readonly _tag: "isBetweenBigInt";
|
|
1036
|
-
readonly minimum: bigint;
|
|
1037
|
-
readonly maximum: bigint;
|
|
1038
|
-
readonly exclusiveMinimum?: boolean | undefined;
|
|
1039
|
-
readonly exclusiveMaximum?: boolean | undefined;
|
|
1040
|
-
}>, Check<{
|
|
1041
|
-
readonly _tag: "isGreaterThanBigInt";
|
|
1042
|
-
readonly exclusiveMinimum: bigint;
|
|
1043
|
-
} | {
|
|
1044
|
-
readonly _tag: "isGreaterThanOrEqualToBigInt";
|
|
1045
|
-
readonly minimum: bigint;
|
|
1046
|
-
} | {
|
|
1047
|
-
readonly _tag: "isLessThanBigInt";
|
|
1048
|
-
readonly exclusiveMaximum: bigint;
|
|
1049
|
-
} | {
|
|
1050
|
-
readonly _tag: "isLessThanOrEqualToBigInt";
|
|
1051
|
-
readonly maximum: bigint;
|
|
1052
|
-
} | {
|
|
1053
|
-
readonly _tag: "isBetweenBigInt";
|
|
1054
|
-
readonly minimum: bigint;
|
|
1055
|
-
readonly maximum: bigint;
|
|
1056
|
-
readonly exclusiveMinimum?: boolean | undefined;
|
|
1057
|
-
readonly exclusiveMaximum?: boolean | undefined;
|
|
1058
|
-
}>, never, never>>;
|
|
1059
|
-
}>;
|
|
1060
|
-
/**
|
|
1061
|
-
* Schema for the {@link Symbol} representation node.
|
|
1062
|
-
*
|
|
1063
|
-
* @category schemas
|
|
1064
|
-
* @since 4.0.0
|
|
1065
|
-
*/
|
|
1066
|
-
export declare const $Symbol: Schema.Struct<{
|
|
1067
|
-
readonly _tag: Schema.tag<"Symbol">;
|
|
1068
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1069
|
-
}>;
|
|
1070
|
-
/**
|
|
1071
|
-
* Schema for the literal value types allowed in a {@link Literal} node
|
|
1072
|
-
* (string, finite number, boolean, or bigint).
|
|
1073
|
-
*
|
|
1074
|
-
* @category schemas
|
|
593
|
+
* @category constructors
|
|
1075
594
|
* @since 4.0.0
|
|
1076
595
|
*/
|
|
1077
|
-
export declare
|
|
1078
|
-
/**
|
|
1079
|
-
* Schema for the {@link Literal} representation node.
|
|
1080
|
-
*
|
|
1081
|
-
* @category schemas
|
|
1082
|
-
* @since 4.0.0
|
|
1083
|
-
*/
|
|
1084
|
-
export declare const $Literal: Schema.Struct<{
|
|
1085
|
-
readonly _tag: Schema.tag<"Literal">;
|
|
1086
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1087
|
-
readonly literal: Schema.Union<readonly [Schema.String, Schema.Finite, Schema.Boolean, Schema.BigInt]>;
|
|
1088
|
-
}>;
|
|
596
|
+
export declare function toRepresentation(ast: SchemaAST.AST): Document;
|
|
1089
597
|
/**
|
|
1090
|
-
*
|
|
598
|
+
* Lowers one or more AST encoded sides in a shared reference environment.
|
|
1091
599
|
*
|
|
1092
|
-
*
|
|
1093
|
-
* @since 4.0.0
|
|
1094
|
-
*/
|
|
1095
|
-
export declare const $UniqueSymbol: Schema.Struct<{
|
|
1096
|
-
readonly _tag: Schema.tag<"UniqueSymbol">;
|
|
1097
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1098
|
-
readonly symbol: Schema.Symbol;
|
|
1099
|
-
}>;
|
|
1100
|
-
/**
|
|
1101
|
-
* Schema for the {@link ObjectKeyword} representation node.
|
|
600
|
+
* **Details**
|
|
1102
601
|
*
|
|
1103
|
-
*
|
|
1104
|
-
* @since 4.0.0
|
|
1105
|
-
*/
|
|
1106
|
-
export declare const $ObjectKeyword: Schema.Struct<{
|
|
1107
|
-
readonly _tag: Schema.tag<"ObjectKeyword">;
|
|
1108
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1109
|
-
}>;
|
|
1110
|
-
/**
|
|
1111
|
-
* Schema for the {@link Enum} representation node.
|
|
602
|
+
* Apply `SchemaAST.toType` to an AST first to lower its type side instead.
|
|
1112
603
|
*
|
|
1113
|
-
* @category
|
|
604
|
+
* @category constructors
|
|
1114
605
|
* @since 4.0.0
|
|
1115
606
|
*/
|
|
1116
|
-
export declare
|
|
1117
|
-
readonly _tag: Schema.tag<"Enum">;
|
|
1118
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1119
|
-
readonly enums: Schema.$Array<Schema.Tuple<readonly [Schema.String, Schema.Union<readonly [Schema.String, Schema.Number]>]>>;
|
|
1120
|
-
}>;
|
|
1121
|
-
/**
|
|
1122
|
-
* Schema for the {@link TemplateLiteral} representation node.
|
|
1123
|
-
*
|
|
1124
|
-
* @category schemas
|
|
1125
|
-
* @since 4.0.0
|
|
1126
|
-
*/
|
|
1127
|
-
export declare const $TemplateLiteral: Schema.Struct<{
|
|
1128
|
-
readonly _tag: Schema.tag<"TemplateLiteral">;
|
|
1129
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1130
|
-
readonly parts: Schema.$Array<Schema.suspend<$Representation>>;
|
|
1131
|
-
}>;
|
|
607
|
+
export declare function toRepresentations(asts: readonly [SchemaAST.AST, ...Array<SchemaAST.AST>]): MultiDocument;
|
|
1132
608
|
/**
|
|
1133
|
-
*
|
|
609
|
+
* Wraps a single representation document as a multi-document with one root.
|
|
1134
610
|
*
|
|
1135
|
-
*
|
|
1136
|
-
* @since 4.0.0
|
|
1137
|
-
*/
|
|
1138
|
-
export declare const $Element: Schema.Struct<{
|
|
1139
|
-
readonly isOptional: Schema.Boolean;
|
|
1140
|
-
readonly type: Schema.suspend<$Representation>;
|
|
1141
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1142
|
-
}>;
|
|
1143
|
-
/**
|
|
1144
|
-
* Schema for the {@link Arrays} representation node.
|
|
611
|
+
* **When to use**
|
|
1145
612
|
*
|
|
1146
|
-
*
|
|
1147
|
-
* @since 4.0.0
|
|
1148
|
-
*/
|
|
1149
|
-
export declare const $Arrays: Schema.Struct<{
|
|
1150
|
-
readonly _tag: Schema.tag<"Arrays">;
|
|
1151
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1152
|
-
readonly elements: Schema.$Array<Schema.Struct<{
|
|
1153
|
-
readonly isOptional: Schema.Boolean;
|
|
1154
|
-
readonly type: Schema.suspend<$Representation>;
|
|
1155
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1156
|
-
}>>;
|
|
1157
|
-
readonly rest: Schema.$Array<Schema.suspend<$Representation>>;
|
|
1158
|
-
readonly checks: Schema.$Array<Schema.Codec<Check<{
|
|
1159
|
-
readonly _tag: "isMinLength";
|
|
1160
|
-
readonly minLength: number;
|
|
1161
|
-
} | {
|
|
1162
|
-
readonly _tag: "isMaxLength";
|
|
1163
|
-
readonly maxLength: number;
|
|
1164
|
-
} | {
|
|
1165
|
-
readonly _tag: "isLengthBetween";
|
|
1166
|
-
readonly minimum: number;
|
|
1167
|
-
readonly maximum: number;
|
|
1168
|
-
} | {
|
|
1169
|
-
readonly _tag: "isUnique";
|
|
1170
|
-
}>, Check<{
|
|
1171
|
-
readonly _tag: "isMinLength";
|
|
1172
|
-
readonly minLength: number;
|
|
1173
|
-
} | {
|
|
1174
|
-
readonly _tag: "isMaxLength";
|
|
1175
|
-
readonly maxLength: number;
|
|
1176
|
-
} | {
|
|
1177
|
-
readonly _tag: "isLengthBetween";
|
|
1178
|
-
readonly minimum: number;
|
|
1179
|
-
readonly maximum: number;
|
|
1180
|
-
} | {
|
|
1181
|
-
readonly _tag: "isUnique";
|
|
1182
|
-
}>, never, never>>;
|
|
1183
|
-
}>;
|
|
1184
|
-
/**
|
|
1185
|
-
* Schema for the {@link PropertySignature} type.
|
|
1186
|
-
*
|
|
1187
|
-
* @category schemas
|
|
1188
|
-
* @since 4.0.0
|
|
1189
|
-
*/
|
|
1190
|
-
export declare const $PropertySignature: Schema.Struct<{
|
|
1191
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1192
|
-
readonly name: Schema.Union<readonly [Schema.Finite, Schema.Symbol, Schema.String]>;
|
|
1193
|
-
readonly type: Schema.suspend<$Representation>;
|
|
1194
|
-
readonly isOptional: Schema.Boolean;
|
|
1195
|
-
readonly isMutable: Schema.Boolean;
|
|
1196
|
-
}>;
|
|
1197
|
-
/**
|
|
1198
|
-
* Schema for the {@link IndexSignature} type.
|
|
1199
|
-
*
|
|
1200
|
-
* @category schemas
|
|
1201
|
-
* @since 4.0.0
|
|
1202
|
-
*/
|
|
1203
|
-
export declare const $IndexSignature: Schema.Struct<{
|
|
1204
|
-
readonly parameter: Schema.suspend<$Representation>;
|
|
1205
|
-
readonly type: Schema.suspend<$Representation>;
|
|
1206
|
-
}>;
|
|
1207
|
-
/**
|
|
1208
|
-
* Schema for {@link ObjectsMeta}.
|
|
1209
|
-
*
|
|
1210
|
-
* @category schemas
|
|
1211
|
-
* @since 4.0.0
|
|
1212
|
-
*/
|
|
1213
|
-
export declare const $ObjectsMeta: Schema.Union<readonly [Schema.Struct<{
|
|
1214
|
-
readonly _tag: Schema.tag<"isMinProperties">;
|
|
1215
|
-
readonly minProperties: Schema.Int;
|
|
1216
|
-
}>, Schema.Struct<{
|
|
1217
|
-
readonly _tag: Schema.tag<"isMaxProperties">;
|
|
1218
|
-
readonly maxProperties: Schema.Int;
|
|
1219
|
-
}>, Schema.Struct<{
|
|
1220
|
-
readonly _tag: Schema.tag<"isPropertiesLengthBetween">;
|
|
1221
|
-
readonly minimum: Schema.Int;
|
|
1222
|
-
readonly maximum: Schema.Int;
|
|
1223
|
-
}>, Schema.Struct<{
|
|
1224
|
-
readonly _tag: Schema.tag<"isPropertyNames">;
|
|
1225
|
-
readonly propertyNames: Schema.suspend<$Representation>;
|
|
1226
|
-
}>]>;
|
|
1227
|
-
/**
|
|
1228
|
-
* Schema for the {@link Objects} representation node.
|
|
1229
|
-
*
|
|
1230
|
-
* @category schemas
|
|
1231
|
-
* @since 4.0.0
|
|
1232
|
-
*/
|
|
1233
|
-
export declare const $Objects: Schema.Struct<{
|
|
1234
|
-
readonly _tag: Schema.tag<"Objects">;
|
|
1235
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1236
|
-
readonly propertySignatures: Schema.$Array<Schema.Struct<{
|
|
1237
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1238
|
-
readonly name: Schema.Union<readonly [Schema.Finite, Schema.Symbol, Schema.String]>;
|
|
1239
|
-
readonly type: Schema.suspend<$Representation>;
|
|
1240
|
-
readonly isOptional: Schema.Boolean;
|
|
1241
|
-
readonly isMutable: Schema.Boolean;
|
|
1242
|
-
}>>;
|
|
1243
|
-
readonly indexSignatures: Schema.$Array<Schema.Struct<{
|
|
1244
|
-
readonly parameter: Schema.suspend<$Representation>;
|
|
1245
|
-
readonly type: Schema.suspend<$Representation>;
|
|
1246
|
-
}>>;
|
|
1247
|
-
readonly checks: Schema.$Array<Schema.Codec<Check<{
|
|
1248
|
-
readonly _tag: "isMinProperties";
|
|
1249
|
-
readonly minProperties: number;
|
|
1250
|
-
} | {
|
|
1251
|
-
readonly _tag: "isMaxProperties";
|
|
1252
|
-
readonly maxProperties: number;
|
|
1253
|
-
} | {
|
|
1254
|
-
readonly _tag: "isPropertiesLengthBetween";
|
|
1255
|
-
readonly minimum: number;
|
|
1256
|
-
readonly maximum: number;
|
|
1257
|
-
} | {
|
|
1258
|
-
readonly _tag: "isPropertyNames";
|
|
1259
|
-
readonly propertyNames: Representation;
|
|
1260
|
-
}>, Check<{
|
|
1261
|
-
readonly _tag: "isMinProperties";
|
|
1262
|
-
readonly minProperties: number;
|
|
1263
|
-
} | {
|
|
1264
|
-
readonly _tag: "isMaxProperties";
|
|
1265
|
-
readonly maxProperties: number;
|
|
1266
|
-
} | {
|
|
1267
|
-
readonly _tag: "isPropertiesLengthBetween";
|
|
1268
|
-
readonly minimum: number;
|
|
1269
|
-
readonly maximum: number;
|
|
1270
|
-
} | {
|
|
1271
|
-
readonly _tag: "isPropertyNames";
|
|
1272
|
-
readonly propertyNames: Representation;
|
|
1273
|
-
}>, never, never>>;
|
|
1274
|
-
}>;
|
|
1275
|
-
/**
|
|
1276
|
-
* Schema for the {@link Union} representation node.
|
|
1277
|
-
*
|
|
1278
|
-
* @category schemas
|
|
1279
|
-
* @since 4.0.0
|
|
1280
|
-
*/
|
|
1281
|
-
export declare const $Union: Schema.Struct<{
|
|
1282
|
-
readonly _tag: Schema.tag<"Union">;
|
|
1283
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1284
|
-
readonly types: Schema.$Array<Schema.suspend<$Representation>>;
|
|
1285
|
-
readonly mode: Schema.Literals<readonly ["anyOf", "oneOf"]>;
|
|
1286
|
-
}>;
|
|
1287
|
-
/**
|
|
1288
|
-
* Schema for the {@link Reference} representation node.
|
|
1289
|
-
*
|
|
1290
|
-
* @category schemas
|
|
1291
|
-
* @since 4.0.0
|
|
1292
|
-
*/
|
|
1293
|
-
export declare const $Reference: Schema.Struct<{
|
|
1294
|
-
readonly _tag: Schema.tag<"Reference">;
|
|
1295
|
-
readonly $ref: Schema.String;
|
|
1296
|
-
}>;
|
|
1297
|
-
/**
|
|
1298
|
-
* Schema for {@link DateMeta}.
|
|
1299
|
-
*
|
|
1300
|
-
* @category schemas
|
|
1301
|
-
* @since 4.0.0
|
|
1302
|
-
*/
|
|
1303
|
-
export declare const $DateMeta: Schema.Union<readonly [Schema.Struct<{
|
|
1304
|
-
readonly _tag: Schema.tag<"isDateValid">;
|
|
1305
|
-
}>, Schema.Struct<{
|
|
1306
|
-
readonly _tag: Schema.tag<"isGreaterThanDate">;
|
|
1307
|
-
readonly exclusiveMinimum: Schema.Date;
|
|
1308
|
-
}>, Schema.Struct<{
|
|
1309
|
-
readonly _tag: Schema.tag<"isGreaterThanOrEqualToDate">;
|
|
1310
|
-
readonly minimum: Schema.Date;
|
|
1311
|
-
}>, Schema.Struct<{
|
|
1312
|
-
readonly _tag: Schema.tag<"isLessThanDate">;
|
|
1313
|
-
readonly exclusiveMaximum: Schema.Date;
|
|
1314
|
-
}>, Schema.Struct<{
|
|
1315
|
-
readonly _tag: Schema.tag<"isLessThanOrEqualToDate">;
|
|
1316
|
-
readonly maximum: Schema.Date;
|
|
1317
|
-
}>, Schema.Struct<{
|
|
1318
|
-
readonly _tag: Schema.tag<"isBetweenDate">;
|
|
1319
|
-
readonly minimum: Schema.Date;
|
|
1320
|
-
readonly maximum: Schema.Date;
|
|
1321
|
-
readonly exclusiveMinimum: Schema.optional<Schema.Boolean>;
|
|
1322
|
-
readonly exclusiveMaximum: Schema.optional<Schema.Boolean>;
|
|
1323
|
-
}>]>;
|
|
1324
|
-
/**
|
|
1325
|
-
* Schema for {@link SizeMeta}.
|
|
1326
|
-
*
|
|
1327
|
-
* @category schemas
|
|
1328
|
-
* @since 4.0.0
|
|
1329
|
-
*/
|
|
1330
|
-
export declare const $SizeMeta: Schema.Union<readonly [Schema.Struct<{
|
|
1331
|
-
readonly _tag: Schema.tag<"isMinSize">;
|
|
1332
|
-
readonly minSize: Schema.Int;
|
|
1333
|
-
}>, Schema.Struct<{
|
|
1334
|
-
readonly _tag: Schema.tag<"isMaxSize">;
|
|
1335
|
-
readonly maxSize: Schema.Int;
|
|
1336
|
-
}>, Schema.Struct<{
|
|
1337
|
-
readonly _tag: Schema.tag<"isSizeBetween">;
|
|
1338
|
-
readonly minimum: Schema.Int;
|
|
1339
|
-
readonly maximum: Schema.Int;
|
|
1340
|
-
}>]>;
|
|
1341
|
-
/**
|
|
1342
|
-
* Schema for {@link DeclarationMeta}.
|
|
1343
|
-
*
|
|
1344
|
-
* @category schemas
|
|
1345
|
-
* @since 4.0.0
|
|
1346
|
-
*/
|
|
1347
|
-
export declare const $DeclarationMeta: Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{
|
|
1348
|
-
readonly _tag: Schema.tag<"isDateValid">;
|
|
1349
|
-
}>, Schema.Struct<{
|
|
1350
|
-
readonly _tag: Schema.tag<"isGreaterThanDate">;
|
|
1351
|
-
readonly exclusiveMinimum: Schema.Date;
|
|
1352
|
-
}>, Schema.Struct<{
|
|
1353
|
-
readonly _tag: Schema.tag<"isGreaterThanOrEqualToDate">;
|
|
1354
|
-
readonly minimum: Schema.Date;
|
|
1355
|
-
}>, Schema.Struct<{
|
|
1356
|
-
readonly _tag: Schema.tag<"isLessThanDate">;
|
|
1357
|
-
readonly exclusiveMaximum: Schema.Date;
|
|
1358
|
-
}>, Schema.Struct<{
|
|
1359
|
-
readonly _tag: Schema.tag<"isLessThanOrEqualToDate">;
|
|
1360
|
-
readonly maximum: Schema.Date;
|
|
1361
|
-
}>, Schema.Struct<{
|
|
1362
|
-
readonly _tag: Schema.tag<"isBetweenDate">;
|
|
1363
|
-
readonly minimum: Schema.Date;
|
|
1364
|
-
readonly maximum: Schema.Date;
|
|
1365
|
-
readonly exclusiveMinimum: Schema.optional<Schema.Boolean>;
|
|
1366
|
-
readonly exclusiveMaximum: Schema.optional<Schema.Boolean>;
|
|
1367
|
-
}>]>, Schema.Union<readonly [Schema.Struct<{
|
|
1368
|
-
readonly _tag: Schema.tag<"isMinSize">;
|
|
1369
|
-
readonly minSize: Schema.Int;
|
|
1370
|
-
}>, Schema.Struct<{
|
|
1371
|
-
readonly _tag: Schema.tag<"isMaxSize">;
|
|
1372
|
-
readonly maxSize: Schema.Int;
|
|
1373
|
-
}>, Schema.Struct<{
|
|
1374
|
-
readonly _tag: Schema.tag<"isSizeBetween">;
|
|
1375
|
-
readonly minimum: Schema.Int;
|
|
1376
|
-
readonly maximum: Schema.Int;
|
|
1377
|
-
}>]>]>;
|
|
1378
|
-
/**
|
|
1379
|
-
* Schema for the {@link Declaration} representation node.
|
|
1380
|
-
*
|
|
1381
|
-
* @category schemas
|
|
1382
|
-
* @since 4.0.0
|
|
1383
|
-
*/
|
|
1384
|
-
export declare const $Declaration: Schema.Struct<{
|
|
1385
|
-
readonly _tag: Schema.tag<"Declaration">;
|
|
1386
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1387
|
-
readonly typeParameters: Schema.$Array<Schema.suspend<$Representation>>;
|
|
1388
|
-
readonly checks: Schema.$Array<Schema.Codec<Check<{
|
|
1389
|
-
readonly _tag: "isDateValid";
|
|
1390
|
-
} | {
|
|
1391
|
-
readonly _tag: "isGreaterThanDate";
|
|
1392
|
-
readonly exclusiveMinimum: Date;
|
|
1393
|
-
} | {
|
|
1394
|
-
readonly _tag: "isGreaterThanOrEqualToDate";
|
|
1395
|
-
readonly minimum: Date;
|
|
1396
|
-
} | {
|
|
1397
|
-
readonly _tag: "isLessThanDate";
|
|
1398
|
-
readonly exclusiveMaximum: Date;
|
|
1399
|
-
} | {
|
|
1400
|
-
readonly _tag: "isLessThanOrEqualToDate";
|
|
1401
|
-
readonly maximum: Date;
|
|
1402
|
-
} | {
|
|
1403
|
-
readonly _tag: "isBetweenDate";
|
|
1404
|
-
readonly minimum: Date;
|
|
1405
|
-
readonly maximum: Date;
|
|
1406
|
-
readonly exclusiveMinimum?: boolean | undefined;
|
|
1407
|
-
readonly exclusiveMaximum?: boolean | undefined;
|
|
1408
|
-
} | {
|
|
1409
|
-
readonly _tag: "isMinSize";
|
|
1410
|
-
readonly minSize: number;
|
|
1411
|
-
} | {
|
|
1412
|
-
readonly _tag: "isMaxSize";
|
|
1413
|
-
readonly maxSize: number;
|
|
1414
|
-
} | {
|
|
1415
|
-
readonly _tag: "isSizeBetween";
|
|
1416
|
-
readonly minimum: number;
|
|
1417
|
-
readonly maximum: number;
|
|
1418
|
-
}>, Check<{
|
|
1419
|
-
readonly _tag: "isDateValid";
|
|
1420
|
-
} | {
|
|
1421
|
-
readonly _tag: "isGreaterThanDate";
|
|
1422
|
-
readonly exclusiveMinimum: Date;
|
|
1423
|
-
} | {
|
|
1424
|
-
readonly _tag: "isGreaterThanOrEqualToDate";
|
|
1425
|
-
readonly minimum: Date;
|
|
1426
|
-
} | {
|
|
1427
|
-
readonly _tag: "isLessThanDate";
|
|
1428
|
-
readonly exclusiveMaximum: Date;
|
|
1429
|
-
} | {
|
|
1430
|
-
readonly _tag: "isLessThanOrEqualToDate";
|
|
1431
|
-
readonly maximum: Date;
|
|
1432
|
-
} | {
|
|
1433
|
-
readonly _tag: "isBetweenDate";
|
|
1434
|
-
readonly minimum: Date;
|
|
1435
|
-
readonly maximum: Date;
|
|
1436
|
-
readonly exclusiveMinimum?: boolean | undefined;
|
|
1437
|
-
readonly exclusiveMaximum?: boolean | undefined;
|
|
1438
|
-
} | {
|
|
1439
|
-
readonly _tag: "isMinSize";
|
|
1440
|
-
readonly minSize: number;
|
|
1441
|
-
} | {
|
|
1442
|
-
readonly _tag: "isMaxSize";
|
|
1443
|
-
readonly maxSize: number;
|
|
1444
|
-
} | {
|
|
1445
|
-
readonly _tag: "isSizeBetween";
|
|
1446
|
-
readonly minimum: number;
|
|
1447
|
-
readonly maximum: number;
|
|
1448
|
-
}>, never, never>>;
|
|
1449
|
-
readonly encodedSchema: Schema.suspend<$Representation>;
|
|
1450
|
-
}>;
|
|
1451
|
-
/**
|
|
1452
|
-
* Schema for the {@link Suspend} representation node.
|
|
1453
|
-
*
|
|
1454
|
-
* @category schemas
|
|
1455
|
-
* @since 4.0.0
|
|
1456
|
-
*/
|
|
1457
|
-
export declare const $Suspend: Schema.Struct<{
|
|
1458
|
-
readonly _tag: Schema.tag<"Suspend">;
|
|
1459
|
-
readonly annotations: Schema.optional<Schema.decodeTo<Schema.$Record<Schema.String, Schema.Unknown>, Schema.$Record<Schema.String, Schema.Codec<PrimitiveTree, PrimitiveTree, never, never>>, never, never>>;
|
|
1460
|
-
readonly checks: Schema.Tuple<readonly []>;
|
|
1461
|
-
readonly thunk: Schema.suspend<$Representation>;
|
|
1462
|
-
}>;
|
|
1463
|
-
/**
|
|
1464
|
-
* Type-level helper for the recursive {@link $Representation} codec.
|
|
1465
|
-
*
|
|
1466
|
-
* @category schemas
|
|
1467
|
-
* @since 4.0.0
|
|
1468
|
-
*/
|
|
1469
|
-
export interface $Representation extends Schema.Codec<Representation> {
|
|
1470
|
-
}
|
|
1471
|
-
/**
|
|
1472
|
-
* Schema for the full {@link Representation} union. It recursively validates
|
|
1473
|
-
* and encodes any representation node.
|
|
613
|
+
* Use when an API such as `toCodeDocument` requires a `MultiDocument`.
|
|
1474
614
|
*
|
|
1475
|
-
* @category
|
|
615
|
+
* @category transforming
|
|
1476
616
|
* @since 4.0.0
|
|
1477
617
|
*/
|
|
1478
|
-
export declare
|
|
618
|
+
export declare function toMultiDocument(document: Document): MultiDocument;
|
|
1479
619
|
/**
|
|
1480
|
-
* Schema
|
|
620
|
+
* Compiles a live representation document to JSON Schema Draft 2020-12.
|
|
1481
621
|
*
|
|
1482
622
|
* **When to use**
|
|
1483
623
|
*
|
|
1484
|
-
* Use
|
|
1485
|
-
* `Schema.decodeUnknownSync` or `Schema.encodeSync`.
|
|
624
|
+
* Use when you need JSON Schema output from a representation whose checks carry compiler annotations.
|
|
1486
625
|
*
|
|
1487
626
|
* **Gotchas**
|
|
1488
627
|
*
|
|
1489
|
-
*
|
|
1490
|
-
* against `references`.
|
|
628
|
+
* Opaque declarations are represented by an unconstrained JSON Schema. Check callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
1491
629
|
*
|
|
1492
|
-
* @see {@link
|
|
1493
|
-
* @see {@link $MultiDocument} for validating documents with multiple root representations
|
|
630
|
+
* @see {@link toJsonSchemaMultiDocument} for multiple roots sharing definitions
|
|
1494
631
|
*
|
|
1495
|
-
* @category
|
|
1496
|
-
* @since 4.0.0
|
|
1497
|
-
*/
|
|
1498
|
-
export declare const $Document: Schema.Struct<{
|
|
1499
|
-
readonly representation: $Representation;
|
|
1500
|
-
readonly references: Schema.$Record<Schema.String, $Representation>;
|
|
1501
|
-
}>;
|
|
1502
|
-
/**
|
|
1503
|
-
* Schema for {@link MultiDocument}.
|
|
1504
|
-
*
|
|
1505
|
-
* @category schemas
|
|
632
|
+
* @category transforming
|
|
1506
633
|
* @since 4.0.0
|
|
1507
634
|
*/
|
|
1508
|
-
export declare
|
|
1509
|
-
readonly representations: Schema.NonEmptyArray<$Representation>;
|
|
1510
|
-
readonly references: Schema.$Record<Schema.String, $Representation>;
|
|
1511
|
-
}>;
|
|
635
|
+
export declare function toJsonSchemaDocument(document: Document, options?: Schema.ToJsonSchemaOptions): JsonSchema.Document<"draft-2020-12">;
|
|
1512
636
|
/**
|
|
1513
|
-
*
|
|
637
|
+
* Compiles multiple live representations to a shared JSON Schema Draft 2020-12 document.
|
|
1514
638
|
*
|
|
1515
639
|
* **When to use**
|
|
1516
640
|
*
|
|
1517
|
-
* Use when
|
|
1518
|
-
* document.
|
|
1519
|
-
*
|
|
1520
|
-
* **Details**
|
|
1521
|
-
*
|
|
1522
|
-
* Shared/recursive sub-schemas are extracted into the `references` map.
|
|
641
|
+
* Use when several representation roots must share the same JSON Schema definitions.
|
|
1523
642
|
*
|
|
1524
|
-
* **
|
|
1525
|
-
*
|
|
1526
|
-
* ```ts
|
|
1527
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
1528
|
-
*
|
|
1529
|
-
* const Person = Schema.Struct({
|
|
1530
|
-
* name: Schema.String,
|
|
1531
|
-
* age: Schema.Number
|
|
1532
|
-
* })
|
|
643
|
+
* **Gotchas**
|
|
1533
644
|
*
|
|
1534
|
-
*
|
|
1535
|
-
* console.log(doc.representation._tag)
|
|
1536
|
-
* // "Objects"
|
|
1537
|
-
* ```
|
|
645
|
+
* Every definition is compiled, including definitions that are not reachable from a root.
|
|
1538
646
|
*
|
|
1539
|
-
* @see {@link
|
|
1540
|
-
* @see {@link fromASTs}
|
|
647
|
+
* @see {@link toJsonSchemaDocument} for a single root
|
|
1541
648
|
*
|
|
1542
|
-
* @category
|
|
649
|
+
* @category transforming
|
|
1543
650
|
* @since 4.0.0
|
|
1544
651
|
*/
|
|
1545
|
-
export declare
|
|
652
|
+
export declare function toJsonSchemaMultiDocument(document: MultiDocument, options?: Schema.ToJsonSchemaOptions): JsonSchema.MultiDocument<"draft-2020-12">;
|
|
1546
653
|
/**
|
|
1547
|
-
*
|
|
654
|
+
* Generates TypeScript source for live schema representations and their definitions.
|
|
1548
655
|
*
|
|
1549
656
|
* **When to use**
|
|
1550
657
|
*
|
|
1551
|
-
* Use when
|
|
1552
|
-
* `MultiDocument` with shared references.
|
|
1553
|
-
*
|
|
1554
|
-
* **Details**
|
|
658
|
+
* Use when custom declarations and checks provide `toCode` callbacks and must be emitted without a central handler registry.
|
|
1555
659
|
*
|
|
1556
|
-
*
|
|
660
|
+
* **Gotchas**
|
|
1557
661
|
*
|
|
1558
|
-
*
|
|
1559
|
-
* @see {@link fromAST}
|
|
662
|
+
* Opaque declarations and leaf checks require `toCode` callbacks. Callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
1560
663
|
*
|
|
1561
|
-
* @category
|
|
664
|
+
* @category transforming
|
|
1562
665
|
* @since 4.0.0
|
|
1563
666
|
*/
|
|
1564
|
-
export declare
|
|
667
|
+
export declare function toCodeDocument(document: MultiDocument): CodeDocument;
|
|
1565
668
|
/**
|
|
1566
|
-
*
|
|
669
|
+
* Projects a live single-root representation document and encodes it as JSON.
|
|
1567
670
|
*
|
|
1568
671
|
* **When to use**
|
|
1569
672
|
*
|
|
1570
|
-
* Use when you need a JSON
|
|
1571
|
-
* `Schema.decodeUnknownSync` or `Schema.encodeSync`.
|
|
673
|
+
* Use when you need a stable JSON value for storage or transport after calling `toRepresentation`.
|
|
1572
674
|
*
|
|
1573
|
-
* **
|
|
1574
|
-
*
|
|
1575
|
-
* ```ts
|
|
1576
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
675
|
+
* **Gotchas**
|
|
1577
676
|
*
|
|
1578
|
-
*
|
|
1579
|
-
* const json = Schema.encodeSync(SchemaRepresentation.DocumentFromJson)(doc)
|
|
1580
|
-
* const back = Schema.decodeUnknownSync(SchemaRepresentation.DocumentFromJson)(json)
|
|
1581
|
-
* ```
|
|
677
|
+
* Generic annotations that are not JSON are omitted. Invalid persistence identities and unsupported structural values throw an `Error` containing their representation path.
|
|
1582
678
|
*
|
|
1583
|
-
* @see {@link
|
|
1584
|
-
* @see {@link
|
|
679
|
+
* @see {@link toRepresentation} for constructing the live document
|
|
680
|
+
* @see {@link toJsonMultiDocument} for documents with multiple roots
|
|
1585
681
|
*
|
|
1586
|
-
* @category
|
|
682
|
+
* @category encoding
|
|
1587
683
|
* @since 4.0.0
|
|
1588
684
|
*/
|
|
1589
|
-
export declare
|
|
685
|
+
export declare function toJson(document: Document): Schema.Json;
|
|
1590
686
|
/**
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1593
|
-
* @see {@link $MultiDocument}
|
|
1594
|
-
* @see {@link DocumentFromJson}
|
|
1595
|
-
*
|
|
1596
|
-
* @category schemas
|
|
1597
|
-
* @since 4.0.0
|
|
1598
|
-
*/
|
|
1599
|
-
export declare const MultiDocumentFromJson: Schema.Codec<MultiDocument, Schema.Json>;
|
|
1600
|
-
/**
|
|
1601
|
-
* Wraps a single {@link Document} as a {@link MultiDocument} with one
|
|
1602
|
-
* representation.
|
|
687
|
+
* Projects a live multi-root representation document and encodes it as JSON.
|
|
1603
688
|
*
|
|
1604
689
|
* **When to use**
|
|
1605
690
|
*
|
|
1606
|
-
* Use when you need
|
|
1607
|
-
* API expects a `MultiDocument`.
|
|
1608
|
-
*
|
|
1609
|
-
* @see {@link Document}
|
|
1610
|
-
* @see {@link MultiDocument}
|
|
1611
|
-
*
|
|
1612
|
-
* @category transforming
|
|
1613
|
-
* @since 4.0.0
|
|
1614
|
-
*/
|
|
1615
|
-
export declare function toMultiDocument(document: Document): MultiDocument;
|
|
1616
|
-
/**
|
|
1617
|
-
* A callback that handles {@link Declaration} nodes during reconstruction
|
|
1618
|
-
* ({@link toSchema}) or code generation ({@link toCodeDocument}).
|
|
691
|
+
* Use when you need one JSON value for multiple live roots that share a reference environment.
|
|
1619
692
|
*
|
|
1620
|
-
* **
|
|
693
|
+
* **Gotchas**
|
|
1621
694
|
*
|
|
1622
|
-
*
|
|
1623
|
-
* default behavior, which uses `encodedSchema` for `toSchema` or the
|
|
1624
|
-
* `generation` annotation for `toCodeDocument`. `recur` processes child
|
|
1625
|
-
* representations recursively.
|
|
695
|
+
* The root order and shared reference keys are preserved, while non-JSON generic annotations are omitted.
|
|
1626
696
|
*
|
|
1627
|
-
* @see {@link
|
|
1628
|
-
* @see {@link
|
|
1629
|
-
* @see {@link toCodeDocument}
|
|
697
|
+
* @see {@link toRepresentations} for constructing the live multi-document
|
|
698
|
+
* @see {@link toJson} for a single-root document
|
|
1630
699
|
*
|
|
1631
|
-
* @category
|
|
700
|
+
* @category encoding
|
|
1632
701
|
* @since 4.0.0
|
|
1633
702
|
*/
|
|
1634
|
-
export
|
|
703
|
+
export declare function toJsonMultiDocument(document: MultiDocument): Schema.Json;
|
|
1635
704
|
/**
|
|
1636
|
-
*
|
|
1637
|
-
* types, including Option, Result, Redacted, Cause, Exit, ReadonlyMap, HashMap,
|
|
1638
|
-
* ReadonlySet, Date, Duration, URL, and RegExp.
|
|
705
|
+
* Decodes a persisted single-root representation document from JSON.
|
|
1639
706
|
*
|
|
1640
707
|
* **When to use**
|
|
1641
708
|
*
|
|
1642
|
-
* Use when
|
|
1643
|
-
* reconstruct runtime schemas for built-in Effect declarations.
|
|
709
|
+
* Use when reading a representation document from storage or transport before inspecting it or passing it to `fromRepresentation`.
|
|
1644
710
|
*
|
|
1645
|
-
* **
|
|
711
|
+
* **Gotchas**
|
|
1646
712
|
*
|
|
1647
|
-
*
|
|
1648
|
-
* fallback to `encodedSchema`.
|
|
713
|
+
* Invalid documents throw a schema decoding error. Decoding does not reconstruct runtime callbacks.
|
|
1649
714
|
*
|
|
1650
|
-
* @see {@link
|
|
1651
|
-
* @see {@link
|
|
715
|
+
* @see {@link toJson} for encoding a document
|
|
716
|
+
* @see {@link fromRepresentation} for reconstructing a runtime schema
|
|
717
|
+
* @see {@link fromJsonMultiDocument} for multiple roots sharing references
|
|
1652
718
|
*
|
|
1653
|
-
* @category
|
|
719
|
+
* @category decoding
|
|
1654
720
|
* @since 4.0.0
|
|
1655
721
|
*/
|
|
1656
|
-
export declare
|
|
722
|
+
export declare function fromJson(input: Schema.Json): Document;
|
|
1657
723
|
/**
|
|
1658
|
-
*
|
|
724
|
+
* Decodes a persisted multi-root representation document from JSON.
|
|
1659
725
|
*
|
|
1660
726
|
* **When to use**
|
|
1661
727
|
*
|
|
1662
|
-
* Use when
|
|
1663
|
-
* need a runtime Schema for decoding/encoding.
|
|
1664
|
-
*
|
|
1665
|
-
* **Details**
|
|
1666
|
-
*
|
|
1667
|
-
* Pass `options.reviver`, such as {@link toSchemaDefaultReviver}, to handle
|
|
1668
|
-
* {@link Declaration} nodes for types like `Date` and `Option`. Without a
|
|
1669
|
-
* reviver, declarations fall back to their `encodedSchema`. Circular references
|
|
1670
|
-
* are handled via lazy `Schema.suspend`.
|
|
728
|
+
* Use when reading multiple representation roots that share references before inspecting them or passing them to `fromRepresentations`.
|
|
1671
729
|
*
|
|
1672
730
|
* **Gotchas**
|
|
1673
731
|
*
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1676
|
-
* **Example** (Reconstructing a Schema)
|
|
732
|
+
* Invalid documents throw a schema decoding error. Decoding does not reconstruct runtime callbacks.
|
|
1677
733
|
*
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1680
|
-
*
|
|
1681
|
-
* const doc = SchemaRepresentation.fromAST(
|
|
1682
|
-
* Schema.Struct({ name: Schema.String }).ast
|
|
1683
|
-
* )
|
|
734
|
+
* @see {@link toJsonMultiDocument} for encoding a multi-document
|
|
735
|
+
* @see {@link fromRepresentations} for reconstructing runtime schemas
|
|
736
|
+
* @see {@link fromJson} for a single root
|
|
1684
737
|
*
|
|
1685
|
-
*
|
|
1686
|
-
* console.log(JSON.stringify(Schema.toJsonSchemaDocument(schema), null, 2))
|
|
1687
|
-
* ```
|
|
1688
|
-
*
|
|
1689
|
-
* @see {@link Document}
|
|
1690
|
-
* @see {@link Reviver}
|
|
1691
|
-
* @see {@link toSchemaDefaultReviver}
|
|
1692
|
-
*
|
|
1693
|
-
* @category Runtime Generation
|
|
738
|
+
* @category decoding
|
|
1694
739
|
* @since 4.0.0
|
|
1695
740
|
*/
|
|
1696
|
-
export declare function
|
|
1697
|
-
readonly reviver?: Reviver<Schema.Top> | undefined;
|
|
1698
|
-
}): S;
|
|
741
|
+
export declare function fromJsonMultiDocument(input: Schema.Json): MultiDocument;
|
|
1699
742
|
/**
|
|
1700
|
-
*
|
|
743
|
+
* Reconstructs a runtime schema from a representation document.
|
|
1701
744
|
*
|
|
1702
745
|
* **When to use**
|
|
1703
746
|
*
|
|
1704
|
-
* Use when you
|
|
1705
|
-
* representation `Document`.
|
|
747
|
+
* Use when you have decoded or constructed a document whose declaration and check annotations may require revivers.
|
|
1706
748
|
*
|
|
1707
749
|
* **Gotchas**
|
|
1708
750
|
*
|
|
1709
|
-
*
|
|
1710
|
-
* semantics cannot be represented exactly in JSON Schema, and importing an
|
|
1711
|
-
* emitted JSON Schema may produce an equivalent approximation rather than the
|
|
1712
|
-
* original representation shape.
|
|
751
|
+
* Revivers are resolved locally by `id`; none are installed implicitly. Reviver results are used directly, and exceptions raised by a reviver pass through unchanged.
|
|
1713
752
|
*
|
|
1714
|
-
* **Example** (
|
|
753
|
+
* **Example** (Restoring a persisted schema)
|
|
1715
754
|
*
|
|
1716
|
-
* ```ts
|
|
755
|
+
* ```ts import.meta.vitest
|
|
1717
756
|
* import { Schema, SchemaRepresentation } from "effect"
|
|
1718
757
|
*
|
|
1719
|
-
* const
|
|
1720
|
-
* const
|
|
1721
|
-
*
|
|
1722
|
-
*
|
|
758
|
+
* const document = SchemaRepresentation.toRepresentation(Schema.Struct({ name: Schema.String }).ast)
|
|
759
|
+
* const persisted = SchemaRepresentation.toJson(document)
|
|
760
|
+
* const restored = SchemaRepresentation.fromJson(persisted)
|
|
761
|
+
* const schema = SchemaRepresentation.fromRepresentation(restored, { revivers: [] })
|
|
762
|
+
* const Person = Schema.make<Schema.Codec<{ readonly name: string }>>(schema.ast)
|
|
763
|
+
*
|
|
764
|
+
* Schema.decodeUnknownSync(Person)({ name: "Ada" }) // => { name: "Ada" }
|
|
1723
765
|
* ```
|
|
1724
766
|
*
|
|
1725
|
-
* @see {@link
|
|
1726
|
-
* @see {@link
|
|
1727
|
-
* @see {@link fromJsonSchemaDocument}
|
|
767
|
+
* @see {@link fromJson} for decoding a persisted document
|
|
768
|
+
* @see {@link fromRepresentations} for multiple roots sharing references
|
|
1728
769
|
*
|
|
1729
770
|
* @category transforming
|
|
1730
771
|
* @since 4.0.0
|
|
1731
772
|
*/
|
|
1732
|
-
export declare
|
|
773
|
+
export declare function fromRepresentation(document: Document, options: {
|
|
774
|
+
readonly revivers: ReadonlyArray<AnyReviver>;
|
|
775
|
+
}): Schema.Top;
|
|
1733
776
|
/**
|
|
1734
|
-
*
|
|
1735
|
-
* multi-document.
|
|
777
|
+
* Reconstructs multiple runtime schemas from a representation multi-document.
|
|
1736
778
|
*
|
|
1737
779
|
* **When to use**
|
|
1738
780
|
*
|
|
1739
|
-
* Use when
|
|
1740
|
-
* so shared definitions stay in multi-document JSON Schema form.
|
|
781
|
+
* Use when multiple roots must be rebuilt in one shared reference environment.
|
|
1741
782
|
*
|
|
1742
783
|
* **Gotchas**
|
|
1743
784
|
*
|
|
1744
|
-
*
|
|
1745
|
-
* semantics cannot be represented exactly in JSON Schema, and importing an
|
|
1746
|
-
* emitted JSON Schema may produce equivalent approximations rather than the
|
|
1747
|
-
* original representation shapes.
|
|
785
|
+
* Only references reachable from a root are revived. Revivers are resolved locally by `id`; none are installed implicitly.
|
|
1748
786
|
*
|
|
1749
|
-
* @see {@link
|
|
1750
|
-
* @see {@link
|
|
1751
|
-
* @see {@link fromJsonSchemaMultiDocument}
|
|
787
|
+
* @see {@link fromJsonMultiDocument} for decoding a persisted multi-document
|
|
788
|
+
* @see {@link fromRepresentation} for a single root
|
|
1752
789
|
*
|
|
1753
790
|
* @category transforming
|
|
1754
791
|
* @since 4.0.0
|
|
1755
792
|
*/
|
|
1756
|
-
export declare
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
* executable Schema expression, `Type` is the corresponding TypeScript type.
|
|
1760
|
-
*
|
|
1761
|
-
* @see {@link makeCode}
|
|
1762
|
-
* @see {@link CodeDocument}
|
|
1763
|
-
*
|
|
1764
|
-
* @category Code Generation
|
|
1765
|
-
* @since 4.0.0
|
|
1766
|
-
*/
|
|
1767
|
-
export type Code = {
|
|
1768
|
-
readonly runtime: string;
|
|
1769
|
-
readonly Type: string;
|
|
1770
|
-
};
|
|
1771
|
-
/**
|
|
1772
|
-
* Constructs a {@link Code} value from a runtime expression string and a
|
|
1773
|
-
* TypeScript type string.
|
|
1774
|
-
*
|
|
1775
|
-
* @see {@link Code}
|
|
1776
|
-
*
|
|
1777
|
-
* @category Code Generation
|
|
1778
|
-
* @since 4.0.0
|
|
1779
|
-
*/
|
|
1780
|
-
export declare function makeCode(runtime: string, Type: string): Code;
|
|
1781
|
-
/**
|
|
1782
|
-
* An auxiliary code artifact produced during code generation — a symbol
|
|
1783
|
-
* declaration, an enum declaration, or an import statement.
|
|
1784
|
-
*
|
|
1785
|
-
* @see {@link CodeDocument}
|
|
1786
|
-
* @see {@link toCodeDocument}
|
|
1787
|
-
*
|
|
1788
|
-
* @category Code Generation
|
|
1789
|
-
* @since 4.0.0
|
|
1790
|
-
*/
|
|
1791
|
-
export type Artifact = {
|
|
1792
|
-
readonly _tag: "Symbol";
|
|
1793
|
-
readonly identifier: string;
|
|
1794
|
-
readonly generation: Code;
|
|
1795
|
-
} | {
|
|
1796
|
-
readonly _tag: "Enum";
|
|
1797
|
-
readonly identifier: string;
|
|
1798
|
-
readonly generation: Code;
|
|
1799
|
-
} | {
|
|
1800
|
-
readonly _tag: "Import";
|
|
1801
|
-
readonly importDeclaration: string;
|
|
1802
|
-
};
|
|
1803
|
-
/**
|
|
1804
|
-
* The output of {@link toCodeDocument}: generated TypeScript code for one or
|
|
1805
|
-
* more schemas plus their shared references and auxiliary artifacts.
|
|
1806
|
-
*
|
|
1807
|
-
* **Details**
|
|
1808
|
-
*
|
|
1809
|
-
* `codes` contains one {@link Code} per input representation.
|
|
1810
|
-
* `references.nonRecursives` contains topologically sorted non-recursive
|
|
1811
|
-
* definitions. `references.recursives` contains definitions involved in cycles.
|
|
1812
|
-
* `artifacts` contains symbols, enums, and import statements needed by the
|
|
1813
|
-
* code.
|
|
1814
|
-
*
|
|
1815
|
-
* @see {@link toCodeDocument}
|
|
1816
|
-
* @see {@link Code}
|
|
1817
|
-
* @see {@link Artifact}
|
|
1818
|
-
*
|
|
1819
|
-
* @category Code Generation
|
|
1820
|
-
* @since 4.0.0
|
|
1821
|
-
*/
|
|
1822
|
-
export type CodeDocument = {
|
|
1823
|
-
readonly codes: ReadonlyArray<Code>;
|
|
1824
|
-
readonly references: {
|
|
1825
|
-
readonly nonRecursives: ReadonlyArray<{
|
|
1826
|
-
readonly $ref: string;
|
|
1827
|
-
readonly code: Code;
|
|
1828
|
-
}>;
|
|
1829
|
-
readonly recursives: {
|
|
1830
|
-
readonly [$ref: string]: Code;
|
|
1831
|
-
};
|
|
1832
|
-
};
|
|
1833
|
-
readonly artifacts: ReadonlyArray<Artifact>;
|
|
1834
|
-
};
|
|
1835
|
-
/**
|
|
1836
|
-
* Generates TypeScript code strings from a {@link MultiDocument}.
|
|
1837
|
-
*
|
|
1838
|
-
* **When to use**
|
|
1839
|
-
*
|
|
1840
|
-
* Use when you need to produce source code for Effect Schema definitions from a
|
|
1841
|
-
* schema representation `MultiDocument`.
|
|
1842
|
-
*
|
|
1843
|
-
* **Details**
|
|
1844
|
-
*
|
|
1845
|
-
* `options.reviver` can customize code generation for {@link Declaration}
|
|
1846
|
-
* nodes. Return `undefined` to fall back to the default logic, which uses
|
|
1847
|
-
* `generation` annotations or the encoded schema. References are
|
|
1848
|
-
* topologically sorted so non-recursive definitions are emitted before their
|
|
1849
|
-
* dependents. `$ref` keys are converted to sanitized JavaScript identifiers.
|
|
1850
|
-
*
|
|
1851
|
-
* **Example** (Generating TypeScript code)
|
|
1852
|
-
*
|
|
1853
|
-
* ```ts
|
|
1854
|
-
* import { Schema, SchemaRepresentation } from "effect"
|
|
1855
|
-
*
|
|
1856
|
-
* const Person = Schema.Struct({
|
|
1857
|
-
* name: Schema.String,
|
|
1858
|
-
* age: Schema.Int
|
|
1859
|
-
* })
|
|
1860
|
-
*
|
|
1861
|
-
* const multi = SchemaRepresentation.toMultiDocument(
|
|
1862
|
-
* SchemaRepresentation.fromAST(Person.ast)
|
|
1863
|
-
* )
|
|
1864
|
-
* const codeDoc = SchemaRepresentation.toCodeDocument(multi)
|
|
1865
|
-
* console.log(codeDoc.codes[0].runtime)
|
|
1866
|
-
* // Schema.Struct({ ... })
|
|
1867
|
-
* ```
|
|
1868
|
-
*
|
|
1869
|
-
* @see {@link CodeDocument}
|
|
1870
|
-
* @see {@link MultiDocument}
|
|
1871
|
-
* @see {@link Reviver}
|
|
1872
|
-
*
|
|
1873
|
-
* @category Code Generation
|
|
1874
|
-
* @since 4.0.0
|
|
1875
|
-
*/
|
|
1876
|
-
export declare function toCodeDocument(multiDocument: MultiDocument, options?: {
|
|
1877
|
-
/**
|
|
1878
|
-
* The reviver can return `undefined` to indicate that the generation should be generated by the default logic
|
|
1879
|
-
*/
|
|
1880
|
-
readonly reviver?: Reviver<Code> | undefined;
|
|
1881
|
-
}): CodeDocument;
|
|
793
|
+
export declare function fromRepresentations(document: MultiDocument, options: {
|
|
794
|
+
readonly revivers: ReadonlyArray<AnyReviver>;
|
|
795
|
+
}): readonly [Schema.Top, ...Array<Schema.Top>];
|
|
1882
796
|
/**
|
|
1883
|
-
*
|
|
797
|
+
* Imports a JSON Schema Draft 2020-12 document as a runtime schema.
|
|
1884
798
|
*
|
|
1885
799
|
* **When to use**
|
|
1886
800
|
*
|
|
1887
|
-
* Use when you need to
|
|
1888
|
-
* Effect schema representation system.
|
|
1889
|
-
*
|
|
1890
|
-
* **Details**
|
|
1891
|
-
*
|
|
1892
|
-
* `options.onEnter` is an optional hook called on each JSON Schema node before
|
|
1893
|
-
* processing, allowing pre-transformation.
|
|
801
|
+
* Use when you need to validate or transform values described by an external JSON Schema document.
|
|
1894
802
|
*
|
|
1895
803
|
* **Gotchas**
|
|
1896
804
|
*
|
|
1897
|
-
*
|
|
1898
|
-
* exactly to Effect schema representations, and importing a schema previously
|
|
1899
|
-
* emitted by `toJsonSchemaDocument` may produce an equivalent approximation
|
|
1900
|
-
* rather than the original representation shape.
|
|
805
|
+
* 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.
|
|
1901
806
|
*
|
|
1902
|
-
*
|
|
1903
|
-
*
|
|
1904
|
-
*
|
|
1905
|
-
* @see {@link Document}
|
|
1906
|
-
* @see {@link toJsonSchemaDocument}
|
|
1907
|
-
* @see {@link fromJsonSchemaMultiDocument}
|
|
807
|
+
* @see {@link fromJsonSchemaMultiDocument} for multiple roots sharing definitions
|
|
808
|
+
* @see {@link toRepresentation} for converting the result to a representation document
|
|
1908
809
|
*
|
|
1909
810
|
* @category constructors
|
|
1910
811
|
* @since 4.0.0
|
|
1911
812
|
*/
|
|
1912
|
-
export declare function fromJsonSchemaDocument(document: JsonSchema.Document<"draft-2020-12">, options?:
|
|
1913
|
-
readonly onEnter?: ((js: JsonSchema.JsonSchema) => JsonSchema.JsonSchema) | undefined;
|
|
1914
|
-
}): Document;
|
|
813
|
+
export declare function fromJsonSchemaDocument(document: JsonSchema.Document<"draft-2020-12">, options?: FromJsonSchemaOptions): Schema.Top;
|
|
1915
814
|
/**
|
|
1916
|
-
*
|
|
1917
|
-
* {@link MultiDocument}.
|
|
815
|
+
* Imports multiple JSON Schema Draft 2020-12 roots as runtime schemas with shared definitions.
|
|
1918
816
|
*
|
|
1919
817
|
* **When to use**
|
|
1920
818
|
*
|
|
1921
|
-
* Use when
|
|
1922
|
-
* schemas share definitions.
|
|
1923
|
-
*
|
|
1924
|
-
* **Details**
|
|
1925
|
-
*
|
|
1926
|
-
* `options.onEnter` is an optional hook called on each JSON Schema node before
|
|
1927
|
-
* processing.
|
|
819
|
+
* Use when multiple imported roots share reachable definitions, aliases, or recursion.
|
|
1928
820
|
*
|
|
1929
821
|
* **Gotchas**
|
|
1930
822
|
*
|
|
1931
|
-
*
|
|
1932
|
-
* exactly to Effect schema representations, and importing schemas previously
|
|
1933
|
-
* emitted by `toJsonSchemaMultiDocument` may produce equivalent approximations
|
|
1934
|
-
* rather than the original representation shapes.
|
|
1935
|
-
*
|
|
1936
|
-
* This throws if a `$ref` cannot be resolved.
|
|
823
|
+
* Only definitions reachable from a root are translated. Callback results are used directly, and exceptions raised by a callback pass through unchanged.
|
|
1937
824
|
*
|
|
1938
|
-
* @see {@link
|
|
1939
|
-
* @see {@link
|
|
1940
|
-
* @see {@link fromJsonSchemaDocument}
|
|
825
|
+
* @see {@link fromJsonSchemaDocument} for a single root
|
|
826
|
+
* @see {@link toRepresentations} for converting the returned schema ASTs to a representation document
|
|
1941
827
|
*
|
|
1942
828
|
* @category constructors
|
|
1943
829
|
* @since 4.0.0
|
|
1944
830
|
*/
|
|
1945
|
-
export declare function fromJsonSchemaMultiDocument(document: JsonSchema.MultiDocument<"draft-2020-12">, options?:
|
|
1946
|
-
|
|
1947
|
-
}): MultiDocument;
|
|
831
|
+
export declare function fromJsonSchemaMultiDocument(document: JsonSchema.MultiDocument<"draft-2020-12">, options?: FromJsonSchemaOptions): readonly [Schema.Top, ...Array<Schema.Top>];
|
|
832
|
+
export {};
|
|
1948
833
|
//# sourceMappingURL=SchemaRepresentation.d.ts.map
|