@ryneex/api-client 1.0.0-beta.1 → 1.0.0-beta.3

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as axios from 'axios';
-import { AxiosRequestConfig, AxiosError, AxiosInstance } from 'axios';
+import { AxiosRequestConfig, AxiosResponse, AxiosError, AxiosInstance } from 'axios';
 import z, { ZodError } from 'zod';
 import { UseQueryOptions, UseMutationOptions } from '@tanstack/react-query';
 
@@ -9,30 +9,43 @@ type ClientPayload<TInput, TVariables> = {} & (unknown extends TInput ? unknown
     variables: TVariables;
 });
 type OptionalPayload<T> = object extends T ? void : T;
-type ClientOptions<TOutputSchema extends z.ZodType, TInputSchema extends z.ZodType, TVariablesSchema extends z.ZodType, TOutput = z.infer<TOutputSchema>, TInput = z.infer<TInputSchema>, TVariables = z.infer<TVariablesSchema>> = {
+type ClientOptions<TOutputSchema extends z.ZodType, TInputSchema extends z.ZodType, TVariablesSchema extends z.ZodType, TOutput = z.output<TOutputSchema>, TInput = z.input<TInputSchema>, TVariables = z.input<TVariablesSchema>> = {
     method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     path: string | ((payload: ClientPayload<TInput, TVariables>) => string);
     axiosOptions?: (payload: ClientPayload<TInput, TVariables>) => AxiosRequestConfig;
     variablesSchema?: TVariablesSchema;
     inputSchema?: TInputSchema;
     outputSchema: TOutputSchema;
-    transform?: (data: z.infer<TOutputSchema>, payload: ClientPayload<TInput, TVariables>) => TOutput;
+    transform?: (data: z.output<TOutputSchema>, payload: ClientPayload<TInput, TVariables>) => TOutput;
 };
 
-type ReactQueryOptions<TOutput, TInput, TVariables> = Omit<UseQueryOptions<TOutput, ZodError<TOutput> | AxiosError>, "queryFn" | "queryKey"> & {
+type ReactQueryOptions<TOutput, TInput, TVariables> = Omit<UseQueryOptions<TOutput, ClientError>, "queryFn" | "queryKey"> & {
     queryKey?: unknown[];
 } & (object extends ClientPayload<TInput, TVariables> ? unknown : {
     data: ClientPayload<TInput, TVariables>;
 }) & {
     onSuccess?: (data: TOutput, payload: ClientPayload<TInput, TVariables>) => void;
-    onError?: (error: ZodError<TOutput> | AxiosError, payload: ClientPayload<TInput, TVariables>) => void;
+    onError?: (error: ClientError, payload: ClientPayload<TInput, TVariables>) => void;
 };
-type ReactMutationOptions<TOutput, TInput, TVariables> = Omit<UseMutationOptions<TOutput, ZodError<TOutput> | AxiosError, object extends ClientPayload<TInput, TVariables> ? void : ClientPayload<TInput, TVariables>>, "mutationFn"> & {};
+type ReactMutationOptions<TOutput, TInput, TVariables> = Omit<UseMutationOptions<TOutput, ClientError, object extends ClientPayload<TInput, TVariables> ? void : ClientPayload<TInput, TVariables>>, "mutationFn"> & {};
+
+type Ok<T> = {
+    success: true;
+    data: T;
+    response: AxiosResponse;
+};
+type ClientError = ValidationError | AxiosError;
+type Err<E> = {
+    success: false;
+    error: E;
+};
+type Result<T, E> = Ok<T> | Err<E>;
 
 declare function createClient(axios: AxiosInstance): {
-    create: <TOutputSchema extends z.ZodType, TInputSchema extends z.ZodType, TVariablesSchema extends z.ZodType, TOutput = z.core.output<TOutputSchema>, TInput = z.core.output<TInputSchema>, TVariables = z.core.output<TVariablesSchema>>(opts: ClientOptions<TOutputSchema, TInputSchema, TVariablesSchema, TOutput, TInput, TVariables>) => ((_payload: OptionalPayload<ClientPayload<TInput, TVariables>>) => Promise<axios.AxiosResponse<TOutput, any, {}>>) & {
-        queryOptions: (_opts: object extends ClientPayload<TInput, TVariables> ? ReactQueryOptions<TOutput, TInput, TVariables> | void : ReactQueryOptions<TOutput, TInput, TVariables>) => UseQueryOptions<TOutput, ZodError<TOutput> | AxiosError>;
-        mutationOptions: (_opts: ReactMutationOptions<TOutput, TInput, TVariables> | void) => UseMutationOptions<TOutput, ZodError<TOutput> | AxiosError, object extends ClientPayload<TInput, TVariables> ? void : ClientPayload<TInput, TVariables>>;
+    create: <TOutputSchema extends z.ZodType, TInputSchema extends z.ZodType, TVariablesSchema extends z.ZodType, TOutput = z.core.output<TOutputSchema>, TInput = z.core.input<TInputSchema>, TVariables = z.core.input<TVariablesSchema>>(opts: ClientOptions<TOutputSchema, TInputSchema, TVariablesSchema, TOutput, TInput, TVariables>) => ((_payload: OptionalPayload<ClientPayload<TInput, TVariables>>) => Promise<Result<TOutput, ClientError>>) & {
+        call: (_payload: OptionalPayload<ClientPayload<TInput, TVariables>>) => Promise<Result<TOutput, ClientError>>;
+        queryOptions: (_opts: object extends ClientPayload<TInput, TVariables> ? ReactQueryOptions<TOutput, TInput, TVariables> | void : ReactQueryOptions<TOutput, TInput, TVariables>) => UseQueryOptions<TOutput, ClientError>;
+        mutationOptions: (_opts: ReactMutationOptions<TOutput, TInput, TVariables> | void) => UseMutationOptions<TOutput, ClientError, object extends ClientPayload<TInput, TVariables> ? void : ClientPayload<TInput, TVariables>>;
         queryKey: (data?: ClientPayload<TInput, TVariables>) => (string | ClientPayload<TInput, TVariables>)[];
         mutationKey: () => string[];
         config: {
@@ -48,4 +61,24 @@ declare function createClient(axios: AxiosInstance): {
     };
 };
 
-export { createClient };
+declare function callApi<TOutputSchema extends z.ZodType, TInputSchema extends z.ZodType, TVariablesSchema extends z.ZodType, TOutput = z.output<TOutputSchema>, TInput = z.input<TInputSchema>, TVariables = z.input<TVariablesSchema>>(opts: ClientOptions<TOutputSchema, TInputSchema, TVariablesSchema, TOutput, TInput, TVariables> & {
+    axios: AxiosInstance;
+}, data: ClientPayload<TInput, TVariables>): Promise<Result<TOutput, ClientError>>;
+declare function getResponse<TOutputSchema extends z.ZodType, TInputSchema extends z.ZodType, TVariablesSchema extends z.ZodType, TOutput = z.output<TOutputSchema>, TInput = z.input<TInputSchema>, TVariables = z.input<TVariablesSchema>>(request: Promise<AxiosResponse<TOutput>>, opts: ClientOptions<TOutputSchema, TInputSchema, TVariablesSchema, TOutput, TInput, TVariables>, payload: ClientPayload<TInput, TVariables>): Promise<Result<TOutput, ClientError>>;
+
+declare const VALIDATION_ERROR_NAMES: {
+    readonly INPUT: "InputValidationError";
+    readonly VARIABLE: "VariableValidationError";
+    readonly OUTPUT: "OutputValidationError";
+};
+type ApiClientErrorProps = {
+    type: keyof typeof VALIDATION_ERROR_NAMES;
+    issues: z.core.$ZodIssue[];
+};
+declare class ValidationError extends ZodError {
+    constructor({ type, issues }: ApiClientErrorProps);
+}
+declare function ok<T>(data: T, response: AxiosResponse): Ok<T>;
+declare function err<E>(error: E): Err<E>;
+
+export { type ApiClientErrorProps, type ClientError, type ClientOptions, type ClientPayload, type Err, type Ok, type OptionalPayload, type ReactMutationOptions, type ReactQueryOptions, type Result, VALIDATION_ERROR_NAMES, ValidationError, callApi, createClient, err, getResponse, ok };

package/index.js

@@ -1,62 +1,5 @@
 // src/lib/api-client.ts
 import "zod";
-
-// src/lib/call-api.ts
-import "zod";
-async function callApi(opts, data) {
-  if (typeof data !== "object")
-    throw new Error("API SDK: Data must be an object");
-  if (opts.inputSchema && "input" in data) {
-    opts.inputSchema.parse(data.input);
-  }
-  if (opts.variablesSchema && "variables" in data) {
-    opts.variablesSchema.parse(data.variables);
-  }
-  const axiosOptions = opts.axiosOptions?.(data);
-  const url = typeof opts.path === "function" ? opts.path(data) : opts.path;
-  if (opts.method === "GET") {
-    const response = await opts.axios.get(url, axiosOptions);
-    return getResponse(opts, data, response);
-  }
-  if (opts.method === "POST") {
-    const response = await opts.axios.post(
-      url,
-      axiosOptions?.data,
-      axiosOptions
-    );
-    return getResponse(opts, data, response);
-  }
-  if (opts.method === "PUT") {
-    const response = await opts.axios.put(
-      url,
-      axiosOptions?.data,
-      axiosOptions
-    );
-    return getResponse(opts, data, response);
-  }
-  if (opts.method === "PATCH") {
-    const response = await opts.axios.patch(
-      url,
-      axiosOptions?.data,
-      axiosOptions
-    );
-    return getResponse(opts, data, response);
-  }
-  if (opts.method === "DELETE") {
-    const response = await opts.axios.delete(url, axiosOptions);
-    return getResponse(opts, data, response);
-  }
-  throw new Error(`API SDK: Unsupported method: ${opts.method}`);
-}
-function getResponse(opts, payload, response) {
-  const parsedData = opts.outputSchema.parse(response.data);
-  if (opts.transform) {
-    return { ...response, data: opts.transform(parsedData, payload) };
-  }
-  return { ...response, data: parsedData };
-}
-
-// src/lib/api-client.ts
 import "@tanstack/react-query";
 function createClient(axios) {
   function create(opts) {
@@ -73,14 +16,13 @@ function createClient(axios) {
       const data = _data ?? {};
       return {
         queryFn: async () => {
-          try {
-            const response = await callApi(apiOptionas, data);
-            options.onSuccess?.(response.data, data);
-            return response.data;
-          } catch (error) {
-            options.onError?.(error, data);
-            throw error;
+          const result = await callApi(apiOptionas, data);
+          if (result.success) {
+            options.onSuccess?.(result.data, data);
+            return result.data;
           }
+          options.onError?.(result.error, data);
+          throw result.error;
         },
         queryKey: queryKey(data),
         ...options
@@ -91,14 +33,16 @@ function createClient(axios) {
       return {
         mutationFn: async (_data) => {
           const data = _data ?? {};
-          const response = await callApi(apiOptionas, data);
-          return response.data;
+          const result = await callApi(apiOptionas, data);
+          if (result.success) return result.data;
+          throw result.error;
         },
         mutationKey: mutationKey(),
         ...options
       };
     };
     return Object.assign(call, {
+      call,
       queryOptions,
       mutationOptions,
       queryKey,
@@ -112,6 +56,116 @@ function createClient(axios) {
   }
   return { create };
 }
+
+// src/lib/call-api.ts
+import "zod";
+async function callApi(opts, data) {
+  if (typeof data !== "object")
+    throw new Error("API_CLIENT_INTERNAL_ERROR: Data must be an object");
+  if (opts.inputSchema && "input" in data) {
+    const parsedResult = opts.inputSchema.safeParse(data.input);
+    if (!parsedResult.success)
+      return err(
+        new ValidationError({
+          type: "INPUT",
+          issues: parsedResult.error.issues
+        })
+      );
+  }
+  if (opts.variablesSchema && "variables" in data) {
+    const parsedResult = opts.variablesSchema.safeParse(data.variables);
+    if (!parsedResult.success)
+      return err(
+        new ValidationError({
+          type: "VARIABLE",
+          issues: parsedResult.error.issues
+        })
+      );
+  }
+  const axiosOptions = opts.axiosOptions?.(data);
+  const url = typeof opts.path === "function" ? opts.path(data) : opts.path;
+  if (opts.method === "GET") {
+    return await getResponse(
+      opts.axios.get(url, axiosOptions),
+      opts,
+      data
+    );
+  }
+  if (opts.method === "POST") {
+    return await getResponse(
+      opts.axios.post(url, axiosOptions?.data, axiosOptions),
+      opts,
+      data
+    );
+  }
+  if (opts.method === "PUT") {
+    return await getResponse(
+      opts.axios.put(url, axiosOptions?.data, axiosOptions),
+      opts,
+      data
+    );
+  }
+  if (opts.method === "PATCH") {
+    return await getResponse(
+      opts.axios.patch(url, axiosOptions?.data, axiosOptions),
+      opts,
+      data
+    );
+  }
+  if (opts.method === "DELETE") {
+    return await getResponse(
+      opts.axios.delete(url, axiosOptions),
+      opts,
+      data
+    );
+  }
+  throw new Error(`API SDK: Unsupported method: ${opts.method}`);
+}
+async function getResponse(request, opts, payload) {
+  try {
+    const response = await request;
+    const parsedResult = opts.outputSchema.safeParse(response.data);
+    if (!parsedResult.success)
+      return err(
+        new ValidationError({
+          type: "OUTPUT",
+          issues: parsedResult.error.issues
+        })
+      );
+    if (opts.transform) {
+      return ok(opts.transform(parsedResult.data, payload), response);
+    }
+    return ok(parsedResult.data, response);
+  } catch (error) {
+    return err(error);
+  }
+}
+
+// src/lib/result.ts
+import { ZodError } from "zod";
+var VALIDATION_ERROR_NAMES = {
+  INPUT: "InputValidationError",
+  VARIABLE: "VariableValidationError",
+  OUTPUT: "OutputValidationError"
+};
+var ValidationError = class extends ZodError {
+  constructor({ type, issues }) {
+    super(issues);
+    this.name = VALIDATION_ERROR_NAMES[type];
+  }
+};
+function ok(data, response) {
+  return { success: true, data, response };
+}
+function err(error) {
+  return { success: false, error };
+}
 export {
-  createClient
+  VALIDATION_ERROR_NAMES,
+  ValidationError,
+  callApi,
+  createClient,
+  err,
+  getResponse,
+  ok
 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ryneex/api-client",
   "module": "src/index.ts",
   "type": "module",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "exports": {
     ".": "./index.js"
   },