Add a schema option to the options object

[d-a-ve]

Feature:

Adding an option where consumers can pass a schema to be used for validating the response from the request.

Reason:

This option will give consumers the guarantee of the response matching the schema provided and that their application will not break due to a change in the response structure.

Example:

This is an example code snippet from a replication of the API call request with an option to pass a schema.

export async function apiCall<T>(args: {
  url: `/${string}`;
  method: AxiosRequestConfig["method"];
  data?: Record<string, unknown>;
  params?: Record<string, unknown>;
  schema: ZodSchema<T>;
}): Promise<SuccessResponse<T>> {
  const { url, method, data, params, schema } = args;
  try {
    const res = await $http.request<T>({
      url,
      method,
      data,
      params,
      headers: {
        "Content-Type": "application/json",
        Accept: "application/json",
      },
    });
    const parsed = schema.parse(res.data);
    return { success: true, data: parsed };
  } catch (e: unknown) {
    if (e instanceof AxiosError) {
      throw {
        success: false,
        error: {
          message: e.response?.data.message || "An error occurred",
          status: e.response?.status || 500,
        },
      };
    }

    if (e instanceof ZodError) {
      throw {
        success: false,
        error: {
          message: "Something went wrong, please try again later!",
          status: 500,
        },
      };
    }

    throw {
      success: false,
      error: {
        message: "An error occurred",
        status: 500,
      },
    };
  }
}