@typespec/spec-api 0.1.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,2 @@
+# @typespec/spec-api
+

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/dist/expectation.d.ts

@@ -0,0 +1,63 @@
+import { CollectionFormat, RequestExt } from "./types.js";
+/**
+ * Class containing all the expectations that can be run on the request.
+ */
+export declare class RequestExpectation {
+    private originalRequest;
+    constructor(originalRequest: RequestExt);
+    /**
+     * Expect the raw body of the request to match the given string.
+     * @param rawBody Raw request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    rawBodyEquals(expectedRawBody: string | Buffer | undefined): void;
+    /**
+     * Expect the body of the request to match the given object.
+     * @param rawBody Raw request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    bodyEquals(expectedRawBody: unknown | undefined): void;
+    /**
+     * Expect the coerced body of the request to match the given object.
+     * @param rawBody Raw request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    coercedBodyEquals(expectedRawBody: unknown | undefined): void;
+    /**
+     * Expect the body of the request to be empty.
+     * @throws {ValidationError} if there is an error.
+     */
+    bodyEmpty(): void;
+    /**
+     * Expect the body of the request to be not empty.
+     * @throws {ValidationError} if there is an error.
+     */
+    bodyNotEmpty(): void;
+    /**
+     * Expect the header of the request contains the expected key/value pair
+     * @param headerName Key expected in header
+     * @param expectedValue Values expected in header
+     * @throws {ValidationError} if there is an error.
+     */
+    containsHeader(headerName: string, expectedValue: string): void;
+    /**
+     * Expect the query string of the request contains the expected name/value pair.
+     * @param paramName Name of the query parameter.
+     * @param expectedValue Value expected of the query parameter.
+     */
+    containsQueryParam(paramName: string, expectedValue: string | string[], collectionFormat?: CollectionFormat): void;
+    /**
+     * Check if two requests are equal
+     * @param actual Actual value
+     * @param expected Expected value
+     */
+    deepEqual(actual: unknown, expected: unknown, message?: string): void;
+    /**
+     * Expect the body of the request to be semantically equivalent to the provided XML string.
+     * The XML declaration prefix will automatically be added to expectedBody.
+     * @param expectedBody expected value of request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    xmlBodyEquals(expectedBody: string): void;
+}
+//# sourceMappingURL=expectation.d.ts.map

package/dist/expectation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expectation.d.ts","sourceRoot":"","sources":["../src/expectation.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG1D;;GAEG;AACH,qBAAa,kBAAkB;IACV,OAAO,CAAC,eAAe;gBAAf,eAAe,EAAE,UAAU;IACtD;;;;OAIG;IACI,aAAa,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI;IAIxE;;;;OAIG;IACI,UAAU,CAAC,eAAe,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAI7D;;;;OAIG;IACI,iBAAiB,CAAC,eAAe,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAIpE;;;OAGG;IACI,SAAS,IAAI,IAAI;IAIxB;;;OAGG;IACI,YAAY,IAAI,IAAI;IAI3B;;;;;OAKG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAItE;;;;OAIG;IACI,kBAAkB,CACvB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,EAChC,gBAAgB,CAAC,EAAE,gBAAgB,GAClC,IAAI;IAIP;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,SAA0B,GAAG,IAAI;IAM7F;;;;;OAKG;IACI,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CAGjD"}

package/dist/expectation.js

@@ -0,0 +1,87 @@
+import deepEqual from "deep-equal";
+import { validateBodyEmpty, validateBodyEquals, validateBodyNotEmpty, validateCoercedDateBodyEquals, validateHeader, validateQueryParam, validateRawBodyEquals, validateXmlBodyEquals, } from "./request-validations.js";
+import { ValidationError } from "./validation-error.js";
+/**
+ * Class containing all the expectations that can be run on the request.
+ */
+export class RequestExpectation {
+    originalRequest;
+    constructor(originalRequest) {
+        this.originalRequest = originalRequest;
+    }
+    /**
+     * Expect the raw body of the request to match the given string.
+     * @param rawBody Raw request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    rawBodyEquals(expectedRawBody) {
+        validateRawBodyEquals(this.originalRequest, expectedRawBody);
+    }
+    /**
+     * Expect the body of the request to match the given object.
+     * @param rawBody Raw request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    bodyEquals(expectedRawBody) {
+        validateBodyEquals(this.originalRequest, expectedRawBody);
+    }
+    /**
+     * Expect the coerced body of the request to match the given object.
+     * @param rawBody Raw request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    coercedBodyEquals(expectedRawBody) {
+        validateCoercedDateBodyEquals(this.originalRequest, expectedRawBody);
+    }
+    /**
+     * Expect the body of the request to be empty.
+     * @throws {ValidationError} if there is an error.
+     */
+    bodyEmpty() {
+        validateBodyEmpty(this.originalRequest);
+    }
+    /**
+     * Expect the body of the request to be not empty.
+     * @throws {ValidationError} if there is an error.
+     */
+    bodyNotEmpty() {
+        validateBodyNotEmpty(this.originalRequest);
+    }
+    /**
+     * Expect the header of the request contains the expected key/value pair
+     * @param headerName Key expected in header
+     * @param expectedValue Values expected in header
+     * @throws {ValidationError} if there is an error.
+     */
+    containsHeader(headerName, expectedValue) {
+        validateHeader(this.originalRequest, headerName, expectedValue);
+    }
+    /**
+     * Expect the query string of the request contains the expected name/value pair.
+     * @param paramName Name of the query parameter.
+     * @param expectedValue Value expected of the query parameter.
+     */
+    containsQueryParam(paramName, expectedValue, collectionFormat) {
+        validateQueryParam(this.originalRequest, paramName, expectedValue, collectionFormat);
+    }
+    /**
+     * Check if two requests are equal
+     * @param actual Actual value
+     * @param expected Expected value
+     */
+    deepEqual(actual, expected, message = "Values not deep equal") {
+        if (!deepEqual(actual, expected, { strict: true })) {
+            throw new ValidationError(message, expected, actual);
+        }
+    }
+    /**
+     * Expect the body of the request to be semantically equivalent to the provided XML string.
+     * The XML declaration prefix will automatically be added to expectedBody.
+     * @param expectedBody expected value of request body.
+     * @throws {ValidationError} if there is an error.
+     */
+    xmlBodyEquals(expectedBody) {
+        validateXmlBodyEquals(this.originalRequest, expectedBody);
+    }
+}
+//# sourceMappingURL=expectation.js.map

package/dist/expectation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expectation.js","sourceRoot":"","sources":["../src/expectation.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,6BAA6B,EAC7B,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IACF;IAA3B,YAA2B,eAA2B;QAA3B,oBAAe,GAAf,eAAe,CAAY;IAAG,CAAC;IAC1D;;;;OAIG;IACI,aAAa,CAAC,eAA4C;QAC/D,qBAAqB,CAAC,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,eAAoC;QACpD,kBAAkB,CAAC,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,eAAoC;QAC3D,6BAA6B,CAAC,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,YAAY;QACjB,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAkB,EAAE,aAAqB;QAC7D,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CACvB,SAAiB,EACjB,aAAgC,EAChC,gBAAmC;QAEnC,kBAAkB,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,MAAe,EAAE,QAAiB,EAAE,OAAO,GAAG,uBAAuB;QACpF,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,YAAoB;QACvC,qBAAqB,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAC5D,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { MockRequest } from "./mock-request.js";
+export { BODY_EMPTY_ERROR_MESSAGE, BODY_NOT_EMPTY_ERROR_MESSAGE, BODY_NOT_EQUAL_ERROR_MESSAGE, validateBodyEmpty, validateBodyEquals, validateBodyNotEmpty, validateCoercedDateBodyEquals, validateHeader, validateQueryParam, validateRawBodyEquals, validateValueFormat, validateXmlBodyEquals, } from "./request-validations.js";
+export { json, xml } from "./response-utils.js";
+export { mockapi } from "./routes.js";
+export { WithKeysScenarioExpect, passOnCode, passOnSuccess, withKeys, withServiceKeys, } from "./scenarios.js";
+export { CollectionFormat, Fail, HttpMethod, KeyedMockApi, KeyedMockRequestHandler, KeyedMockResponse, MockApi, MockApiDefinition, MockApiForHandler, MockRequestHandler, MockResponse, MockResponseBody, PassByKeyScenario, PassByServiceKeyScenario, PassOnCodeScenario, PassOnSuccessScenario, RequestExt, ScenarioMockApi, ScenarioPassCondition, ServiceRequestFile, SimpleMockRequestHandler, } from "./types.js";
+export { ValidationError } from "./validation-error.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EACL,wBAAwB,EACxB,4BAA4B,EAC5B,4BAA4B,EAC5B,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,6BAA6B,EAC7B,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,UAAU,EACV,aAAa,EACb,QAAQ,EACR,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,IAAI,EACJ,UAAU,EACV,YAAY,EACZ,uBAAuB,EACvB,iBAAiB,EACjB,OAAO,EACP,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+export { MockRequest } from "./mock-request.js";
+export { BODY_EMPTY_ERROR_MESSAGE, BODY_NOT_EMPTY_ERROR_MESSAGE, BODY_NOT_EQUAL_ERROR_MESSAGE, validateBodyEmpty, validateBodyEquals, validateBodyNotEmpty, validateCoercedDateBodyEquals, validateHeader, validateQueryParam, validateRawBodyEquals, validateValueFormat, validateXmlBodyEquals, } from "./request-validations.js";
+export { json, xml } from "./response-utils.js";
+export { mockapi } from "./routes.js";
+export { passOnCode, passOnSuccess, withKeys, withServiceKeys, } from "./scenarios.js";
+export { Fail, } from "./types.js";
+export { ValidationError } from "./validation-error.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EACL,wBAAwB,EACxB,4BAA4B,EAC5B,4BAA4B,EAC5B,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,6BAA6B,EAC7B,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAEL,UAAU,EACV,aAAa,EACb,QAAQ,EACR,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAEL,IAAI,GAoBL,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/mock-request.d.ts

@@ -0,0 +1,22 @@
+import { RequestExpectation } from "./expectation.js";
+import { RequestExt } from "./types.js";
+export declare class MockRequest {
+    originalRequest: RequestExt;
+    readonly expect: RequestExpectation;
+    readonly baseUrl: string;
+    readonly headers: {
+        [key: string]: string;
+    };
+    readonly query: {
+        [key: string]: string | string[];
+    };
+    readonly params: {
+        [key: string]: string;
+    };
+    readonly body: any;
+    readonly files?: {
+        [fieldname: string]: Express.Multer.File[];
+    } | Express.Multer.File[] | undefined;
+    constructor(originalRequest: RequestExt);
+}
+//# sourceMappingURL=mock-request.d.ts.map

package/dist/mock-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-request.d.ts","sourceRoot":"","sources":["../src/mock-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,qBAAa,WAAW;IAeI,eAAe,EAAE,UAAU;IAdrD,SAAgB,MAAM,EAAE,kBAAkB,CAAC;IAE3C,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnD,SAAgB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC;IAC5D,SAAgB,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClD,SAAgB,IAAI,EAAE,GAAG,CAAC;IAC1B,SAAgB,KAAK,CAAC,EAClB;QACE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;KAC5C,GACD,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GACrB,SAAS,CAAC;gBAEY,eAAe,EAAE,UAAU;CAStD"}

package/dist/mock-request.js

@@ -0,0 +1,23 @@
+import { RequestExpectation } from "./expectation.js";
+export class MockRequest {
+    originalRequest;
+    expect;
+    baseUrl;
+    headers;
+    query;
+    params;
+    body;
+    files;
+    constructor(originalRequest) {
+        this.originalRequest = originalRequest;
+        this.baseUrl = getRequestBaseUrl(originalRequest);
+        this.expect = new RequestExpectation(originalRequest);
+        this.headers = originalRequest.headers;
+        this.query = originalRequest.query;
+        this.params = originalRequest.params;
+        this.body = originalRequest.body;
+        this.files = originalRequest.files;
+    }
+}
+const getRequestBaseUrl = (request) => `${request.protocol}://${request.get("host")}`;
+//# sourceMappingURL=mock-request.js.map

package/dist/mock-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-request.js","sourceRoot":"","sources":["../src/mock-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAGtD,MAAM,OAAO,WAAW;IAeI;IAdV,MAAM,CAAqB;IAE3B,OAAO,CAAS;IAChB,OAAO,CAA4B;IACnC,KAAK,CAAuC;IAC5C,MAAM,CAA4B;IAClC,IAAI,CAAM;IACV,KAAK,CAKP;IAEd,YAA0B,eAA2B;QAA3B,oBAAe,GAAf,eAAe,CAAY;QACnD,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAoC,CAAC;QACpE,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,KAAkC,CAAC;QAChE,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAmC,CAAC;QAClE,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC;IACrC,CAAC;CACF;AAED,MAAM,iBAAiB,GAAG,CAAC,OAAmB,EAAU,EAAE,CACxD,GAAG,OAAO,CAAC,QAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC"}

package/dist/request-validations.d.ts

@@ -0,0 +1,24 @@
+import { CollectionFormat, RequestExt } from "./types.js";
+export declare const BODY_NOT_EQUAL_ERROR_MESSAGE = "Body provided doesn't match expected body";
+export declare const BODY_EMPTY_ERROR_MESSAGE = "Body should exists";
+export declare const BODY_NOT_EMPTY_ERROR_MESSAGE = "Body should be empty";
+export declare const validateRawBodyEquals: (request: RequestExt, expectedRawBody: string | Buffer | undefined) => void;
+export declare const validateBodyEquals: (request: RequestExt, expectedBody: unknown | undefined) => void;
+export declare const validateXmlBodyEquals: (request: RequestExt, expectedBody: string) => void;
+export declare const validateCoercedDateBodyEquals: (request: RequestExt, expectedBody: unknown | undefined) => void;
+export declare const validateBodyEmpty: (request: RequestExt) => void;
+export declare const validateBodyNotEmpty: (request: RequestExt) => void;
+/**
+ * Check whether the request header contains the given name/value pair
+ */
+export declare const validateHeader: (request: RequestExt, headerName: string, expected: string) => void;
+/**
+ * Check whether the query string contains the given parameter name and value.
+ * Supports query param as string or collection. e.g. if it's a collection, one can call the method like this: validateQueryParam(request, ["a", "b", "c"], "multi")
+ */
+export declare const validateQueryParam: (request: RequestExt, paramName: string, expected: string | string[], collectionFormat?: CollectionFormat) => void;
+/**
+ * Check whether the value follow the right format.
+ */
+export declare const validateValueFormat: (value: string, format: "uuid" | "rfc7231" | "rfc3339") => void;
+//# sourceMappingURL=request-validations.d.ts.map

package/dist/request-validations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-validations.d.ts","sourceRoot":"","sources":["../src/request-validations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG1D,eAAO,MAAM,4BAA4B,8CAA8C,CAAC;AACxF,eAAO,MAAM,wBAAwB,uBAAuB,CAAC;AAC7D,eAAO,MAAM,4BAA4B,yBAAyB,CAAC;AAEnE,eAAO,MAAM,qBAAqB,YACvB,UAAU,mBACF,MAAM,GAAG,MAAM,GAAG,SAAS,KAC3C,IAaF,CAAC;AAEF,eAAO,MAAM,kBAAkB,YACpB,UAAU,gBACL,OAAO,GAAG,SAAS,KAChC,IAWF,CAAC;AAEF,eAAO,MAAM,qBAAqB,YAAa,UAAU,gBAAgB,MAAM,KAAG,IA8BjF,CAAC;AAEF,eAAO,MAAM,6BAA6B,YAC/B,UAAU,gBACL,OAAO,GAAG,SAAS,KAChC,IAWF,CAAC;AAEF,eAAO,MAAM,iBAAiB,YAAa,UAAU,KAAG,IAUvD,CAAC;AAEF,eAAO,MAAM,oBAAoB,YAAa,UAAU,KAAG,IAU1D,CAAC;AAUF;;GAEG;AACH,eAAO,MAAM,cAAc,YAAa,UAAU,cAAc,MAAM,YAAY,MAAM,KAAG,IAK1F,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,YACpB,UAAU,aACR,MAAM,YACP,MAAM,GAAG,MAAM,EAAE,qBACR,gBAAgB,KAClC,IA+BF,CAAC;AAWF;;GAEG;AACH,eAAO,MAAM,mBAAmB,UACvB,MAAM,UACL,MAAM,GAAG,SAAS,GAAG,SAAS,KACrC,IAwBF,CAAC"}

package/dist/request-validations.js

@@ -0,0 +1,164 @@
+import deepEqual from "deep-equal";
+import * as prettier from "prettier";
+import { parseString } from "xml2js";
+import { ValidationError } from "./validation-error.js";
+export const BODY_NOT_EQUAL_ERROR_MESSAGE = "Body provided doesn't match expected body";
+export const BODY_EMPTY_ERROR_MESSAGE = "Body should exists";
+export const BODY_NOT_EMPTY_ERROR_MESSAGE = "Body should be empty";
+export const validateRawBodyEquals = (request, expectedRawBody) => {
+    const actualRawBody = request.rawBody;
+    if (expectedRawBody == null) {
+        if (!isBodyEmpty(actualRawBody)) {
+            throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, expectedRawBody, actualRawBody);
+        }
+        return;
+    }
+    if (!deepEqual(actualRawBody, expectedRawBody, { strict: true })) {
+        throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, expectedRawBody, actualRawBody);
+    }
+};
+export const validateBodyEquals = (request, expectedBody) => {
+    if (expectedBody == null) {
+        if (!isBodyEmpty(request.rawBody)) {
+            throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, expectedBody, request.rawBody);
+        }
+        return;
+    }
+    if (!deepEqual(request.body, expectedBody, { strict: true })) {
+        throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, expectedBody, request.body);
+    }
+};
+export const validateXmlBodyEquals = (request, expectedBody) => {
+    if (request.rawBody === undefined || isBodyEmpty(request.rawBody)) {
+        throw new ValidationError(BODY_EMPTY_ERROR_MESSAGE, expectedBody, request.rawBody);
+    }
+    expectedBody = `<?xml version='1.0' encoding='UTF-8'?>` + expectedBody;
+    let actualParsedBody = "";
+    parseString(request.rawBody, (err, result) => {
+        if (err !== null) {
+            throw err;
+        }
+        actualParsedBody = result;
+    });
+    let expectedParsedBody = "";
+    parseString(expectedBody, (err, result) => {
+        if (err !== null) {
+            throw err;
+        }
+        expectedParsedBody = result;
+    });
+    if (!deepEqual(actualParsedBody, expectedParsedBody, { strict: true })) {
+        throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, prettier.format(expectedBody), prettier.format(request.body));
+    }
+};
+export const validateCoercedDateBodyEquals = (request, expectedBody) => {
+    if (expectedBody == null) {
+        if (!isBodyEmpty(request.rawBody)) {
+            throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, expectedBody, request.rawBody);
+        }
+        return;
+    }
+    if (!deepEqual(coerceDate(request.body), expectedBody, { strict: true })) {
+        throw new ValidationError(BODY_NOT_EQUAL_ERROR_MESSAGE, expectedBody, request.body);
+    }
+};
+export const validateBodyEmpty = (request) => {
+    if (isBodyEmpty(request.rawBody)) {
+        if (request.body instanceof Buffer) {
+            if (request.body.length > 0) {
+                throw new ValidationError(BODY_NOT_EMPTY_ERROR_MESSAGE, undefined, request.rawBody);
+            }
+        }
+    }
+    else {
+        throw new ValidationError(BODY_EMPTY_ERROR_MESSAGE, undefined, request.rawBody);
+    }
+};
+export const validateBodyNotEmpty = (request) => {
+    if (isBodyEmpty(request.rawBody)) {
+        if (request.body instanceof Buffer) {
+            if (request.body.length === 0) {
+                throw new ValidationError(BODY_EMPTY_ERROR_MESSAGE, undefined, request.rawBody);
+            }
+        }
+        else {
+            throw new ValidationError(BODY_EMPTY_ERROR_MESSAGE, undefined, request.rawBody);
+        }
+    }
+};
+/**
+ * Check if the provided body is empty.
+ * @param body express.js request body.
+ */
+const isBodyEmpty = (body) => {
+    return body == null || body === "" || body.length === 0;
+};
+/**
+ * Check whether the request header contains the given name/value pair
+ */
+export const validateHeader = (request, headerName, expected) => {
+    const actual = request.headers[headerName];
+    if (actual !== expected) {
+        throw new ValidationError(`Expected ${expected} but got ${actual}`, expected, actual);
+    }
+};
+/**
+ * Check whether the query string contains the given parameter name and value.
+ * Supports query param as string or collection. e.g. if it's a collection, one can call the method like this: validateQueryParam(request, ["a", "b", "c"], "multi")
+ */
+export const validateQueryParam = (request, paramName, expected, collectionFormat) => {
+    const actual = request.query[paramName];
+    const splitterMap = {
+        csv: ",",
+        ssv: " ",
+        tsv: "\t",
+        pipes: "|",
+    };
+    let isExpected = false;
+    if (collectionFormat && Array.isArray(expected)) {
+        // verify query parameter as collection
+        if (collectionFormat === "multi" && Array.isArray(actual)) {
+            isExpected = deepEqual(actual, expected);
+        }
+        else if (collectionFormat !== "multi" && typeof actual === "string") {
+            const expectedString = expected.join(splitterMap[collectionFormat]);
+            isExpected = expectedString === decodeURIComponent(actual);
+        }
+        if (!isExpected) {
+            throw new ValidationError(`Expected query param collection ${paramName}=${expected} in ${collectionFormat}, but got ${actual}`, expected, actual);
+        }
+    }
+    else if (actual !== expected) {
+        throw new ValidationError(`Expected query param ${paramName}=${expected} but got ${actual}`, expected, actual);
+    }
+};
+const coerceDate = (targetObject) => {
+    let stringRep = JSON.stringify(targetObject);
+    stringRep = stringRep.replace(/(\d\d\d\d-\d\d-\d\d[Tt]\d\d:\d\d:\d\d)(\.\d{3,7})?([Zz]|[+-]00:00)/g, "$1Z");
+    return JSON.parse(stringRep);
+};
+/**
+ * Check whether the value follow the right format.
+ */
+export const validateValueFormat = (value, format) => {
+    switch (format) {
+        case "uuid":
+            if (!/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/i.test(value)) {
+                throw new ValidationError(`Expected uuid format but got ${value}`, "uuid", value);
+            }
+            break;
+        case "rfc7231":
+            if (!/^(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT$/i.test(value)) {
+                throw new ValidationError(`Expected rfc7231 format but got ${value}`, "rfc7231", value);
+            }
+            break;
+        case "rfc3339":
+            if (!/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})?$/i.test(value)) {
+                throw new ValidationError(`Expected rfc3339 format but got ${value}`, "rfc3339", value);
+            }
+            break;
+        default:
+            throw new ValidationError(`Unsupported format ${format}`, format, value);
+    }
+};
+//# sourceMappingURL=request-validations.js.map

package/dist/request-validations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-validations.js","sourceRoot":"","sources":["../src/request-validations.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,CAAC,MAAM,4BAA4B,GAAG,2CAA2C,CAAC;AACxF,MAAM,CAAC,MAAM,wBAAwB,GAAG,oBAAoB,CAAC;AAC7D,MAAM,CAAC,MAAM,4BAA4B,GAAG,sBAAsB,CAAC;AAEnE,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,OAAmB,EACnB,eAA4C,EACtC,EAAE;IACR,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAEtC,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC;IAC1F,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,OAAmB,EACnB,YAAiC,EAC3B,EAAE;IACR,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACzF,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC7D,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAmB,EAAE,YAAoB,EAAQ,EAAE;IACvF,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,MAAM,IAAI,eAAe,CAAC,wBAAwB,EAAE,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACrF,CAAC;IAED,YAAY,GAAG,wCAAwC,GAAG,YAAY,CAAC;IAEvE,IAAI,gBAAgB,GAAG,EAAE,CAAC;IAC1B,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,GAAiB,EAAE,MAAW,EAAQ,EAAE;QACpE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,gBAAgB,GAAG,MAAM,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,IAAI,kBAAkB,GAAG,EAAE,CAAC;IAC5B,WAAW,CAAC,YAAY,EAAE,CAAC,GAAiB,EAAE,MAAW,EAAQ,EAAE;QACjE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,kBAAkB,GAAG,MAAM,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QACvE,MAAM,IAAI,eAAe,CACvB,4BAA4B,EAC5B,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAC7B,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAC9B,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,OAAmB,EACnB,YAAiC,EAC3B,EAAE;IACR,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACzF,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAmB,EAAQ,EAAE;IAC7D,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,IAAI,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,CAAC;YACnC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,eAAe,CAAC,4BAA4B,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,eAAe,CAAC,wBAAwB,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAClF,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,OAAmB,EAAQ,EAAE;IAChE,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,IAAI,OAAO,CAAC,IAAI,YAAY,MAAM,EAAE,CAAC;YACnC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,eAAe,CAAC,wBAAwB,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAClF,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,eAAe,CAAC,wBAAwB,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,IAAwC,EAAE,EAAE;IAC/D,OAAO,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAmB,EAAE,UAAkB,EAAE,QAAgB,EAAQ,EAAE;IAChG,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,MAAM,IAAI,eAAe,CAAC,YAAY,QAAQ,YAAY,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACxF,CAAC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,OAAmB,EACnB,SAAiB,EACjB,QAA2B,EAC3B,gBAAmC,EAC7B,EAAE;IACR,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,WAAW,GAAG;QAClB,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,GAAG;KACX,CAAC;IACF,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,uCAAuC;QACvC,IAAI,gBAAgB,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,UAAU,GAAG,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC3C,CAAC;aAAM,IAAI,gBAAgB,KAAK,OAAO,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtE,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACpE,UAAU,GAAG,cAAc,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,eAAe,CACvB,mCAAmC,SAAS,IAAI,QAAQ,OAAO,gBAAgB,aAAa,MAAM,EAAE,EACpG,QAAQ,EACR,MAAM,CACP,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CACvB,wBAAwB,SAAS,IAAI,QAAQ,YAAY,MAAM,EAAE,EACjE,QAAQ,EACR,MAAM,CACP,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,YAAqC,EAA2B,EAAE;IACpF,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC7C,SAAS,GAAG,SAAS,CAAC,OAAO,CAC3B,qEAAqE,EACrE,KAAK,CACN,CAAC;IACF,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAa,EACb,MAAsC,EAChC,EAAE;IACR,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM;YACT,IAAI,CAAC,8CAA8C,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChE,MAAM,IAAI,eAAe,CAAC,gCAAgC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YACpF,CAAC;YACD,MAAM;QACR,KAAK,SAAS;YACZ,IACE,CAAC,4HAA4H,CAAC,IAAI,CAChI,KAAK,CACN,EACD,CAAC;gBACD,MAAM,IAAI,eAAe,CAAC,mCAAmC,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAC1F,CAAC;YACD,MAAM;QACR,KAAK,SAAS;YACZ,IAAI,CAAC,oEAAoE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtF,MAAM,IAAI,eAAe,CAAC,mCAAmC,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAC1F,CAAC;YACD,MAAM;QACR;YACE,MAAM,IAAI,eAAe,CAAC,sBAAsB,MAAM,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC,CAAC"}

package/dist/response-utils.d.ts

@@ -0,0 +1,15 @@
+import { MockResponseBody } from "./types.js";
+/**
+ * Serialize the provided content as json to use in a MockResponse body.
+ * @content Object to return as json.
+ * @returns {MockResponseBody} response body with application/json content type.
+ */
+export declare function json(content: unknown): MockResponseBody;
+/**
+ * Sends the provided XML string in a MockResponse body.
+ * The XML declaration prefix will automatically be added to xmlString.
+ * @content Object to return as XML.
+ * @returns {MockResponseBody} response body with application/xml content type.
+ */
+export declare function xml(xmlString: string): MockResponseBody;
+//# sourceMappingURL=response-utils.d.ts.map

package/dist/response-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-utils.d.ts","sourceRoot":"","sources":["../src/response-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAKvD;AAED;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,CAKvD"}

package/dist/response-utils.js

@@ -0,0 +1,24 @@
+/**
+ * Serialize the provided content as json to use in a MockResponse body.
+ * @content Object to return as json.
+ * @returns {MockResponseBody} response body with application/json content type.
+ */
+export function json(content) {
+    return {
+        contentType: "application/json",
+        rawContent: JSON.stringify(content),
+    };
+}
+/**
+ * Sends the provided XML string in a MockResponse body.
+ * The XML declaration prefix will automatically be added to xmlString.
+ * @content Object to return as XML.
+ * @returns {MockResponseBody} response body with application/xml content type.
+ */
+export function xml(xmlString) {
+    return {
+        contentType: "application/xml",
+        rawContent: `<?xml version='1.0' encoding='UTF-8'?>` + xmlString,
+    };
+}
+//# sourceMappingURL=response-utils.js.map

package/dist/response-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-utils.js","sourceRoot":"","sources":["../src/response-utils.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,OAAgB;IACnC,OAAO;QACL,WAAW,EAAE,kBAAkB;QAC/B,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KACpC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,SAAiB;IACnC,OAAO;QACL,WAAW,EAAE,iBAAiB;QAC9B,UAAU,EAAE,wCAAwC,GAAG,SAAS;KACjE,CAAC;AACJ,CAAC"}

package/dist/routes.d.ts

@@ -0,0 +1,65 @@
+import { HttpMethod, MockApiForHandler, MockRequestHandler } from "./types.js";
+/**
+ * Register a GET request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+declare function get<const T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a POST request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+declare function post<T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a PUT request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+declare function put<T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a PATCH request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+declare function patch<T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a DELETE request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+declare function deleteReq<T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a Options request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+declare function options<T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a HEAD request for the provided uri.
+ * @param uri URI to match.
+ * @param name Name of the scenario(For coverage).
+ * @param func Request handler.
+ */
+declare function head<T extends MockRequestHandler>(uri: string, func: T): MockApiForHandler<T>;
+/**
+ * Register a request for the provided uri.
+ * @param method Method to use.
+ * @param uri URI to match.
+ * @param func Request handler.
+ *
+ * @note prefer to use the corresponding method method directly instead of `request()`(i.e `get(), post()`)
+ */
+declare function request<T extends MockRequestHandler>(method: HttpMethod, uri: string, handler: T): MockApiForHandler<T>;
+export declare const mockapi: {
+    get: typeof get;
+    post: typeof post;
+    put: typeof put;
+    patch: typeof patch;
+    delete: typeof deleteReq;
+    options: typeof options;
+    head: typeof head;
+    request: typeof request;
+};
+export {};
+//# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAE/E;;;;GAIG;AACH,iBAAS,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAE3F;AAED;;;;GAIG;AACH,iBAAS,IAAI,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAEtF;AAED;;;;GAIG;AACH,iBAAS,GAAG,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAErF;AAED;;;;GAIG;AACH,iBAAS,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAEvF;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAE3F;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAEzF;AAED;;;;;GAKG;AACH,iBAAS,IAAI,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAEtF;AAED;;;;;;;GAOG;AACH,iBAAS,OAAO,CAAC,CAAC,SAAS,kBAAkB,EAC3C,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,CAAC,GACT,iBAAiB,CAAC,CAAC,CAAC,CAEtB;AAED,eAAO,MAAM,OAAO;;;;;;;;;CASnB,CAAC"}