effect-app 1.15.3 → 1.15.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @effect-app/prelude
 
+## 1.15.4
+
+### Patch Changes
+
+- 70c6222: improve doc
+
 ## 1.15.3
 
 ### Patch Changes

package/_cjs/client/router.cjs

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.makeClientRouter = void 0;
 var _REST = require("@effect-app/schema/REST");
 var _lib = require("../lib.cjs");
-// TODO: get rid of Request in Request
+// TODO: get rid of Request in Request and Response in C
 const makeClientRouter = () => {
   function Req() {
     return (fields, config) => {

package/_cjs/client/router.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"router.cjs","names":["_REST","require","_lib","makeClientRouter","Req","fields","config","req","success","Req_","Response","S","Void","req2","Object","assign","Request","exports"],"sources":["../../src/client/router.ts"],"sourcesContent":[null],"mappings":";;;;;;AACA,IAAAA,KAAA,GAAAC,OAAA;AAEA,IAAAC,IAAA,GAAAD,OAAA;AAEA;AACO,MAAME,gBAAgB,GAAGA,CAAA,KAAmC;EACjE,SAASC,GAAGA,CAAA;IAmEV,OAAO,CACLC,MAAc,EACdC,MAAU,KACR;MACF;MACA,MAAMC,GAAG,GAAGD,MAAM,EAAEE,OAAO,GACvB,IAAAC,SAAI,EAAI;QAAE,GAAGH,MAAM;QAAEI,QAAQ,EAAEJ,MAAM,CAACE;MAAO,CAAE,CAAC,EAAK,CAASH,MAAM,CAAC,GACrE,IAAAI,SAAI,EAAC;QAAE,GAAGH,MAAM;QAAEE,OAAO,EAAEG,MAAC,CAACC,IAAI;QAAEF,QAAQ,EAAEC,MAAC,CAACC;MAAI,CAAE,CAAC,EAAK,CAASP,MAAM,CAAC;MAC/E,MAAMQ,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACR,GAAG,EAAE;QAAES,OAAO,EAAET;MAAG,CAAE,CAAC,EAAC;MAClD,OAAOM,IAAI;IACb,CAAC;EACH;EAEA,OAAOT,GAAG;AACZ,CAAC;AAAAa,OAAA,CAAAd,gBAAA,GAAAA,gBAAA","ignoreList":[]}
+{"version":3,"file":"router.cjs","names":["_REST","require","_lib","makeClientRouter","Req","fields","config","req","success","Req_","Response","S","Void","req2","Object","assign","Request","exports"],"sources":["../../src/client/router.ts"],"sourcesContent":[null],"mappings":";;;;;;AACA,IAAAA,KAAA,GAAAC,OAAA;AACA,IAAAC,IAAA,GAAAD,OAAA;AAEA;AACO,MAAME,gBAAgB,GAAGA,CAAA,KAAmC;EAGjE,SAASC,GAAGA,CAAA;IAgEV,OAAQ,CACNC,MAAc,EACdC,MAAU,KACR;MACF;MACA,MAAMC,GAAG,GAAGD,MAAM,EAAEE,OAAO,GACvB,IAAAC,SAAI,EAAI;QAAE,GAAGH,MAAM;QAAEI,QAAQ,EAAEJ,MAAM,CAACE;MAAO,CAAE,CAAC,EAAK,CAASH,MAAM,CAAC,GACrE,IAAAI,SAAI,EAAC;QAAE,GAAGH,MAAM;QAAEE,OAAO,EAAEG,MAAC,CAACC,IAAI;QAAEF,QAAQ,EAAEC,MAAC,CAACC;MAAI,CAAE,CAAC,EAAK,CAASP,MAAM,CAAC;MAC/E,MAAMQ,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACR,GAAG,EAAE;QAAES,OAAO,EAAET;MAAG,CAAE,CAAC,EAAC;MAClD,OAAOM,IAAI;IACb,CAAC;EACH;EAEA,OAAOT,GAAG;AACZ,CAAC;AAAAa,OAAA,CAAAd,gBAAA,GAAAA,gBAAA","ignoreList":[]}

package/dist/client/router.d.ts

@@ -1,22 +1,32 @@
 import type { BuildRequest } from "@effect-app/schema/REST";
 import { S } from "../lib.js";
 export declare const makeClientRouter: <RequestConfig extends object>() => <M>() => {
-    <Fields extends S.Struct.Fields, C extends RequestConfig & {
+    <Fields extends S.Struct.Fields, C extends {
         success: S.Schema.Any;
-    }>(fields: Fields, config: C): BuildRequest<Fields, "/", "AUTO", M, C & {
+    }>(fields: Fields, config: RequestConfig & C): BuildRequest<Fields, "/", "AUTO", M, C & {
         Response: C["success"];
     }> & {
-        Request: BuildRequest<Fields, "/", "AUTO", M, C>;
+        Request: BuildRequest<Fields, "/", "AUTO", M, C & {
+            Response: C["success"];
+        }>;
     };
-    <Fields extends S.Struct.Fields, C_1 extends RequestConfig>(fields: Fields, config: C_1): BuildRequest<Fields, "/", "AUTO", M, C_1 & {
+    <Fields extends S.Struct.Fields>(fields: Fields, config: RequestConfig): BuildRequest<Fields, "/", "AUTO", M, {
+        success: typeof S.Void;
         Response: typeof S.Void;
     }> & {
-        Request: BuildRequest<Fields, "/", "AUTO", M, C_1>;
+        Request: BuildRequest<Fields, "/", "AUTO", M, {
+            success: typeof S.Void;
+            Response: typeof S.Void;
+        }>;
     };
     <Fields extends S.Struct.Fields>(fields: Fields): BuildRequest<Fields, "/", "AUTO", M, {
+        success: typeof S.Void;
         Response: typeof S.Void;
     }> & {
-        Request: BuildRequest<Fields, "/", "AUTO", M, import("vitest/dist/chunks/environment.C5eAp3K6.js").C>;
+        Request: BuildRequest<Fields, "/", "AUTO", M, {
+            success: typeof S.Void;
+            Response: typeof S.Void;
+        }>;
     };
 };
 //# sourceMappingURL=router.d.ts.map

package/dist/client/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/client/router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAG3D,OAAO,EAAE,CAAC,EAAE,MAAM,WAAW,CAAA;AAG7B,eAAO,MAAM,gBAAgB,GAAI,aAAa,SAAS,MAAM,QAC9C,CAAC,OAAK;IACjB,CAAC,MAA8B,SAAf,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAmD,SAAzC,aAAa,GAAG;QAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAA;KAAE,EAClF,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,CAAC,GAEP,YAAY,CACZ,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,CAAC,GAAG;QACF,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAA;KACvB,CACF,GACC;QACA,OAAO,EAAE,YAAY,CACnB,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,CAAC,CACF,CAAA;KACF,CAAA;IACH,CAAC,MAA8B,SAAf,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,GAAuB,SAAb,aAAa,EACtD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,GAAC,GAEP,YAAY,CACZ,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,GAAC,GAAG;QACF,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;KACxB,CACF,GACC;QACA,OAAO,EAAE,YAAY,CACnB,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,GAAC,CACF,CAAA;KACF,CAAA;IACH,CAAC,MAA8B,SAAf,CAAC,CAAC,MAAM,CAAC,MAAM,EAC7B,MAAM,EAAE,MAAM,GAEZ,YAAY,CACZ,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD;QACE,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;KACxB,CACF,GACC;QACA,OAAO,EAAE,YAAY,CACnB,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,sDAAC,CACF,CAAA;KACF,CAAA;CAgBN,CAAA"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/client/router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAE3D,OAAO,EAAE,CAAC,EAAE,MAAM,WAAW,CAAA;AAG7B,eAAO,MAAM,gBAAgB,GAAI,aAAa,SAAS,MAAM,QAG9C,CAAC,OAAK;IACjB,CAAC,MAA8B,SAAf,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAiB;iBAF1B,CAAC,CAAC,MAAM,CAAC,GAAG;KAEc,EAChD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,aAAa,GAAG,CAAC,GAEvB,YAAY,CACZ,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,CAAC,GAAG;QAAE,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAA;KAAE,CAC/B,GACC;QACA,OAAO,EAAE,YAAY,CACnB,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD,CAAC,GAAG;YAAE,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAA;SAAE,CAC/B,CAAA;KACF,CAAA;IACH,CAAC,MAA8B,SAAf,CAAC,CAAC,MAAM,CAAC,MAAM,EAC7B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,aAAa,GAEnB,YAAY,CACZ,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD;QAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;KAAE,CACpD,GACC;QACA,OAAO,EAAE,YAAY,CACnB,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD;YAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;YAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;SAAE,CACpD,CAAA;KACF,CAAA;IACH,CAAC,MAA8B,SAAf,CAAC,CAAC,MAAM,CAAC,MAAM,EAC7B,MAAM,EAAE,MAAM,GAEZ,YAAY,CACZ,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD;QACE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;QACtB,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;KACxB,CACF,GACC;QACA,OAAO,EAAE,YAAY,CACnB,MAAM,EACN,GAAG,EACH,MAAM,EACN,CAAC,EACD;YAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;YAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;SAAE,CACpD,CAAA;KACF,CAAA;CAgBN,CAAA"}

package/dist/client/router.js

@@ -1,17 +1,17 @@
 import { Req as Req_ } from "@effect-app/schema/REST";
 import { S } from "../lib.js";
-// TODO: get rid of Request in Request
+// TODO: get rid of Request in Request and Response in C
 export const makeClientRouter = () => {
     function Req() {
-        return (fields, config) => {
+        return ((fields, config) => {
             // TODO: get rid of Response, just use success (only all legacy migrated)
             const req = config?.success
                 ? Req_({ ...config, Response: config.success })()(fields)
                 : Req_({ ...config, success: S.Void, Response: S.Void })()(fields);
             const req2 = Object.assign(req, { Request: req }); // bwc
             return req2;
-        };
+        });
     }
     return Req;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaWVudC9yb3V0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEdBQUcsSUFBSSxJQUFJLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQTtBQUVyRCxPQUFPLEVBQUUsQ0FBQyxFQUFFLE1BQU0sV0FBVyxDQUFBO0FBRTdCLHNDQUFzQztBQUN0QyxNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRyxHQUFpQyxFQUFFO0lBQ2pFLFNBQVMsR0FBRztRQW1FVixPQUFPLENBQ0wsTUFBYyxFQUNkLE1BQVUsRUFDVixFQUFFO1lBQ0YseUVBQXlFO1lBQ3pFLE1BQU0sR0FBRyxHQUFHLE1BQU0sRUFBRSxPQUFPO2dCQUN6QixDQUFDLENBQUMsSUFBSSxDQUFJLEVBQUUsR0FBRyxNQUFNLEVBQUUsUUFBUSxFQUFFLE1BQU0sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxFQUFLLENBQVMsTUFBTSxDQUFDO2dCQUN2RSxDQUFDLENBQUMsSUFBSSxDQUFDLEVBQUUsR0FBRyxNQUFNLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQyxJQUFJLEVBQUUsUUFBUSxFQUFFLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxFQUFLLENBQVMsTUFBTSxDQUFDLENBQUE7WUFDL0UsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsRUFBRSxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQSxDQUFDLE1BQU07WUFDeEQsT0FBTyxJQUFJLENBQUE7UUFDYixDQUFDLENBQUE7SUFDSCxDQUFDO0lBRUQsT0FBTyxHQUFHLENBQUE7QUFDWixDQUFDLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaWVudC9yb3V0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEdBQUcsSUFBSSxJQUFJLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQTtBQUNyRCxPQUFPLEVBQUUsQ0FBQyxFQUFFLE1BQU0sV0FBVyxDQUFBO0FBRTdCLHdEQUF3RDtBQUN4RCxNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRyxHQUFpQyxFQUFFO0lBR2pFLFNBQVMsR0FBRztRQWdFVixPQUFPLENBQUMsQ0FDTixNQUFjLEVBQ2QsTUFBVSxFQUNWLEVBQUU7WUFDRix5RUFBeUU7WUFDekUsTUFBTSxHQUFHLEdBQUcsTUFBTSxFQUFFLE9BQU87Z0JBQ3pCLENBQUMsQ0FBQyxJQUFJLENBQUksRUFBRSxHQUFHLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxDQUFDLE9BQU8sRUFBRSxDQUFDLEVBQUssQ0FBUyxNQUFNLENBQUM7Z0JBQ3ZFLENBQUMsQ0FBQyxJQUFJLENBQUMsRUFBRSxHQUFHLE1BQU0sRUFBRSxPQUFPLEVBQUUsQ0FBQyxDQUFDLElBQUksRUFBRSxRQUFRLEVBQUUsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDLEVBQUssQ0FBUyxNQUFNLENBQUMsQ0FBQTtZQUMvRSxNQUFNLElBQUksR0FBRyxNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsRUFBRSxFQUFFLE9BQU8sRUFBRSxHQUFHLEVBQUUsQ0FBQyxDQUFBLENBQUMsTUFBTTtZQUN4RCxPQUFPLElBQUksQ0FBQTtRQUNiLENBQUMsQ0FBUSxDQUFBO0lBQ1gsQ0FBQztJQUVELE9BQU8sR0FBRyxDQUFBO0FBQ1osQ0FBQyxDQUFBIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "effect-app",
-  "version": "1.15.3",
+  "version": "1.15.4",
   "license": "MIT",
   "type": "module",
   "dependencies": {

package/src/client/router.ts

@@ -1,23 +1,22 @@
 import type { BuildRequest } from "@effect-app/schema/REST"
 import { Req as Req_ } from "@effect-app/schema/REST"
-import type { C } from "vitest/dist/chunks/environment.C5eAp3K6.js"
 import { S } from "../lib.js"
 
-// TODO: get rid of Request in Request
+// TODO: get rid of Request in Request and Response in C
 export const makeClientRouter = <RequestConfig extends object>() => {
+  // Long way around Context/C extends etc to support actual jsdoc from passed in RequestConfig etc...
+  type Context = { success: S.Schema.Any }
   function Req<M>(): {
-    <Fields extends S.Struct.Fields, C extends RequestConfig & { success: S.Schema.Any }>(
+    <Fields extends S.Struct.Fields, C extends Context>(
       fields: Fields,
-      config: C
+      config: RequestConfig & C
     ):
       & BuildRequest<
         Fields,
         "/",
         "AUTO",
         M,
-        C & {
-          Response: C["success"]
-        }
+        C & { Response: C["success"] }
       >
       & {
         Request: BuildRequest<
@@ -25,21 +24,19 @@ export const makeClientRouter = <RequestConfig extends object>() => {
           "/",
           "AUTO",
           M,
-          C
+          C & { Response: C["success"] }
         >
       }
-    <Fields extends S.Struct.Fields, C extends RequestConfig>(
+    <Fields extends S.Struct.Fields>(
       fields: Fields,
-      config: C
+      config: RequestConfig
     ):
       & BuildRequest<
         Fields,
         "/",
         "AUTO",
         M,
-        C & {
-          Response: typeof S.Void
-        }
+        { success: typeof S.Void; Response: typeof S.Void }
       >
       & {
         Request: BuildRequest<
@@ -47,7 +44,7 @@ export const makeClientRouter = <RequestConfig extends object>() => {
           "/",
           "AUTO",
           M,
-          C
+          { success: typeof S.Void; Response: typeof S.Void }
         >
       }
     <Fields extends S.Struct.Fields>(
@@ -59,6 +56,7 @@ export const makeClientRouter = <RequestConfig extends object>() => {
         "AUTO",
         M,
         {
+          success: typeof S.Void
           Response: typeof S.Void
         }
       >
@@ -68,11 +66,11 @@ export const makeClientRouter = <RequestConfig extends object>() => {
           "/",
           "AUTO",
           M,
-          C
+          { success: typeof S.Void; Response: typeof S.Void }
         >
       }
   } {
-    return <Fields extends S.Struct.Fields, C extends RequestConfig & { success: S.Schema.Any }>(
+    return (<Fields extends S.Struct.Fields, C extends Context>(
       fields: Fields,
       config?: C
     ) => {
@@ -82,7 +80,7 @@ export const makeClientRouter = <RequestConfig extends object>() => {
         : Req_({ ...config, success: S.Void, Response: S.Void })<M>()<Fields>(fields)
       const req2 = Object.assign(req, { Request: req }) // bwc
       return req2
-    }
+    }) as any
   }
 
   return Req