@zimic/interceptor 1.2.7-canary.2 → 1.3.0-canary.1

package/dist/http.d.ts

@@ -64,6 +64,83 @@ declare class DisabledRequestSavingError extends TypeError {
     constructor();
 }
 
+type JSON = {
+    [key: string]: JSON;
+} | JSON[] | string | number | boolean | null | undefined;
+declare namespace JSON {
+    type Loose = Record<string, any> | Loose[] | string | number | boolean | null | undefined;
+}
+/**
+ * Represents or validates a type that is compatible with JSON.
+ *
+ * **IMPORTANT**: the input of `JSONValue` and all of its internal types must be declared inline or as a type aliases
+ * (`type`). They cannot be interfaces.
+ *
+ * @example
+ *   import { type JSONValue } from '@zimic/http';
+ *
+ *   // Can be used as a standalone type:
+ *   const value: JSONValue = {
+ *     name: 'example',
+ *     tags: ['one', 'two'],
+ *   };
+ *
+ * @example
+ *   import { type JSONValue } from '@zimic/http';
+ *
+ *   // Can be used with a type argument to validate a JSON value:
+ *   type ValidJSON = JSONValue<{
+ *     id: string;
+ *     email: string;
+ *     createdAt: string;
+ *   }>;
+ *
+ *   // This results in a type error:
+ *   type InvalidJSON = JSONValue<{
+ *     id: string;
+ *     email: string;
+ *     createdAt: Date; // `Date` is not a valid JSON value.
+ *     save: () => Promise<void>; // Functions are not valid JSON values.
+ *   }>;
+ */
+type JSONValue<Type extends JSON = JSON> = Type;
+declare namespace JSONValue {
+    /** A loose version of the JSON value type. JSON objects are not strictly typed. */
+    type Loose<Type extends JSON.Loose = JSON.Loose> = Type;
+}
+/**
+ * Recursively converts a type to its JSON-serialized version. Dates are converted to strings and keys with non-JSON
+ * values are excluded.
+ *
+ * @example
+ *   import { type JSONSerialized } from '@zimic/http';
+ *
+ *   type SerializedUser = JSONSerialized<{
+ *     id: string;
+ *     email: string;
+ *     createdAt: Date;
+ *     save: () => Promise<void>;
+ *   }>;
+ *   // {
+ *   //   id: string;
+ *   //   email: string;
+ *   //   createdAt: string;
+ *   // }
+ */
+type JSONSerialized<Type> = Type extends JSONValue ? Type : Type extends Date ? string : Type extends (...parameters: never[]) => unknown ? never : Type extends symbol ? never : Type extends Map<infer _Key, infer _Value> ? Record<string, never> : Type extends Set<infer _Value> ? Record<string, never> : Type extends (infer ArrayItem)[] ? JSONSerialized<ArrayItem>[] : Type extends object ? {
+    [Key in keyof Type as [JSONSerialized<Type[Key]>] extends [never] ? never : Key]: JSONSerialized<Type[Key]>;
+} : never;
+declare global {
+    interface JSON {
+        readonly value: unique symbol;
+        stringify<Value>(value: Value, replacer?: ((this: any, key: string, value: Value) => any) | (number | string)[] | null, space?: string | number): JSONStringified<Value>;
+        parse<Value>(text: JSONStringified<Value>, reviver?: (this: any, key: string, value: any) => any): JSONSerialized<Value>;
+    }
+}
+type JSONStringified<Value> = string & {
+    [JSON.value]: JSONSerialized<Value>;
+};
+
 type Default<Type, IfEmpty = never> = [undefined | void] extends [Type] ? IfEmpty : Exclude<Type, undefined | void>;
 type IfNever<Type, Yes, No = Type> = [Type] extends [never] ? Yes : No;
 type PossiblePromise<Type> = Type | PromiseLike<Type>;
@@ -98,10 +175,18 @@ type HttpRequestHandlerResponseDeclarationWithHeaders<ResponseSchema extends Htt
     headers: HttpRequestHandlerResponseDeclarationHeaders<ResponseSchema>;
 };
 /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
-type HttpRequestHandlerResponseDeclaration<MethodSchema extends HttpMethodSchema = HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = StatusCode extends StatusCode ? {
+type HttpRequestHandlerStatusResponseDeclaration<MethodSchema extends HttpMethodSchema = HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = StatusCode extends StatusCode ? {
     status: StatusCode;
+    action?: never;
 } & HttpRequestHandlerResponseWithBody<Default<Default<MethodSchema['response']>[StatusCode]>, StatusCode> & HttpRequestHandlerResponseDeclarationWithHeaders<Default<Default<MethodSchema['response']>[StatusCode]>> : never;
 /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
+interface HttpRequestHandlerActionResponseDeclaration {
+    status?: never;
+    action: UnhandledRequestStrategy.Action;
+}
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
+type HttpRequestHandlerResponseDeclaration<MethodSchema extends HttpMethodSchema = HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = HttpRequestHandlerStatusResponseDeclaration<MethodSchema, StatusCode> | HttpRequestHandlerActionResponseDeclaration;
+/** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerrespond `handler.respond()` API reference} */
 type HttpRequestHandlerResponseDeclarationFactory<Path extends string, MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = (request: Omit<HttpInterceptorRequest<Path, MethodSchema>, 'response'>) => PossiblePromise<HttpRequestHandlerResponseDeclaration<MethodSchema, StatusCode>>;
 /** @see {@link https://zimic.dev/docs/interceptor/api/http-request-handler#handlerdelay `handler.delay()` API reference} */
 type HttpRequestHandlerResponseDelayFactory<Path extends string, MethodSchema extends HttpMethodSchema> = (request: Omit<HttpInterceptorRequest<Path, MethodSchema>, 'response'>) => PossiblePromise<number>;
@@ -177,7 +262,11 @@ type HttpInterceptorPlatform = 'node' | 'browser';
 /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
 declare namespace UnhandledRequestStrategy {
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
-    type Action = 'bypass' | 'reject';
+    type LocalAction = 'bypass' | 'reject';
+    /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
+    type RemoteAction = 'reject';
+    /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
+    type Action = LocalAction | RemoteAction;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
     interface Declaration<DeclarationAction extends Action = Action> {
         /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
@@ -188,13 +277,13 @@ declare namespace UnhandledRequestStrategy {
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
     type DeclarationFactory<DeclarationAction extends Action = Action> = (request: UnhandledHttpInterceptorRequest) => PossiblePromise<Declaration<DeclarationAction>>;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
-    type LocalDeclaration = Declaration;
+    type LocalDeclaration = Declaration<LocalAction>;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
-    type LocalDeclarationFactory = DeclarationFactory;
+    type LocalDeclarationFactory = DeclarationFactory<LocalAction>;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
-    type RemoteDeclaration = Declaration<'reject'>;
+    type RemoteDeclaration = Declaration<RemoteAction>;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
-    type RemoteDeclarationFactory = DeclarationFactory<'reject'>;
+    type RemoteDeclarationFactory = DeclarationFactory<RemoteAction>;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */
     type Local = LocalDeclaration | LocalDeclarationFactory;
     /** @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests} */