openapi-ff 0.1.3 → 0.2.2

package/README.md

@@ -2,7 +2,7 @@
 
 openapi-ff is a type-safe tiny wrapper around [effector](https://effector.dev/) and [farfetched](https://ff.effector.dev/) to work with OpenAPI schema.
 
-It works by using [openapi-fetch](../openapi-fetch) and [openapi-typescript](../openapi-typescript).
+It works by using [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) and [openapi-typescript](https://openapi-ts.dev/).
 
 ## Setup
 
@@ -21,17 +21,17 @@ npx openapi-typescript ./path/to/api/v1.yaml -o ./src/shared/api/schema.d.ts
 
 ```ts
 import createFetchClient from "openapi-fetch";
-import { createClient } from "openapi-ff";
+import { createEffectorClient } from "openapi-ff";
 import { createQuery } from "@farfetched/core";
 import type { paths } from "./schema"; // generated by openapi-typescript
 
 export const client = createFetchClient<paths>({
   baseUrl: "https://myapi.dev/v1/",
 });
-export const { createApiEffect } = createClient(client);
+export const { createApiEffect } = createEffectorClient(client);
 
 const blogpostQuery = createQuery({
-  effect: createApiEffect("get", "/blogposts/{post_id}"),
+  ...createApiEffect("get", "/blogposts/{post_id}"),
 });
 ```
 
@@ -60,11 +60,10 @@ 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 } } }),
-});
 const blogpostQuery = createQuery({
-  effect: getBlogpostFx,
+  ...createApiEffect("get", "/blogposts/{post_id}", {
+    mapParams: (args: { postId: string }) => ({ params: { path: { post_id: args.postId } } }),
+  }),
   mapData: ({ result, params }) => ({ ...result, ...params }),
   initialData: { body: "-", title: "-", postId: "0" },
 });
@@ -80,16 +79,31 @@ const apiError = sample({
 });
 ```
 
+Map with source:
+
+```ts
+import { mergeInitHeaders } from 'openapi-ff';
+
+const blogpostQuery = createQuery({
+  ...createApiEffect("get", "/blogposts/{post_id}", {
+    mapParams: {
+      source: $token,
+      fn: (token, init) => mergeInitHeaders(init, { Authorization: token }),
+    },
+  }),
+});
+```
+
 ## Runtime Validation
 
 `openapi-ff` does not handle runtime validation, as `openapi-typescript` [does not support it](https://github.com/openapi-ts/openapi-typescript/issues/1420#issuecomment-1792909086).
 
 > openapi-typescript by its design generates runtime-free static types, and only static types.
 
-However, `openapi-ff` allows adding a contract factory when creating a client and provides a corresponding method, `createApiEffectWithContract`:
+However, `openapi-ff` allows adding a contract factory when creating a client:
 
 ```ts
-const { createApiEffectWithContract } = createClient(fetchClient, {
+const { createApiEffect } = createEffectorClient(fetchClient, {
   createContract(method, path) {
     // ... create your own contract
     return contract; // Contract<unknown, unknown>
@@ -97,7 +111,7 @@ const { createApiEffectWithContract } = createClient(fetchClient, {
 });
 
 const query = createQuery({
-  ...createApiEffectWithContract("get", "/blogposts"),
+  ...createApiEffect("get", "/blogposts"),
 });
 ```
 
@@ -112,10 +126,9 @@ pnpm install zod @farfetched/zod
 import { EndpointByMethod } from "./zod";
 import { zodContract } from "@farfetched/zod";
 
-const { createApiEffectWithContract } = createClient(fetchClient, {
+const { createApiEffect } = createEffectorClient(fetchClient, {
   createContract(method, path) {
-    const endpoints = EndpointByMethod[method] as any;
-    const response = endpoints[path]?.response;
+    const response = (EndpointByMethod as any)[method][path]?.response;
     if (!response) {
       throw new Error(`Response schema for route "${method} ${path}" doesn't exist`);
     }
@@ -124,39 +137,6 @@ const { createApiEffectWithContract } = createClient(fetchClient, {
 });
 
 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";
-import { getBlogpostsResponseItem } from "./zod";
-
-const blogpostQuery = createQuery({
-  effect: createApiEffect("get", "/blogposts/{post_id}"),
-  contract: zodContract(getBlogpostsResponseItem),
-});
-```
-
-## TODO
-
-Add `createApiQuery`:
-
-```ts
-createApiQuery({
-  method: "get",
-  path: "/blogposts/{post_id}",
-  mapParams: (args: { postId: string }) => ({ params: { path: { post_id: args.postId } } }),
-  mapData: ({ result, params }) => ({ ...result, ...params }),
-  initialData: { body: "-", title: "-", postId: "0" },
+  ...createApiEffect("get", "/blogposts"),
 });
 ```

package/dist/openapi-ff.cjs

@@ -1 +1 @@
-"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 m(t,e={}){const u=(s,a,r)=>{const w=s.toUpperCase(),E=t[w];return p.createEffect(async f=>{var i;const{data:T,error:o,response:n}=await E(a,((i=r==null?void 0:r.mapParams)==null?void 0:i.call(r,f))??f).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)}}}}exports.createClient=m;exports.isApiError=A;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("@farfetched/core"),q=require("effector"),i=require("openapi-fetch"),x="API";function p(e){var a;return((a=e.error)==null?void 0:a.errorType)===x}function S(e,a){let s,t;return e===void 0?(s=i(),t=void 0):typeof e=="object"&&"request"in e?(s=e,t=a):(s=i(),t=e),{createApiEffect:(l,m,r)=>{var P,g;const A=l.toUpperCase(),T=s[A],y=((P=r==null?void 0:r.mapParams)==null?void 0:P.source)??q.createStore(null),d=!!(r!=null&&r.mapParams),h=!!(r!=null&&r.mapParams.fn),E=d?h?r.mapParams.fn:r.mapParams:null;return{effect:q.attach({source:y,effect:async(C,u)=>{let o=u;d&&(h?o=E(C,u):o=E(u));const{data:I,error:f,response:n}=await T(m,o).catch(c=>{throw w.networkError({reason:(c==null?void 0:c.message)??null,cause:c})});if(f!=null&&f!=="")throw b({status:n.status,statusText:n.statusText,response:f});if(!n.ok)throw w.httpError({status:n.status,statusText:n.statusText,response:null});return I}}),contract:((g=t==null?void 0:t.createContract)==null?void 0:g.call(t,l,m))??H()}}}}function b(e){return{...e,errorType:x,explanation:"Request was finished with unsuccessful API response"}}function v(e,a){return{...e,headers:i.mergeHeaders(e.headers,a)}}function H(){return{isData:e=>!0,getErrorMessages:()=>[]}}exports.createEffectorClient=S;exports.isApiError=p;exports.mergeInitHeaders=v;

package/dist/openapi-ff.d.cts

@@ -1,50 +1,122 @@
+import { BodySerializer } from 'openapi-fetch';
 import { Client } from 'openapi-fetch';
+import { ClientOptions } from 'openapi-fetch';
 import { Contract } from '@farfetched/core';
 import { Effect } from 'effector';
 import { FarfetchedError } from '@farfetched/core';
+import { FetchOptions } from 'openapi-fetch';
 import { FetchResponse } from 'openapi-fetch';
+import { HeadersOptions } from 'openapi-fetch';
 import { HttpError } from '@farfetched/core';
-import { HttpMethod } from 'openapi-typescript-helpers';
 import { MaybeOptionalInit } from 'openapi-fetch';
-import { MediaType } from 'openapi-typescript-helpers';
 import { NetworkError } from '@farfetched/core';
-import { PathsWithMethod } from 'openapi-typescript-helpers';
+import { ParamsOption } from 'openapi-fetch';
+import { ParseAs } from 'openapi-fetch';
+import { QuerySerializer } from 'openapi-fetch';
+import { QuerySerializerOptions } from 'openapi-fetch';
+import { RequestBodyOption } from 'openapi-fetch';
+import { Store } from 'effector';
 
 declare const API = "API";
 
-export declare interface ApiError<Status extends number = number, ApiResponse = unknown> extends FarfetchedError<typeof API> {
-    status: Status;
+declare type ApiError<S extends ErrorStatus, T> = {
+    status: S;
     statusText: string;
-    response: ApiResponse;
-}
+    response: T;
+} & FarfetchedError<typeof API>;
 
-declare type CreateApiEffect<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<Init extends undefined ? void : InitOrPrependInit<Init, Parameters<NonNullable<Options["mapParams"]>>[0], Options>, Response["data"], ApiError<number, Response["error"]> | HttpError | NetworkError>;
+declare type ApiErrors<Responses extends Record<string | number, any>> = {
+    [K in keyof Responses]: K extends ErrorStatus ? Responses[K] extends {
+        content: Record<string, any>;
+    } ? ApiError<K, FilterKeys<Responses[K]['content'], `${string}/json`>> : never : never;
+}[keyof Responses & ErrorStatus];
 
-declare type CreateApiEffectOptions<Init> = {
-    mapParams?: (init: any) => Init;
+declare type CreateApiEffect<Paths extends Record<string, Record<HttpMethod, {}>>> = {
+    <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Operation extends Paths[Path][Method], Responses extends ResponseObjectMap<Operation>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, `${string}/json`>>>(method: Method, path: Path): {
+        effect: Effect<OptionalParams<Init>, Response['data'], ApiErrors<Responses> | HttpError | NetworkError>;
+        contract: Contract<unknown, Response['data']>;
+    };
+    <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Operation extends Paths[Path][Method], Responses extends ResponseObjectMap<Operation>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, `${string}/json`>>, Source, NewInit = Init>(method: Method, path: Path, options: {
+        mapParams: {
+            source: Store<Source>;
+            fn: (source: Source, params: NewInit) => Init;
+        };
+    }): {
+        effect: Effect<OptionalParams<NewInit>, Response['data'], ApiErrors<Responses> | HttpError | NetworkError>;
+        contract: Contract<unknown, Response['data']>;
+    };
+    <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Operation extends Paths[Path][Method], Responses extends ResponseObjectMap<Operation>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, `${string}/json`>>, NewInit>(method: Method, path: Path, options: {
+        mapParams: (params: NewInit) => Init;
+    }): {
+        effect: Effect<OptionalParams<NewInit>, Response['data'], ApiErrors<Responses> | HttpError | NetworkError>;
+        contract: Contract<unknown, Response['data']>;
+    };
 };
 
-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 createEffectorClient<Paths extends {}>(): OpenapiEffectorClient<Paths>;
+
+export declare function createEffectorClient<Paths extends {}>(client: Client<Paths>): OpenapiEffectorClient<Paths>;
+
+export declare function createEffectorClient<Paths extends {}>(client: Client<Paths>, options: EffectorClientOptions<Paths>): OpenapiEffectorClient<Paths>;
 
-export declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>, config?: EffectorClientOptions<Paths>): OpenapiEffectorClient<Paths, Media>;
+export declare function createEffectorClient<Paths extends {}>(options: EffectorClientOptions<Paths>): OpenapiEffectorClient<Paths>;
 
-declare type EffectorClientOptions<Paths extends Record<string, Record<HttpMethod, {}>>> = {
+declare type EffectorClientOptions<Paths extends {}> = {
     createContract?: <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>>(method: Method, path: Path) => Contract<unknown, unknown>;
 };
 
-declare type InitOrPrependInit<Init, PrependInit, Options extends CreateApiEffectOptions<Init>> = Options extends {
-    mapParams: (init: any) => any;
-} ? PrependInit : Init;
+/** 2XX statuses */
+declare type ErrorStatus = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 | '5XX' | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | '4XX' | "default";
+
+/** Find first match of multiple keys */
+declare type FilterKeys<Obj, Matchers> = Obj[keyof Obj & Matchers];
+
+declare type HasRequiredKeys<T> = {} extends T ? true : false;
+
+declare type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+
+export declare function isApiError<S extends ErrorStatus, R>(args: WithError): args is WithError<ApiError<S, R>>;
+
+export declare function mergeInitHeaders<T>(init: FetchOptions<T>, headers: Record<string, any>): ParamsOption<T> & RequestBodyOption<T> & {
+    baseUrl?: string;
+    querySerializer?: QuerySerializerOptions | QuerySerializer<T> | undefined;
+    bodySerializer?: BodySerializer<T> | undefined;
+    parseAs?: ParseAs;
+    fetch?: ClientOptions["fetch"];
+    headers?: HeadersOptions;
+} & {
+    headers: Headers;
+    cache?: RequestCache | undefined;
+    credentials?: RequestCredentials | undefined;
+    integrity?: string | undefined;
+    keepalive?: boolean | undefined;
+    method?: string | undefined;
+    mode?: RequestMode | undefined;
+    priority?: RequestPriority | undefined;
+    redirect?: RequestRedirect | undefined;
+    referrer?: string | undefined;
+    referrerPolicy?: ReferrerPolicy | undefined;
+    signal?: (AbortSignal | null) | undefined;
+    window?: null | undefined;
+};
+
+declare type OpenapiEffectorClient<Paths extends {}> = {
+    createApiEffect: CreateApiEffect<Paths>;
+};
+
+declare type OptionalParams<T> = HasRequiredKeys<T> extends true ? T | void : T;
 
-export declare function isApiError(args: WithError): args is WithError<ApiError>;
+/** Given an OpenAPI **Paths Object**, find all paths that have the given method */
+declare type PathsWithMethod<Paths extends {}, PathnameMethod extends HttpMethod> = {
+    [Pathname in keyof Paths]: Paths[Pathname] extends {
+        [K in PathnameMethod]: any;
+    } ? Pathname : never;
+}[keyof Paths];
 
-declare interface OpenapiEffectorClient<Paths extends {}, Media extends MediaType = MediaType> {
-    createApiEffect: CreateApiEffect<Paths, Media>;
-    createApiEffectWithContract: CreateApiEffectWithContract<Paths, Media>;
-}
+/** Return `responses` for an Operation Object */
+declare type ResponseObjectMap<T> = T extends {
+    responses: any;
+} ? T['responses'] : unknown;
 
 declare type WithError<T = any, P = Record<string, unknown>> = P & {
     error: T;

package/dist/openapi-ff.d.ts

@@ -1,50 +1,122 @@
+import { BodySerializer } from 'openapi-fetch';
 import { Client } from 'openapi-fetch';
+import { ClientOptions } from 'openapi-fetch';
 import { Contract } from '@farfetched/core';
 import { Effect } from 'effector';
 import { FarfetchedError } from '@farfetched/core';
+import { FetchOptions } from 'openapi-fetch';
 import { FetchResponse } from 'openapi-fetch';
+import { HeadersOptions } from 'openapi-fetch';
 import { HttpError } from '@farfetched/core';
-import { HttpMethod } from 'openapi-typescript-helpers';
 import { MaybeOptionalInit } from 'openapi-fetch';
-import { MediaType } from 'openapi-typescript-helpers';
 import { NetworkError } from '@farfetched/core';
-import { PathsWithMethod } from 'openapi-typescript-helpers';
+import { ParamsOption } from 'openapi-fetch';
+import { ParseAs } from 'openapi-fetch';
+import { QuerySerializer } from 'openapi-fetch';
+import { QuerySerializerOptions } from 'openapi-fetch';
+import { RequestBodyOption } from 'openapi-fetch';
+import { Store } from 'effector';
 
 declare const API = "API";
 
-export declare interface ApiError<Status extends number = number, ApiResponse = unknown> extends FarfetchedError<typeof API> {
-    status: Status;
+declare type ApiError<S extends ErrorStatus, T> = {
+    status: S;
     statusText: string;
-    response: ApiResponse;
-}
+    response: T;
+} & FarfetchedError<typeof API>;
 
-declare type CreateApiEffect<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<Init extends undefined ? void : InitOrPrependInit<Init, Parameters<NonNullable<Options["mapParams"]>>[0], Options>, Response["data"], ApiError<number, Response["error"]> | HttpError | NetworkError>;
+declare type ApiErrors<Responses extends Record<string | number, any>> = {
+    [K in keyof Responses]: K extends ErrorStatus ? Responses[K] extends {
+        content: Record<string, any>;
+    } ? ApiError<K, FilterKeys<Responses[K]['content'], `${string}/json`>> : never : never;
+}[keyof Responses & ErrorStatus];
 
-declare type CreateApiEffectOptions<Init> = {
-    mapParams?: (init: any) => Init;
+declare type CreateApiEffect<Paths extends Record<string, Record<HttpMethod, {}>>> = {
+    <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Operation extends Paths[Path][Method], Responses extends ResponseObjectMap<Operation>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, `${string}/json`>>>(method: Method, path: Path): {
+        effect: Effect<OptionalParams<Init>, Response['data'], ApiErrors<Responses> | HttpError | NetworkError>;
+        contract: Contract<unknown, Response['data']>;
+    };
+    <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Operation extends Paths[Path][Method], Responses extends ResponseObjectMap<Operation>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, `${string}/json`>>, Source, NewInit = Init>(method: Method, path: Path, options: {
+        mapParams: {
+            source: Store<Source>;
+            fn: (source: Source, params: NewInit) => Init;
+        };
+    }): {
+        effect: Effect<OptionalParams<NewInit>, Response['data'], ApiErrors<Responses> | HttpError | NetworkError>;
+        contract: Contract<unknown, Response['data']>;
+    };
+    <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>, Operation extends Paths[Path][Method], Responses extends ResponseObjectMap<Operation>, Init extends MaybeOptionalInit<Paths[Path], Method>, Response extends Required<FetchResponse<Paths[Path][Method], Init, `${string}/json`>>, NewInit>(method: Method, path: Path, options: {
+        mapParams: (params: NewInit) => Init;
+    }): {
+        effect: Effect<OptionalParams<NewInit>, Response['data'], ApiErrors<Responses> | HttpError | NetworkError>;
+        contract: Contract<unknown, Response['data']>;
+    };
 };
 
-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 createEffectorClient<Paths extends {}>(): OpenapiEffectorClient<Paths>;
+
+export declare function createEffectorClient<Paths extends {}>(client: Client<Paths>): OpenapiEffectorClient<Paths>;
+
+export declare function createEffectorClient<Paths extends {}>(client: Client<Paths>, options: EffectorClientOptions<Paths>): OpenapiEffectorClient<Paths>;
 
-export declare function createClient<Paths extends {}, Media extends MediaType = MediaType>(client: Client<Paths, Media>, config?: EffectorClientOptions<Paths>): OpenapiEffectorClient<Paths, Media>;
+export declare function createEffectorClient<Paths extends {}>(options: EffectorClientOptions<Paths>): OpenapiEffectorClient<Paths>;
 
-declare type EffectorClientOptions<Paths extends Record<string, Record<HttpMethod, {}>>> = {
+declare type EffectorClientOptions<Paths extends {}> = {
     createContract?: <Method extends HttpMethod, Path extends PathsWithMethod<Paths, Method>>(method: Method, path: Path) => Contract<unknown, unknown>;
 };
 
-declare type InitOrPrependInit<Init, PrependInit, Options extends CreateApiEffectOptions<Init>> = Options extends {
-    mapParams: (init: any) => any;
-} ? PrependInit : Init;
+/** 2XX statuses */
+declare type ErrorStatus = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 | '5XX' | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | '4XX' | "default";
+
+/** Find first match of multiple keys */
+declare type FilterKeys<Obj, Matchers> = Obj[keyof Obj & Matchers];
+
+declare type HasRequiredKeys<T> = {} extends T ? true : false;
+
+declare type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+
+export declare function isApiError<S extends ErrorStatus, R>(args: WithError): args is WithError<ApiError<S, R>>;
+
+export declare function mergeInitHeaders<T>(init: FetchOptions<T>, headers: Record<string, any>): ParamsOption<T> & RequestBodyOption<T> & {
+    baseUrl?: string;
+    querySerializer?: QuerySerializerOptions | QuerySerializer<T> | undefined;
+    bodySerializer?: BodySerializer<T> | undefined;
+    parseAs?: ParseAs;
+    fetch?: ClientOptions["fetch"];
+    headers?: HeadersOptions;
+} & {
+    headers: Headers;
+    cache?: RequestCache | undefined;
+    credentials?: RequestCredentials | undefined;
+    integrity?: string | undefined;
+    keepalive?: boolean | undefined;
+    method?: string | undefined;
+    mode?: RequestMode | undefined;
+    priority?: RequestPriority | undefined;
+    redirect?: RequestRedirect | undefined;
+    referrer?: string | undefined;
+    referrerPolicy?: ReferrerPolicy | undefined;
+    signal?: (AbortSignal | null) | undefined;
+    window?: null | undefined;
+};
+
+declare type OpenapiEffectorClient<Paths extends {}> = {
+    createApiEffect: CreateApiEffect<Paths>;
+};
+
+declare type OptionalParams<T> = HasRequiredKeys<T> extends true ? T | void : T;
 
-export declare function isApiError(args: WithError): args is WithError<ApiError>;
+/** Given an OpenAPI **Paths Object**, find all paths that have the given method */
+declare type PathsWithMethod<Paths extends {}, PathnameMethod extends HttpMethod> = {
+    [Pathname in keyof Paths]: Paths[Pathname] extends {
+        [K in PathnameMethod]: any;
+    } ? Pathname : never;
+}[keyof Paths];
 
-declare interface OpenapiEffectorClient<Paths extends {}, Media extends MediaType = MediaType> {
-    createApiEffect: CreateApiEffect<Paths, Media>;
-    createApiEffectWithContract: CreateApiEffectWithContract<Paths, Media>;
-}
+/** Return `responses` for an Operation Object */
+declare type ResponseObjectMap<T> = T extends {
+    responses: any;
+} ? T['responses'] : unknown;
 
 declare type WithError<T = any, P = Record<string, unknown>> = P & {
     error: T;

package/dist/openapi-ff.js

@@ -1,59 +1,68 @@
-import { createEffect as m } from "effector";
-import { networkError as E, httpError as T } from "@farfetched/core";
-const l = "API";
-function x(t) {
+import { networkError as I, httpError as q } from "@farfetched/core";
+import { createStore as y, attach as k } from "effector";
+import E, { mergeHeaders as v } from "openapi-fetch";
+const P = "API";
+function R(e) {
+  var a;
+  return ((a = e.error) == null ? void 0 : a.errorType) === P;
+}
+function U(e, a) {
+  let s, t;
+  return e === void 0 ? (s = E(), t = void 0) : typeof e == "object" && "request" in e ? (s = e, t = a) : (s = E(), t = e), { createApiEffect: (m, i, r) => {
+    var w, x;
+    const p = m.toUpperCase(), A = s[p], T = ((w = r == null ? void 0 : r.mapParams) == null ? void 0 : w.source) ?? y(null), l = !!(r != null && r.mapParams), h = !!(r != null && r.mapParams.fn), d = l ? h ? r.mapParams.fn : r.mapParams : null;
+    return {
+      effect: k({
+        source: T,
+        effect: async (g, u) => {
+          let f = u;
+          l && (h ? f = d(g, u) : f = d(u));
+          const { data: C, error: o, response: n } = await A(i, f).catch((c) => {
+            throw I({
+              reason: (c == null ? void 0 : c.message) ?? null,
+              cause: c
+            });
+          });
+          if (o != null && o !== "")
+            throw F({
+              status: n.status,
+              statusText: n.statusText,
+              response: o
+            });
+          if (!n.ok)
+            throw q({
+              status: n.status,
+              statusText: n.statusText,
+              response: null
+            });
+          return C;
+        }
+      }),
+      contract: ((x = t == null ? void 0 : t.createContract) == null ? void 0 : x.call(t, m, i)) ?? H()
+    };
+  } };
+}
+function F(e) {
   return {
-    ...t,
-    errorType: l,
-    explanation: "Request was finished with unsuccessful HTTP code"
+    ...e,
+    errorType: P,
+    explanation: "Request was finished with unsuccessful API response"
   };
 }
-function P(t) {
-  var e;
-  return ((e = t.error) == null ? void 0 : e.errorType) === l;
-}
-function y(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 (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;
-    });
+function _(e, a) {
+  return {
+    ...e,
+    headers: v(e.headers, a)
   };
+}
+function H() {
   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)
-      };
-    }
+    isData: (e) => !0,
+    getErrorMessages: () => []
   };
 }
 export {
-  y as createClient,
-  P as isApiError
+  U as createEffectorClient,
+  R as isApiError,
+  _ as mergeInitHeaders
 };

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "openapi-ff",
-  "version": "0.1.3",
+  "version": "0.2.2",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/borolgs/openapi-ff.git"
+  },
   "scripts": {
     "test": "vitest run --typecheck",
     "build": "vite build",
@@ -31,7 +35,7 @@
     "@biomejs/biome": "^1.9.4",
     "@farfetched/zod": "^0.12.8",
     "@types/node": "^20.12.7",
-    "typescript": "5.1.6",
+    "typescript": "5.8.3",
     "undici": "^6.21.0",
     "vite": "5",
     "vite-plugin-dts": "^3.8.3",
@@ -44,7 +48,6 @@
     "effector": "^23.2.3"
   },
   "dependencies": {
-    "openapi-fetch": "^0.13.0",
-    "openapi-typescript-helpers": "^0.0.15"
+    "openapi-fetch": "^0.14.0"
   }
 }