@effect/platform 0.68.6 → 0.69.1
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/HttpApiMiddleware/package.json +6 -0
- package/README.md +306 -233
- package/dist/cjs/Headers.js +7 -2
- package/dist/cjs/Headers.js.map +1 -1
- package/dist/cjs/HttpApi.js +90 -78
- package/dist/cjs/HttpApi.js.map +1 -1
- package/dist/cjs/HttpApiBuilder.js +245 -255
- package/dist/cjs/HttpApiBuilder.js.map +1 -1
- package/dist/cjs/HttpApiClient.js +64 -59
- package/dist/cjs/HttpApiClient.js.map +1 -1
- package/dist/cjs/HttpApiEndpoint.js +74 -109
- package/dist/cjs/HttpApiEndpoint.js.map +1 -1
- package/dist/cjs/HttpApiError.js +3 -4
- package/dist/cjs/HttpApiError.js.map +1 -1
- package/dist/cjs/HttpApiGroup.js +103 -100
- package/dist/cjs/HttpApiGroup.js.map +1 -1
- package/dist/cjs/HttpApiMiddleware.js +67 -0
- package/dist/cjs/HttpApiMiddleware.js.map +1 -0
- package/dist/cjs/HttpApiSchema.js +33 -7
- package/dist/cjs/HttpApiSchema.js.map +1 -1
- package/dist/cjs/HttpApiSecurity.js +2 -2
- package/dist/cjs/HttpApiSecurity.js.map +1 -1
- package/dist/cjs/HttpApiSwagger.js +3 -1
- package/dist/cjs/HttpApiSwagger.js.map +1 -1
- package/dist/cjs/HttpBody.js.map +1 -1
- package/dist/cjs/HttpIncomingMessage.js +5 -1
- package/dist/cjs/HttpIncomingMessage.js.map +1 -1
- package/dist/cjs/HttpServer.js +12 -1
- package/dist/cjs/HttpServer.js.map +1 -1
- package/dist/cjs/HttpServerRespondable.js +1 -1
- package/dist/cjs/HttpServerRespondable.js.map +1 -1
- package/dist/cjs/OpenApi.js +102 -63
- package/dist/cjs/OpenApi.js.map +1 -1
- package/dist/cjs/OpenApiJsonSchema.js +58 -47
- package/dist/cjs/OpenApiJsonSchema.js.map +1 -1
- package/dist/cjs/Transferable.js +2 -2
- package/dist/cjs/Transferable.js.map +1 -1
- package/dist/cjs/UrlParams.js +5 -1
- package/dist/cjs/UrlParams.js.map +1 -1
- package/dist/cjs/Worker.js.map +1 -1
- package/dist/cjs/WorkerError.js +1 -5
- package/dist/cjs/WorkerError.js.map +1 -1
- package/dist/cjs/WorkerRunner.js.map +1 -1
- package/dist/cjs/index.js +3 -1
- package/dist/cjs/internal/httpBody.js +1 -1
- package/dist/cjs/internal/httpBody.js.map +1 -1
- package/dist/cjs/internal/httpClientRequest.js.map +1 -1
- package/dist/cjs/internal/httpClientResponse.js +1 -1
- package/dist/cjs/internal/httpClientResponse.js.map +1 -1
- package/dist/cjs/internal/httpRouter.js +1 -1
- package/dist/cjs/internal/httpRouter.js.map +1 -1
- package/dist/cjs/internal/httpServer.js +7 -1
- package/dist/cjs/internal/httpServer.js.map +1 -1
- package/dist/cjs/internal/httpServerRequest.js +1 -1
- package/dist/cjs/internal/httpServerRequest.js.map +1 -1
- package/dist/cjs/internal/httpServerResponse.js.map +1 -1
- package/dist/cjs/internal/keyValueStore.js +1 -1
- package/dist/cjs/internal/keyValueStore.js.map +1 -1
- package/dist/cjs/internal/multipart.js +1 -1
- package/dist/cjs/internal/multipart.js.map +1 -1
- package/dist/cjs/internal/worker.js +6 -7
- package/dist/cjs/internal/worker.js.map +1 -1
- package/dist/cjs/internal/workerRunner.js +3 -4
- package/dist/cjs/internal/workerRunner.js.map +1 -1
- package/dist/dts/Headers.d.ts +4 -6
- package/dist/dts/Headers.d.ts.map +1 -1
- package/dist/dts/HttpApi.d.ts +64 -140
- package/dist/dts/HttpApi.d.ts.map +1 -1
- package/dist/dts/HttpApiBuilder.d.ts +86 -167
- package/dist/dts/HttpApiBuilder.d.ts.map +1 -1
- package/dist/dts/HttpApiClient.d.ts +34 -11
- package/dist/dts/HttpApiClient.d.ts.map +1 -1
- package/dist/dts/HttpApiEndpoint.d.ts +119 -273
- package/dist/dts/HttpApiEndpoint.d.ts.map +1 -1
- package/dist/dts/HttpApiError.d.ts +5 -2
- package/dist/dts/HttpApiError.d.ts.map +1 -1
- package/dist/dts/HttpApiGroup.d.ts +96 -194
- package/dist/dts/HttpApiGroup.d.ts.map +1 -1
- package/dist/dts/HttpApiMiddleware.d.ts +228 -0
- package/dist/dts/HttpApiMiddleware.d.ts.map +1 -0
- package/dist/dts/HttpApiSchema.d.ts +6 -2
- package/dist/dts/HttpApiSchema.d.ts.map +1 -1
- package/dist/dts/HttpApiSecurity.d.ts +1 -1
- package/dist/dts/HttpApiSecurity.d.ts.map +1 -1
- package/dist/dts/HttpApiSwagger.d.ts +2 -2
- package/dist/dts/HttpApiSwagger.d.ts.map +1 -1
- package/dist/dts/HttpBody.d.ts +2 -2
- package/dist/dts/HttpBody.d.ts.map +1 -1
- package/dist/dts/HttpClientRequest.d.ts +2 -2
- package/dist/dts/HttpClientRequest.d.ts.map +1 -1
- package/dist/dts/HttpClientResponse.d.ts +3 -3
- package/dist/dts/HttpClientResponse.d.ts.map +1 -1
- package/dist/dts/HttpIncomingMessage.d.ts +3 -3
- package/dist/dts/HttpIncomingMessage.d.ts.map +1 -1
- package/dist/dts/HttpRouter.d.ts +3 -3
- package/dist/dts/HttpRouter.d.ts.map +1 -1
- package/dist/dts/HttpServer.d.ts +15 -0
- package/dist/dts/HttpServer.d.ts.map +1 -1
- package/dist/dts/HttpServerRequest.d.ts +3 -3
- package/dist/dts/HttpServerRequest.d.ts.map +1 -1
- package/dist/dts/HttpServerRespondable.d.ts.map +1 -1
- package/dist/dts/HttpServerResponse.d.ts +2 -2
- package/dist/dts/HttpServerResponse.d.ts.map +1 -1
- package/dist/dts/KeyValueStore.d.ts +2 -2
- package/dist/dts/KeyValueStore.d.ts.map +1 -1
- package/dist/dts/Multipart.d.ts +3 -3
- package/dist/dts/Multipart.d.ts.map +1 -1
- package/dist/dts/OpenApi.d.ts +17 -39
- package/dist/dts/OpenApi.d.ts.map +1 -1
- package/dist/dts/OpenApiJsonSchema.d.ts +10 -5
- package/dist/dts/OpenApiJsonSchema.d.ts.map +1 -1
- package/dist/dts/Transferable.d.ts +4 -1
- package/dist/dts/Transferable.d.ts.map +1 -1
- package/dist/dts/UrlParams.d.ts +3 -6
- package/dist/dts/UrlParams.d.ts.map +1 -1
- package/dist/dts/Worker.d.ts +7 -8
- package/dist/dts/Worker.d.ts.map +1 -1
- package/dist/dts/WorkerError.d.ts +1 -1
- package/dist/dts/WorkerError.d.ts.map +1 -1
- package/dist/dts/WorkerRunner.d.ts +2 -3
- package/dist/dts/WorkerRunner.d.ts.map +1 -1
- package/dist/dts/index.d.ts +4 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/internal/httpRouter.d.ts.map +1 -1
- package/dist/esm/Headers.js +7 -2
- package/dist/esm/Headers.js.map +1 -1
- package/dist/esm/HttpApi.js +88 -77
- package/dist/esm/HttpApi.js.map +1 -1
- package/dist/esm/HttpApiBuilder.js +238 -244
- package/dist/esm/HttpApiBuilder.js.map +1 -1
- package/dist/esm/HttpApiClient.js +64 -59
- package/dist/esm/HttpApiClient.js.map +1 -1
- package/dist/esm/HttpApiEndpoint.js +73 -106
- package/dist/esm/HttpApiEndpoint.js.map +1 -1
- package/dist/esm/HttpApiError.js +3 -4
- package/dist/esm/HttpApiError.js.map +1 -1
- package/dist/esm/HttpApiGroup.js +102 -99
- package/dist/esm/HttpApiGroup.js.map +1 -1
- package/dist/esm/HttpApiMiddleware.js +56 -0
- package/dist/esm/HttpApiMiddleware.js.map +1 -0
- package/dist/esm/HttpApiSchema.js +31 -5
- package/dist/esm/HttpApiSchema.js.map +1 -1
- package/dist/esm/HttpApiSecurity.js +1 -1
- package/dist/esm/HttpApiSecurity.js.map +1 -1
- package/dist/esm/HttpApiSwagger.js +4 -2
- package/dist/esm/HttpApiSwagger.js.map +1 -1
- package/dist/esm/HttpBody.js.map +1 -1
- package/dist/esm/HttpIncomingMessage.js +4 -1
- package/dist/esm/HttpIncomingMessage.js.map +1 -1
- package/dist/esm/HttpServer.js +11 -0
- package/dist/esm/HttpServer.js.map +1 -1
- package/dist/esm/HttpServerRespondable.js +1 -1
- package/dist/esm/HttpServerRespondable.js.map +1 -1
- package/dist/esm/OpenApi.js +97 -59
- package/dist/esm/OpenApi.js.map +1 -1
- package/dist/esm/OpenApiJsonSchema.js +56 -46
- package/dist/esm/OpenApiJsonSchema.js.map +1 -1
- package/dist/esm/Transferable.js +2 -2
- package/dist/esm/Transferable.js.map +1 -1
- package/dist/esm/UrlParams.js +4 -1
- package/dist/esm/UrlParams.js.map +1 -1
- package/dist/esm/Worker.js.map +1 -1
- package/dist/esm/WorkerError.js +1 -4
- package/dist/esm/WorkerError.js.map +1 -1
- package/dist/esm/WorkerRunner.js.map +1 -1
- package/dist/esm/index.js +4 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/internal/httpBody.js +1 -1
- package/dist/esm/internal/httpBody.js.map +1 -1
- package/dist/esm/internal/httpClientRequest.js.map +1 -1
- package/dist/esm/internal/httpClientResponse.js +1 -1
- package/dist/esm/internal/httpClientResponse.js.map +1 -1
- package/dist/esm/internal/httpRouter.js +1 -1
- package/dist/esm/internal/httpRouter.js.map +1 -1
- package/dist/esm/internal/httpServer.js +6 -0
- package/dist/esm/internal/httpServer.js.map +1 -1
- package/dist/esm/internal/httpServerRequest.js +1 -1
- package/dist/esm/internal/httpServerRequest.js.map +1 -1
- package/dist/esm/internal/httpServerResponse.js.map +1 -1
- package/dist/esm/internal/keyValueStore.js +1 -1
- package/dist/esm/internal/keyValueStore.js.map +1 -1
- package/dist/esm/internal/multipart.js +1 -1
- package/dist/esm/internal/multipart.js.map +1 -1
- package/dist/esm/internal/worker.js +6 -7
- package/dist/esm/internal/worker.js.map +1 -1
- package/dist/esm/internal/workerRunner.js +3 -4
- package/dist/esm/internal/workerRunner.js.map +1 -1
- package/package.json +10 -3
- package/src/Headers.ts +12 -4
- package/src/HttpApi.ts +183 -258
- package/src/HttpApiBuilder.ts +534 -481
- package/src/HttpApiClient.ts +163 -112
- package/src/HttpApiEndpoint.ts +443 -564
- package/src/HttpApiError.ts +4 -6
- package/src/HttpApiGroup.ts +277 -325
- package/src/HttpApiMiddleware.ts +317 -0
- package/src/HttpApiSchema.ts +39 -2
- package/src/HttpApiSecurity.ts +1 -1
- package/src/HttpApiSwagger.ts +3 -3
- package/src/HttpBody.ts +2 -2
- package/src/HttpClientRequest.ts +2 -2
- package/src/HttpClientResponse.ts +3 -3
- package/src/HttpIncomingMessage.ts +3 -3
- package/src/HttpRouter.ts +3 -3
- package/src/HttpServer.ts +21 -0
- package/src/HttpServerRequest.ts +3 -3
- package/src/HttpServerRespondable.ts +1 -1
- package/src/HttpServerResponse.ts +2 -2
- package/src/KeyValueStore.ts +2 -2
- package/src/Multipart.ts +3 -3
- package/src/OpenApi.ts +113 -104
- package/src/OpenApiJsonSchema.ts +67 -53
- package/src/Transferable.ts +2 -2
- package/src/UrlParams.ts +3 -3
- package/src/Worker.ts +7 -8
- package/src/WorkerError.ts +1 -1
- package/src/WorkerRunner.ts +2 -3
- package/src/index.ts +5 -0
- package/src/internal/httpBody.ts +2 -2
- package/src/internal/httpClientRequest.ts +2 -2
- package/src/internal/httpClientResponse.ts +3 -3
- package/src/internal/httpRouter.ts +2 -2
- package/src/internal/httpServer.ts +13 -0
- package/src/internal/httpServerRequest.ts +3 -3
- package/src/internal/httpServerResponse.ts +2 -2
- package/src/internal/keyValueStore.ts +1 -1
- package/src/internal/multipart.ts +3 -3
- package/src/internal/worker.ts +6 -7
- package/src/internal/workerRunner.ts +3 -4
package/dist/dts/HttpApi.d.ts
CHANGED
|
@@ -1,17 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @since 1.0.0
|
|
3
3
|
*/
|
|
4
|
-
import * as AST from "@effect/schema/AST";
|
|
5
|
-
import type * as Schema from "@effect/schema/Schema";
|
|
6
|
-
import * as Chunk from "effect/Chunk";
|
|
7
4
|
import * as Context from "effect/Context";
|
|
5
|
+
import * as HashMap from "effect/HashMap";
|
|
6
|
+
import * as HashSet from "effect/HashSet";
|
|
8
7
|
import * as Option from "effect/Option";
|
|
9
|
-
import type
|
|
10
|
-
import * as
|
|
11
|
-
import * as
|
|
12
|
-
import * as
|
|
8
|
+
import { type Pipeable } from "effect/Pipeable";
|
|
9
|
+
import type * as Schema from "effect/Schema";
|
|
10
|
+
import * as AST from "effect/SchemaAST";
|
|
11
|
+
import type * as HttpApiEndpoint from "./HttpApiEndpoint.js";
|
|
12
|
+
import { HttpApiDecodeError } from "./HttpApiError.js";
|
|
13
|
+
import type * as HttpApiGroup from "./HttpApiGroup.js";
|
|
14
|
+
import type * as HttpApiMiddleware from "./HttpApiMiddleware.js";
|
|
13
15
|
import type { HttpMethod } from "./HttpMethod.js";
|
|
14
|
-
import type
|
|
16
|
+
import type { PathInput } from "./HttpRouter.js";
|
|
15
17
|
/**
|
|
16
18
|
* @since 1.0.0
|
|
17
19
|
* @category type ids
|
|
@@ -26,167 +28,89 @@ export type TypeId = typeof TypeId;
|
|
|
26
28
|
* @since 1.0.0
|
|
27
29
|
* @category guards
|
|
28
30
|
*/
|
|
29
|
-
export declare const isHttpApi: (u: unknown) => u is HttpApi
|
|
31
|
+
export declare const isHttpApi: (u: unknown) => u is HttpApi.Any;
|
|
30
32
|
/**
|
|
31
|
-
* An `HttpApi`
|
|
32
|
-
* represent your
|
|
33
|
+
* An `HttpApi` is a collection of `HttpApiEndpoint`s. You can use an `HttpApi` to
|
|
34
|
+
* represent a portion of your domain.
|
|
35
|
+
*
|
|
36
|
+
* The endpoints can be implemented later using the `HttpApiBuilder.make` api.
|
|
33
37
|
*
|
|
34
38
|
* @since 1.0.0
|
|
35
39
|
* @category models
|
|
36
40
|
*/
|
|
37
|
-
export interface HttpApi<out Groups extends HttpApiGroup.HttpApiGroup.Any = never, in out
|
|
41
|
+
export interface HttpApi<out Groups extends HttpApiGroup.HttpApiGroup.Any = never, in out E = never, out R = never> extends Pipeable {
|
|
38
42
|
new (_: never): {};
|
|
39
43
|
readonly [TypeId]: TypeId;
|
|
40
|
-
readonly groups:
|
|
41
|
-
readonly errorSchema: Schema.Schema<Error, unknown, ErrorR>;
|
|
44
|
+
readonly groups: HashMap.HashMap<string, Groups>;
|
|
42
45
|
readonly annotations: Context.Context<never>;
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
* @since 1.0.0
|
|
46
|
-
* @category tags
|
|
47
|
-
*/
|
|
48
|
-
export declare const HttpApi: Context.Tag<HttpApi.Service, HttpApi.Any>;
|
|
49
|
-
/**
|
|
50
|
-
* @since 1.0.0
|
|
51
|
-
* @category models
|
|
52
|
-
*/
|
|
53
|
-
export declare namespace HttpApi {
|
|
46
|
+
readonly errorSchema: Schema.Schema<E, unknown, R>;
|
|
47
|
+
readonly middlewares: HashSet.HashSet<HttpApiMiddleware.TagClassAny>;
|
|
54
48
|
/**
|
|
55
|
-
*
|
|
56
|
-
* @category models
|
|
57
|
-
*/
|
|
58
|
-
interface Service {
|
|
59
|
-
readonly _: unique symbol;
|
|
60
|
-
}
|
|
61
|
-
/**
|
|
62
|
-
* @since 1.0.0
|
|
63
|
-
* @category models
|
|
49
|
+
* Add an endpoint to the `HttpApi`.
|
|
64
50
|
*/
|
|
65
|
-
|
|
66
|
-
new (_: never): {};
|
|
67
|
-
readonly [TypeId]: TypeId;
|
|
68
|
-
readonly groups: Chunk.Chunk<HttpApiGroup.HttpApiGroup.Any>;
|
|
69
|
-
readonly errorSchema: Schema.Schema.All;
|
|
70
|
-
readonly annotations: Context.Context<never>;
|
|
71
|
-
}
|
|
51
|
+
add<A extends HttpApiGroup.HttpApiGroup.Any>(group: A): HttpApi<Groups | A, E, R>;
|
|
72
52
|
/**
|
|
73
|
-
*
|
|
74
|
-
* @category models
|
|
53
|
+
* Add an global error to the `HttpApi`.
|
|
75
54
|
*/
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
* An empty `HttpApi`. You can use this to start building your `HttpApi`.
|
|
80
|
-
*
|
|
81
|
-
* You can add groups to this `HttpApi` using the `addGroup` function.
|
|
82
|
-
*
|
|
83
|
-
* @since 1.0.0
|
|
84
|
-
* @category constructors
|
|
85
|
-
*/
|
|
86
|
-
export declare const empty: HttpApi;
|
|
87
|
-
/**
|
|
88
|
-
* Add a `HttpApiGroup` to an `HttpApi`.
|
|
89
|
-
*
|
|
90
|
-
* @since 1.0.0
|
|
91
|
-
* @category constructors
|
|
92
|
-
*/
|
|
93
|
-
export declare const addGroup: {
|
|
55
|
+
addError<A, I, RX>(schema: Schema.Schema<A, I, RX>, annotations?: {
|
|
56
|
+
readonly status?: number | undefined;
|
|
57
|
+
}): HttpApi<Groups, E | A, R | RX>;
|
|
94
58
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
* @since 1.0.0
|
|
98
|
-
* @category constructors
|
|
59
|
+
* Prefix all endpoints in the `HttpApi`.
|
|
99
60
|
*/
|
|
100
|
-
|
|
61
|
+
prefix(prefix: PathInput): HttpApi<Groups, E, R>;
|
|
101
62
|
/**
|
|
102
|
-
* Add a
|
|
103
|
-
*
|
|
104
|
-
* @since 1.0.0
|
|
105
|
-
* @category constructors
|
|
63
|
+
* Add a middleware to a `HttpApi`. It will be applied to all endpoints in the
|
|
64
|
+
* `HttpApi`.
|
|
106
65
|
*/
|
|
107
|
-
<
|
|
66
|
+
middleware<I extends HttpApiMiddleware.HttpApiMiddleware.AnyId, S>(middleware: Context.Tag<I, S>): HttpApi<Groups, E | HttpApiMiddleware.HttpApiMiddleware.Error<I>, R | I | HttpApiMiddleware.HttpApiMiddleware.ErrorContext<I>>;
|
|
108
67
|
/**
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
* @since 1.0.0
|
|
112
|
-
* @category constructors
|
|
68
|
+
* Annotate the `HttpApi`.
|
|
113
69
|
*/
|
|
114
|
-
<
|
|
70
|
+
annotate<I, S>(tag: Context.Tag<I, S>, value: S): HttpApi<Groups, E, R>;
|
|
115
71
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
* @since 1.0.0
|
|
119
|
-
* @category constructors
|
|
72
|
+
* Annotate the `HttpApi` with a Context.
|
|
120
73
|
*/
|
|
121
|
-
<
|
|
122
|
-
}
|
|
74
|
+
annotateContext<I>(context: Context.Context<I>): HttpApi<Groups, E, R>;
|
|
75
|
+
}
|
|
76
|
+
declare const Api_base: Context.TagClass<Api, "@effect/platform/HttpApi/Api", {
|
|
77
|
+
readonly api: HttpApi<HttpApiGroup.HttpApiGroup.AnyWithProps>;
|
|
78
|
+
readonly context: Context.Context<never>;
|
|
79
|
+
}>;
|
|
123
80
|
/**
|
|
124
|
-
* Add an error schema to an `HttpApi`, which is shared by all endpoints in the
|
|
125
|
-
* `HttpApi`.
|
|
126
|
-
*
|
|
127
|
-
* Useful for adding error types from middleware or other shared error types.
|
|
128
|
-
*
|
|
129
81
|
* @since 1.0.0
|
|
130
|
-
* @category
|
|
82
|
+
* @category tags
|
|
131
83
|
*/
|
|
132
|
-
export declare
|
|
133
|
-
|
|
134
|
-
* Add an error schema to an `HttpApi`, which is shared by all endpoints in the
|
|
135
|
-
* `HttpApi`.
|
|
136
|
-
*
|
|
137
|
-
* Useful for adding error types from middleware or other shared error types.
|
|
138
|
-
*
|
|
139
|
-
* @since 1.0.0
|
|
140
|
-
* @category errors
|
|
141
|
-
*/
|
|
142
|
-
<A, I, R>(schema: Schema.Schema<A, I, R>, annotations?: {
|
|
143
|
-
readonly status?: number | undefined;
|
|
144
|
-
}): <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR>(self: HttpApi<Groups, Error, ErrorR>) => HttpApi<Groups, Error | A, ErrorR | R>;
|
|
145
|
-
/**
|
|
146
|
-
* Add an error schema to an `HttpApi`, which is shared by all endpoints in the
|
|
147
|
-
* `HttpApi`.
|
|
148
|
-
*
|
|
149
|
-
* Useful for adding error types from middleware or other shared error types.
|
|
150
|
-
*
|
|
151
|
-
* @since 1.0.0
|
|
152
|
-
* @category errors
|
|
153
|
-
*/
|
|
154
|
-
<Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR, A, I, R>(self: HttpApi<Groups, Error, ErrorR>, schema: Schema.Schema<A, I, R>, annotations?: {
|
|
155
|
-
readonly status?: number | undefined;
|
|
156
|
-
}): HttpApi<Groups, Error | A, ErrorR | R>;
|
|
157
|
-
};
|
|
84
|
+
export declare class Api extends Api_base {
|
|
85
|
+
}
|
|
158
86
|
/**
|
|
159
87
|
* @since 1.0.0
|
|
160
|
-
* @category
|
|
88
|
+
* @category models
|
|
161
89
|
*/
|
|
162
|
-
export declare
|
|
90
|
+
export declare namespace HttpApi {
|
|
163
91
|
/**
|
|
164
92
|
* @since 1.0.0
|
|
165
|
-
* @category
|
|
93
|
+
* @category models
|
|
166
94
|
*/
|
|
167
|
-
|
|
95
|
+
interface Any {
|
|
96
|
+
readonly [TypeId]: TypeId;
|
|
97
|
+
}
|
|
168
98
|
/**
|
|
169
99
|
* @since 1.0.0
|
|
170
|
-
* @category
|
|
100
|
+
* @category models
|
|
171
101
|
*/
|
|
172
|
-
|
|
173
|
-
}
|
|
102
|
+
type AnyWithProps = HttpApi<HttpApiGroup.HttpApiGroup.AnyWithProps, any, any>;
|
|
103
|
+
}
|
|
174
104
|
/**
|
|
105
|
+
* An `HttpApi` is a collection of `HttpApiEndpoint`s. You can use an `HttpApi` to
|
|
106
|
+
* represent a portion of your domain.
|
|
107
|
+
*
|
|
108
|
+
* The endpoints can be implemented later using the `HttpApiBuilder.make` api.
|
|
109
|
+
*
|
|
175
110
|
* @since 1.0.0
|
|
176
|
-
* @category
|
|
111
|
+
* @category constructors
|
|
177
112
|
*/
|
|
178
|
-
export declare const
|
|
179
|
-
/**
|
|
180
|
-
* @since 1.0.0
|
|
181
|
-
* @category annotations
|
|
182
|
-
*/
|
|
183
|
-
<I, S>(tag: Context.Tag<I, S>, value: S): <A extends HttpApi.Any>(self: A) => A;
|
|
184
|
-
/**
|
|
185
|
-
* @since 1.0.0
|
|
186
|
-
* @category annotations
|
|
187
|
-
*/
|
|
188
|
-
<A extends HttpApi.Any, I, S>(self: A, tag: Context.Tag<I, S>, value: S): A;
|
|
189
|
-
};
|
|
113
|
+
export declare const empty: HttpApi<never, HttpApiDecodeError>;
|
|
190
114
|
/**
|
|
191
115
|
* Extract metadata from an `HttpApi`, which can be used to generate documentation
|
|
192
116
|
* or other tooling.
|
|
@@ -196,19 +120,19 @@ export declare const annotate: {
|
|
|
196
120
|
* @since 1.0.0
|
|
197
121
|
* @category reflection
|
|
198
122
|
*/
|
|
199
|
-
export declare const reflect: <Groups extends HttpApiGroup.HttpApiGroup.Any, Error,
|
|
123
|
+
export declare const reflect: <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, R>(self: HttpApi<Groups, Error, R>, options: {
|
|
200
124
|
readonly onGroup: (options: {
|
|
201
|
-
readonly group: HttpApiGroup.HttpApiGroup
|
|
125
|
+
readonly group: HttpApiGroup.HttpApiGroup.AnyWithProps;
|
|
202
126
|
readonly mergedAnnotations: Context.Context<never>;
|
|
203
127
|
}) => void;
|
|
204
128
|
readonly onEndpoint: (options: {
|
|
205
|
-
readonly group: HttpApiGroup.HttpApiGroup
|
|
129
|
+
readonly group: HttpApiGroup.HttpApiGroup.AnyWithProps;
|
|
206
130
|
readonly endpoint: HttpApiEndpoint.HttpApiEndpoint<string, HttpMethod>;
|
|
207
131
|
readonly mergedAnnotations: Context.Context<never>;
|
|
208
|
-
readonly
|
|
209
|
-
readonly
|
|
210
|
-
readonly successEncoding: HttpApiSchema.Encoding;
|
|
132
|
+
readonly middleware: HashSet.HashSet<HttpApiMiddleware.TagClassAny>;
|
|
133
|
+
readonly successes: ReadonlyMap<number, Option.Option<AST.AST>>;
|
|
211
134
|
readonly errors: ReadonlyMap<number, Option.Option<AST.AST>>;
|
|
212
135
|
}) => void;
|
|
213
136
|
}) => void;
|
|
137
|
+
export {};
|
|
214
138
|
//# sourceMappingURL=HttpApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpApi.d.ts","sourceRoot":"","sources":["../../src/HttpApi.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"HttpApi.d.ts","sourceRoot":"","sources":["../../src/HttpApi.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,iBAAiB,CAAA;AAE9D,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AACvC,OAAO,KAAK,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAEhE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,MAA+C,CAAA;AAE3E;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA;AAElC;;;GAGG;AACH,eAAO,MAAM,SAAS,MAAO,OAAO,KAAG,CAAC,IAAI,OAAO,CAAC,GAAuC,CAAA;AAE3F;;;;;;;;GAQG;AACH,MAAM,WAAW,OAAO,CACtB,GAAG,CAAC,MAAM,SAAS,YAAY,CAAC,YAAY,CAAC,GAAG,GAAG,KAAK,EACxD,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,EAChB,GAAG,CAAC,CAAC,GAAG,KAAK,CACb,SAAQ,QAAQ;IAChB,KAAI,CAAC,EAAE,KAAK,GAAG,EAAE,CAAA;IACjB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC5C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;IAClD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEpE;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,YAAY,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACjF;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EACf,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAC/B,WAAW,CAAC,EAAE;QACZ,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACrC,GACA,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;IACjC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAChD;;;OAGG;IACH,UAAU,CAAC,CAAC,SAAS,iBAAiB,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC,EAC/D,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,OAAO,CACR,MAAM,EACN,CAAC,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,EAChD,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC,CAC5D,CAAA;IACD;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACvE;;OAEG;IACH,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CACvE;;kBASiB,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;sBAC3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;;AAR5C;;;GAGG;AACH,qBAAa,GAAI,SAAQ,QAMtB;CAAG;AAEN;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B;;;OAGG;IACH,UAAiB,GAAG;QAClB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAC1B;IAED;;;OAGG;IACH,KAAY,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;CACrF;AA2FD;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,kBAAkB,CAKnD,CAAA;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,MAAM,SAAS,YAAY,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,QACtE,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,WACtB;IACP,QAAQ,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE;QAC1B,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAA;QACtD,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KACnD,KAAK,IAAI,CAAA;IACV,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE;QAC7B,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAA;QACtD,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QACtE,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAClD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAA;QACnE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;QAC/D,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;KAC7D,KAAK,IAAI,CAAA;CACX,SAwBF,CAAA"}
|