@resapi/core 0.2.0 → 0.4.0

package/README.md

@@ -8,4 +8,4 @@ npm install @resapi/core
 
 Add `"@resapi/core"` to `dependencies` in `rescript.json`. Modules are under the `ResApi` namespace.
 
-See the [README](https://github.com/Seaside-Logic/resapi#readme) and [API reference](https://github.com/Seaside-Logic/resapi/blob/main/docs/api.md).
+See the [README](https://github.com/Seaside-Logic/resapi#readme) and [API reference](https://github.com/Seaside-Logic/resapi/blob/main/site/content/api.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resapi/core",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Type-safe HTTP contracts for ReScript: endpoint contracts, codecs and a typed client.",
   "license": "MIT",
   "homepage": "https://resapi.dev",

package/src/Client.res

@@ -139,13 +139,13 @@ let requestInit = (
 ): Fetch.Request.requestInit => {
   let signal = signal->Option.map(Nullable.make)
   switch contract.method {
-  | Get => {
-      method: "GET",
+  | Get | Delete => {
+      method: Endpoint.methodName(contract.method),
       headers: Fetch.HeadersInit.fromDict(mergeHeaders([client.headers, headers])),
       ?signal,
     }
-  | Post => {
-      method: "POST",
+  | Post | Put => {
+      method: Endpoint.methodName(contract.method),
       headers: Fetch.HeadersInit.fromDict(
         mergeHeaders([client.headers, dict{"content-type": "application/json"}, headers]),
       ),

package/src/Dispatch.res

@@ -36,8 +36,8 @@ let applicationErrorResponse = (contract: Endpoint.t<_, _, _, _>, error) => {
 
 let readJsonBody = async (contract: Endpoint.t<_, _, _, _>, readBody) =>
   switch contract.method {
-  | Get => Ok(JSON.Null)
-  | Post =>
+  | Get | Delete => Ok(JSON.Null)
+  | Post | Put =>
     switch readBody() {
     | Parsed(json) => Ok(json)
     | Text(text) =>

package/src/Dispatch.resi

@@ -17,7 +17,7 @@ let errorResponse: (
   ~path: array<string>=?,
 ) => response
 
-/** `readBody` is called only for POST, after params decode. `handle` must return one of the contract's
+/** `readBody` is called only for POST and PUT, after params decode. `handle` must return one of the contract's
     declared errors. Any exception from a codec, `handle` or reading the body is logged and answered
     with a 500 that reveals nothing. */
 let run: (

package/src/Endpoint.res

@@ -2,7 +2,7 @@
 // it references no server or runtime code. Server adapters turn contracts into routes.
 // Constructors check the route's params against the params codec and throw on a mismatch (RouteCheck).
 
-type method = Get | Post
+type method = Get | Post | Put | Delete
 
 type noError
 
@@ -48,6 +48,32 @@ let post = (path, ~params, ~body, ~response) => {
   }
 }
 
+let put = (path, ~params, ~body, ~response) => {
+  RouteCheck.assertValid(path, params)
+  {
+    method: Put,
+    path,
+    paramsCodec: params,
+    bodyCodec: body,
+    responseCodec: response,
+    errorCodec: noErrorCodec,
+    errorStatus: _ => 500,
+  }
+}
+
+let delete = (path, ~params, ~response) => {
+  RouteCheck.assertValid(path, params)
+  {
+    method: Delete,
+    path,
+    paramsCodec: params,
+    bodyCodec: Codec.unit,
+    responseCodec: response,
+    errorCodec: noErrorCodec,
+    errorStatus: _ => 500,
+  }
+}
+
 let withErrors = (contract: t<'p, 'b, 'r, noError>, errorCodec: Codec.t<'e>, ~status) => {
   ...contract,
   errorCodec,
@@ -62,4 +88,6 @@ let methodName = method =>
   switch method {
   | Get => "GET"
   | Post => "POST"
+  | Put => "PUT"
+  | Delete => "DELETE"
   }

package/src/Endpoint.resi

@@ -1,13 +1,13 @@
 // A contract describes an endpoint's wire format and is safe to share with clients: it references no
 // server or runtime code. Server adapters turn contracts into routes.
 
-type method = Get | Post
+type method = Get | Post | Put | Delete
 
 /** The error type of an endpoint that declares no application errors. It has no values, so a handler
     for such an endpoint cannot return `Error(_)`. */
 type noError
 
-/** Read-only outside this module: contracts are built with `get`/`post`, which check the route. */
+/** Read-only outside this module: contracts are built with `get`/`post`/`put`/`delete`, which check the route. */
 type t<'params, 'body, 'response, 'error> = private {
   method: method,
   path: string,
@@ -30,6 +30,18 @@ let post: (
   ~response: Codec.t<'r>,
 ) => t<'p, 'b, 'r, noError>
 
+/** Throws if the route's `:params` don't match the params codec (see `RouteCheck`). */
+let put: (
+  string,
+  ~params: Codec.t<'p>,
+  ~body: Codec.t<'b>,
+  ~response: Codec.t<'r>,
+) => t<'p, 'b, 'r, noError>
+
+/** Like `get`, a DELETE contract has no request body. Throws if the route's `:params` don't match the
+    params codec (see `RouteCheck`). */
+let delete: (string, ~params: Codec.t<'p>, ~response: Codec.t<'r>) => t<'p, unit, 'r, noError>
+
 /** Declares the endpoint's application errors and the HTTP status (4xx or 5xx) each one is sent with. */
 let withErrors: (t<'p, 'b, 'r, noError>, Codec.t<'e>, ~status: 'e => int) => t<'p, 'b, 'r, 'e>
 
@@ -39,5 +51,5 @@ type any = private {method: method, path: string}
 
 let any: t<'p, 'b, 'r, 'e> => any
 
-/** `"GET"` or `"POST"`. */
+/** `"GET"`, `"POST"`, `"PUT"`, or `"DELETE"`. */
 let methodName: method => string

package/src/Fetch.res

@@ -6,7 +6,9 @@
 //
 // Mirrored from rescript-lang/experimental-rescript-webapi main as of 2026-10-11 (alpha build b1d58f9):
 // src/fetch/{Request,Response,Headers,HeadersInit,BodyInit,Fetch}.res, src/event/{AbortSignal,
-// AbortController}.res. Re-checked for 0.2.0 against main b46bc2c on 2026-10-11: those files are unchanged.
+// AbortController}.res. Re-checked for 0.4.0 against main 4888db2 on 2026-11-15: nothing mirrored here
+// changed (upstream retyped byte streams as Uint8Array and added `type t` aliases to Headers and
+// AbortController).
 // Re-check it at every resAPI release (docs/release-process.md).
 // Abstract types (Headers.t, AbortSignal.t) are subsets of webapi's records: the re-export adds
 // `type t = WebAPI.FetchTypes.headers` and `type t = WebAPI.DOM.abortSignal`.