Simplified type exports

[diego-aquino]

No description provided.

[diego-aquino]

Migration guide

As part of Zimic's export improvements, generic HTTP types are now exported directly from zimic, as opposed to zimic/interceptor. This is more appropriate because those types are not specific to Zimic interceptors.

1. Moved HTTP type exports

No behavior changes were added to the moved types. Therefore, migrating to the new exports amounts to renaming the types and importing them from zimic directly.

Previously exported from zimic/interceptor:	Equivalent now exported from zimic:
HttpInterceptorMethod	HttpMethod
HttpInterceptorMethodSchema	HttpServiceMethodSchema
HttpInterceptorPathSchema	HttpServiceMethodsSchema
HttpInterceptorRequestSchema	HttpServiceRequestSchema
HttpInterceptorResponseSchema	HttpServiceResponseSchema
HttpInterceptorResponseSchemaByStatusCode	HttpServiceResponseSchemaByStatusCode
HttpInterceptorResponseSchemaStatusCode	HttpServiceResponseSchemaStatusCode
HttpInterceptorSchemaMethod	HttpServiceSchemaMethod
HttpInterceptorSchemaPath	HttpServiceSchemaPath
LiteralHttpInterceptorSchemaPath	LiteralHttpServiceSchemaPath
NonLiteralHttpInterceptorSchemaPath	NonLiteralHttpServiceSchemaPath
HttpInterceptorSearchParamsSchema	HttpSearchParamsSchema
HttpInterceptorBodySchema	HttpBody
HttpInterceptorSchema	HttpServiceSchema
HttpInterceptorSchema.Root	HttpSchema.Paths
HttpInterceptorSchema.Path	HttpSchema.Methods
HttpInterceptorSchema.Method	HttpSchema.Method
HttpInterceptorSchema.Request	HttpSchema.Request
HttpInterceptorSchema.ResponseByStatusCode	HttpSchema.ResponseByStatusCode
HttpInterceptorSchema.Response	HttpSchema.Response
HttpInterceptorSchema.Headers	HttpSchema.Headers
HttpInterceptorSchema.SearchParams	HttpSchema.SearchParams
HttpInterceptorSchema.Body	JSONValue

HttpSchema is a namespace, so it is imported as import { HttpSchema } from 'zimic';

2. JSONCompatible unified to JSONValue

On https://github.com/diego-aquino/zimic/issues/106, we introduced a strict JSON validation, adding the type JSONCompatible. That type was now unified with JSONValue, which both represents a JSON value and is capable of validating JSON types. We now recommend using JSONValue to declare the JSON entities used as bodies in interceptor schemas.

Generic example of JSONValue:

import { JSONValue } from 'zimic';

// `JSONValue` can be used to type expected JSON values...
function doSomething(value: JSONValue) {
  // ...
}

// ... also declare types compatible with JSON
type User = JSONValue<{
  id: string;
  name: string;
}>

type InvalidUser = JSONValue<{
  id: string;
  name: string;
  createdAt: Date // shows an error, since `Date` is not a JSON value
}>

Example of JSONValue with interceptors:

import type { JSONValue } from 'zimic';

type Organization = JSONValue<{
  id: string;
  name: string;
}>;

type User = JSONValue<{
  id: string;
  name: string;
  organization: Organization
}>;

const interceptor = createHttpInterceptor<{
  GET: {
    response: {
      200: { body: User[] };
    };
  };
}>({
  worker,
  baseURL: 'http://localhost:3000',
});