@dimah-s3/server 1.7.1 → 2.0.0-beta.0

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.
Files changed (187) hide show
  1. package/README.md +72 -16
  2. package/dist/adapters/express.d.ts +7 -7
  3. package/dist/adapters/express.d.ts.map +1 -1
  4. package/dist/adapters/express.js +73 -96
  5. package/dist/adapters/express.js.map +1 -1
  6. package/dist/adapters/fastify.d.ts +11 -5
  7. package/dist/adapters/fastify.d.ts.map +1 -1
  8. package/dist/adapters/fastify.js +73 -96
  9. package/dist/adapters/fastify.js.map +1 -1
  10. package/dist/adapters/node.d.ts +20 -3
  11. package/dist/adapters/node.d.ts.map +1 -1
  12. package/dist/adapters/node.js +71 -94
  13. package/dist/adapters/node.js.map +1 -1
  14. package/dist/api/context.d.ts +8 -4
  15. package/dist/api/context.d.ts.map +1 -1
  16. package/dist/api/{routes/index.d.ts → core-endpoints.d.ts} +43 -68
  17. package/dist/api/core-endpoints.d.ts.map +1 -0
  18. package/dist/api/create-s3-endpoint.d.ts +70 -48
  19. package/dist/api/create-s3-endpoint.d.ts.map +1 -1
  20. package/dist/api/create-s3-middleware.d.ts +19 -16
  21. package/dist/api/create-s3-middleware.d.ts.map +1 -1
  22. package/dist/api/router-context.d.ts +23 -0
  23. package/dist/api/router-context.d.ts.map +1 -0
  24. package/dist/api/router.d.ts +15 -5
  25. package/dist/api/router.d.ts.map +1 -1
  26. package/dist/config/feature-toggle.d.ts +16 -0
  27. package/dist/config/feature-toggle.d.ts.map +1 -0
  28. package/dist/config/resolve-config.d.ts +9 -0
  29. package/dist/config/resolve-config.d.ts.map +1 -0
  30. package/dist/config/resolve-routes.d.ts +37 -0
  31. package/dist/config/resolve-routes.d.ts.map +1 -0
  32. package/dist/dimah-s3.d.ts +22 -32
  33. package/dist/dimah-s3.d.ts.map +1 -1
  34. package/dist/helpers/authorize-download.d.ts +25 -0
  35. package/dist/helpers/authorize-download.d.ts.map +1 -0
  36. package/dist/helpers/aws-errors.d.ts +16 -0
  37. package/dist/helpers/aws-errors.d.ts.map +1 -0
  38. package/dist/helpers/best-effort.d.ts +22 -3
  39. package/dist/helpers/best-effort.d.ts.map +1 -1
  40. package/dist/helpers/checksum-config.d.ts +13 -0
  41. package/dist/helpers/checksum-config.d.ts.map +1 -0
  42. package/dist/helpers/constraints.d.ts +17 -12
  43. package/dist/helpers/constraints.d.ts.map +1 -1
  44. package/dist/helpers/error-boundary.d.ts +28 -0
  45. package/dist/helpers/error-boundary.d.ts.map +1 -0
  46. package/dist/helpers/finalize-confirmed.d.ts +42 -13
  47. package/dist/helpers/finalize-confirmed.d.ts.map +1 -1
  48. package/dist/helpers/head-object.d.ts +6 -9
  49. package/dist/helpers/head-object.d.ts.map +1 -1
  50. package/dist/helpers/hooks.d.ts +29 -15
  51. package/dist/helpers/hooks.d.ts.map +1 -1
  52. package/dist/helpers/inline-types.d.ts +24 -7
  53. package/dist/helpers/inline-types.d.ts.map +1 -1
  54. package/dist/helpers/list-parts.d.ts +4 -6
  55. package/dist/helpers/list-parts.d.ts.map +1 -1
  56. package/dist/helpers/metadata-encoding.d.ts +15 -0
  57. package/dist/helpers/metadata-encoding.d.ts.map +1 -0
  58. package/dist/helpers/object-meta.d.ts +39 -0
  59. package/dist/helpers/object-meta.d.ts.map +1 -0
  60. package/dist/helpers/object-s3.d.ts +5 -2
  61. package/dist/helpers/object-s3.d.ts.map +1 -1
  62. package/dist/helpers/open-target.d.ts +89 -0
  63. package/dist/helpers/open-target.d.ts.map +1 -0
  64. package/dist/helpers/part-layout.d.ts +19 -0
  65. package/dist/helpers/part-layout.d.ts.map +1 -0
  66. package/dist/helpers/presign.d.ts +54 -0
  67. package/dist/helpers/presign.d.ts.map +1 -0
  68. package/dist/helpers/request.d.ts +6 -11
  69. package/dist/helpers/request.d.ts.map +1 -1
  70. package/dist/helpers/resolve-target.d.ts +28 -20
  71. package/dist/helpers/resolve-target.d.ts.map +1 -1
  72. package/dist/helpers/sniff-object.d.ts +22 -0
  73. package/dist/helpers/sniff-object.d.ts.map +1 -0
  74. package/dist/helpers/ticket.d.ts +75 -0
  75. package/dist/helpers/ticket.d.ts.map +1 -0
  76. package/dist/index.d.ts +4 -12
  77. package/dist/index.d.ts.map +1 -1
  78. package/dist/index.js +2647 -1579
  79. package/dist/index.js.map +1 -1
  80. package/dist/operations/catalog.d.ts +16 -0
  81. package/dist/operations/catalog.d.ts.map +1 -0
  82. package/dist/operations/confirm.d.ts +19 -0
  83. package/dist/operations/confirm.d.ts.map +1 -0
  84. package/dist/operations/delete-many.d.ts +18 -0
  85. package/dist/operations/delete-many.d.ts.map +1 -0
  86. package/dist/operations/delete.d.ts +14 -0
  87. package/dist/operations/delete.d.ts.map +1 -0
  88. package/dist/operations/download.d.ts +20 -0
  89. package/dist/operations/download.d.ts.map +1 -0
  90. package/dist/operations/file.d.ts +38 -0
  91. package/dist/operations/file.d.ts.map +1 -0
  92. package/dist/operations/multipart/abort.d.ts +20 -0
  93. package/dist/operations/multipart/abort.d.ts.map +1 -0
  94. package/dist/operations/multipart/complete.d.ts +21 -0
  95. package/dist/operations/multipart/complete.d.ts.map +1 -0
  96. package/dist/operations/multipart/init.d.ts +19 -0
  97. package/dist/operations/multipart/init.d.ts.map +1 -0
  98. package/dist/operations/multipart/list-parts.d.ts +11 -0
  99. package/dist/operations/multipart/list-parts.d.ts.map +1 -0
  100. package/dist/operations/multipart/open-multipart.d.ts +25 -0
  101. package/dist/operations/multipart/open-multipart.d.ts.map +1 -0
  102. package/dist/operations/multipart/sign-part.d.ts +20 -0
  103. package/dist/operations/multipart/sign-part.d.ts.map +1 -0
  104. package/dist/operations/put.d.ts +18 -0
  105. package/dist/operations/put.d.ts.map +1 -0
  106. package/dist/operations/run-operation.d.ts +18 -0
  107. package/dist/operations/run-operation.d.ts.map +1 -0
  108. package/dist/operations/s3-api.d.ts +12 -0
  109. package/dist/operations/s3-api.d.ts.map +1 -0
  110. package/dist/operations/upload.d.ts +19 -0
  111. package/dist/operations/upload.d.ts.map +1 -0
  112. package/dist/plugin/apply-plugins.d.ts +9 -11
  113. package/dist/plugin/apply-plugins.d.ts.map +1 -1
  114. package/dist/plugin/chain-hooks.d.ts +12 -9
  115. package/dist/plugin/chain-hooks.d.ts.map +1 -1
  116. package/dist/plugin/define-plugin.d.ts +11 -4
  117. package/dist/plugin/define-plugin.d.ts.map +1 -1
  118. package/dist/plugin/index.d.ts +1 -2
  119. package/dist/plugin/index.d.ts.map +1 -1
  120. package/dist/plugin/types.d.ts +52 -56
  121. package/dist/plugin/types.d.ts.map +1 -1
  122. package/dist/plugins.d.ts +10 -8
  123. package/dist/plugins.d.ts.map +1 -1
  124. package/dist/plugins.js +325 -1627
  125. package/dist/plugins.js.map +1 -1
  126. package/dist/route.d.ts +0 -1
  127. package/dist/route.d.ts.map +1 -1
  128. package/dist/types/config.d.ts +171 -172
  129. package/dist/types/config.d.ts.map +1 -1
  130. package/dist/types/hook-contexts.d.ts +139 -147
  131. package/dist/types/hook-contexts.d.ts.map +1 -1
  132. package/dist/types/index.d.ts +3 -3
  133. package/dist/types/index.d.ts.map +1 -1
  134. package/dist/types/locals.d.ts +37 -0
  135. package/dist/types/locals.d.ts.map +1 -0
  136. package/dist/types/resolved.d.ts +118 -0
  137. package/dist/types/resolved.d.ts.map +1 -0
  138. package/package.json +8 -12
  139. package/dist/api/bind-endpoints.d.ts +0 -12
  140. package/dist/api/bind-endpoints.d.ts.map +0 -1
  141. package/dist/api/index.d.ts +0 -6
  142. package/dist/api/index.d.ts.map +0 -1
  143. package/dist/api/index.js +0 -1353
  144. package/dist/api/index.js.map +0 -1
  145. package/dist/api/routes/catalog.d.ts +0 -9
  146. package/dist/api/routes/catalog.d.ts.map +0 -1
  147. package/dist/api/routes/confirm.d.ts +0 -13
  148. package/dist/api/routes/confirm.d.ts.map +0 -1
  149. package/dist/api/routes/delete-batch.d.ts +0 -14
  150. package/dist/api/routes/delete-batch.d.ts.map +0 -1
  151. package/dist/api/routes/delete.d.ts +0 -26
  152. package/dist/api/routes/delete.d.ts.map +0 -1
  153. package/dist/api/routes/download.d.ts +0 -21
  154. package/dist/api/routes/download.d.ts.map +0 -1
  155. package/dist/api/routes/file.d.ts +0 -20
  156. package/dist/api/routes/file.d.ts.map +0 -1
  157. package/dist/api/routes/index.d.ts.map +0 -1
  158. package/dist/api/routes/multipart/abort.d.ts +0 -16
  159. package/dist/api/routes/multipart/abort.d.ts.map +0 -1
  160. package/dist/api/routes/multipart/complete.d.ts +0 -22
  161. package/dist/api/routes/multipart/complete.d.ts.map +0 -1
  162. package/dist/api/routes/multipart/init.d.ts +0 -22
  163. package/dist/api/routes/multipart/init.d.ts.map +0 -1
  164. package/dist/api/routes/multipart/list-parts.d.ts +0 -17
  165. package/dist/api/routes/multipart/list-parts.d.ts.map +0 -1
  166. package/dist/api/routes/multipart/part.d.ts +0 -20
  167. package/dist/api/routes/multipart/part.d.ts.map +0 -1
  168. package/dist/api/routes/upload.d.ts +0 -22
  169. package/dist/api/routes/upload.d.ts.map +0 -1
  170. package/dist/errors.d.ts +0 -23
  171. package/dist/errors.d.ts.map +0 -1
  172. package/dist/helpers/expires.d.ts +0 -21
  173. package/dist/helpers/expires.d.ts.map +0 -1
  174. package/dist/helpers/features.d.ts +0 -17
  175. package/dist/helpers/features.d.ts.map +0 -1
  176. package/dist/helpers/index.d.ts +0 -19
  177. package/dist/helpers/index.d.ts.map +0 -1
  178. package/dist/helpers/is-aws-not-found.d.ts +0 -5
  179. package/dist/helpers/is-aws-not-found.d.ts.map +0 -1
  180. package/dist/helpers/previous-key.d.ts +0 -5
  181. package/dist/helpers/previous-key.d.ts.map +0 -1
  182. package/dist/helpers/resolve-route.d.ts +0 -33
  183. package/dist/helpers/resolve-route.d.ts.map +0 -1
  184. package/dist/plugin/hook-registry.d.ts +0 -21
  185. package/dist/plugin/hook-registry.d.ts.map +0 -1
  186. package/dist/put.d.ts +0 -15
  187. package/dist/put.d.ts.map +0 -1
@@ -1,4 +1,4 @@
1
- /** Core better-call endpoints — keys become `s3.api.*`. */
1
+ /** One endpoint per `S3_API_ROUTES` entry, under the same name. */
2
2
  export declare const coreEndpoints: {
3
3
  upload: import("better-call").StrictEndpoint<"/presign/upload", {
4
4
  use: import("better-call").MiddlewareHandler[];
@@ -6,16 +6,16 @@ export declare const coreEndpoints: {
6
6
  method: "POST";
7
7
  body: import("better-call").StandardSchemaV1<{
8
8
  route: string;
9
- fileName: string;
10
- fileSize: number;
11
- contentType?: unknown;
9
+ name: string;
10
+ size: number;
11
+ type?: unknown;
12
12
  metadata?: Record<string, string> | undefined;
13
13
  checksum?: unknown;
14
14
  }, {
15
15
  route: string;
16
- fileName: string;
17
- fileSize: number;
18
- contentType?: unknown;
16
+ name: string;
17
+ size: number;
18
+ type?: unknown;
19
19
  metadata?: Record<string, string> | undefined;
20
20
  checksum?: unknown;
21
21
  }>;
@@ -25,11 +25,9 @@ export declare const coreEndpoints: {
25
25
  } & {
26
26
  method: "POST";
27
27
  body: import("better-call").StandardSchemaV1<{
28
- route: string;
29
- key: string;
28
+ ticket: string;
30
29
  }, {
31
- route: string;
32
- key: string;
30
+ ticket: string;
33
31
  }>;
34
32
  }, import("@dimah-s3/core").ConfirmedObjectResponse>;
35
33
  download: import("better-call").StrictEndpoint<"/presign/download", {
@@ -40,14 +38,14 @@ export declare const coreEndpoints: {
40
38
  query: import("better-call").StandardSchemaV1<{
41
39
  route: string;
42
40
  key: string;
43
- fileName?: unknown;
44
- disposition?: "attachment" | "inline" | undefined;
41
+ name?: unknown;
42
+ disposition?: unknown;
45
43
  expiresIn?: unknown;
46
44
  }, {
47
45
  route: string;
48
46
  key: string;
49
- fileName?: unknown;
50
- disposition?: "attachment" | "inline" | undefined;
47
+ name?: unknown;
48
+ disposition?: unknown;
51
49
  expiresIn?: unknown;
52
50
  }>;
53
51
  }, import("@dimah-s3/core").DownloadPresignResponse>;
@@ -58,19 +56,23 @@ export declare const coreEndpoints: {
58
56
  }, import("@dimah-s3/core").RouteCatalogResponse>;
59
57
  file: import("better-call").StrictEndpoint<"/file", {
60
58
  use: import("better-call").MiddlewareHandler[];
59
+ onValidationError: ({ message }: {
60
+ message: string;
61
+ issues: readonly import("better-call").StandardSchemaV1.Issue[];
62
+ }) => never;
61
63
  } & {
62
64
  method: "GET";
63
65
  } & {
64
66
  query: import("better-call").StandardSchemaV1<{
65
67
  route: string;
66
68
  key: string;
67
- fileName?: unknown;
68
- disposition?: "attachment" | "inline" | undefined;
69
+ name?: unknown;
70
+ disposition?: unknown;
69
71
  }, {
70
72
  route: string;
71
73
  key: string;
72
- fileName?: unknown;
73
- disposition?: "attachment" | "inline" | undefined;
74
+ name?: unknown;
75
+ disposition?: unknown;
74
76
  }>;
75
77
  }, Response>;
76
78
  delete: import("better-call").StrictEndpoint<"/delete", {
@@ -87,7 +89,7 @@ export declare const coreEndpoints: {
87
89
  key: string;
88
90
  }>;
89
91
  }, import("@dimah-s3/core").DeleteResponse>;
90
- deleteBatch: import("better-call").StrictEndpoint<"/delete/batch", {
92
+ deleteMany: import("better-call").StrictEndpoint<"/delete/batch", {
91
93
  use: import("better-call").MiddlewareHandler[];
92
94
  } & {
93
95
  method: "POST";
@@ -98,58 +100,47 @@ export declare const coreEndpoints: {
98
100
  route: string;
99
101
  keys: string[];
100
102
  }>;
101
- }, import("@dimah-s3/core").DeleteBatchResponse>;
103
+ }, import("@dimah-s3/core").DeleteManyResponse>;
102
104
  multipartInit: import("better-call").StrictEndpoint<"/presign/multipart/init", {
103
105
  use: import("better-call").MiddlewareHandler[];
104
106
  } & {
105
107
  method: "POST";
106
108
  body: import("better-call").StandardSchemaV1<{
107
109
  route: string;
108
- fileName: string;
109
- fileSize: number;
110
- contentType?: unknown;
110
+ name: string;
111
+ size: number;
112
+ type?: unknown;
111
113
  metadata?: Record<string, string> | undefined;
112
- checksum?: unknown;
113
114
  }, {
114
115
  route: string;
115
- fileName: string;
116
- fileSize: number;
117
- contentType?: unknown;
116
+ name: string;
117
+ size: number;
118
+ type?: unknown;
118
119
  metadata?: Record<string, string> | undefined;
119
- checksum?: unknown;
120
120
  }>;
121
121
  }, import("@dimah-s3/core").MultipartInitResponse>;
122
- multipartPart: import("better-call").StrictEndpoint<"/presign/multipart/part", {
122
+ multipartSignPart: import("better-call").StrictEndpoint<"/presign/multipart/part", {
123
123
  use: import("better-call").MiddlewareHandler[];
124
124
  } & {
125
125
  method: "POST";
126
126
  body: import("better-call").StandardSchemaV1<{
127
- route: string;
128
- key: string;
129
- uploadId: string;
127
+ ticket: string;
130
128
  partNumber: number;
131
- partSize: number;
129
+ checksum?: unknown;
132
130
  }, {
133
- route: string;
134
- key: string;
135
- uploadId: string;
131
+ ticket: string;
136
132
  partNumber: number;
137
- partSize: number;
133
+ checksum?: unknown;
138
134
  }>;
139
135
  }, import("@dimah-s3/core").MultipartPartResponse>;
140
136
  multipartListParts: import("better-call").StrictEndpoint<"/presign/multipart/parts", {
141
137
  use: import("better-call").MiddlewareHandler[];
142
138
  } & {
143
- method: "GET";
144
- } & {
145
- query: import("better-call").StandardSchemaV1<{
146
- route: string;
147
- key: string;
148
- uploadId: string;
139
+ method: "POST";
140
+ body: import("better-call").StandardSchemaV1<{
141
+ ticket: string;
149
142
  }, {
150
- route: string;
151
- key: string;
152
- uploadId: string;
143
+ ticket: string;
153
144
  }>;
154
145
  }, import("@dimah-s3/core").MultipartListPartsResponse>;
155
146
  multipartComplete: import("better-call").StrictEndpoint<"/presign/multipart/complete", {
@@ -157,19 +148,9 @@ export declare const coreEndpoints: {
157
148
  } & {
158
149
  method: "POST";
159
150
  body: import("better-call").StandardSchemaV1<{
160
- route: string;
161
- key: string;
162
- uploadId: string;
163
- parts: {
164
- partNumber: number;
165
- }[];
151
+ ticket: string;
166
152
  }, {
167
- route: string;
168
- key: string;
169
- uploadId: string;
170
- parts: {
171
- partNumber: number;
172
- }[];
153
+ ticket: string;
173
154
  }>;
174
155
  }, import("@dimah-s3/core").MultipartCompleteResponse>;
175
156
  multipartAbort: import("better-call").StrictEndpoint<"/presign/multipart/abort", {
@@ -177,16 +158,10 @@ export declare const coreEndpoints: {
177
158
  } & {
178
159
  method: "POST";
179
160
  body: import("better-call").StandardSchemaV1<{
180
- route: string;
181
- key: string;
182
- uploadId: string;
161
+ ticket: string;
183
162
  }, {
184
- route: string;
185
- key: string;
186
- uploadId: string;
163
+ ticket: string;
187
164
  }>;
188
165
  }, import("@dimah-s3/core").MultipartAbortResponse>;
189
166
  };
190
- export type CoreEndpoints = typeof coreEndpoints;
191
- export declare const CORE_ENDPOINT_NAMES: (keyof CoreEndpoints)[];
192
- //# sourceMappingURL=index.d.ts.map
167
+ //# sourceMappingURL=core-endpoints.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"core-endpoints.d.ts","sourceRoot":"","sources":["../../src/api/core-endpoints.ts"],"names":[],"mappings":"AA+CA,mEAAmE;AACnE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqH8B,CAAC"}
@@ -1,9 +1,23 @@
1
- import { type EndpointOptions } from "better-call";
2
- declare const createEndpointWithContext: {
3
- <Path extends string, Opts extends EndpointOptions, R>(path: Path, options: Opts, handler: import("better-call").EndpointHandler<Path, Opts, R, {
4
- config: import("..").ResolvedDimahS3Config;
5
- request: Request;
6
- }>): import("better-call").StrictEndpoint<Path, ("use" | Exclude<keyof Opts, "body" | "error" | "method" | "query"> extends infer T extends keyof (Opts & {
1
+ import { type EndpointBaseOptions, type EndpointHandler, type StandardSchemaV1 } from "better-call";
2
+ import type { S3EndpointContext } from "./context";
3
+ /** HTTP methods a dimah-s3 endpoint can use. */
4
+ export type S3EndpointMethod = "GET" | "POST" | "PATCH" | "DELETE";
5
+ /**
6
+ * Options of {@link createS3Endpoint}. `GET` and `DELETE` read the `query`.
7
+ * `POST` and `PATCH` read a JSON `body`.
8
+ */
9
+ export type S3EndpointOptions = Omit<EndpointBaseOptions, "disableBody"> & ({
10
+ method: "GET";
11
+ body?: never;
12
+ } | {
13
+ method: "DELETE";
14
+ body?: never;
15
+ } | {
16
+ method: "POST" | "PATCH";
17
+ body?: StandardSchemaV1;
18
+ });
19
+ declare const pluginEndpoint: {
20
+ <Path extends string, Opts extends import("better-call").EndpointOptions, R>(path: Path, options: Opts, handler: EndpointHandler<Path, Opts, R, S3EndpointContext>): import("better-call").StrictEndpoint<Path, ("use" | Exclude<keyof Opts, "body" | "error" | "method" | "query"> extends infer T extends keyof (Opts & {
7
21
  use: import("better-call").MiddlewareHandler[];
8
22
  }) ? { [P in T]: (Opts & {
9
23
  use: import("better-call").MiddlewareHandler[];
@@ -13,28 +27,28 @@ declare const createEndpointWithContext: {
13
27
  use: import("better-call").MiddlewareHandler[];
14
28
  } ? T_1 extends {
15
29
  method: ("POST" | "PUT" | "DELETE" | "PATCH" | "GET" | "HEAD")[];
16
- body?: import("better-call").StandardSchemaV1<infer B>;
30
+ body?: StandardSchemaV1<infer B>;
17
31
  } ? T_1 extends {
18
32
  method: infer M;
19
- body?: import("better-call").StandardSchemaV1<B>;
33
+ body?: StandardSchemaV1<B>;
20
34
  } ? {
21
35
  method: M;
22
- body: import("better-call").StandardSchemaV1<B>;
36
+ body: StandardSchemaV1<B>;
23
37
  } : never : T_1 extends {
24
38
  method: "POST" | "PUT" | "DELETE" | "PATCH" | ("POST" | "PUT" | "DELETE" | "PATCH")[];
25
- body?: import("better-call").StandardSchemaV1<infer B_1>;
39
+ body?: StandardSchemaV1<infer B_1>;
26
40
  } ? T_1 extends {
27
41
  method: infer M_1;
28
- body?: import("better-call").StandardSchemaV1<B_1>;
42
+ body?: StandardSchemaV1<B_1>;
29
43
  } ? {
30
44
  method: M_1;
31
- body: import("better-call").StandardSchemaV1<B_1>;
45
+ body: StandardSchemaV1<B_1>;
32
46
  } : never : T_1 extends {
33
47
  method: "*";
34
- body?: import("better-call").StandardSchemaV1<infer B_2>;
48
+ body?: StandardSchemaV1<infer B_2>;
35
49
  } ? {
36
50
  method: "*";
37
- body?: import("better-call").StandardSchemaV1<B_2>;
51
+ body?: StandardSchemaV1<B_2>;
38
52
  } : T_1 extends {
39
53
  method: "GET" | "HEAD" | ("GET" | "HEAD")[];
40
54
  body?: never;
@@ -47,22 +61,19 @@ declare const createEndpointWithContext: {
47
61
  } extends infer T_2 ? T_2 extends Opts & {
48
62
  use: import("better-call").MiddlewareHandler[];
49
63
  } ? T_2 extends {
50
- query?: import("better-call").StandardSchemaV1<infer Q>;
64
+ query?: StandardSchemaV1<infer Q>;
51
65
  } ? {
52
- query: import("better-call").StandardSchemaV1<Q>;
66
+ query: StandardSchemaV1<Q>;
53
67
  } : {} : never : never) & (Opts & {
54
68
  use: import("better-call").MiddlewareHandler[];
55
69
  } extends infer T_3 ? T_3 extends Opts & {
56
70
  use: import("better-call").MiddlewareHandler[];
57
71
  } ? T_3 extends {
58
- error?: import("better-call").StandardSchemaV1<infer Err>;
72
+ error?: StandardSchemaV1<infer Err>;
59
73
  } ? {
60
- error: import("better-call").StandardSchemaV1<Err>;
74
+ error: StandardSchemaV1<Err>;
61
75
  } : {} : never : never), R>;
62
- <Opts_1 extends EndpointOptions, R_1>(options: Opts_1, handler: (context: import("better-call").EndpointContext<string, Opts_1, {
63
- config: import("..").ResolvedDimahS3Config;
64
- request: Request;
65
- }, Record<string, string | undefined> | undefined>) => Promise<R_1>): import("better-call").StrictEndpoint<never, ("use" | Exclude<keyof Opts_1, "body" | "error" | "method" | "query"> extends infer T extends keyof (Opts_1 & {
76
+ <Opts_1 extends import("better-call").EndpointOptions, R_1>(options: Opts_1, handler: (context: import("better-call").EndpointContext<string, Opts_1, S3EndpointContext, Record<string, string | undefined> | undefined>) => Promise<R_1>): import("better-call").StrictEndpoint<never, ("use" | Exclude<keyof Opts_1, "body" | "error" | "method" | "query"> extends infer T extends keyof (Opts_1 & {
66
77
  use: import("better-call").MiddlewareHandler[];
67
78
  }) ? { [P in T]: (Opts_1 & {
68
79
  use: import("better-call").MiddlewareHandler[];
@@ -72,28 +83,28 @@ declare const createEndpointWithContext: {
72
83
  use: import("better-call").MiddlewareHandler[];
73
84
  } ? T_1 extends {
74
85
  method: ("POST" | "PUT" | "DELETE" | "PATCH" | "GET" | "HEAD")[];
75
- body?: import("better-call").StandardSchemaV1<infer B>;
86
+ body?: StandardSchemaV1<infer B>;
76
87
  } ? T_1 extends {
77
88
  method: infer M;
78
- body?: import("better-call").StandardSchemaV1<B>;
89
+ body?: StandardSchemaV1<B>;
79
90
  } ? {
80
91
  method: M;
81
- body: import("better-call").StandardSchemaV1<B>;
92
+ body: StandardSchemaV1<B>;
82
93
  } : never : T_1 extends {
83
94
  method: "POST" | "PUT" | "DELETE" | "PATCH" | ("POST" | "PUT" | "DELETE" | "PATCH")[];
84
- body?: import("better-call").StandardSchemaV1<infer B_1>;
95
+ body?: StandardSchemaV1<infer B_1>;
85
96
  } ? T_1 extends {
86
97
  method: infer M_1;
87
- body?: import("better-call").StandardSchemaV1<B_1>;
98
+ body?: StandardSchemaV1<B_1>;
88
99
  } ? {
89
100
  method: M_1;
90
- body: import("better-call").StandardSchemaV1<B_1>;
101
+ body: StandardSchemaV1<B_1>;
91
102
  } : never : T_1 extends {
92
103
  method: "*";
93
- body?: import("better-call").StandardSchemaV1<infer B_2>;
104
+ body?: StandardSchemaV1<infer B_2>;
94
105
  } ? {
95
106
  method: "*";
96
- body?: import("better-call").StandardSchemaV1<B_2>;
107
+ body?: StandardSchemaV1<B_2>;
97
108
  } : T_1 extends {
98
109
  method: "GET" | "HEAD" | ("GET" | "HEAD")[];
99
110
  body?: never;
@@ -106,40 +117,51 @@ declare const createEndpointWithContext: {
106
117
  } extends infer T_2 ? T_2 extends Opts_1 & {
107
118
  use: import("better-call").MiddlewareHandler[];
108
119
  } ? T_2 extends {
109
- query?: import("better-call").StandardSchemaV1<infer Q>;
120
+ query?: StandardSchemaV1<infer Q>;
110
121
  } ? {
111
- query: import("better-call").StandardSchemaV1<Q>;
122
+ query: StandardSchemaV1<Q>;
112
123
  } : {} : never : never) & (Opts_1 & {
113
124
  use: import("better-call").MiddlewareHandler[];
114
125
  } extends infer T_3 ? T_3 extends Opts_1 & {
115
126
  use: import("better-call").MiddlewareHandler[];
116
127
  } ? T_3 extends {
117
- error?: import("better-call").StandardSchemaV1<infer Err>;
128
+ error?: StandardSchemaV1<infer Err>;
118
129
  } ? {
119
- error: import("better-call").StandardSchemaV1<Err>;
130
+ error: StandardSchemaV1<Err>;
120
131
  } : {} : never : never), R_1>;
121
132
  };
122
- type CreateS3Endpoint = typeof createEndpointWithContext;
133
+ /** The endpoint {@link createS3Endpoint} returns for a path, options and result. */
134
+ export type S3Endpoint<Path extends string, Options extends S3EndpointOptions, R> = ReturnType<typeof pluginEndpoint<Path, Options, R>>;
135
+ /** Body endpoints accept only JSON, so a cross-site form post is refused. */
136
+ export declare const BODY_MEDIA_TYPES: string[];
123
137
  /**
124
- * Typed endpoint for dimah-s3 plugins and core routes.
138
+ * Creates an endpoint for a plugin's `endpoints`. The path is under
139
+ * `basePath`, such as `/audit/recent`.
125
140
  *
126
- * Paths are absolute under `basePath` (e.g. `/db/objects`). Context
127
- * (`config`, `request`) is injected by the router / `s3.api`.
128
- * Zod failures throw `APIError` (`VALIDATION_ERROR`) via
129
- * better-call `onValidationError`. Endpoints with a `body` set
130
- * `cloneRequest` so hooks can still read that JSON. Zod `body` / `query`
131
- * schemas are compiled with `z.compile()` so valid requests skip the interpreter.
132
- * Unsupported schemas, and runtimes that reject `new Function`, keep
133
- * the runtime parser.
141
+ * - `GET` and `DELETE` read the `query`. `POST` and `PATCH` read a JSON
142
+ * `body`; any other content type returns `415 UNSUPPORTED_MEDIA_TYPE`.
143
+ * - The instance guards run first (operation `"plugin"`), and the `locals`
144
+ * they return are on `ctx.context.locals`, next to `config` and `request`.
145
+ * - A schema failure returns `400 VALIDATION_ERROR`. An `APIError` passes
146
+ * through; anything else is logged, passed to `onError`, and returns
147
+ * `500 INTERNAL_ERROR`.
134
148
  *
135
149
  * ```ts
136
150
  * endpoints: {
137
- * recent: createS3Endpoint("/audit/recent", { method: "GET" }, async (ctx) => {
138
- * return { events: [] };
139
- * }),
151
+ * recent: createS3Endpoint(
152
+ * "/audit/recent",
153
+ * { method: "GET", query: z.object({ limit: z.coerce.number().optional() }) },
154
+ * async (ctx) => ({ events: await audit.recent(ctx.context.locals, ctx.query) }),
155
+ * ),
140
156
  * }
141
157
  * ```
142
158
  */
143
- export declare const createS3Endpoint: CreateS3Endpoint;
159
+ export declare function createS3Endpoint<Path extends string, Options extends S3EndpointOptions, R>(path: Path, options: Options, handler: EndpointHandler<Path, Options, R, S3EndpointContext>): S3Endpoint<Path, Options, R>;
160
+ /**
161
+ * A core endpoint. Internal: its operation runs the guards and names the
162
+ * call, so the context middleware only adds `config`, `request` and an
163
+ * empty `locals`.
164
+ */
165
+ export declare function createCoreEndpoint<Path extends string, Options extends S3EndpointOptions, R>(path: Path, options: Options, handler: EndpointHandler<Path, Options, R, S3EndpointContext>): S3Endpoint<Path, Options, R>;
144
166
  export {};
145
167
  //# sourceMappingURL=create-s3-endpoint.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-s3-endpoint.d.ts","sourceRoot":"","sources":["../../src/api/create-s3-endpoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AAKnE,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAE7B,CAAC;AA6BH,KAAK,gBAAgB,GAAG,OAAO,yBAAyB,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,EAAE,gBAgBE,CAAC"}
1
+ {"version":3,"file":"create-s3-endpoint.d.ts","sourceRoot":"","sources":["../../src/api/create-s3-endpoint.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACtB,MAAM,aAAa,CAAC;AAIrB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAOnD,gDAAgD;AAChD,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,EAAE,aAAa,CAAC,GACtE,CACI;IAAE,MAAM,EAAE,KAAK,CAAC;IAAC,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAC/B;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAClC;IAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,gBAAgB,CAAA;CAAE,CACxD,CAAC;AAEJ,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAElB,CAAC;AAOH,oFAAoF;AACpF,MAAM,MAAM,UAAU,CACpB,IAAI,SAAS,MAAM,EACnB,OAAO,SAAS,iBAAiB,EACjC,CAAC,IACC,UAAU,CAAC,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;AAExD,6EAA6E;AAC7E,eAAO,MAAM,gBAAgB,EAAE,MAAM,EAAyB,CAAC;AAI/D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,SAAS,MAAM,EACnB,OAAO,SAAS,iBAAiB,EACjC,CAAC,EAED,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,iBAAiB,CAAC,GAC5D,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAO9B;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,SAAS,MAAM,EACnB,OAAO,SAAS,iBAAiB,EACjC,CAAC,EAED,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,iBAAiB,CAAC,GAC5D,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAE9B"}
@@ -1,23 +1,26 @@
1
+ import type { S3EndpointContext } from "./context";
1
2
  /**
2
- * Injects `config` / `request` and runs the global `guard`.
3
- * Used by {@link createS3Endpoint} so HTTP and `s3.api` share the same path.
3
+ * Context middleware of every plugin endpoint. Plugin endpoints are guarded
4
+ * here; core endpoints run their guards inside the operation.
4
5
  */
5
- export declare const s3ContextMiddleware: import("better-call").Middleware<import("better-call").MiddlewareOptions, <InputCtx extends import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>>(inputContext: InputCtx) => Promise<{
6
- config: import("..").ResolvedDimahS3Config;
7
- request: Request;
8
- }>>;
6
+ export declare const s3ContextMiddleware: import("better-call").Middleware<import("better-call").MiddlewareOptions, <InputCtx extends import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>>(inputContext: InputCtx) => Promise<S3EndpointContext>>;
7
+ /** Context middleware of the core endpoints, whose operations run the guards. */
8
+ export declare const coreContextMiddleware: import("better-call").Middleware<import("better-call").MiddlewareOptions, <InputCtx extends import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>>(inputContext: InputCtx) => Promise<S3EndpointContext>>;
9
9
  /**
10
- * Middleware factory with dimah-s3 context already applied — same idea as
11
- * Better Auth `createAuthMiddleware`.
10
+ * Creates a middleware for plugin endpoints. Its handler sees the same
11
+ * `ctx.context` as the endpoint (`config`, `request`, `locals`), and the
12
+ * instance guards have already run.
13
+ *
14
+ * ```ts
15
+ * const requireUser = createS3Middleware(async (ctx) => {
16
+ * if (!ctx.context.locals.userId) throw s3Error("UNAUTHORIZED");
17
+ * });
18
+ *
19
+ * createS3Endpoint("/audit/recent", { method: "GET", use: [requireUser] }, handler);
20
+ * ```
12
21
  */
13
22
  export declare const createS3Middleware: {
14
- <Options extends import("better-call").MiddlewareOptions, R>(options: Options, handler: (ctx: import("better-call").MiddlewareContext<Options, {
15
- config: import("..").ResolvedDimahS3Config;
16
- request: Request;
17
- }>) => Promise<R>): import("better-call").Middleware<Options, (inputContext: import("better-call").MiddlewareInputContext<Options>) => Promise<R>>;
18
- <Options extends import("better-call").MiddlewareOptions, R_1>(handler: (ctx: import("better-call").MiddlewareContext<Options, {
19
- config: import("..").ResolvedDimahS3Config;
20
- request: Request;
21
- }>) => Promise<R_1>): import("better-call").Middleware<Options, (inputContext: import("better-call").MiddlewareInputContext<Options>) => Promise<R_1>>;
23
+ <Options extends import("better-call").MiddlewareOptions, R>(options: Options, handler: (ctx: import("better-call").MiddlewareContext<Options, S3EndpointContext>) => Promise<R>): import("better-call").Middleware<Options, (inputContext: import("better-call").MiddlewareInputContext<Options>) => Promise<R>>;
24
+ <Options extends import("better-call").MiddlewareOptions, R_1>(handler: (ctx: import("better-call").MiddlewareContext<Options, S3EndpointContext>) => Promise<R_1>): import("better-call").Middleware<Options, (inputContext: import("better-call").MiddlewareInputContext<Options>) => Promise<R_1>>;
22
25
  };
23
26
  //# sourceMappingURL=create-s3-middleware.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-s3-middleware.d.ts","sourceRoot":"","sources":["../../src/api/create-s3-middleware.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;GAmB9B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;CAE7B,CAAC"}
1
+ {"version":3,"file":"create-s3-middleware.d.ts","sourceRoot":"","sources":["../../src/api/create-s3-middleware.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAkCnD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,2OAAyC,CAAC;AAE1E,iFAAiF;AACjF,eAAO,MAAM,qBAAqB,2OAA0C,CAAC;AAE7E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB;;;CAE7B,CAAC"}
@@ -0,0 +1,23 @@
1
+ import type { DimahS3Config } from "../types/config.js";
2
+ import type { ResolvedConfig } from "../types/resolved.js";
3
+ /**
4
+ * Router context key of the resolved config. Plugin endpoints see only the
5
+ * user `config`; the core endpoints and the error boundary read this one.
6
+ * `Symbol.for` keeps one key across the entry points, which are bundled
7
+ * separately.
8
+ */
9
+ declare const RESOLVED_CONFIG: unique symbol;
10
+ /** What the dimahS3 router injects into every endpoint's `ctx.context`. */
11
+ export type RouterContext = {
12
+ config: Readonly<DimahS3Config>;
13
+ [RESOLVED_CONFIG]: ResolvedConfig;
14
+ };
15
+ /** The router context for the user config and its resolved form. */
16
+ export declare function createRouterContext(config: Readonly<DimahS3Config>, resolved: ResolvedConfig): RouterContext;
17
+ /**
18
+ * The resolved config in an endpoint's `ctx.context`. Throws when the
19
+ * endpoint is called outside a dimahS3 router.
20
+ */
21
+ export declare function resolvedConfig(context: object): ResolvedConfig;
22
+ export {};
23
+ //# sourceMappingURL=router-context.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"router-context.d.ts","sourceRoot":"","sources":["../../src/api/router-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;GAKG;AACH,QAAA,MAAM,eAAe,EAAE,OAAO,MAA+C,CAAC;AAE9E,2EAA2E;AAC3E,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAChC,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;CACnC,CAAC;AAEF,oEAAoE;AACpE,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,EAC/B,QAAQ,EAAE,cAAc,GACvB,aAAa,CAEf;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CAQ9D"}
@@ -1,13 +1,23 @@
1
1
  import { type Endpoint } from "better-call";
2
- import type { ResolvedDimahS3Config } from "../types/index.js";
2
+ import type { DimahS3Config } from "../types/config.js";
3
+ import type { ResolvedConfig } from "../types/resolved.js";
3
4
  /**
4
- * Internal better-call router with dimah-s3 context, OpenAPI off, and native
5
- * APIError JSON. Not part of the public package surface.
5
+ * The HTTP router of a dimah-s3 instance. Internal: `dimahS3()` returns its
6
+ * `handler`.
7
+ *
8
+ * - The body is capped at `maxRequestBodySize` before anything parses it.
9
+ * A declared `Content-Length` over the cap fails at once, and a body
10
+ * without one is counted as it streams. Either way the client gets
11
+ * `413 REQUEST_TOO_LARGE`.
12
+ * - A body that is not `application/json` returns `415
13
+ * UNSUPPORTED_MEDIA_TYPE`, for plugin endpoints too.
14
+ * - Every failure is a JSON `APIError` (see {@link toAPIError}), and a path
15
+ * no endpoint serves returns `404 NOT_FOUND`.
6
16
  */
7
17
  export declare function createS3Router<E extends Record<string, Endpoint>>(endpoints: E, env: {
8
- config: ResolvedDimahS3Config;
18
+ config: Readonly<DimahS3Config>;
19
+ resolved: ResolvedConfig;
9
20
  }): {
10
- endpoints: E;
11
21
  handler: (request: Request) => Promise<Response>;
12
22
  };
13
23
  //# sourceMappingURL=router.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/api/router.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAStE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AA+CrD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAC/D,SAAS,EAAE,CAAC,EACZ,GAAG,EAAE;IAAE,MAAM,EAAE,qBAAqB,CAAA;CAAE;IAcpC,SAAS;IACT,OAAO,YA/BE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC;EAiCzC"}
1
+ {"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/api/router.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIvD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EAC/D,SAAS,EAAE,CAAC,EACZ,GAAG,EAAE;IAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAAC,QAAQ,EAAE,cAAc,CAAA;CAAE,GACjE;IAAE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAAE,CA4BtD"}
@@ -0,0 +1,16 @@
1
+ import type { FeatureToggle } from "../types/config.js";
2
+ /** Whether a resolved feature is on. Narrows to the enabled shape. */
3
+ export declare function isEnabled<T extends {
4
+ enabled: boolean;
5
+ }>(feature: T): feature is T & {
6
+ enabled: true;
7
+ };
8
+ /**
9
+ * Whether a feature toggle is on: `true` or an options object is on, and
10
+ * `false` is off. `undefined` uses `defaultOn`. A resolved `{ enabled }`
11
+ * object uses its flag.
12
+ */
13
+ export declare function isFeatureOn<T extends object>(value: FeatureToggle<T> | {
14
+ enabled: boolean;
15
+ } | undefined, defaultOn?: boolean): boolean;
16
+ //# sourceMappingURL=feature-toggle.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"feature-toggle.d.ts","sourceRoot":"","sources":["../../src/config/feature-toggle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,sEAAsE;AACtE,wBAAgB,SAAS,CAAC,CAAC,SAAS;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,EACtD,OAAO,EAAE,CAAC,GACT,OAAO,IAAI,CAAC,GAAG;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,CAElC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAC1C,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,EAC1D,SAAS,UAAQ,GAChB,OAAO,CAOT"}
@@ -0,0 +1,9 @@
1
+ import type { DimahS3Config } from "../types/config.js";
2
+ import type { ResolvedConfig } from "../types/resolved.js";
3
+ /**
4
+ * Checks the `dimahS3()` config, applies the documented defaults, and builds
5
+ * the hook lists: plugin hooks in plugin order, then the user hook. Throws
6
+ * on a config error, so `dimahS3()` fails at startup.
7
+ */
8
+ export declare function resolveConfig(config: DimahS3Config): ResolvedConfig;
9
+ //# sourceMappingURL=resolve-config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolve-config.d.ts","sourceRoot":"","sources":["../../src/config/resolve-config.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAUvD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,cAAc,CA8BnE"}
@@ -0,0 +1,37 @@
1
+ import type { DimahS3PluginHooks } from "../plugin/types.js";
2
+ import type { DimahS3Config, DimahS3Logger } from "../types/config.js";
3
+ import type { HookList, ResolvedRoute } from "../types/resolved.js";
4
+ /** The route hooks of a plugin: every slot but the instance `guard` and `ticketSubject`. */
5
+ export type RoutePluginHooks = Pick<DimahS3PluginHooks, "upload" | "download" | "delete">;
6
+ /** The parts of a plugin that route resolution reads. */
7
+ export type RoutePlugin = {
8
+ id: string;
9
+ hooks?: RoutePluginHooks;
10
+ };
11
+ export type ResolveRoutesOptions = {
12
+ /** Instance `maxExpiresIn`. Caps every route TTL. */
13
+ maxExpiresIn: number;
14
+ /** Plugins in order. A route skips a plugin it sets to `false`. */
15
+ plugins?: readonly RoutePlugin[];
16
+ /** Warns about a config that works but is likely a mistake. */
17
+ logger?: DimahS3Logger;
18
+ };
19
+ /**
20
+ * One hook slot in run order: each plugin's hook in plugin order, then the
21
+ * user hook.
22
+ */
23
+ export declare function hookList<P extends {
24
+ id: string;
25
+ }, H>(plugins: readonly P[], pick: (plugin: P) => H | undefined, user: H | undefined): HookList<H>;
26
+ /**
27
+ * Validates every route, applies the documented defaults, and builds each
28
+ * hook list from the plugins and the user config. Throws on a config
29
+ * error, so `dimahS3()` fails at startup.
30
+ */
31
+ export declare function resolveRoutes(config: Pick<DimahS3Config, "client" | "bucket" | "routes">, options: ResolveRoutesOptions): Record<string, ResolvedRoute>;
32
+ /**
33
+ * A positive safe integer, or `undefined` when unset. Anything else throws
34
+ * `"{label} must be a positive integer."`, so `dimahS3()` fails at startup.
35
+ */
36
+ export declare function optionalPositiveInteger(value: number | undefined, label: string): number | undefined;
37
+ //# sourceMappingURL=resolve-routes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolve-routes.d.ts","sourceRoot":"","sources":["../../src/config/resolve-routes.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAEV,aAAa,EAEb,aAAa,EAKd,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAEV,QAAQ,EAIR,aAAa,EAEd,MAAM,kBAAkB,CAAC;AAK1B,4FAA4F;AAC5F,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,kBAAkB,EAClB,QAAQ,GAAG,UAAU,GAAG,QAAQ,CACjC,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG;IACjC,qDAAqD;IACrD,YAAY,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,OAAO,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IACjC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,EAClD,OAAO,EAAE,SAAS,CAAC,EAAE,EACrB,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,SAAS,EAClC,IAAI,EAAE,CAAC,GAAG,SAAS,GAClB,QAAQ,CAAC,CAAC,CAAC,CAQb;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,EAC3D,OAAO,EAAE,oBAAoB,GAC5B,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAW/B;AAgOD;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,KAAK,EAAE,MAAM,GACZ,MAAM,GAAG,SAAS,CAMpB"}