effect 4.0.0-beta.94 → 4.0.0-beta.98
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Array.d.ts.map +1 -1
- package/dist/BigDecimal.d.ts.map +1 -1
- package/dist/BigDecimal.js.map +1 -1
- package/dist/BigInt.d.ts.map +1 -1
- package/dist/Boolean.d.ts.map +1 -1
- package/dist/Brand.d.ts.map +1 -1
- package/dist/Cache.d.ts.map +1 -1
- package/dist/Cause.d.ts.map +1 -1
- package/dist/Channel.d.ts.map +1 -1
- package/dist/ChannelSchema.d.ts.map +1 -1
- package/dist/Chunk.d.ts.map +1 -1
- package/dist/Combiner.d.ts.map +1 -1
- package/dist/Config.d.ts.map +1 -1
- package/dist/Config.js.map +1 -1
- package/dist/ConfigProvider.d.ts +44 -6
- package/dist/ConfigProvider.d.ts.map +1 -1
- package/dist/ConfigProvider.js +63 -24
- package/dist/ConfigProvider.js.map +1 -1
- package/dist/Console.d.ts.map +1 -1
- package/dist/Context.d.ts.map +1 -1
- package/dist/Cron.d.ts +4 -1
- package/dist/Cron.d.ts.map +1 -1
- package/dist/Cron.js +98 -53
- package/dist/Cron.js.map +1 -1
- package/dist/Crypto.d.ts.map +1 -1
- package/dist/Data.d.ts.map +1 -1
- package/dist/DateTime.d.ts +12 -12
- package/dist/DateTime.d.ts.map +1 -1
- package/dist/Deferred.d.ts.map +1 -1
- package/dist/Duration.d.ts.map +1 -1
- package/dist/Effect.d.ts.map +1 -1
- package/dist/Effectable.d.ts.map +1 -1
- package/dist/Encoding.d.ts.map +1 -1
- package/dist/Equal.d.ts.map +1 -1
- package/dist/Equivalence.d.ts.map +1 -1
- package/dist/ErrorReporter.d.ts.map +1 -1
- package/dist/ExecutionPlan.d.ts +2 -2
- package/dist/ExecutionPlan.d.ts.map +1 -1
- package/dist/Fiber.d.ts.map +1 -1
- package/dist/FiberHandle.d.ts +8 -8
- package/dist/FiberHandle.d.ts.map +1 -1
- package/dist/FiberMap.d.ts +8 -8
- package/dist/FiberMap.d.ts.map +1 -1
- package/dist/FiberSet.d.ts +4 -4
- package/dist/FiberSet.d.ts.map +1 -1
- package/dist/FileSystem.d.ts.map +1 -1
- package/dist/Filter.d.ts.map +1 -1
- package/dist/Function.d.ts.map +1 -1
- package/dist/Graph.d.ts.map +1 -1
- package/dist/Graph.js.map +1 -1
- package/dist/Hash.d.ts.map +1 -1
- package/dist/HashMap.d.ts.map +1 -1
- package/dist/HashRing.d.ts.map +1 -1
- package/dist/Inspectable.d.ts.map +1 -1
- package/dist/Inspectable.js.map +1 -1
- package/dist/Iterable.d.ts.map +1 -1
- package/dist/Latch.d.ts.map +1 -1
- package/dist/Layer.d.ts.map +1 -1
- package/dist/LayerMap.d.ts.map +1 -1
- package/dist/LayerRef.d.ts +5 -7
- package/dist/LayerRef.d.ts.map +1 -1
- package/dist/LayerRef.js +4 -6
- package/dist/LayerRef.js.map +1 -1
- package/dist/LogLevel.d.ts.map +1 -1
- package/dist/Logger.d.ts.map +1 -1
- package/dist/ManagedRuntime.d.ts.map +1 -1
- package/dist/Metric.d.ts.map +1 -1
- package/dist/MutableHashMap.d.ts.map +1 -1
- package/dist/MutableHashSet.d.ts.map +1 -1
- package/dist/MutableList.d.ts.map +1 -1
- package/dist/MutableRef.d.ts.map +1 -1
- package/dist/NonEmptyIterable.d.ts.map +1 -1
- package/dist/Number.d.ts.map +1 -1
- package/dist/Number.js +28 -10
- package/dist/Number.js.map +1 -1
- package/dist/Optic.d.ts.map +1 -1
- package/dist/Option.d.ts.map +1 -1
- package/dist/Order.d.ts.map +1 -1
- package/dist/Ordering.d.ts.map +1 -1
- package/dist/PartitionedSemaphore.d.ts.map +1 -1
- package/dist/Pipeable.d.ts.map +1 -1
- package/dist/PlatformError.d.ts.map +1 -1
- package/dist/Pool.d.ts.map +1 -1
- package/dist/PrimaryKey.d.ts.map +1 -1
- package/dist/PubSub.d.ts.map +1 -1
- package/dist/Pull.d.ts.map +1 -1
- package/dist/Queue.d.ts.map +1 -1
- package/dist/Random.d.ts.map +1 -1
- package/dist/RcMap.d.ts.map +1 -1
- package/dist/Record.d.ts.map +1 -1
- package/dist/Redactable.d.ts.map +1 -1
- package/dist/Redacted.d.ts.map +1 -1
- package/dist/Ref.d.ts.map +1 -1
- package/dist/RegExp.d.ts.map +1 -1
- package/dist/Request.d.ts +1 -1
- package/dist/Request.d.ts.map +1 -1
- package/dist/RequestResolver.d.ts.map +1 -1
- package/dist/Resource.d.ts.map +1 -1
- package/dist/Result.d.ts.map +1 -1
- package/dist/Runtime.d.ts.map +1 -1
- package/dist/Schedule.d.ts +1206 -4013
- package/dist/Schedule.d.ts.map +1 -1
- package/dist/Schedule.js +244 -1348
- package/dist/Schedule.js.map +1 -1
- package/dist/Scheduler.d.ts.map +1 -1
- package/dist/Scheduler.js.map +1 -1
- package/dist/Schema.d.ts +71 -22
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +76 -33
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts.map +1 -1
- package/dist/SchemaAST.js +25 -10
- package/dist/SchemaAST.js.map +1 -1
- package/dist/SchemaError.d.ts +53 -0
- package/dist/SchemaError.d.ts.map +1 -0
- package/dist/SchemaError.js +61 -0
- package/dist/SchemaError.js.map +1 -0
- package/dist/SchemaGetter.d.ts.map +1 -1
- package/dist/SchemaGetter.js +17 -12
- package/dist/SchemaGetter.js.map +1 -1
- package/dist/SchemaIssue.d.ts.map +1 -1
- package/dist/SchemaIssue.js.map +1 -1
- package/dist/SchemaParser.d.ts.map +1 -1
- package/dist/SchemaRepresentation.d.ts +106 -106
- package/dist/SchemaRepresentation.d.ts.map +1 -1
- package/dist/SchemaRepresentation.js +186 -224
- package/dist/SchemaRepresentation.js.map +1 -1
- package/dist/SchemaTransformation.d.ts +38 -2
- package/dist/SchemaTransformation.d.ts.map +1 -1
- package/dist/SchemaTransformation.js +38 -2
- package/dist/SchemaTransformation.js.map +1 -1
- package/dist/ScopedCache.d.ts.map +1 -1
- package/dist/ScopedRef.d.ts.map +1 -1
- package/dist/Semaphore.d.ts.map +1 -1
- package/dist/Sink.d.ts.map +1 -1
- package/dist/Stdio.d.ts.map +1 -1
- package/dist/Stream.d.ts +2 -2
- package/dist/Stream.d.ts.map +1 -1
- package/dist/Stream.js +1 -1
- package/dist/String.d.ts.map +1 -1
- package/dist/String.js.map +1 -1
- package/dist/Struct.d.ts.map +1 -1
- package/dist/SubscriptionRef.d.ts.map +1 -1
- package/dist/SynchronizedRef.d.ts.map +1 -1
- package/dist/Take.d.ts.map +1 -1
- package/dist/Terminal.d.ts.map +1 -1
- package/dist/Tracer.d.ts.map +1 -1
- package/dist/Trie.d.ts.map +1 -1
- package/dist/Tuple.d.ts.map +1 -1
- package/dist/TxChunk.d.ts.map +1 -1
- package/dist/TxDeferred.d.ts.map +1 -1
- package/dist/TxHashMap.d.ts.map +1 -1
- package/dist/TxHashSet.d.ts.map +1 -1
- package/dist/TxPriorityQueue.d.ts.map +1 -1
- package/dist/TxPubSub.d.ts.map +1 -1
- package/dist/TxQueue.d.ts.map +1 -1
- package/dist/TxReentrantLock.d.ts.map +1 -1
- package/dist/TxRef.d.ts.map +1 -1
- package/dist/TxSemaphore.d.ts.map +1 -1
- package/dist/TxSubscriptionRef.d.ts.map +1 -1
- package/dist/Types.d.ts +1 -1
- package/dist/Types.d.ts.map +1 -1
- package/dist/UndefinedOr.d.ts.map +1 -1
- package/dist/Utils.d.ts.map +1 -1
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/effect.js +26 -8
- package/dist/internal/effect.js.map +1 -1
- package/dist/internal/schema/equivalence.js +1 -2
- package/dist/internal/schema/equivalence.js.map +1 -1
- package/dist/internal/schema/representation.js +1 -3
- package/dist/internal/schema/representation.js.map +1 -1
- package/dist/internal/schema/schema.d.ts +0 -13
- package/dist/internal/schema/schema.d.ts.map +1 -1
- package/dist/internal/schema/schema.js +4 -29
- package/dist/internal/schema/schema.js.map +1 -1
- package/dist/testing/TestClock.d.ts.map +1 -1
- package/dist/testing/TestConsole.d.ts.map +1 -1
- package/dist/testing/TestSchema.d.ts.map +1 -1
- package/dist/unstable/ai/AiError.d.ts +1 -1
- package/dist/unstable/ai/AiError.d.ts.map +1 -1
- package/dist/unstable/ai/Chat.d.ts +1 -1
- package/dist/unstable/ai/Chat.d.ts.map +1 -1
- package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
- package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
- package/dist/unstable/ai/McpSchema.d.ts +278 -278
- package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
- package/dist/unstable/ai/McpServer.d.ts.map +1 -1
- package/dist/unstable/ai/Model.d.ts.map +1 -1
- package/dist/unstable/ai/Prompt.d.ts.map +1 -1
- package/dist/unstable/ai/Response.d.ts.map +1 -1
- package/dist/unstable/ai/Telemetry.d.ts.map +1 -1
- package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
- package/dist/unstable/ai/Tool.d.ts.map +1 -1
- package/dist/unstable/ai/Toolkit.d.ts.map +1 -1
- package/dist/unstable/cli/Argument.d.ts.map +1 -1
- package/dist/unstable/cli/CliError.d.ts +8 -16
- package/dist/unstable/cli/CliError.d.ts.map +1 -1
- package/dist/unstable/cli/CliError.js +8 -16
- package/dist/unstable/cli/CliError.js.map +1 -1
- package/dist/unstable/cli/CliOutput.d.ts.map +1 -1
- package/dist/unstable/cli/Command.d.ts +4 -3
- package/dist/unstable/cli/Command.d.ts.map +1 -1
- package/dist/unstable/cli/Command.js +3 -3
- package/dist/unstable/cli/Command.js.map +1 -1
- package/dist/unstable/cli/Completions.d.ts.map +1 -1
- package/dist/unstable/cli/Flag.d.ts.map +1 -1
- package/dist/unstable/cli/GlobalFlag.d.ts +6 -8
- package/dist/unstable/cli/GlobalFlag.d.ts.map +1 -1
- package/dist/unstable/cli/GlobalFlag.js +6 -6
- package/dist/unstable/cli/GlobalFlag.js.map +1 -1
- package/dist/unstable/cli/Param.d.ts.map +1 -1
- package/dist/unstable/cli/Primitive.d.ts.map +1 -1
- package/dist/unstable/cli/Prompt.d.ts.map +1 -1
- package/dist/unstable/cli/Prompt.js.map +1 -1
- package/dist/unstable/cli/internal/ansi.d.ts.map +1 -1
- package/dist/unstable/cli/internal/ansi.js.map +1 -1
- package/dist/unstable/cli/internal/command.d.ts.map +1 -1
- package/dist/unstable/cli/internal/help.d.ts.map +1 -1
- package/dist/unstable/cli/internal/parser.js.map +1 -1
- package/dist/unstable/cluster/ClusterCron.d.ts.map +1 -1
- package/dist/unstable/cluster/ClusterCron.js +1 -1
- package/dist/unstable/cluster/ClusterCron.js.map +1 -1
- package/dist/unstable/cluster/ClusterError.d.ts.map +1 -1
- package/dist/unstable/cluster/ClusterSchema.d.ts +1 -1
- package/dist/unstable/cluster/ClusterSchema.d.ts.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
- package/dist/unstable/cluster/DeliverAt.d.ts.map +1 -1
- package/dist/unstable/cluster/Entity.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityAddress.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityId.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxy.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxyServer.d.ts +1 -1
- package/dist/unstable/cluster/EntityProxyServer.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxyServer.js +2 -4
- package/dist/unstable/cluster/EntityProxyServer.js.map +1 -1
- package/dist/unstable/cluster/EntityType.d.ts.map +1 -1
- package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
- package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
- package/dist/unstable/cluster/MachineId.d.ts.map +1 -1
- package/dist/unstable/cluster/Message.d.ts.map +1 -1
- package/dist/unstable/cluster/MessageStorage.d.ts +25 -29
- package/dist/unstable/cluster/MessageStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/Reply.d.ts.map +1 -1
- package/dist/unstable/cluster/Runner.d.ts.map +1 -1
- package/dist/unstable/cluster/RunnerAddress.d.ts.map +1 -1
- package/dist/unstable/cluster/RunnerHealth.d.ts.map +1 -1
- package/dist/unstable/cluster/RunnerServer.d.ts +1 -1
- package/dist/unstable/cluster/RunnerStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/Runners.d.ts +8 -8
- package/dist/unstable/cluster/ShardId.d.ts.map +1 -1
- package/dist/unstable/cluster/Sharding.js +3 -4
- package/dist/unstable/cluster/Sharding.js.map +1 -1
- package/dist/unstable/cluster/ShardingConfig.d.ts.map +1 -1
- package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts +6 -8
- package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts.map +1 -1
- package/dist/unstable/cluster/SingleRunner.d.ts.map +1 -1
- package/dist/unstable/cluster/Singleton.d.ts.map +1 -1
- package/dist/unstable/cluster/SingletonAddress.d.ts.map +1 -1
- package/dist/unstable/cluster/Snowflake.d.ts +1 -1
- package/dist/unstable/cluster/Snowflake.d.ts.map +1 -1
- package/dist/unstable/cluster/Snowflake.js +1 -1
- package/dist/unstable/cluster/Snowflake.js.map +1 -1
- package/dist/unstable/cluster/SqlMessageStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/SqlRunnerStorage.d.ts +1 -1
- package/dist/unstable/cluster/SqlRunnerStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/internal/entityManager.js +26 -24
- package/dist/unstable/cluster/internal/entityManager.js.map +1 -1
- package/dist/unstable/devtools/DevTools.d.ts.map +1 -1
- package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
- package/dist/unstable/encoding/Ndjson.d.ts.map +1 -1
- package/dist/unstable/encoding/Sse.d.ts.map +1 -1
- package/dist/unstable/eventlog/Event.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventGroup.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventJournal.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventJournal.js.map +1 -1
- package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLog.js +2 -2
- package/dist/unstable/eventlog/EventLog.js.map +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogRemote.d.ts +21 -21
- package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +3 -4
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.d.ts.map +1 -1
- package/dist/unstable/eventlog/SqlEventJournal.d.ts.map +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerEncrypted.d.ts.map +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.d.ts.map +1 -1
- package/dist/unstable/http/Cookies.d.ts +1 -1
- package/dist/unstable/http/Cookies.d.ts.map +1 -1
- package/dist/unstable/http/Etag.d.ts.map +1 -1
- package/dist/unstable/http/Headers.d.ts.map +1 -1
- package/dist/unstable/http/HttpBody.d.ts.map +1 -1
- package/dist/unstable/http/HttpClient.d.ts.map +1 -1
- package/dist/unstable/http/HttpClientError.d.ts +1 -1
- package/dist/unstable/http/HttpClientError.d.ts.map +1 -1
- package/dist/unstable/http/HttpClientRequest.d.ts.map +1 -1
- package/dist/unstable/http/HttpClientResponse.d.ts.map +1 -1
- package/dist/unstable/http/HttpEffect.d.ts.map +1 -1
- package/dist/unstable/http/HttpIncomingMessage.d.ts.map +1 -1
- package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
- package/dist/unstable/http/HttpMiddleware.d.ts +1 -1
- package/dist/unstable/http/HttpMiddleware.d.ts.map +1 -1
- package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
- package/dist/unstable/http/HttpServer.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerError.d.ts +1 -1
- package/dist/unstable/http/HttpServerError.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerRequest.d.ts +2 -2
- package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerRespondable.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
- package/dist/unstable/http/HttpStaticServer.d.ts.map +1 -1
- package/dist/unstable/http/HttpTraceContext.d.ts.map +1 -1
- package/dist/unstable/http/Multipart.d.ts +2 -1
- package/dist/unstable/http/Multipart.d.ts.map +1 -1
- package/dist/unstable/http/Url.d.ts.map +1 -1
- package/dist/unstable/http/UrlParams.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApi.d.ts +36 -15
- package/dist/unstable/httpapi/HttpApi.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApi.js +19 -20
- package/dist/unstable/httpapi/HttpApi.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts +51 -62
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.js +68 -58
- package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.d.ts +53 -53
- package/dist/unstable/httpapi/HttpApiClient.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.js +40 -30
- package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiEndpoint.d.ts +171 -170
- package/dist/unstable/httpapi/HttpApiEndpoint.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiEndpoint.js +31 -19
- package/dist/unstable/httpapi/HttpApiEndpoint.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiError.d.ts +23 -1
- package/dist/unstable/httpapi/HttpApiError.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiError.js +31 -0
- package/dist/unstable/httpapi/HttpApiError.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.d.ts +55 -30
- package/dist/unstable/httpapi/HttpApiGroup.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.js +22 -29
- package/dist/unstable/httpapi/HttpApiGroup.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +8 -8
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.d.ts +2 -2
- package/dist/unstable/httpapi/HttpApiScalar.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.js +4 -3
- package/dist/unstable/httpapi/HttpApiScalar.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSchema.d.ts +8 -0
- package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.d.ts +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiTest.d.ts +4 -4
- package/dist/unstable/httpapi/HttpApiTest.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiTest.js +9 -8
- package/dist/unstable/httpapi/HttpApiTest.js.map +1 -1
- package/dist/unstable/httpapi/OpenApi.d.ts +1 -1
- package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
- package/dist/unstable/httpapi/OpenApi.js +77 -37
- package/dist/unstable/httpapi/OpenApi.js.map +1 -1
- package/dist/unstable/httpapi/internal/html.js +6 -2
- package/dist/unstable/httpapi/internal/html.js.map +1 -1
- package/dist/unstable/httpapi/internal/mediaType.d.ts +2 -0
- package/dist/unstable/httpapi/internal/mediaType.d.ts.map +1 -0
- package/dist/unstable/httpapi/internal/mediaType.js +7 -0
- package/dist/unstable/httpapi/internal/mediaType.js.map +1 -0
- package/dist/unstable/observability/Otlp.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpExporter.js +3 -1
- package/dist/unstable/observability/OtlpExporter.js.map +1 -1
- package/dist/unstable/observability/OtlpLogger.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpResource.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpTracer.d.ts.map +1 -1
- package/dist/unstable/observability/PrometheusMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/internal/otlpEnv.d.ts.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
- package/dist/unstable/persistence/Persistable.d.ts.map +1 -1
- package/dist/unstable/persistence/PersistedQueue.d.ts +1 -1
- package/dist/unstable/persistence/PersistedQueue.d.ts.map +1 -1
- package/dist/unstable/persistence/PersistedQueue.js +16 -12
- package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
- package/dist/unstable/persistence/Persistence.d.ts.map +1 -1
- package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
- package/dist/unstable/persistence/Redis.d.ts.map +1 -1
- package/dist/unstable/process/ChildProcess.d.ts.map +1 -1
- package/dist/unstable/process/ChildProcess.js.map +1 -1
- package/dist/unstable/process/ChildProcessSpawner.d.ts.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.d.ts +2 -2
- package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
- package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
- package/dist/unstable/reactivity/Atom.js +1 -1
- package/dist/unstable/reactivity/Atom.js.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.d.ts +7 -7
- package/dist/unstable/reactivity/AtomHttpApi.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.js +3 -2
- package/dist/unstable/reactivity/AtomHttpApi.js.map +1 -1
- package/dist/unstable/reactivity/AtomRef.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomRegistry.d.ts +2 -2
- package/dist/unstable/reactivity/AtomRegistry.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomRegistry.js +28 -37
- package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
- package/dist/unstable/reactivity/AtomRpc.d.ts.map +1 -1
- package/dist/unstable/reactivity/Hydration.d.ts.map +1 -1
- package/dist/unstable/reactivity/Reactivity.d.ts.map +1 -1
- package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcClient.d.ts +2 -1
- package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcClient.js +5 -5
- package/dist/unstable/rpc/RpcClient.js.map +1 -1
- package/dist/unstable/rpc/RpcGroup.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcMessage.d.ts +7 -7
- package/dist/unstable/rpc/RpcMessage.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcMessage.js +2 -2
- package/dist/unstable/rpc/RpcMessage.js.map +1 -1
- package/dist/unstable/rpc/RpcMiddleware.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcSchema.d.ts +1 -1
- package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcSerialization.js +8 -8
- package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
- package/dist/unstable/rpc/RpcServer.d.ts +5 -3
- package/dist/unstable/rpc/RpcServer.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcServer.js +11 -8
- package/dist/unstable/rpc/RpcServer.js.map +1 -1
- package/dist/unstable/rpc/RpcWorker.d.ts.map +1 -1
- package/dist/unstable/rpc/Utils.d.ts.map +1 -1
- package/dist/unstable/schema/Model.d.ts +24 -38
- package/dist/unstable/schema/Model.d.ts.map +1 -1
- package/dist/unstable/schema/VariantSchema.d.ts +1 -1
- package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
- package/dist/unstable/socket/Socket.d.ts +1 -1
- package/dist/unstable/socket/Socket.d.ts.map +1 -1
- package/dist/unstable/socket/SocketServer.d.ts.map +1 -1
- package/dist/unstable/sql/Migrator.d.ts.map +1 -1
- package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
- package/dist/unstable/sql/SqlError.d.ts +2 -2
- package/dist/unstable/sql/SqlError.d.ts.map +1 -1
- package/dist/unstable/sql/SqlError.js.map +1 -1
- package/dist/unstable/sql/SqlModel.d.ts.map +1 -1
- package/dist/unstable/sql/SqlResolver.d.ts.map +1 -1
- package/dist/unstable/sql/SqlSchema.d.ts.map +1 -1
- package/dist/unstable/sql/SqlStream.d.ts.map +1 -1
- package/dist/unstable/sql/Statement.d.ts.map +1 -1
- package/dist/unstable/workers/Transferable.d.ts.map +1 -1
- package/dist/unstable/workers/Worker.d.ts.map +1 -1
- package/dist/unstable/workers/WorkerError.d.ts.map +1 -1
- package/dist/unstable/workflow/Activity.d.ts +1 -1
- package/dist/unstable/workflow/Activity.d.ts.map +1 -1
- package/dist/unstable/workflow/Activity.js +1 -1
- package/dist/unstable/workflow/Activity.js.map +1 -1
- package/dist/unstable/workflow/DurableClock.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableDeferred.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableDeferred.js +1 -1
- package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
- package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableQueue.js +1 -1
- package/dist/unstable/workflow/DurableQueue.js.map +1 -1
- package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowEngine.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowEngine.js +1 -1
- package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
- package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.d.ts +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.js +1 -2
- package/dist/unstable/workflow/WorkflowProxyServer.js.map +1 -1
- package/package.json +11 -12
- package/src/ConfigProvider.ts +79 -27
- package/src/Cron.ts +109 -57
- package/src/LayerRef.ts +4 -6
- package/src/Number.ts +29 -10
- package/src/Schedule.ts +1437 -4445
- package/src/Schema.ts +95 -34
- package/src/SchemaAST.ts +25 -13
- package/src/SchemaError.ts +64 -0
- package/src/SchemaGetter.ts +22 -16
- package/src/SchemaRepresentation.ts +165 -202
- package/src/SchemaTransformation.ts +42 -2
- package/src/Stream.ts +1 -1
- package/src/index.ts +10 -0
- package/src/internal/effect.ts +39 -22
- package/src/internal/schema/equivalence.ts +1 -2
- package/src/internal/schema/representation.ts +4 -4
- package/src/internal/schema/schema.ts +4 -37
- package/src/unstable/cli/CliError.ts +24 -16
- package/src/unstable/cli/Command.ts +8 -8
- package/src/unstable/cli/GlobalFlag.ts +22 -33
- package/src/unstable/cluster/ClusterCron.ts +4 -3
- package/src/unstable/cluster/ClusterWorkflowEngine.ts +4 -3
- package/src/unstable/cluster/EntityProxyServer.ts +15 -17
- package/src/unstable/cluster/Sharding.ts +4 -4
- package/src/unstable/cluster/Snowflake.ts +2 -2
- package/src/unstable/cluster/internal/entityManager.ts +61 -47
- package/src/unstable/eventlog/EventLog.ts +4 -3
- package/src/unstable/httpapi/HttpApi.ts +72 -47
- package/src/unstable/httpapi/HttpApiBuilder.ts +320 -217
- package/src/unstable/httpapi/HttpApiClient.ts +196 -151
- package/src/unstable/httpapi/HttpApiEndpoint.ts +251 -447
- package/src/unstable/httpapi/HttpApiError.ts +33 -0
- package/src/unstable/httpapi/HttpApiGroup.ts +95 -74
- package/src/unstable/httpapi/HttpApiMiddleware.ts +10 -7
- package/src/unstable/httpapi/HttpApiScalar.ts +15 -12
- package/src/unstable/httpapi/HttpApiSchema.ts +8 -0
- package/src/unstable/httpapi/HttpApiSwagger.ts +2 -2
- package/src/unstable/httpapi/HttpApiTest.ts +15 -14
- package/src/unstable/httpapi/OpenApi.ts +74 -36
- package/src/unstable/httpapi/internal/html.ts +9 -2
- package/src/unstable/httpapi/internal/mediaType.ts +6 -0
- package/src/unstable/observability/OtlpExporter.ts +1 -1
- package/src/unstable/persistence/PersistedQueue.ts +16 -14
- package/src/unstable/reactivity/Atom.ts +1 -1
- package/src/unstable/reactivity/AtomHttpApi.ts +164 -162
- package/src/unstable/reactivity/AtomRegistry.ts +35 -44
- package/src/unstable/rpc/RpcClient.ts +10 -9
- package/src/unstable/rpc/RpcMessage.ts +8 -9
- package/src/unstable/rpc/RpcSerialization.ts +16 -16
- package/src/unstable/rpc/RpcServer.ts +15 -9
- package/src/unstable/workflow/Activity.ts +6 -5
- package/src/unstable/workflow/DurableDeferred.ts +1 -1
- package/src/unstable/workflow/DurableQueue.ts +4 -3
- package/src/unstable/workflow/WorkflowEngine.ts +4 -3
- package/src/unstable/workflow/WorkflowProxyServer.ts +11 -12
|
@@ -4,6 +4,7 @@ import type { Effect } from "../../Effect.ts";
|
|
|
4
4
|
import { type Pipeable } from "../../Pipeable.ts";
|
|
5
5
|
import * as Schema from "../../Schema.ts";
|
|
6
6
|
import type * as Stream from "../../Stream.ts";
|
|
7
|
+
import type { Simplify } from "../../Struct.ts";
|
|
7
8
|
import type * as Types from "../../Types.ts";
|
|
8
9
|
import type { HttpMethod } from "../http/HttpMethod.ts";
|
|
9
10
|
import * as HttpRouter from "../http/HttpRouter.ts";
|
|
@@ -21,25 +22,53 @@ declare const TypeId = "~effect/httpapi/HttpApiEndpoint";
|
|
|
21
22
|
* @category guards
|
|
22
23
|
* @since 4.0.0
|
|
23
24
|
*/
|
|
24
|
-
export declare const isHttpApiEndpoint: (u: unknown) => u is
|
|
25
|
+
export declare const isHttpApiEndpoint: (u: unknown) => u is Top;
|
|
26
|
+
type SuccessType<S> = S extends HttpApiSchema.StreamSse<infer _Events, infer _Error, infer _Value> ? Stream.Stream<_Value, _Error["Type"], never> : S extends HttpApiSchema.StreamUint8Array ? Stream.Stream<Uint8Array, unknown, never> : S extends Schema.Constraint ? S["Type"] : never;
|
|
27
|
+
type SuccessEncodingServices<S> = S extends HttpApiSchema.StreamSse<infer _Events, infer _Error, infer _Value> ? _Events["EncodingServices"] | _Error["EncodingServices"] : S extends HttpApiSchema.StreamUint8Array ? never : S extends Schema.Constraint ? S["EncodingServices"] : never;
|
|
28
|
+
type SuccessDecodingServices<S> = S extends HttpApiSchema.StreamSse<infer _Events, infer _Error, infer _Value> ? _Events["DecodingServices"] | _Error["DecodingServices"] : S extends HttpApiSchema.StreamUint8Array ? never : S extends Schema.Constraint ? S["DecodingServices"] : never;
|
|
29
|
+
type UnwrapReadonlyArray<S> = S extends ReadonlyArray<infer A> ? A : S;
|
|
30
|
+
type ExtractBufferedSuccess<S extends SuccessConstraint> = Exclude<Extract<UnwrapReadonlyArray<S>, Schema.Top>, HttpApiSchema.StreamSchema>;
|
|
31
|
+
type ExtractStreamSuccess<S extends SuccessConstraint> = UnwrapReadonlyArray<S> extends infer Success ? Success extends HttpApiSchema.StreamSchema ? Success : never : never;
|
|
32
|
+
type ToSuccessCodec<S extends SuccessConstraint> = [ExtractBufferedSuccess<S>] extends [never] ? ExtractStreamSuccess<S> : Schema.toCodecJson<ExtractBufferedSuccess<S>> | ExtractStreamSuccess<S>;
|
|
33
|
+
type ToJsonCodec<S> = [S] extends [never] ? never : [S] extends [Schema.Constraint] ? Schema.toCodecJson<S> : never;
|
|
34
|
+
type ToStringTreeCodec<S> = [S] extends [never] ? never : [S] extends [Schema.Struct.Fields] ? Schema.toCodecStringTree<Schema.Struct<S>> : [S] extends [Schema.Constraint] ? Schema.toCodecStringTree<S> : never;
|
|
35
|
+
type RequestFromParts<Endpoint, ParamsType, QueryType, PayloadType, HeadersType> = ([ParamsType] extends [never] ? {} : {
|
|
36
|
+
readonly params: Simplify<ParamsType>;
|
|
37
|
+
}) & ([QueryType] extends [never] ? {} : {
|
|
38
|
+
readonly query: Simplify<QueryType>;
|
|
39
|
+
}) & ([PayloadType] extends [never] ? {} : PayloadType extends Brand<HttpApiSchema.MultipartStreamTypeId> ? {
|
|
40
|
+
readonly payload: Stream.Stream<Multipart.Part, Multipart.MultipartError>;
|
|
41
|
+
} : {
|
|
42
|
+
readonly payload: Simplify<PayloadType>;
|
|
43
|
+
}) & ([HeadersType] extends [never] ? {} : {
|
|
44
|
+
readonly headers: Simplify<HeadersType>;
|
|
45
|
+
}) & {
|
|
46
|
+
readonly request: HttpServerRequest;
|
|
47
|
+
readonly endpoint: Endpoint;
|
|
48
|
+
readonly group: HttpApiGroup.Top;
|
|
49
|
+
};
|
|
50
|
+
type RequestRawFromParts<Endpoint, ParamsType, QueryType, HeadersType> = ([ParamsType] extends [never] ? {} : {
|
|
51
|
+
readonly params: Simplify<ParamsType>;
|
|
52
|
+
}) & ([QueryType] extends [never] ? {} : {
|
|
53
|
+
readonly query: Simplify<QueryType>;
|
|
54
|
+
}) & ([HeadersType] extends [never] ? {} : {
|
|
55
|
+
readonly headers: Simplify<HeadersType>;
|
|
56
|
+
}) & {
|
|
57
|
+
readonly request: HttpServerRequest;
|
|
58
|
+
readonly endpoint: Endpoint;
|
|
59
|
+
readonly group: HttpApiGroup.Top;
|
|
60
|
+
};
|
|
25
61
|
/**
|
|
26
|
-
* Maps
|
|
27
|
-
*
|
|
62
|
+
* Maps normalized media types to a payload encoding strategy and one or more
|
|
63
|
+
* schemas. Each schema retains its declared content type in its encoding annotation.
|
|
28
64
|
*
|
|
29
65
|
* @category models
|
|
30
66
|
* @since 4.0.0
|
|
31
67
|
*/
|
|
32
68
|
export type PayloadMap = ReadonlyMap<string, {
|
|
33
69
|
readonly encoding: HttpApiSchema.PayloadEncoding;
|
|
34
|
-
readonly schemas: [Schema.Top, ...Array<Schema.Top>];
|
|
70
|
+
readonly schemas: readonly [Schema.Top, ...Array<Schema.Top>];
|
|
35
71
|
}>;
|
|
36
|
-
type SuccessType<S> = S extends HttpApiSchema.StreamSse<infer _Events, infer _Error, infer _Value> ? Stream.Stream<_Value, _Error["Type"], never> : S extends HttpApiSchema.StreamUint8Array ? Stream.Stream<Uint8Array, unknown, never> : S extends Schema.Constraint ? S["Type"] : never;
|
|
37
|
-
type SuccessEncodingServices<S> = S extends HttpApiSchema.StreamSse<infer _Events, infer _Error, infer _Value> ? _Events["EncodingServices"] | _Error["EncodingServices"] : S extends HttpApiSchema.StreamUint8Array ? never : S extends Schema.Constraint ? S["EncodingServices"] : never;
|
|
38
|
-
type SuccessDecodingServices<S> = S extends HttpApiSchema.StreamSse<infer _Events, infer _Error, infer _Value> ? _Events["DecodingServices"] | _Error["DecodingServices"] : S extends HttpApiSchema.StreamUint8Array ? never : S extends Schema.Constraint ? S["DecodingServices"] : never;
|
|
39
|
-
type ExtractSuccessOrArray<S extends SuccessConstraint> = S extends ReadonlyArray<Schema.Constraint> ? S[number] : S;
|
|
40
|
-
type ExtractBufferedSuccess<S extends SuccessConstraint> = Exclude<Extract<ExtractSuccessOrArray<S>, Schema.Top>, HttpApiSchema.StreamSchema>;
|
|
41
|
-
type ExtractStreamSuccess<S extends SuccessConstraint> = ExtractSuccessOrArray<S> extends infer Success ? Success extends HttpApiSchema.StreamSchema ? Success : never : never;
|
|
42
|
-
type JsonSuccessOrArray<S extends SuccessConstraint> = [ExtractBufferedSuccess<S>] extends [never] ? ExtractStreamSuccess<S> : Json<ExtractBufferedSuccess<S>> | ExtractStreamSuccess<S>;
|
|
43
72
|
/**
|
|
44
73
|
* Represents an API endpoint. An API endpoint is mapped to a single route on
|
|
45
74
|
* the underlying `HttpRouter`.
|
|
@@ -47,17 +76,20 @@ type JsonSuccessOrArray<S extends SuccessConstraint> = [ExtractBufferedSuccess<S
|
|
|
47
76
|
* @category models
|
|
48
77
|
* @since 4.0.0
|
|
49
78
|
*/
|
|
50
|
-
export interface HttpApiEndpoint<out
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
};
|
|
79
|
+
export interface HttpApiEndpoint<out Identifier extends string, out Method extends HttpMethod, out Path extends string, out Params extends Schema.Top = never, out Query extends Schema.Top = never, out Payload extends Schema.Top = never, out Headers extends Schema.Top = never, out Success extends Schema.Top = typeof HttpApiSchema.NoContent, out Error extends Schema.Top = never, in out Middleware = never, out MiddlewareServices = never> extends Pipeable {
|
|
80
|
+
new (_: never): {};
|
|
81
|
+
readonly [TypeId]: typeof TypeId;
|
|
54
82
|
readonly "~Params": Params;
|
|
55
83
|
readonly "~Query": Query;
|
|
56
84
|
readonly "~Headers": Headers;
|
|
57
85
|
readonly "~Payload": Payload;
|
|
58
86
|
readonly "~Success": Success;
|
|
59
87
|
readonly "~Error": Error;
|
|
60
|
-
readonly
|
|
88
|
+
readonly "~Middleware": Middleware;
|
|
89
|
+
readonly "~MiddlewareServices": MiddlewareServices;
|
|
90
|
+
readonly "~Request": RequestFromParts<this, Params["Type"], Query["Type"], Payload["Type"], Headers["Type"]>;
|
|
91
|
+
readonly "~RequestRaw": RequestRawFromParts<this, Params["Type"], Query["Type"], Headers["Type"]>;
|
|
92
|
+
readonly identifier: Identifier;
|
|
61
93
|
readonly path: Path;
|
|
62
94
|
readonly method: Method;
|
|
63
95
|
readonly params: Schema.Top | undefined;
|
|
@@ -71,19 +103,19 @@ export interface HttpApiEndpoint<out Name extends string, out Method extends Htt
|
|
|
71
103
|
/**
|
|
72
104
|
* Add a prefix to the path of the endpoint.
|
|
73
105
|
*/
|
|
74
|
-
prefix<const Prefix extends HttpRouter.PathInput>(prefix: Prefix): HttpApiEndpoint<
|
|
106
|
+
prefix<const Prefix extends HttpRouter.PathInput>(prefix: Prefix): HttpApiEndpoint<Identifier, Method, `${Prefix}${Path}`, Params, Query, Payload, Headers, Success, Error, Middleware, MiddlewareServices>;
|
|
75
107
|
/**
|
|
76
108
|
* Add an `HttpApiMiddleware` to the endpoint.
|
|
77
109
|
*/
|
|
78
|
-
middleware<I extends HttpApiMiddleware.AnyId, S>(middleware: Context.Key<I, S>): HttpApiEndpoint<
|
|
110
|
+
middleware<I extends HttpApiMiddleware.AnyId, S>(middleware: Context.Key<I, S>): HttpApiEndpoint<Identifier, Method, Path, Params, Query, Payload, Headers, Success, Error, Middleware | I, HttpApiMiddleware.ApplyServices<I, MiddlewareServices>>;
|
|
79
111
|
/**
|
|
80
112
|
* Add an annotation on the endpoint.
|
|
81
113
|
*/
|
|
82
|
-
annotate<I, S>(key: Context.Key<I, S>, value: Types.NoInfer<S>): HttpApiEndpoint<
|
|
114
|
+
annotate<I, S>(key: Context.Key<I, S>, value: Types.NoInfer<S>): HttpApiEndpoint<Identifier, Method, Path, Params, Query, Payload, Headers, Success, Error, Middleware, MiddlewareServices>;
|
|
83
115
|
/**
|
|
84
116
|
* Merge the annotations of the endpoint with the provided context.
|
|
85
117
|
*/
|
|
86
|
-
annotateMerge<I>(annotations: Context.Context<I>): HttpApiEndpoint<
|
|
118
|
+
annotateMerge<I>(annotations: Context.Context<I>): HttpApiEndpoint<Identifier, Method, Path, Params, Query, Payload, Headers, Success, Error, Middleware, MiddlewareServices>;
|
|
87
119
|
}
|
|
88
120
|
/**
|
|
89
121
|
* A widened `HttpApiEndpoint` type used when the concrete method, path, schemas,
|
|
@@ -92,11 +124,26 @@ export interface HttpApiEndpoint<out Name extends string, out Method extends Htt
|
|
|
92
124
|
* @category models
|
|
93
125
|
* @since 4.0.0
|
|
94
126
|
*/
|
|
95
|
-
export interface
|
|
96
|
-
readonly [TypeId]:
|
|
97
|
-
readonly
|
|
98
|
-
readonly ["~Success"]: Schema.
|
|
99
|
-
readonly ["~Error"]: Schema.
|
|
127
|
+
export interface Constraint {
|
|
128
|
+
readonly [TypeId]: typeof TypeId;
|
|
129
|
+
readonly identifier: string;
|
|
130
|
+
readonly ["~Success"]: Schema.Constraint;
|
|
131
|
+
readonly ["~Error"]: Schema.Constraint;
|
|
132
|
+
readonly ["~Request"]: unknown;
|
|
133
|
+
readonly ["~RequestRaw"]: unknown;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* A widened endpoint type that preserves request and middleware pipeline phantom fields.
|
|
137
|
+
*
|
|
138
|
+
* @category models
|
|
139
|
+
* @since 4.0.0
|
|
140
|
+
*/
|
|
141
|
+
export interface ConstraintRequest extends Constraint {
|
|
142
|
+
readonly ["~Params"]: Schema.Constraint;
|
|
143
|
+
readonly ["~Query"]: Schema.Constraint;
|
|
144
|
+
readonly ["~Payload"]: Schema.Constraint;
|
|
145
|
+
readonly ["~Headers"]: Schema.Constraint;
|
|
146
|
+
readonly ["~Middleware"]: unknown;
|
|
100
147
|
}
|
|
101
148
|
/**
|
|
102
149
|
* A widened endpoint type that preserves concrete runtime properties such as
|
|
@@ -105,78 +152,80 @@ export interface Any extends Pipeable {
|
|
|
105
152
|
* @category models
|
|
106
153
|
* @since 4.0.0
|
|
107
154
|
*/
|
|
108
|
-
export interface
|
|
155
|
+
export interface Top extends HttpApiEndpoint<string, HttpMethod, string, Schema.Top, Schema.Top, Schema.Top, Schema.Top, Schema.Top, Schema.Top, any, unknown> {
|
|
109
156
|
}
|
|
110
157
|
/**
|
|
111
|
-
* Extracts the
|
|
158
|
+
* Extracts the endpoint identifier literal from an `HttpApiEndpoint`.
|
|
112
159
|
*
|
|
113
160
|
* @category models
|
|
114
161
|
* @since 4.0.0
|
|
115
162
|
*/
|
|
116
|
-
export type
|
|
163
|
+
export type Identifier<Endpoint> = Endpoint extends Constraint ? Endpoint["identifier"] : never;
|
|
117
164
|
/**
|
|
118
165
|
* Extracts the success schema associated with an endpoint.
|
|
119
166
|
*
|
|
120
167
|
* @category models
|
|
121
168
|
* @since 4.0.0
|
|
122
169
|
*/
|
|
123
|
-
export type Success<Endpoint
|
|
170
|
+
export type Success<Endpoint> = Endpoint extends Constraint ? Endpoint["~Success"] : never;
|
|
124
171
|
/**
|
|
125
172
|
* Extracts the error schema associated with an endpoint.
|
|
126
173
|
*
|
|
127
174
|
* @category models
|
|
128
175
|
* @since 4.0.0
|
|
129
176
|
*/
|
|
130
|
-
export type Error<Endpoint
|
|
177
|
+
export type Error<Endpoint> = Endpoint extends Constraint ? Endpoint["~Error"] : never;
|
|
131
178
|
/**
|
|
132
179
|
* Extracts the schema used for an endpoint's path parameters.
|
|
133
180
|
*
|
|
134
181
|
* @category models
|
|
135
182
|
* @since 4.0.0
|
|
136
183
|
*/
|
|
137
|
-
export type Params<Endpoint
|
|
184
|
+
export type Params<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Params"] : never;
|
|
138
185
|
/**
|
|
139
186
|
* Extracts the schema used for an endpoint's query parameters.
|
|
140
187
|
*
|
|
141
188
|
* @category models
|
|
142
189
|
* @since 4.0.0
|
|
143
190
|
*/
|
|
144
|
-
export type Query<Endpoint
|
|
191
|
+
export type Query<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Query"] : never;
|
|
145
192
|
/**
|
|
146
193
|
* Extracts the schema used for an endpoint's request payload.
|
|
147
194
|
*
|
|
148
195
|
* @category models
|
|
149
196
|
* @since 4.0.0
|
|
150
197
|
*/
|
|
151
|
-
export type Payload<Endpoint
|
|
198
|
+
export type Payload<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Payload"] : never;
|
|
152
199
|
/**
|
|
153
200
|
* Extracts the schema used for an endpoint's request headers.
|
|
154
201
|
*
|
|
155
202
|
* @category models
|
|
156
203
|
* @since 4.0.0
|
|
157
204
|
*/
|
|
158
|
-
export type Headers<Endpoint
|
|
205
|
+
export type Headers<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Headers"] : never;
|
|
159
206
|
/**
|
|
160
207
|
* Extracts the middleware identifiers attached to an endpoint.
|
|
161
208
|
*
|
|
162
209
|
* @category models
|
|
163
210
|
* @since 4.0.0
|
|
164
211
|
*/
|
|
165
|
-
export type Middleware<Endpoint
|
|
212
|
+
export type Middleware<Endpoint> = Endpoint extends {
|
|
213
|
+
readonly "~Middleware": infer M;
|
|
214
|
+
} ? M : never;
|
|
166
215
|
/**
|
|
167
216
|
* Computes the services provided by the middleware attached to an endpoint.
|
|
168
217
|
*
|
|
169
218
|
* @category models
|
|
170
219
|
* @since 4.0.0
|
|
171
220
|
*/
|
|
172
|
-
export type MiddlewareProvides<Endpoint
|
|
221
|
+
export type MiddlewareProvides<Endpoint> = HttpApiMiddleware.Provides<Middleware<Endpoint>>;
|
|
173
222
|
/**
|
|
174
223
|
* Computes the client-side middleware services required by an endpoint.
|
|
175
224
|
*
|
|
176
225
|
* @category models
|
|
177
226
|
* @since 4.0.0
|
|
178
227
|
*/
|
|
179
|
-
export type MiddlewareClient<Endpoint
|
|
228
|
+
export type MiddlewareClient<Endpoint> = HttpApiMiddleware.MiddlewareClient<Middleware<Endpoint>>;
|
|
180
229
|
/**
|
|
181
230
|
* Computes the error types that can be produced by the middleware attached to an
|
|
182
231
|
* endpoint.
|
|
@@ -184,7 +233,7 @@ export type MiddlewareClient<Endpoint extends Any> = HttpApiMiddleware.Middlewar
|
|
|
184
233
|
* @category models
|
|
185
234
|
* @since 4.0.0
|
|
186
235
|
*/
|
|
187
|
-
export type MiddlewareError<Endpoint
|
|
236
|
+
export type MiddlewareError<Endpoint> = HttpApiMiddleware.Error<Middleware<Endpoint>>;
|
|
188
237
|
/**
|
|
189
238
|
* Computes the full error value union for an endpoint, including the endpoint
|
|
190
239
|
* error schema's type and errors introduced by middleware.
|
|
@@ -192,7 +241,7 @@ export type MiddlewareError<Endpoint extends Any> = HttpApiMiddleware.Error<Midd
|
|
|
192
241
|
* @category models
|
|
193
242
|
* @since 4.0.0
|
|
194
243
|
*/
|
|
195
|
-
export type Errors<Endpoint
|
|
244
|
+
export type Errors<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Error"]["Type"] | HttpApiMiddleware.Error<Endpoint["~Middleware"]> : never;
|
|
196
245
|
/**
|
|
197
246
|
* Computes the services required to encode an endpoint's error responses,
|
|
198
247
|
* including services required by middleware error encoders.
|
|
@@ -200,7 +249,7 @@ export type Errors<Endpoint extends Any> = Endpoint extends HttpApiEndpoint<infe
|
|
|
200
249
|
* @category models
|
|
201
250
|
* @since 4.0.0
|
|
202
251
|
*/
|
|
203
|
-
export type ErrorServicesEncode<Endpoint
|
|
252
|
+
export type ErrorServicesEncode<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Error"]["EncodingServices"] | HttpApiMiddleware.ErrorServicesEncode<Endpoint["~Middleware"]> : never;
|
|
204
253
|
/**
|
|
205
254
|
* Builds the decoded request shape passed to a normal endpoint handler, including
|
|
206
255
|
* available params, query, payload, headers, the raw request, endpoint, and group.
|
|
@@ -209,21 +258,7 @@ export type ErrorServicesEncode<Endpoint extends Any> = Endpoint extends HttpApi
|
|
|
209
258
|
* @category models
|
|
210
259
|
* @since 4.0.0
|
|
211
260
|
*/
|
|
212
|
-
export type Request<Endpoint
|
|
213
|
-
readonly params: _Params["Type"];
|
|
214
|
-
}) & ([_Query["Type"]] extends [never] ? {} : {
|
|
215
|
-
readonly query: _Query["Type"];
|
|
216
|
-
}) & ([_Payload["Type"]] extends [never] ? {} : _Payload["Type"] extends Brand<HttpApiSchema.MultipartStreamTypeId> ? {
|
|
217
|
-
readonly payload: Stream.Stream<Multipart.Part, Multipart.MultipartError>;
|
|
218
|
-
} : {
|
|
219
|
-
readonly payload: _Payload["Type"];
|
|
220
|
-
}) & ([_Headers] extends [never] ? {} : {
|
|
221
|
-
readonly headers: _Headers["Type"];
|
|
222
|
-
}) & {
|
|
223
|
-
readonly request: HttpServerRequest;
|
|
224
|
-
readonly endpoint: Endpoint;
|
|
225
|
-
readonly group: HttpApiGroup.AnyWithProps;
|
|
226
|
-
} : {};
|
|
261
|
+
export type Request<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Request"] : {};
|
|
227
262
|
/**
|
|
228
263
|
* Builds the request shape passed to a raw endpoint handler, including decoded
|
|
229
264
|
* params, query, and headers plus the raw request, endpoint, and group, while
|
|
@@ -232,17 +267,7 @@ export type Request<Endpoint extends Any> = Endpoint extends HttpApiEndpoint<inf
|
|
|
232
267
|
* @category models
|
|
233
268
|
* @since 4.0.0
|
|
234
269
|
*/
|
|
235
|
-
export type RequestRaw<Endpoint
|
|
236
|
-
readonly params: _Params["Type"];
|
|
237
|
-
}) & ([_Query["Type"]] extends [never] ? {} : {
|
|
238
|
-
readonly query: _Query["Type"];
|
|
239
|
-
}) & ([_Headers["Type"]] extends [never] ? {} : {
|
|
240
|
-
readonly headers: _Headers["Type"];
|
|
241
|
-
}) & {
|
|
242
|
-
readonly request: HttpServerRequest;
|
|
243
|
-
readonly endpoint: Endpoint;
|
|
244
|
-
readonly group: HttpApiGroup.AnyWithProps;
|
|
245
|
-
} : {};
|
|
270
|
+
export type RequestRaw<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~RequestRaw"] : {};
|
|
246
271
|
/**
|
|
247
272
|
* Builds the request object accepted by a generated client method, including only
|
|
248
273
|
* the params, query, headers, payload, and response mode fields required by the
|
|
@@ -283,7 +308,7 @@ export type ClientResponseMode = "decoded-only" | "decoded-and-response" | "resp
|
|
|
283
308
|
* @category models
|
|
284
309
|
* @since 4.0.0
|
|
285
310
|
*/
|
|
286
|
-
export type ServerServices<Endpoint> = Endpoint extends
|
|
311
|
+
export type ServerServices<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Params"]["DecodingServices"] | Endpoint["~Query"]["DecodingServices"] | Endpoint["~Payload"]["DecodingServices"] | Endpoint["~Headers"]["DecodingServices"] | SuccessEncodingServices<Endpoint["~Success"]> | Endpoint["~Error"]["EncodingServices"] | HttpApiMiddleware.ErrorServicesEncode<Endpoint["~Middleware"]> : never;
|
|
287
312
|
/**
|
|
288
313
|
* Computes the services required on the client to encode endpoint requests and
|
|
289
314
|
* decode endpoint success or error responses.
|
|
@@ -291,14 +316,16 @@ export type ServerServices<Endpoint> = Endpoint extends HttpApiEndpoint<infer _N
|
|
|
291
316
|
* @category models
|
|
292
317
|
* @since 4.0.0
|
|
293
318
|
*/
|
|
294
|
-
export type ClientServices<Endpoint> = Endpoint extends
|
|
319
|
+
export type ClientServices<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Params"]["EncodingServices"] | Endpoint["~Query"]["EncodingServices"] | Endpoint["~Payload"]["EncodingServices"] | Endpoint["~Headers"]["EncodingServices"] | SuccessDecodingServices<Endpoint["~Success"]> | Endpoint["~Error"]["DecodingServices"] : never;
|
|
295
320
|
/**
|
|
296
321
|
* Extracts the additional services required by middleware applied to an endpoint.
|
|
297
322
|
*
|
|
298
323
|
* @category models
|
|
299
324
|
* @since 4.0.0
|
|
300
325
|
*/
|
|
301
|
-
export type MiddlewareServices<Endpoint> = Endpoint extends
|
|
326
|
+
export type MiddlewareServices<Endpoint> = Endpoint extends {
|
|
327
|
+
readonly "~MiddlewareServices": infer R;
|
|
328
|
+
} ? R : never;
|
|
302
329
|
/**
|
|
303
330
|
* Computes the services required to decode an endpoint's error responses,
|
|
304
331
|
* including services required by middleware error decoders.
|
|
@@ -306,7 +333,7 @@ export type MiddlewareServices<Endpoint> = Endpoint extends HttpApiEndpoint<infe
|
|
|
306
333
|
* @category models
|
|
307
334
|
* @since 4.0.0
|
|
308
335
|
*/
|
|
309
|
-
export type ErrorServicesDecode<Endpoint> = Endpoint extends
|
|
336
|
+
export type ErrorServicesDecode<Endpoint> = Endpoint extends ConstraintRequest ? Endpoint["~Error"]["DecodingServices"] | HttpApiMiddleware.ErrorServicesDecode<Endpoint["~Middleware"]> : never;
|
|
310
337
|
/**
|
|
311
338
|
* The normal server handler for an endpoint, accepting the decoded request shape
|
|
312
339
|
* and returning either the endpoint success value or a custom `HttpServerResponse`.
|
|
@@ -314,7 +341,7 @@ export type ErrorServicesDecode<Endpoint> = Endpoint extends HttpApiEndpoint<inf
|
|
|
314
341
|
* @category models
|
|
315
342
|
* @since 4.0.0
|
|
316
343
|
*/
|
|
317
|
-
export type Handler<Endpoint extends
|
|
344
|
+
export type Handler<Endpoint extends Constraint, E, R> = (request: Simplify<Endpoint["~Request"]>) => Effect<SuccessType<Endpoint["~Success"]> | HttpServerResponse, Endpoint["~Error"]["Type"] | E, R>;
|
|
318
345
|
/**
|
|
319
346
|
* The raw server handler for an endpoint, receiving a request shape without a
|
|
320
347
|
* decoded payload so the handler can read the raw `HttpServerRequest` directly.
|
|
@@ -322,89 +349,89 @@ export type Handler<Endpoint extends Any, E, R> = (request: Types.Simplify<Reque
|
|
|
322
349
|
* @category models
|
|
323
350
|
* @since 4.0.0
|
|
324
351
|
*/
|
|
325
|
-
export type HandlerRaw<Endpoint extends
|
|
352
|
+
export type HandlerRaw<Endpoint extends Constraint, E, R> = (request: Simplify<Endpoint["~RequestRaw"]>) => Effect<SuccessType<Endpoint["~Success"]> | HttpServerResponse, Endpoint["~Error"]["Type"] | E, R>;
|
|
326
353
|
/**
|
|
327
|
-
* Selects the endpoint with the specified
|
|
354
|
+
* Selects the endpoint with the specified identifier from a union of endpoints.
|
|
328
355
|
*
|
|
329
356
|
* @category models
|
|
330
357
|
* @since 4.0.0
|
|
331
358
|
*/
|
|
332
|
-
export type
|
|
333
|
-
readonly
|
|
359
|
+
export type WithIdentifier<Endpoints, Identifier extends string> = Extract<Endpoints, {
|
|
360
|
+
readonly identifier: Identifier;
|
|
334
361
|
}>;
|
|
335
362
|
/**
|
|
336
|
-
* Removes endpoints with the specified
|
|
363
|
+
* Removes endpoints with the specified identifier from a union of endpoints.
|
|
337
364
|
*
|
|
338
365
|
* @category models
|
|
339
366
|
* @since 4.0.0
|
|
340
367
|
*/
|
|
341
|
-
export type
|
|
342
|
-
readonly
|
|
368
|
+
export type ExcludeIdentifier<Endpoints, Identifier extends string> = Exclude<Endpoints, {
|
|
369
|
+
readonly identifier: Identifier;
|
|
343
370
|
}>;
|
|
344
371
|
/**
|
|
345
|
-
* Derives the normal handler type for the endpoint with the specified
|
|
346
|
-
* endpoint union.
|
|
372
|
+
* Derives the normal handler type for the endpoint with the specified identifier
|
|
373
|
+
* in an endpoint union.
|
|
347
374
|
*
|
|
348
375
|
* @category models
|
|
349
376
|
* @since 4.0.0
|
|
350
377
|
*/
|
|
351
|
-
export type
|
|
378
|
+
export type HandlerWithIdentifier<Endpoints extends Constraint, Identifier extends string, E, R> = Handler<WithIdentifier<Endpoints, Identifier>, E, R>;
|
|
352
379
|
/**
|
|
353
|
-
* Derives the raw handler type for the endpoint with the specified
|
|
354
|
-
* endpoint union.
|
|
380
|
+
* Derives the raw handler type for the endpoint with the specified identifier in
|
|
381
|
+
* an endpoint union.
|
|
355
382
|
*
|
|
356
383
|
* @category models
|
|
357
384
|
* @since 4.0.0
|
|
358
385
|
*/
|
|
359
|
-
export type
|
|
386
|
+
export type HandlerRawWithIdentifier<Endpoints extends Constraint, Identifier extends string, E, R> = HandlerRaw<WithIdentifier<Endpoints, Identifier>, E, R>;
|
|
360
387
|
/**
|
|
361
|
-
* Extracts the decoded success value type for the endpoint with the specified
|
|
362
|
-
* in an endpoint union.
|
|
388
|
+
* Extracts the decoded success value type for the endpoint with the specified
|
|
389
|
+
* identifier in an endpoint union.
|
|
363
390
|
*
|
|
364
391
|
* @category models
|
|
365
392
|
* @since 4.0.0
|
|
366
393
|
*/
|
|
367
|
-
export type
|
|
394
|
+
export type SuccessWithIdentifier<Endpoints extends Constraint, Identifier extends string> = Success<WithIdentifier<Endpoints, Identifier>> extends infer S ? SuccessType<S> : never;
|
|
368
395
|
/**
|
|
369
|
-
* Computes the full error value union for the endpoint with the specified
|
|
370
|
-
* an endpoint union.
|
|
396
|
+
* Computes the full error value union for the endpoint with the specified
|
|
397
|
+
* identifier in an endpoint union.
|
|
371
398
|
*
|
|
372
399
|
* @category models
|
|
373
400
|
* @since 4.0.0
|
|
374
401
|
*/
|
|
375
|
-
export type
|
|
402
|
+
export type ErrorsWithIdentifier<Endpoints extends Constraint, Identifier extends string> = Errors<WithIdentifier<Endpoints, Identifier>>;
|
|
376
403
|
/**
|
|
377
404
|
* Computes the server-side service requirements for the endpoint with the
|
|
378
|
-
* specified
|
|
405
|
+
* specified identifier in an endpoint union.
|
|
379
406
|
*
|
|
380
407
|
* @category models
|
|
381
408
|
* @since 4.0.0
|
|
382
409
|
*/
|
|
383
|
-
export type
|
|
410
|
+
export type ServerServicesWithIdentifier<Endpoints extends Constraint, Identifier extends string> = ServerServices<WithIdentifier<Endpoints, Identifier>>;
|
|
384
411
|
/**
|
|
385
|
-
* Extracts the middleware identifiers for the endpoint with the specified
|
|
386
|
-
* an endpoint union.
|
|
412
|
+
* Extracts the middleware identifiers for the endpoint with the specified
|
|
413
|
+
* identifier in an endpoint union.
|
|
387
414
|
*
|
|
388
415
|
* @category models
|
|
389
416
|
* @since 4.0.0
|
|
390
417
|
*/
|
|
391
|
-
export type
|
|
418
|
+
export type MiddlewareWithIdentifier<Endpoints extends Constraint, Identifier extends string> = Middleware<WithIdentifier<Endpoints, Identifier>>;
|
|
392
419
|
/**
|
|
393
|
-
* Extracts the middleware service requirements for the endpoint with the
|
|
394
|
-
*
|
|
420
|
+
* Extracts the middleware service requirements for the endpoint with the
|
|
421
|
+
* specified identifier in an endpoint union.
|
|
395
422
|
*
|
|
396
423
|
* @category models
|
|
397
424
|
* @since 4.0.0
|
|
398
425
|
*/
|
|
399
|
-
export type
|
|
426
|
+
export type MiddlewareServicesWithIdentifier<Endpoints extends Constraint, Identifier extends string> = MiddlewareServices<WithIdentifier<Endpoints, Identifier>>;
|
|
400
427
|
/**
|
|
401
|
-
* Removes services provided by the HTTP router and the
|
|
402
|
-
* from a service requirement union.
|
|
428
|
+
* Removes services provided by the HTTP router and the selected endpoint's
|
|
429
|
+
* middleware from a service requirement union.
|
|
403
430
|
*
|
|
404
431
|
* @category models
|
|
405
432
|
* @since 4.0.0
|
|
406
433
|
*/
|
|
407
|
-
export type
|
|
434
|
+
export type ExcludeProvidedWithIdentifier<Endpoints extends Constraint, Identifier extends string, R> = ExcludeProvided<WithIdentifier<Endpoints, Identifier>, R>;
|
|
408
435
|
/**
|
|
409
436
|
* Removes services provided by the HTTP router and endpoint middleware from a
|
|
410
437
|
* service requirement union.
|
|
@@ -412,7 +439,7 @@ export type ExcludeProvidedWithName<Endpoints extends Any, Name extends string,
|
|
|
412
439
|
* @category models
|
|
413
440
|
* @since 4.0.0
|
|
414
441
|
*/
|
|
415
|
-
export type ExcludeProvided<Endpoint extends
|
|
442
|
+
export type ExcludeProvided<Endpoint extends Constraint, R> = Exclude<R, HttpRouter.Provided | HttpApiMiddleware.Provides<Middleware<Endpoint>>>;
|
|
416
443
|
/**
|
|
417
444
|
* Returns an endpoint type with the supplied path prefix prepended while
|
|
418
445
|
* preserving the endpoint's schemas, method, errors, and middleware.
|
|
@@ -420,15 +447,7 @@ export type ExcludeProvided<Endpoint extends Any, R> = Exclude<R, HttpRouter.Pro
|
|
|
420
447
|
* @category models
|
|
421
448
|
* @since 4.0.0
|
|
422
449
|
*/
|
|
423
|
-
export type AddPrefix<Endpoint
|
|
424
|
-
/**
|
|
425
|
-
* Returns an endpoint type with an additional error schema added to the endpoint's
|
|
426
|
-
* existing error schema union.
|
|
427
|
-
*
|
|
428
|
-
* @category models
|
|
429
|
-
* @since 4.0.0
|
|
430
|
-
*/
|
|
431
|
-
export type AddError<Endpoint extends Any, E extends Schema.Top> = Endpoint extends HttpApiEndpoint<infer _Name, infer _Method, infer _Path, infer _Params, infer _Query, infer _Payload, infer _Headers, infer _Success, infer _Error, infer _M, infer _MR> ? HttpApiEndpoint<_Name, _Method, _Path, _Params, _Query, _Payload, _Headers, _Success, _Error | E, _M, _MR> : never;
|
|
450
|
+
export type AddPrefix<Endpoint, Prefix extends HttpRouter.PathInput> = Endpoint extends HttpApiEndpoint<infer _Identifier, infer _Method, infer _Path, infer _Params, infer _Query, infer _Payload, infer _Headers, infer _Success, infer _Error, infer _M, infer _MR> ? HttpApiEndpoint<_Identifier, _Method, `${Prefix}${_Path}`, _Params, _Query, _Payload, _Headers, _Success, _Error, _M, _MR> : never;
|
|
432
451
|
/**
|
|
433
452
|
* Returns an endpoint type with additional middleware applied and the endpoint's
|
|
434
453
|
* middleware service requirements updated accordingly.
|
|
@@ -436,7 +455,7 @@ export type AddError<Endpoint extends Any, E extends Schema.Top> = Endpoint exte
|
|
|
436
455
|
* @category models
|
|
437
456
|
* @since 4.0.0
|
|
438
457
|
*/
|
|
439
|
-
export type AddMiddleware<Endpoint
|
|
458
|
+
export type AddMiddleware<Endpoint, M extends HttpApiMiddleware.AnyId> = Endpoint extends HttpApiEndpoint<infer _Identifier, infer _Method, infer _Path, infer _Params, infer _Query, infer _Payload, infer _Headers, infer _Success, infer _Error, infer _M, infer _MR> ? HttpApiEndpoint<_Identifier, _Method, _Path, _Params, _Query, _Payload, _Headers, _Success, _Error, _M | M, HttpApiMiddleware.ApplyServices<M, _MR>> : never;
|
|
440
459
|
/**
|
|
441
460
|
* Constraint for path parameter schemas: each parameter must encode to
|
|
442
461
|
* `string | undefined`, or the schema must encode to a record of those values.
|
|
@@ -503,7 +522,7 @@ type ErrorNoStream<S extends ErrorConstraint> = [
|
|
|
503
522
|
] extends [never] ? S : never;
|
|
504
523
|
/**
|
|
505
524
|
* Creates endpoint constructors for a specific HTTP method. The resulting
|
|
506
|
-
* constructor builds an `HttpApiEndpoint` from
|
|
525
|
+
* constructor builds an `HttpApiEndpoint` from an identifier, path, and optional request
|
|
507
526
|
* and response schemas, applying automatic JSON or string-tree codecs unless
|
|
508
527
|
* `disableCodecs` is enabled.
|
|
509
528
|
*
|
|
@@ -511,7 +530,7 @@ type ErrorNoStream<S extends ErrorConstraint> = [
|
|
|
511
530
|
* @since 4.0.0
|
|
512
531
|
*/
|
|
513
532
|
export declare const make: <Method extends HttpMethod>(method: Method) => {
|
|
514
|
-
<const
|
|
533
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<Method> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
515
534
|
readonly disableCodecs?: false | undefined;
|
|
516
535
|
readonly params?: Params | undefined;
|
|
517
536
|
readonly query?: Query | undefined;
|
|
@@ -519,36 +538,18 @@ export declare const make: <Method extends HttpMethod>(method: Method) => {
|
|
|
519
538
|
readonly payload?: Payload | undefined;
|
|
520
539
|
readonly success?: Success | undefined;
|
|
521
540
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
522
|
-
}): HttpApiEndpoint<
|
|
523
|
-
<const
|
|
541
|
+
}): HttpApiEndpoint<Identifier, Method, Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, Method extends HttpMethod.WithBody ? ToJsonCodec<ToSchema<Payload>> : ToStringTreeCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends ReadonlyArray<Schema.Constraint> ? Error[number] : Error>>;
|
|
542
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<Method> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
524
543
|
readonly disableCodecs: true;
|
|
525
|
-
readonly params?:
|
|
526
|
-
readonly query?:
|
|
527
|
-
readonly headers?:
|
|
528
|
-
readonly payload?:
|
|
529
|
-
readonly success?:
|
|
530
|
-
readonly error?: (
|
|
531
|
-
}): HttpApiEndpoint<
|
|
544
|
+
readonly params?: Params | undefined;
|
|
545
|
+
readonly query?: Query | undefined;
|
|
546
|
+
readonly headers?: Headers | undefined;
|
|
547
|
+
readonly payload?: Payload | undefined;
|
|
548
|
+
readonly success?: Success | undefined;
|
|
549
|
+
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
550
|
+
}): HttpApiEndpoint<Identifier, Method, Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends ReadonlyArray<Schema.Constraint> ? Error[number] : Error>;
|
|
532
551
|
};
|
|
533
|
-
type
|
|
534
|
-
/**
|
|
535
|
-
* A schema codec that decodes and encodes the schema's value type through JSON
|
|
536
|
-
* transport values.
|
|
537
|
-
*
|
|
538
|
-
* @category Codecs
|
|
539
|
-
* @since 4.0.0
|
|
540
|
-
*/
|
|
541
|
-
export interface Json<S extends Schema.Constraint> extends Schema.Codec<S["Type"], Schema.Json, S["DecodingServices"], S["EncodingServices"]> {
|
|
542
|
-
}
|
|
543
|
-
/**
|
|
544
|
-
* A schema codec that decodes and encodes the schema's value type through
|
|
545
|
-
* `Schema.StringTree` transport values.
|
|
546
|
-
*
|
|
547
|
-
* @category Codecs
|
|
548
|
-
* @since 4.0.0
|
|
549
|
-
*/
|
|
550
|
-
export interface StringTree<S extends Schema.Constraint> extends Schema.Codec<S["Type"], Schema.StringTree, S["DecodingServices"], S["EncodingServices"]> {
|
|
551
|
-
}
|
|
552
|
+
type ToSchema<S extends Schema.Struct.Fields | Schema.Constraint | ReadonlyArray<Schema.Constraint>> = S extends Schema.Struct.Fields ? Schema.Struct<S> : S extends ReadonlyArray<Schema.Constraint> ? S[number] : S;
|
|
552
553
|
/**
|
|
553
554
|
* Creates a `GET` endpoint declaration.
|
|
554
555
|
*
|
|
@@ -556,7 +557,7 @@ export interface StringTree<S extends Schema.Constraint> extends Schema.Codec<S[
|
|
|
556
557
|
* @since 4.0.0
|
|
557
558
|
*/
|
|
558
559
|
export declare const get: {
|
|
559
|
-
<const
|
|
560
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"GET"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
560
561
|
readonly disableCodecs?: false | undefined;
|
|
561
562
|
readonly params?: Params | undefined;
|
|
562
563
|
readonly query?: Query | undefined;
|
|
@@ -564,8 +565,8 @@ export declare const get: {
|
|
|
564
565
|
readonly payload?: Payload | undefined;
|
|
565
566
|
readonly success?: Success | undefined;
|
|
566
567
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
567
|
-
} | undefined): HttpApiEndpoint<
|
|
568
|
-
<const
|
|
568
|
+
} | undefined): HttpApiEndpoint<Identifier, "GET", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToStringTreeCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
569
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"GET"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
569
570
|
readonly disableCodecs: true;
|
|
570
571
|
readonly params?: Params | undefined;
|
|
571
572
|
readonly query?: Query | undefined;
|
|
@@ -573,7 +574,7 @@ export declare const get: {
|
|
|
573
574
|
readonly payload?: Payload | undefined;
|
|
574
575
|
readonly success?: Success | undefined;
|
|
575
576
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
576
|
-
} | undefined): HttpApiEndpoint<
|
|
577
|
+
} | undefined): HttpApiEndpoint<Identifier, "GET", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
577
578
|
};
|
|
578
579
|
/**
|
|
579
580
|
* Creates a `POST` endpoint declaration.
|
|
@@ -582,7 +583,7 @@ export declare const get: {
|
|
|
582
583
|
* @since 4.0.0
|
|
583
584
|
*/
|
|
584
585
|
export declare const post: {
|
|
585
|
-
<const
|
|
586
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"POST"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
586
587
|
readonly disableCodecs?: false | undefined;
|
|
587
588
|
readonly params?: Params | undefined;
|
|
588
589
|
readonly query?: Query | undefined;
|
|
@@ -590,8 +591,8 @@ export declare const post: {
|
|
|
590
591
|
readonly payload?: Payload | undefined;
|
|
591
592
|
readonly success?: Success | undefined;
|
|
592
593
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
593
|
-
} | undefined): HttpApiEndpoint<
|
|
594
|
-
<const
|
|
594
|
+
} | undefined): HttpApiEndpoint<Identifier, "POST", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToJsonCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
595
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"POST"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
595
596
|
readonly disableCodecs: true;
|
|
596
597
|
readonly params?: Params | undefined;
|
|
597
598
|
readonly query?: Query | undefined;
|
|
@@ -599,7 +600,7 @@ export declare const post: {
|
|
|
599
600
|
readonly payload?: Payload | undefined;
|
|
600
601
|
readonly success?: Success | undefined;
|
|
601
602
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
602
|
-
} | undefined): HttpApiEndpoint<
|
|
603
|
+
} | undefined): HttpApiEndpoint<Identifier, "POST", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
603
604
|
};
|
|
604
605
|
/**
|
|
605
606
|
* Creates a `PUT` endpoint declaration.
|
|
@@ -608,7 +609,7 @@ export declare const post: {
|
|
|
608
609
|
* @since 4.0.0
|
|
609
610
|
*/
|
|
610
611
|
export declare const put: {
|
|
611
|
-
<const
|
|
612
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"PUT"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
612
613
|
readonly disableCodecs?: false | undefined;
|
|
613
614
|
readonly params?: Params | undefined;
|
|
614
615
|
readonly query?: Query | undefined;
|
|
@@ -616,8 +617,8 @@ export declare const put: {
|
|
|
616
617
|
readonly payload?: Payload | undefined;
|
|
617
618
|
readonly success?: Success | undefined;
|
|
618
619
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
619
|
-
} | undefined): HttpApiEndpoint<
|
|
620
|
-
<const
|
|
620
|
+
} | undefined): HttpApiEndpoint<Identifier, "PUT", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToJsonCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
621
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"PUT"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
621
622
|
readonly disableCodecs: true;
|
|
622
623
|
readonly params?: Params | undefined;
|
|
623
624
|
readonly query?: Query | undefined;
|
|
@@ -625,7 +626,7 @@ export declare const put: {
|
|
|
625
626
|
readonly payload?: Payload | undefined;
|
|
626
627
|
readonly success?: Success | undefined;
|
|
627
628
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
628
|
-
} | undefined): HttpApiEndpoint<
|
|
629
|
+
} | undefined): HttpApiEndpoint<Identifier, "PUT", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
629
630
|
};
|
|
630
631
|
/**
|
|
631
632
|
* Creates a `PATCH` endpoint declaration.
|
|
@@ -634,7 +635,7 @@ export declare const put: {
|
|
|
634
635
|
* @since 4.0.0
|
|
635
636
|
*/
|
|
636
637
|
export declare const patch: {
|
|
637
|
-
<const
|
|
638
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"PATCH"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
638
639
|
readonly disableCodecs?: false | undefined;
|
|
639
640
|
readonly params?: Params | undefined;
|
|
640
641
|
readonly query?: Query | undefined;
|
|
@@ -642,8 +643,8 @@ export declare const patch: {
|
|
|
642
643
|
readonly payload?: Payload | undefined;
|
|
643
644
|
readonly success?: Success | undefined;
|
|
644
645
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
645
|
-
} | undefined): HttpApiEndpoint<
|
|
646
|
-
<const
|
|
646
|
+
} | undefined): HttpApiEndpoint<Identifier, "PATCH", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToJsonCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
647
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"PATCH"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
647
648
|
readonly disableCodecs: true;
|
|
648
649
|
readonly params?: Params | undefined;
|
|
649
650
|
readonly query?: Query | undefined;
|
|
@@ -651,10 +652,10 @@ export declare const patch: {
|
|
|
651
652
|
readonly payload?: Payload | undefined;
|
|
652
653
|
readonly success?: Success | undefined;
|
|
653
654
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
654
|
-
} | undefined): HttpApiEndpoint<
|
|
655
|
+
} | undefined): HttpApiEndpoint<Identifier, "PATCH", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
655
656
|
};
|
|
656
657
|
declare const del: {
|
|
657
|
-
<const
|
|
658
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"DELETE"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
658
659
|
readonly disableCodecs?: false | undefined;
|
|
659
660
|
readonly params?: Params | undefined;
|
|
660
661
|
readonly query?: Query | undefined;
|
|
@@ -662,8 +663,8 @@ declare const del: {
|
|
|
662
663
|
readonly payload?: Payload | undefined;
|
|
663
664
|
readonly success?: Success | undefined;
|
|
664
665
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
665
|
-
} | undefined): HttpApiEndpoint<
|
|
666
|
-
<const
|
|
666
|
+
} | undefined): HttpApiEndpoint<Identifier, "DELETE", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToJsonCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
667
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"DELETE"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
667
668
|
readonly disableCodecs: true;
|
|
668
669
|
readonly params?: Params | undefined;
|
|
669
670
|
readonly query?: Query | undefined;
|
|
@@ -671,7 +672,7 @@ declare const del: {
|
|
|
671
672
|
readonly payload?: Payload | undefined;
|
|
672
673
|
readonly success?: Success | undefined;
|
|
673
674
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
674
|
-
} | undefined): HttpApiEndpoint<
|
|
675
|
+
} | undefined): HttpApiEndpoint<Identifier, "DELETE", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
675
676
|
};
|
|
676
677
|
export {
|
|
677
678
|
/**
|
|
@@ -688,7 +689,7 @@ del as delete };
|
|
|
688
689
|
* @since 4.0.0
|
|
689
690
|
*/
|
|
690
691
|
export declare const head: {
|
|
691
|
-
<const
|
|
692
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"HEAD"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
692
693
|
readonly disableCodecs?: false | undefined;
|
|
693
694
|
readonly params?: Params | undefined;
|
|
694
695
|
readonly query?: Query | undefined;
|
|
@@ -696,8 +697,8 @@ export declare const head: {
|
|
|
696
697
|
readonly payload?: Payload | undefined;
|
|
697
698
|
readonly success?: Success | undefined;
|
|
698
699
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
699
|
-
} | undefined): HttpApiEndpoint<
|
|
700
|
-
<const
|
|
700
|
+
} | undefined): HttpApiEndpoint<Identifier, "HEAD", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToStringTreeCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
701
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"HEAD"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
701
702
|
readonly disableCodecs: true;
|
|
702
703
|
readonly params?: Params | undefined;
|
|
703
704
|
readonly query?: Query | undefined;
|
|
@@ -705,7 +706,7 @@ export declare const head: {
|
|
|
705
706
|
readonly payload?: Payload | undefined;
|
|
706
707
|
readonly success?: Success | undefined;
|
|
707
708
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
708
|
-
} | undefined): HttpApiEndpoint<
|
|
709
|
+
} | undefined): HttpApiEndpoint<Identifier, "HEAD", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
709
710
|
};
|
|
710
711
|
/**
|
|
711
712
|
* Creates an `OPTIONS` endpoint declaration.
|
|
@@ -714,7 +715,7 @@ export declare const head: {
|
|
|
714
715
|
* @since 4.0.0
|
|
715
716
|
*/
|
|
716
717
|
export declare const options: {
|
|
717
|
-
<const
|
|
718
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends Schema.Top | Schema.Struct.Fields = never, Query extends Schema.Top | Schema.Struct.Fields = never, Payload extends PayloadConstraintCodecs<"OPTIONS"> = never, Headers extends Schema.Top | Schema.Struct.Fields = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never>(identifier: Identifier, path: Path, options?: {
|
|
718
719
|
readonly disableCodecs?: false | undefined;
|
|
719
720
|
readonly params?: Params | undefined;
|
|
720
721
|
readonly query?: Query | undefined;
|
|
@@ -722,8 +723,8 @@ export declare const options: {
|
|
|
722
723
|
readonly payload?: Payload | undefined;
|
|
723
724
|
readonly success?: Success | undefined;
|
|
724
725
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
725
|
-
} | undefined): HttpApiEndpoint<
|
|
726
|
-
<const
|
|
726
|
+
} | undefined): HttpApiEndpoint<Identifier, "OPTIONS", Path, ToStringTreeCodec<Params>, ToStringTreeCodec<Query>, ToStringTreeCodec<ToSchema<Payload>>, ToStringTreeCodec<Headers>, ToSuccessCodec<Success>, ToJsonCodec<Error extends readonly Schema.Constraint[] ? Error[number] : Error>, never, never>;
|
|
727
|
+
<const Identifier extends string, const Path extends HttpRouter.PathInput, Params extends ParamsConstraint = never, Query extends QueryConstraint = never, Payload extends PayloadConstraint<"OPTIONS"> = never, Headers extends HeadersConstraint = never, const Success extends SuccessConstraint = HttpApiSchema.NoContent, const Error extends ErrorConstraint = never>(identifier: Identifier, path: Path, options?: {
|
|
727
728
|
readonly disableCodecs: true;
|
|
728
729
|
readonly params?: Params | undefined;
|
|
729
730
|
readonly query?: Query | undefined;
|
|
@@ -731,6 +732,6 @@ export declare const options: {
|
|
|
731
732
|
readonly payload?: Payload | undefined;
|
|
732
733
|
readonly success?: Success | undefined;
|
|
733
734
|
readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined;
|
|
734
|
-
} | undefined): HttpApiEndpoint<
|
|
735
|
+
} | undefined): HttpApiEndpoint<Identifier, "OPTIONS", Path, Params extends Schema.Struct.Fields ? Schema.Struct<Params> : Params, Query extends Schema.Struct.Fields ? Schema.Struct<Query> : Query, ToSchema<Payload>, ToSchema<Headers>, UnwrapReadonlyArray<Success>, Error extends readonly Schema.Constraint[] ? Error[number] : Error, never, never>;
|
|
735
736
|
};
|
|
736
737
|
//# sourceMappingURL=HttpApiEndpoint.d.ts.map
|