@colisweb/rescript-toolkit 5.8.0 → 5.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colisweb/rescript-toolkit",
-  "version": "5.8.0",
+  "version": "5.8.1",
   "type": "module",
   "scripts": {
     "clean": "rescript clean",
@@ -29,7 +29,7 @@
   "dependencies": {
     "@colisweb/bs-react-intl-extractor-bin": "0.12.2",
     "@datadog/browser-rum": "5.8.0",
-    "@dck/rescript-ky": "2.0.3",
+    "@dck/rescript-ky": "2.0.4",
     "@dck/rescript-promise": "1.1.0",
     "@dck/restorative": "1.1.0",
     "@greenlabs/ppx-spice": "0.2.1",

package/src/request/index.md

@@ -4,100 +4,97 @@
 
 ```rescript
 module API = {
-  module FetchUsers = {
-    module Config = {
-      type argument = unit;
-
-      [@spice]
-      type response = array(user)
-      [@spice]
-      and user = {
-        name: string
-      };
-
-      type error = string;
-
-      let exec = clientId => {
-        request->Request.get(baseUrl(~clientId), response_decode);
-      };
-    };
+  let kyInstance = Ky.Instance.create({
+    prefixUrl: `${ColiswebApi__Env.v6ApiUrl}`,
+    timeout: ColiswebApi__Env.isNodeDevelopment ? 5000 : 20000,
+  })
 
-    module Request = Toolkit.Request.Make(Config);
+  module FetchUsers = {
+    type argument = ()
+
+    @spice
+    type user = {
+      id: string,
+      name: string
+    }
+
+    @spice
+    type response = {
+      users: array<user>
+    }
+
+    type error = unit
+
+    let config = () => {
+      kyInstance,
+      requestOptions: {
+        method: Ky.HttpMethod.GET,
+      },
+      key: [
+        "FetchUser"
+      ],
+      path: `/users`,
+    }
   };
 };
 
-API.FetchUsers.Request.exec();
+let (data, isLoading, _) = Request.useFetcher(module(API.FetchUsers), Some())
+
+Request.fetchAPI(module(API.FetchUsers), Some())
+->Promise.tapOk(({users}) => Js.log(users))
 ```
 
 ### Handle custom error
 
 ```rescript
 module API = {
+  let kyInstance = Ky.Instance.create({
+    prefixUrl: `${ColiswebApi__Env.v6ApiUrl}`,
+    timeout: ColiswebApi__Env.isNodeDevelopment ? 5000 : 20000,
+  })
+
   module FetchUsers = {
-    module Error = {
-      type errorType = [
-        | `overlappingActivations(array(activation))
-        | `compileError(string)
-        | `accessRefused
-        | `unknown
-      ]
-      [@spice]
-      and activation = {ruleTitle: string};
-
-      let encoder: Spice.encoder(errorType) = _v => ""->Spice.stringToJson;
-
-      let decoder: Spice.decoder(errorType) =
-        json => {
-          let error = json->Obj.magic;
-          let value =
-            switch (error##code) {
-            | Some("OVERLAPPING_ACTIVATIONS") =>
-              `overlappingActivations(
-                error##overlapped
-                ->Obj.magic
-                ->Array.map(a => a->activation_decode->Result.getExn),
-              )
-            | Some("COMPILE_ERROR") =>
-              `compileError(error##compileError->Obj.magic)
-            | Some("ACCESS_REFUSED") => `accessRefused
-            | _ => `unknown
-            };
-
-          value->Ok;
-        };
-
-      let codec: Spice.codec(errorType) = (encoder, decoder);
-
-      [@spice]
-      type t = [@spice.codec codec] errorType;
-    };
-
-    module Config = {
-      type argument = unit;
-
-      [@spice]
-      type response = array(user)
-      [@spice]
-      and user = {
-        name: string
-      };
-
-      [@spice]
-      type error = Error.t;
-
-      let exec = clientId => {
-        request->Request.get(baseUrl(~clientId), ~errorDecoder=error_decode,response_decode);
-      };
-    };
-
-    module Request = Toolkit.Request.Make(Config);
+    type argument = ()
+
+    @spice
+    type user = {
+      id: string,
+      name: string
+    }
+
+    @spice
+    type response = {
+      users: array<user>
+    }
+
+    type error = Anything
+
+    let config = () => {
+      kyInstance,
+      requestOptions: {
+        method: Ky.HttpMethod.GET,
+      },
+      key: [
+        "FetchUser"
+      ],
+      path: `/users`,
+      mapCustomErrors: error =>
+        switch error.response {
+        | Some({status: 409}) => Custom(Anything)
+        | _ => Unknown(error)
+        }->Promise.resolved,
+    }
   };
 };
 
-API.FetchUsers.Request.exec()
-->Promise.tapError(err => switch (err) {
-  | Custom(`accessRefused) => "handle refused access"
-  | Custom(`compileError(msg)) => msg
-  | _ => "else"
-});
+
+Request.fetchAPI(module(API.FetchUsers), Some())
+->Promise.tapOk(({users}) => Js.log(users))
+->Promise.tapError(error => {
+  switch error {
+    | Custom(Anything) => ...
+    | DecodeError(spiceError) => ...
+    | Unknown(kyError) => ...
+  }
+})
 ```