mockserver-client - npm Package Compare versions

Comparing version 5.13.2 to 5.14.0

index.d.ts

@@ -9,3 +9,3 @@ /*
 
-export { mockServerClient } from './mockServerClient';
+export { mockServerClient, KeysToMultiValues } from './mockServerClient';
 export {
@@ -16,3 +16,3 @@ Expectation,
   HttpResponse,
-  KeysToMultiValues,
+  KeyToMultiValue,
   OpenAPIExpectation,
@@ -19,0 +19,0 @@ RequestDefinition,

mockServer.d.ts

@@ -9,199 +9,161 @@ /*
 
-export interface OpenAPIExpectation {
-    specUrlOrPayload: string;
-    operationsAndResponses?: {
-        [k: string]: string;
-    }
-}
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
 
-export interface Expectation {
-    id?: string;
-    priority?: number;
-    httpRequest?: RequestDefinition;
-    httpResponse?: HttpResponse;
-    httpResponseTemplate?: HttpTemplate;
-    httpResponseClassCallback?: HttpClassCallback;
-    httpResponseObjectCallback?: HttpObjectCallback;
-    httpForward?: HttpForward;
-    httpForwardTemplate?: HttpTemplate;
-    httpForwardClassCallback?: HttpClassCallback;
-    httpForwardObjectCallback?: HttpObjectCallback;
-    httpOverrideForwardedRequest?: HttpOverrideForwardedRequest;
-    httpError?: HttpError;
-    times?: Times;
-    timeToLive?: TimeToLive;
-}
+export type Expectations = Expectation | Expectation[];
 
+export type Expectation = {
+  id?: string;
+  priority?: number;
+  httpRequest?: RequestDefinition;
+  openAPIDefinition?: OpenAPIDefinition;
+  httpResponse?: HttpResponse;
+  httpResponseTemplate?: HttpTemplate;
+  httpResponseClassCallback?: HttpClassCallback;
+  httpResponseObjectCallback?: HttpObjectCallback;
+  httpForward?: HttpForward;
+  httpForwardTemplate?: HttpTemplate;
+  httpForwardClassCallback?: HttpClassCallback;
+  httpForwardObjectCallback?: HttpObjectCallback;
+  httpOverrideForwardedRequest?: HttpOverrideForwardedRequest;
+  httpError?: HttpError;
+  times?: Times;
+  timeToLive?: TimeToLive;
+};
+
 export interface ExpectationId {
-    id: string
+  id: string;
 }
 
-export interface HttpRequest {
-    secure?: boolean;
-    keepAlive?: boolean;
-    method?: string;
-    path?: string;
-    pathParameters?: KeysToMultiValues;
-    queryStringParameters?: KeysToMultiValues;
-    body?: Body;
-    headers?: KeysToMultiValues;
-    cookies?: KeysAndValues;
-    socketAddress?: SocketAddress;
-}
+export type OpenAPIExpectations = OpenAPIExpectation | OpenAPIExpectation[];
 
-export interface OpenAPIDefinition {
-    specUrlOrPayload?:
-        string
-        | object;
-    operationId?: string
+export interface OpenAPIExpectation {
+  specUrlOrPayload: string | object;
+  operationsAndResponses?: Record<string, string>;
 }
 
-export type RequestDefinition =
-    | HttpRequest
-    | OpenAPIDefinition;
+export type RequestDefinition = HttpRequest | OpenAPIDefinition;
 
-export interface HttpResponse {
-    delay?: Delay;
-    body?: BodyWithContentType;
-    cookies?: KeysAndValues;
-    connectionOptions?: ConnectionOptions;
-    headers?: KeysToMultiValues;
-    statusCode?: number;
-    reasonPhrase?: string;
-}
+export interface HttpRequest {
+  secure?: boolean;
+  keepAlive?: boolean;
+  method?: StringOrJsonSchema;
+  path?: StringOrJsonSchema;
+  pathParameters?: KeyToMultiValue;
+  queryStringParameters?: KeyToMultiValue;
 
-export interface HttpRequestModifier {
-    path?: PathModifier;
-    queryStringParameters?: KeysToMultiValuesModifier;
-    headers?: KeysToMultiValuesModifier;
-    cookies?: KeysAndValuesModifier;
+  /** request body matcher */
+  body?: Body;
+  headers?: KeyToMultiValue;
+  cookies?: KeyToValue;
+  socketAddress?: SocketAddress;
 }
 
-export interface HttpResponseModifier {
-    headers?: KeysToMultiValuesModifier;
-    cookies?: KeysAndValuesModifier;
+export interface OpenAPIDefinition {
+  specUrlOrPayload?: string;
+  operationId?: string;
 }
 
-export interface PathModifier {
-    regex: string;
-    substitution?: string;
-}
+export interface HttpResponse {
+  /** response delay */
+  delay?: Delay;
 
-export interface KeysToMultiValuesModifier {
-    add?: KeysToMultiValues;
-    replace?: KeysToMultiValues;
-    remove?: string[];
-}
+  /** response body */
+  body?: BodyWithContentType;
+  cookies?: KeyToValue;
 
-export interface KeysAndValuesModifier {
-    add?: KeysAndValues;
-    replace?: KeysAndValues;
-    remove?: string[];
+  /** connection options */
+  connectionOptions?: ConnectionOptions;
+  headers?: KeyToMultiValue;
+  statusCode?: number;
+  reasonPhrase?: string;
 }
 
 export interface HttpTemplate {
-    delay?: Delay;
-    templateType?: "JAVASCRIPT" | "VELOCITY";
-    template?: string;
+  /** response delay */
+  delay?: Delay;
+  templateType?: "VELOCITY" | "JAVASCRIPT" | "MUSTACHE";
+  template?: string;
 }
 
 export interface HttpForward {
-    delay?: Delay;
-    host?: string;
-    port?: number;
-    scheme?: "HTTP" | "HTTPS";
+  /** response delay */
+  delay?: Delay;
+  host?: string;
+  port?: number;
+  scheme?: "HTTP" | "HTTPS";
 }
 
 export interface HttpClassCallback {
-    delay?: Delay;
-    callbackClass?: string;
+  /** response delay */
+  delay?: Delay;
+  callbackClass?: string;
 }
 
 export interface HttpObjectCallback {
-    delay?: Delay;
-    clientId?: string;
-    responseCallback?: boolean;
+  /** response delay */
+  delay?: Delay;
+  clientId?: string;
+  responseCallback?: boolean;
 }
 
 export type HttpOverrideForwardedRequest =
-    | {
-    delay?: Delay;
-    requestOverride?: HttpRequest;
-    requestModifier?: HttpRequestModifier;
-    responseOverride?: HttpResponse;
-    responseModifier?: HttpResponseModifier;
-}
-    | {
-    delay?: Delay;
-    httpRequest?: HttpRequest;
-    httpResponse?: HttpResponse;
-}
+  | {
+      delay?: Delay;
+      requestOverride?: HttpRequest;
+      requestModifier?: {
+        path?: { regex?: string; substitution?: string };
+        queryStringParameters?: { add?: KeyToMultiValue; replace?: KeyToMultiValue; remove?: string[] };
+        headers?: { add?: KeyToMultiValue; replace?: KeyToMultiValue; remove?: string[] };
+        cookies?: { add?: KeyToValue; replace?: KeyToValue; remove?: string[] };
+      };
+      responseOverride?: HttpResponse;
+      responseModifier?: {
+        headers?: { add?: KeyToMultiValue; replace?: KeyToMultiValue; remove?: string[] };
+        cookies?: { add?: KeyToValue; replace?: KeyToValue; remove?: string[] };
+      };
+    }
+  | { delay?: Delay; httpRequest?: HttpRequest; httpResponse?: HttpResponse };
 
 export interface HttpError {
-    delay?: Delay;
-    dropConnection?: boolean;
-    responseBytes?: string;
+  /** response delay */
+  delay?: Delay;
+  dropConnection?: boolean;
+  responseBytes?: string;
 }
 
 export interface Times {
-    remainingTimes?: number;
-    unlimited?: boolean;
+  remainingTimes?: number;
+  unlimited?: boolean;
 }
 
 export interface TimeToLive {
-    timeUnit?: "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "MILLISECONDS" | "MICROSECONDS" | "NANOSECONDS";
-    timeToLive?: number;
-    endDate?: number;
-    unlimited?: boolean;
+  timeUnit?: "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "MILLISECONDS" | "MICROSECONDS" | "NANOSECONDS";
+  timeToLive?: number;
+  unlimited?: boolean;
 }
 
-export type KeysToMultiValues =
-    | {
-    name?: string;
-    values?: string[];
-}[]
-    | {
-    // TODO keyMatchStyle?: "MATCHING_KEY" | "SUB_SET";
-    /**
-     * via the `patternProperty` "^\S+$".
-     */
-    [k: string]:
-        StringOrJsonSchema[]
-        | {
-        parameterStyle?: "SIMPLE"
-            | "SIMPLE_EXPLODED"
-            | "LABEL"
-            | "LABEL_EXPLODED"
-            | "MATRIX"
-            | "MATRIX_EXPLODED"
-            | "FORM_EXPLODED"
-            | "FORM"
-            | "SPACE_DELIMITED_EXPLODED"
-            | "SPACE_DELIMITED"
-            | "PIPE_DELIMITED_EXPLODED"
-            | "PIPE_DELIMITED"
-            | "DEEP_OBJECT";
-        values: StringOrJsonSchema[]
-    };
-};
-export type KeysAndValues =
-    | {
-    name?: string;
-    value?: string;
-}[]
-    | {
-    /**
-     * via the `patternProperty` "^\S+$".
-     */
-    [k: string]: StringOrJsonSchema;
-};
+export type KeyToMultiValue =
+  | { name?: string; values?: string[] }[]
+  | { keyMatchStyle?: "MATCHING_KEY" | "SUB_SET"; [key: string]: any };
 
+export type KeyToValue = { name?: string; value?: string }[] | Record<string, any>;
+
 export type StringOrJsonSchema =
-    string
-    | {
-    not?: boolean;
-    optional?: number;
-    value?: string;
-    schema?: object;
-    parameterStyle?: "SIMPLE"
+  | string
+  | {
+      not?: boolean;
+      optional?: boolean;
+      value?: string;
+      schema?: any;
+      parameterStyle?:
+        | "SIMPLE"
         | "SIMPLE_EXPLODED"
@@ -219,121 +181,147 @@ | "LABEL"
         | "DEEP_OBJECT";
-};
+    };
 
 export interface SocketAddress {
-    host?: string;
-    port?: number;
-    scheme?: "HTTP" | "HTTPS";
+  host?: string;
+  port?: number;
+  scheme?: "HTTP" | "HTTPS";
 }
 
+/**
+ * request body matcher
+ */
 export type Body =
-    | {
-    not?: boolean;
-    type?: "BINARY";
-    base64Bytes?: string;
-    contentType?: string;
+  | { not?: boolean; type?: "BINARY"; base64Bytes?: string; contentType?: string }
+  | { not?: boolean; type?: "JSON"; json?: string; contentType?: string; matchType?: "STRICT" | "ONLY_MATCHING_FIELDS" }
+  | Record<string, any>
+  | { not?: boolean; type?: "JSON_SCHEMA"; jsonSchema?: any }
+  | { not?: boolean; type?: "JSON_PATH"; jsonPath?: string }
+  | { not?: boolean; type?: "PARAMETERS"; parameters?: KeyToMultiValue }
+  | { not?: boolean; type?: "REGEX"; regex?: string }
+  | { not?: boolean; type?: "STRING"; string?: string; contentType?: string; subString?: boolean }
+  | string
+  | { not?: boolean; type?: "XML"; xml?: string; contentType?: string }
+  | { not?: boolean; type?: "XML_SCHEMA"; xmlSchema?: string }
+  | { not?: boolean; type?: "XPATH"; xpath?: string }
+  | ({ not?: boolean; type?: "BINARY"; base64Bytes?: string; contentType?: string } & {
+      not?: boolean;
+      type?: "JSON";
+      json?: string;
+      contentType?: string;
+      matchType?: "STRICT" | "ONLY_MATCHING_FIELDS";
+    } & Record<string, any> & { not?: boolean; type?: "JSON_SCHEMA"; jsonSchema?: any } & {
+        not?: boolean;
+        type?: "JSON_PATH";
+        jsonPath?: string;
+      } & { not?: boolean; type?: "PARAMETERS"; parameters?: KeyToMultiValue } & {
+        not?: boolean;
+        type?: "REGEX";
+        regex?: string;
+      } & { not?: boolean; type?: "STRING"; string?: string; contentType?: string; subString?: boolean } & {
+        not?: boolean;
+        type?: "XML";
+        xml?: string;
+        contentType?: string;
+      } & { not?: boolean; type?: "XML_SCHEMA"; xmlSchema?: string } & {
+        not?: boolean;
+        type?: "XPATH";
+        xpath?: string;
+      });
+
+/**
+ * response body
+ */
+export type BodyWithContentType =
+  | { not?: boolean; type?: "BINARY"; base64Bytes?: string; contentType?: string }
+  | { not?: boolean; type?: "JSON"; json?: string; contentType?: string }
+  | Record<string, any>
+  | { not?: boolean; type?: "STRING"; string?: string; contentType?: string }
+  | string
+  | { not?: boolean; type?: "XML"; xml?: string; contentType?: string }
+  | ({ not?: boolean; type?: "BINARY"; base64Bytes?: string; contentType?: string } & {
+      not?: boolean;
+      type?: "JSON";
+      json?: string;
+      contentType?: string;
+    } & Record<string, any> & { not?: boolean; type?: "STRING"; string?: string; contentType?: string } & {
+        not?: boolean;
+        type?: "XML";
+        xml?: string;
+        contentType?: string;
+      });
+
+/**
+ * response delay
+ */
+export interface Delay {
+  timeUnit?: string;
+  value?: number;
 }
-    | {
-    not?: boolean;
-    type?: "JSON";
-    json?: string;
-    contentType?: string;
+
+/**
+ * connection options
+ */
+export interface ConnectionOptions {
+  suppressContentLengthHeader?: boolean;
+  contentLengthHeaderOverride?: number;
+  suppressConnectionHeader?: boolean;
+  chunkSize?: number;
+  keepAliveOverride?: boolean;
+  closeSocket?: boolean;
+
+  /** response delay */
+  closeSocketDelay?: Delay;
 }
-    | {
-    [k: string]: any;
-}
-    | any[]
-    | {
-    not?: boolean;
-    type?: "PARAMETERS";
-    parameters?: KeysToMultiValues;
-}
-    | {
-    not?: boolean;
-    type?: "STRING";
-    string?: string;
-    contentType?: string;
-}
-    | string
-    | {
-    not?: boolean;
-    type?: "XML";
-    xml?: string;
-    contentType?: string;
+
+/**
+ * verification
+ */
+export type Verification = {
+  expectationId?: ExpectationId;
+  httpRequest?: RequestDefinition;
+  times?: VerificationTimes;
+  maximumNumberOfRequestToReturnInVerificationFailure?: number;
 };
-export type BodyWithContentType =
-    | {
-    not?: boolean;
-    type?: "BINARY";
-    base64Bytes?: string;
-    contentType?: string;
+
+/**
+ * number of request to verify
+ */
+export interface VerificationTimes {
+  atLeast?: number;
+  atMost?: number;
 }
-    | {
-    not?: boolean;
-    type?: "JSON";
-    json?: string;
-    contentType?: string;
-    matchType?: "STRICT" | "ONLY_MATCHING_FIELDS";
-}
-    | {
-    [k: string]: any;
-}
-    | any[]
-    | {
-    not?: boolean;
-    type?: "JSON_SCHEMA";
-    jsonSchema?: string;
-}
-    | {
-    not?: boolean;
-    type?: "JSON_PATH";
-    jsonPath?: string;
-}
-    | {
-    not?: boolean;
-    type?: "PARAMETERS";
-    parameters?: KeysToMultiValues;
-}
-    | {
-    not?: boolean;
-    type?: "REGEX";
-    regex?: string;
-}
-    | {
-    not?: boolean;
-    type?: "STRING";
-    string?: string;
-    subString?: boolean;
-    contentType?: string;
-}
-    | string
-    | {
-    not?: boolean;
-    type?: "XML";
-    xml?: string;
-    contentType?: string;
-}
-    | {
-    not?: boolean;
-    type?: "XML_SCHEMA";
-    xmlSchema?: string;
-}
-    | {
-    not?: boolean;
-    type?: "XPATH";
-    xpath?: string;
+
+/**
+ * verification sequence
+ */
+export type VerificationSequence = {
+  expectationIds?: ExpectationId[];
+  httpRequests?: RequestDefinition[];
+  maximumNumberOfRequestToReturnInVerificationFailure?: number;
 };
 
-export interface Delay {
-    timeUnit?: string;
-    value?: number;
+/**
+ * list of ports
+ */
+export interface Ports {
+  ports?: number[];
 }
 
-export interface ConnectionOptions {
-    suppressContentLengthHeader?: boolean;
-    contentLengthHeaderOverride?: number;
-    suppressConnectionHeader?: boolean;
-    chunkSize?: number;
-    keepAliveOverride?: boolean;
-    closeSocket?: boolean;
-    closeSocketDelay?: Delay;
+/**
+ * verification sequence
+ */
+export type HttpRequestAndHttpResponse = {
+    httpRequest?: HttpRequest[];
+    httpResponse?: HttpResponse[];
+    timestamp?: string;
+};
+
+export type ClearUpdatePayload = RequestDefinition | ExpectationId;
+
+export interface RetrieveUpdateParams {
+  /** changes response format, default if not specificed is "json", supported values are "java", "json", "log_entries" */
+  format?: "java" | "json" | "log_entries";
+
+  /** specifies the type of object that is retrieve, default if not specified is "requests", supported values are "logs", "requests", "recorded_expectations", "active_expectations" */
+  type?: "logs" | "requests" | "request_responses" | "recorded_expectations" | "active_expectations";
 }

mockServerClient.d.ts

@@ -11,4 +11,3 @@ /*
 
-// TypeScript Version: 2.1
-import {Expectation, ExpectationId, HttpRequest, HttpResponse, KeysToMultiValues, OpenAPIExpectation, RequestDefinition, Times, TimeToLive,} from './mockServer';
+import {Expectation, ExpectationId, HttpRequest, HttpRequestAndHttpResponse, HttpResponse, KeyToMultiValue, OpenAPIExpectation, RequestDefinition, Times, TimeToLive,} from './mockServer';
 
@@ -20,2 +19,4 @@ export type Host = string;
 export type CaCertPemFilePath = string;
+// Retains backwards compatability.
+export type KeysToMultiValues = KeyToMultiValue;
 
@@ -62,3 +63,3 @@ export type ClearType = 'EXPECTATIONS' | 'LOG' | 'ALL';
 
-    retrieveRecordedRequestsAndResponses(pathOrRequestDefinition: PathOrRequestDefinition): Promise<Expectation[]>;
+    retrieveRecordedRequestsAndResponses(pathOrRequestDefinition: PathOrRequestDefinition): Promise<HttpRequestAndHttpResponse[]>;
 
@@ -65,0 +66,0 @@ retrieveActiveExpectations(pathOrRequestDefinition: PathOrRequestDefinition): Promise<Expectation[]>;

mockServerClient.js

@@ -33,3 +33,3 @@ /*
             var body = (typeof jsonBody === "string" ? jsonBody : JSON.stringify(jsonBody || ""));
-            var url = (tls ? 'https' : 'http') + '://' + host + ':' + port + (contextPath.startsWith("/") ? contextPath : "/" + contextPath) + path;
+            var url = (tls ? 'https' : 'http') + '://' + host + ':' + port + (contextPath ? (contextPath.indexOf("/") === 0 ? contextPath : "/" + contextPath) : "") + path;
 
@@ -629,6 +629,10 @@ return {
         var verifySequenceById = function () {
+            /**
+             * Convert to array, because otherwise it JSON-encoded as object
+             */
+            var expectationIds = Array.from(arguments);
             return {
                 then: function (sucess, error) {
                     return makeRequest(host, port, "/mockserver/verifySequence", {
-                        "expectationIds": arguments
+                        "expectationIds": expectationIds
                     }).then(
@@ -828,5 +832,8 @@ function () {
             verify: verify,
+            verifyById: verifyById,
             verifySequence: verifySequence,
+            verifySequenceById: verifySequenceById,
             reset: reset,
             clear: clear,
+            clearById: clearById,
             bind: bind,
@@ -833,0 +840,0 @@ retrieveRecordedRequests: retrieveRecordedRequests,

package.json

 {
   "name": "mockserver-client",
   "description": "A node client for the MockServer",
-  "version": "5.13.2",
+  "version": "5.14.0",
   "homepage": "http://mock-server.com",
@@ -35,3 +35,2 @@ "author": {
   "devDependencies": {
-    "grunt-contrib-clean": "~2.0.0",
     "grunt-contrib-jshint": "~3.2.0",
@@ -42,12 +41,12 @@ "grunt-contrib-nodeunit": "~4.0.0",
     "grunt-ts": "^5.5.1",
-    "jasmine-core": "~4.0.1",
-    "karma": "~6.3.17",
+    "jasmine-core": "~4.3.0",
+    "karma": "~6.4.0",
     "karma-chrome-launcher": "~3.1.1",
     "karma-firefox-launcher": "~2.1.2",
-    "karma-jasmine": "~4.0.2",
-    "karma-spec-reporter": "~0.0.33",
+    "karma-jasmine": "~5.1.0",
+    "karma-spec-reporter": "~0.0.34",
     "karma-xvfb-chrome-launcher": "~0.0.1",
-    "mockserver-node": "~5.13.2",
+    "mockserver-node": "~5.14.0",
     "nodeunit": "~0.11.3",
-    "typescript": "~4.6.3"
+    "typescript": "~4.7.2"
   },
@@ -54,0 +53,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

84010

increased by3.29%

Dev dependency count

15

decreased by-6.25%

Worsened metrics

Lines of code

1459

decreased by-1.08%

No dependency changes