mock-config-server 3.6.0 → 3.7.0

package/dist/src/utils/types/interceptors.d.ts

@@ -1,15 +1,18 @@
 import type { CookieOptions, Request, Response } from 'express';
+import type { Logger, LoggerTokens } from './logger';
+import type { ApiType } from './shared';
 type RequestInterceptorCookieValue = string | undefined;
 type RequestInterceptorHeaderValue = string | number | string[] | undefined;
-export interface RequestInterceptorParams {
+export interface RequestInterceptorParams<Api extends ApiType = ApiType> {
     request: Request;
     setDelay: (delay: number) => Promise<void>;
     getCookie: (name: string) => RequestInterceptorCookieValue;
     getHeader: (field: string) => RequestInterceptorHeaderValue;
     getHeaders: () => Record<string, RequestInterceptorHeaderValue>;
+    log: (logger?: Logger<'request', Api>) => Partial<LoggerTokens>;
 }
-export type RequestInterceptor = (params: RequestInterceptorParams) => void | Promise<void>;
-export interface ResponseInterceptorParams {
+export type RequestInterceptor<Api extends ApiType = ApiType> = (params: RequestInterceptorParams<Api>) => void | Promise<void>;
+export interface ResponseInterceptorParams<Api extends ApiType = ApiType> {
     request: Request;
     response: Response;
     setDelay: (delay: number) => Promise<void>;
@@ -22,10 +25,11 @@ export interface ResponseInterceptorParams {
     getCookie: (name: string) => RequestInterceptorCookieValue;
     clearCookie: (name: string, options?: CookieOptions) => void;
     attachment: (filename: string) => void;
+    log: (logger?: Logger<'response', Api>) => Partial<LoggerTokens>;
 }
-export type ResponseInterceptor<Data = any> = (data: Data, params: ResponseInterceptorParams) => any;
-export interface Interceptors {
-    request?: RequestInterceptor;
-    response?: ResponseInterceptor;
+export type ResponseInterceptor<Data = any, Api extends ApiType = ApiType> = (data: Data, params: ResponseInterceptorParams<Api>) => any;
+export interface Interceptors<Api extends ApiType = ApiType> {
+    request?: RequestInterceptor<Api>;
+    response?: ResponseInterceptor<any, Api>;
 }
 export {};

package/dist/src/utils/types/logger.d.ts

@@ -0,0 +1,43 @@
+import type { GraphQLOperationName, GraphQLOperationType } from './graphql';
+import type { RestMethod } from './rest';
+import type { ApiType } from './shared';
+import type { Cookies, Headers, Params, PlainObject, Query } from './values';
+export interface LoggerBaseTokens {
+    type: string;
+    id: number;
+    timestamp: number;
+    method: RestMethod;
+    url: string;
+    headers: Headers;
+    cookies: Cookies;
+    query: Query;
+    params: Params;
+    body: any;
+}
+interface LoggerRestRequestTokens extends LoggerBaseTokens {
+}
+interface LoggerRestResponseTokens extends LoggerRestRequestTokens {
+    statusCode: number;
+    data: any;
+}
+interface LoggerGraphQLRequestTokens extends LoggerBaseTokens {
+    graphQLOperationType: GraphQLOperationType | null;
+    graphQLOperationName: GraphQLOperationName | null;
+    graphQLQuery: string | null;
+    variables: PlainObject | null;
+}
+interface LoggerGraphQLResponseTokens extends LoggerGraphQLRequestTokens {
+    statusCode: number;
+    data: any;
+}
+export type LoggerType = 'request' | 'response';
+export type LoggerTokens<Type extends LoggerType = LoggerType, Api extends ApiType = ApiType> = Type extends 'request' ? Api extends 'rest' ? LoggerRestRequestTokens : Api extends 'graphql' ? LoggerGraphQLRequestTokens : never : Type extends 'response' ? Api extends 'rest' ? LoggerRestResponseTokens : Api extends 'graphql' ? LoggerGraphQLResponseTokens : never : never;
+type LoggerTokensToLoggerOptions<Type> = {
+    [Key in keyof Type]?: Type[Key] extends PlainObject ? Record<string, boolean> | boolean : boolean;
+};
+export type LoggerOptions<Type extends LoggerType = LoggerType, Api extends ApiType = ApiType> = LoggerTokensToLoggerOptions<LoggerTokens<Type, Api>>;
+export interface Logger<Type extends LoggerType = LoggerType, Api extends ApiType = ApiType> {
+    options?: LoggerOptions<Type, Api>;
+    rewrite?: (tokens: Partial<LoggerTokens<Type, Api>>) => void;
+}
+export {};

package/dist/src/utils/types/logger.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/dist/src/utils/types/rest.d.ts

@@ -36,14 +36,14 @@ export type RestRouteConfig<Method extends RestMethod> = ({
     file: string;
 }) & {
     entities?: RestEntitiesByEntityName<Method>;
-    interceptors?: Interceptors;
+    interceptors?: Interceptors<'rest'>;
 };
 export type RestPathString = `/${string}`;
 interface BaseRestRequestConfig<Method extends RestMethod> {
     path: RestPathString | RegExp;
     method: Method;
     routes: RestRouteConfig<Method>[];
-    interceptors?: Interceptors;
+    interceptors?: Interceptors<'rest'>;
 }
 type RestGetRequestConfig = BaseRestRequestConfig<'get'>;
 type RestPostRequestConfig = BaseRestRequestConfig<'post'>;

package/dist/src/utils/types/server.d.ts

@@ -23,12 +23,12 @@ export type BaseUrl = `/${string}`;
 export interface RestConfig {
     baseUrl?: BaseUrl;
     configs: RestRequestConfig[];
-    interceptors?: Interceptors;
+    interceptors?: Interceptors<'rest'>;
 }
 export interface GraphqlConfig {
     baseUrl?: BaseUrl;
     configs: GraphQLRequestConfig[];
-    interceptors?: Interceptors;
+    interceptors?: Interceptors<'graphql'>;
 }
 export type DatabaseConfig = {
     data: Record<string, unknown> | `${string}.json`;

package/dist/src/utils/types/shared.d.ts

@@ -0,0 +1 @@
+export type ApiType = 'rest' | 'graphql';

package/dist/src/utils/types/shared.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/dist/src/utils/types/values.d.ts

@@ -1,3 +1,10 @@
+/// <reference types="node" />
+import type { ParamsDictionary, Query as ExpressQuery } from 'express-serve-static-core';
+import type { IncomingHttpHeaders } from 'http';
 export type PlainObject = Record<string, any>;
 export type Primitive = boolean | number | bigint | string | null | undefined | symbol;
+export type Headers = IncomingHttpHeaders;
+export type Query = ExpressQuery;
+export type Params = ParamsDictionary;
+export type Cookies = Record<string, string>;
 export type Data = boolean | number | string | any[] | Record<any, any> | null | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mock-config-server",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Tool that easily and quickly imitates server operation, create full fake api in few steps",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",