openapi-ff 0.1.0 → 0.1.1

package/README.md

@@ -58,6 +58,7 @@ Advanced Usage:
 ```ts
 import { chainRoute } from "atomic-router";
 import { startChain } from "@farfetched/atomic-router";
+import { isApiError } from "openapi-ff";
 
 const getBlogpostFx = createApiEffect("get", "/blogposts/{post_id}", {
   mapParams: (args: { postId: string }) => ({ params: { path: { post_id: args.postId } } }),
@@ -85,14 +86,52 @@ const apiError = sample({
 
 > openapi-typescript by its design generates runtime-free static types, and only static types.
 
-To enable runtime validation, you can use third-party solutions, such as **[orval](https://orval.dev/)**:
+However, `openapi-ff` allows adding a contract factory when creating a client and provides a corresponding method, `createApiEffectWithContract`:
+
+```ts
+const { createApiEffectWithContract } = createClient(fetchClient, {
+  createContract(method, path) {
+    // ... create your own contract
+    return contract; // Contract<unknown, unknown>
+  },
+});
+
+const query = createQuery({
+  ...createApiEffectWithContract("get", "/blogposts"),
+});
+```
+
+### [typed-openapi](https://github.com/astahmer/typed-openapi) example
 
 ```bash
+npx typed-openapi path/to/api.yaml -o src/zod.ts -r zod # Generate zod schemas
 pnpm install zod @farfetched/zod
-npx orval --input path/to/api.yaml --output src/zod.ts --client zod --mode single
 ```
 
-Usage:
+```ts
+import { EndpointByMethod } from "./zod";
+import { zodContract } from "@farfetched/zod";
+
+const { createApiEffectWithContract } = createClient(fetchClient, {
+  createContract(method, path) {
+    const { response } = (EndpointByMethod as any)[method][path];
+    return zodContract(response);
+  },
+});
+
+const query = createQuery({
+  ...createApiEffectWithContract("get", "/blogposts"),
+});
+```
+
+### [orval](https://orval.dev/) example
+
+Alternatively, you can simply add any contract to a query:
+
+```bash
+pnpm install zod @farfetched/zod
+npx orval --input path/to/api.yaml --output src/zod.ts --client zod --mode single
+```
 
 ```ts
 import { zodContract } from "@farfetched/zod";

package/dist/openapi-ff.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("effector"),o=require("@farfetched/core"),f="API";function w(r){return{...r,errorType:f,explanation:"Request was finished with unsuccessful HTTP code"}}function E(r){var s;return((s=r.error)==null?void 0:s.errorType)===f}function d(r){return{createApiEffect:(s,i,e)=>{const l=s.toUpperCase(),T=r[l];return p.createEffect(async u=>{var c;const{data:h,error:a,response:t}=await T(i,((c=e==null?void 0:e.mapParams)==null?void 0:c.call(e,u))??u).catch(n=>{throw o.networkError({reason:(n==null?void 0:n.message)??null,cause:n})});if(a!=null&&a!=="")throw w({status:t.status,statusText:t.statusText,response:a});if(!t.ok)throw o.httpError({status:t.status,statusText:t.statusText,response:null});return h})}}}exports.createClient=d;exports.isApiError=E;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("effector"),l=require("@farfetched/core"),h="API";function C(t){return{...t,errorType:h,explanation:"Request was finished with unsuccessful HTTP code"}}function A(t){var e;return((e=t.error)==null?void 0:e.errorType)===h}function g(t,e={}){const u=(s,a,r)=>{const w=s.toUpperCase(),E=t[w];return p.createEffect(async i=>{var f;const{data:T,error:o,response:n}=await E(a,((f=r==null?void 0:r.mapParams)==null?void 0:f.call(r,i))??i).catch(c=>{throw l.networkError({reason:(c==null?void 0:c.message)??null,cause:c})});if(o!=null&&o!=="")throw C({status:n.status,statusText:n.statusText,response:o});if(!n.ok)throw l.httpError({status:n.status,statusText:n.statusText,response:null});return T})};return{createApiEffect:u,createApiEffectWithContract:(s,a,r)=>{if(e.createContract==null)throw new Error("'createContract' is missing in config");return{effect:u(s,a,r),contract:e.createContract(s,a.toString())}}}}exports.createClient=g;exports.isApiError=A;

package/dist/openapi-ff.d.cts

@@ -1,4 +1,5 @@
 import { Client } from 'openapi-fetch';
+import { Contract } from '@farfetched/core';
 import { Effect } from 'effector';
 import { FarfetchedError } from '@farfetched/core';
 import { FetchResponse } from 'openapi-fetch';
@@ -23,7 +24,16 @@ declare type CreateApiEffectOptions<Init> = {
     mapParams?: (init: any) => Init;
 };
 
-export declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>): OpenapiEffectorClient<Paths, Media>;
+declare type CreateApiEffectWithContract<Paths extends Record<string, Record<HttpMethod, {}>>, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, Media>>, Options extends CreateApiEffectOptions<Init> = {}>(method: Method, path: Path, options?: Options) => {
+    effect: Effect<Init extends undefined ? void : InitOrPrependInit<Init, Parameters<NonNullable<Options["mapParams"]>>[0], Options>, Response["data"], ApiError<number, Response["error"]> | HttpError | NetworkError>;
+    contract: Contract<unknown, Response["data"]>;
+};
+
+export declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>, config?: EffectorClientOptions): OpenapiEffectorClient<Paths, Media>;
+
+declare type EffectorClientOptions = {
+    createContract?: (method: HttpMethod, path: string) => Contract<unknown, unknown>;
+};
 
 declare type InitOrPrependInit<Init, PrependInit, Options extends CreateApiEffectOptions<Init>> = Options extends {
     mapParams: (init: any) => any;
@@ -33,6 +43,7 @@ export declare function isApiError(args: WithError): args is WithError<ApiError>
 
 declare interface OpenapiEffectorClient<Paths extends {}, Media extends MediaType = MediaType> {
     createApiEffect: CreateApiEffect<Paths, Media>;
+    createApiEffectWithContract: CreateApiEffectWithContract<Paths, Media>;
 }
 
 declare type WithError<T = any, P = Record<string, unknown>> = P & {

package/dist/openapi-ff.d.ts

@@ -1,4 +1,5 @@
 import { Client } from 'openapi-fetch';
+import { Contract } from '@farfetched/core';
 import { Effect } from 'effector';
 import { FarfetchedError } from '@farfetched/core';
 import { FetchResponse } from 'openapi-fetch';
@@ -23,7 +24,16 @@ declare type CreateApiEffectOptions<Init> = {
     mapParams?: (init: any) => Init;
 };
 
-export declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>): OpenapiEffectorClient<Paths, Media>;
+declare type CreateApiEffectWithContract<Paths extends Record<string, Record<HttpMethod, {}>>, Media extends MediaType> = <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, Media>>, Options extends CreateApiEffectOptions<Init> = {}>(method: Method, path: Path, options?: Options) => {
+    effect: Effect<Init extends undefined ? void : InitOrPrependInit<Init, Parameters<NonNullable<Options["mapParams"]>>[0], Options>, Response["data"], ApiError<number, Response["error"]> | HttpError | NetworkError>;
+    contract: Contract<unknown, Response["data"]>;
+};
+
+export declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>, config?: EffectorClientOptions): OpenapiEffectorClient<Paths, Media>;
+
+declare type EffectorClientOptions = {
+    createContract?: (method: HttpMethod, path: string) => Contract<unknown, unknown>;
+};
 
 declare type InitOrPrependInit<Init, PrependInit, Options extends CreateApiEffectOptions<Init>> = Options extends {
     mapParams: (init: any) => any;
@@ -33,6 +43,7 @@ export declare function isApiError(args: WithError): args is WithError<ApiError>
 
 declare interface OpenapiEffectorClient<Paths extends {}, Media extends MediaType = MediaType> {
     createApiEffect: CreateApiEffect<Paths, Media>;
+    createApiEffectWithContract: CreateApiEffectWithContract<Paths, Media>;
 }
 
 declare type WithError<T = any, P = Record<string, unknown>> = P & {

package/dist/openapi-ff.js

@@ -1,50 +1,59 @@
-import { createEffect as p } from "effector";
-import { networkError as T, httpError as i } from "@farfetched/core";
-const f = "API";
-function w(r) {
+import { createEffect as m } from "effector";
+import { networkError as E, httpError as T } from "@farfetched/core";
+const l = "API";
+function x(t) {
   return {
-    ...r,
-    errorType: f,
+    ...t,
+    errorType: l,
     explanation: "Request was finished with unsuccessful HTTP code"
   };
 }
-function A(r) {
-  var s;
-  return ((s = r.error) == null ? void 0 : s.errorType) === f;
+function P(t) {
+  var e;
+  return ((e = t.error) == null ? void 0 : e.errorType) === l;
 }
-function P(r) {
-  return {
-    createApiEffect: (s, c, t) => {
-      const l = s.toUpperCase(), h = r[l];
-      return p(async (u) => {
-        var o;
-        const { data: m, error: n, response: e } = await h(
-          c,
-          ((o = t == null ? void 0 : t.mapParams) == null ? void 0 : o.call(t, u)) ?? u
-        ).catch((a) => {
-          throw T({
-            reason: (a == null ? void 0 : a.message) ?? null,
-            cause: a
-          });
+function g(t, e = {}) {
+  const f = (a, s, r) => {
+    const h = a.toUpperCase(), p = t[h];
+    return m(async (u) => {
+      var i;
+      const { data: w, error: o, response: n } = await p(
+        s,
+        ((i = r == null ? void 0 : r.mapParams) == null ? void 0 : i.call(r, u)) ?? u
+      ).catch((c) => {
+        throw E({
+          reason: (c == null ? void 0 : c.message) ?? null,
+          cause: c
         });
-        if (n != null && n !== "")
-          throw w({
-            status: e.status,
-            statusText: e.statusText,
-            response: n
-          });
-        if (!e.ok)
-          throw i({
-            status: e.status,
-            statusText: e.statusText,
-            response: null
-          });
-        return m;
       });
+      if (o != null && o !== "")
+        throw x({
+          status: n.status,
+          statusText: n.statusText,
+          response: o
+        });
+      if (!n.ok)
+        throw T({
+          status: n.status,
+          statusText: n.statusText,
+          response: null
+        });
+      return w;
+    });
+  };
+  return {
+    createApiEffect: f,
+    createApiEffectWithContract: (a, s, r) => {
+      if (e.createContract == null)
+        throw new Error("'createContract' is missing in config");
+      return {
+        effect: f(a, s, r),
+        contract: e.createContract(a, s.toString())
+      };
     }
   };
 }
 export {
-  P as createClient,
-  A as isApiError
+  g as createClient,
+  P as isApiError
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ff",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "scripts": {
     "test": "vitest run --typecheck",
@@ -29,13 +29,15 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
+    "@farfetched/zod": "^0.12.8",
     "@types/node": "^20.12.7",
     "typescript": "5.1.6",
     "undici": "^6.21.0",
     "vite": "5",
     "vite-plugin-dts": "^3.8.3",
     "vite-tsconfig-paths": "4.2.1",
-    "vitest": "2.0.4"
+    "vitest": "2.0.4",
+    "zod": "^3.23.8"
   },
   "peerDependencies": {
     "@farfetched/core": "^0.12.8",