@typespec/spec-api 0.1.0-alpha.0

package/dist/routes.js

@@ -0,0 +1,79 @@
+/**
+ * Register a GET request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+function get(uri, func) {
+    return request("get", uri, func);
+}
+/**
+ * Register a POST request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+function post(uri, func) {
+    return request("post", uri, func);
+}
+/**
+ * Register a PUT request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+function put(uri, func) {
+    return request("put", uri, func);
+}
+/**
+ * Register a PATCH request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+function patch(uri, func) {
+    return request("patch", uri, func);
+}
+/**
+ * Register a DELETE request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+function deleteReq(uri, func) {
+    return request("delete", uri, func);
+}
+/**
+ * Register a Options request for the provided uri.
+ * @param uri URI to match.
+ * @param func Request handler.
+ */
+function options(uri, func) {
+    return request("options", uri, func);
+}
+/**
+ * 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.
+ */
+function head(uri, func) {
+    return request("head", uri, func);
+}
+/**
+ * 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()`)
+ */
+function request(method, uri, handler) {
+    return { method, uri, handler };
+}
+export const mockapi = {
+    get,
+    post,
+    put,
+    patch,
+    delete: deleteReq,
+    options,
+    head,
+    request,
+};
+//# sourceMappingURL=routes.js.map

package/dist/routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,SAAS,GAAG,CAAqC,GAAW,EAAE,IAAO;IACnE,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,SAAS,IAAI,CAA+B,GAAW,EAAE,IAAO;IAC9D,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;;GAIG;AACH,SAAS,GAAG,CAA+B,GAAW,EAAE,IAAO;IAC7D,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,SAAS,KAAK,CAA+B,GAAW,EAAE,IAAO;IAC/D,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAA+B,GAAW,EAAE,IAAO;IACnE,OAAO,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,SAAS,OAAO,CAA+B,GAAW,EAAE,IAAO;IACjE,OAAO,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,SAAS,IAAI,CAA+B,GAAW,EAAE,IAAO;IAC9D,OAAO,OAAO,CAAI,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,OAAO,CACd,MAAkB,EAClB,GAAW,EACX,OAAU;IAEV,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAS,CAAC;AACzC,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,GAAG;IACH,IAAI;IACJ,GAAG;IACH,KAAK;IACL,MAAM,EAAE,SAAS;IACjB,OAAO;IACP,IAAI;IACJ,OAAO;CACR,CAAC"}

package/dist/scenarios.d.ts

@@ -0,0 +1,26 @@
+import { KeyedMockApi, KeyedMockApiDefinition, MockApi, MockApiDefinition, PassByKeyScenario, PassByServiceKeyScenario, PassOnCodeScenario, PassOnSuccessScenario } from "./types.js";
+/**
+ * Specify that the scenario should be a `pass` if all the endpoints are called and the API response with 2xx exit code.
+ * @param apis Endpoint or List of endpoints for this scenario
+ */
+export declare function passOnSuccess(apis: MockApi | readonly MockApi[] | MockApiDefinition | readonly MockApiDefinition[]): PassOnSuccessScenario;
+/**
+ * Specify that the scenario should be a `pass` if all the endpoints are called and the API response with the given exit code.
+ * @param code Status code all endpoint should return
+ * @param apis Endpoint or List of endpoints for this scenario
+ */
+export declare function passOnCode(code: number, apis: MockApi | readonly MockApi[] | MockApiDefinition): PassOnCodeScenario;
+export interface WithKeysScenarioExpect<K extends string> {
+    pass(api: KeyedMockApi<K>): PassByKeyScenario<K>;
+}
+/**
+ * Specify a list of keys that must be hit to this scenario to pass
+ * @param keys List of keys
+ * @param api Mock api that in the MockResponse can return a pass key.
+ */
+export declare function withKeys<const K extends string>(keys: K[]): WithKeysScenarioExpect<K>;
+export interface WithServiceKeysScenarioExpect<K extends string> {
+    pass(api: KeyedMockApiDefinition<K> | KeyedMockApiDefinition<K>[]): PassByServiceKeyScenario<K>;
+}
+export declare function withServiceKeys<const K extends string>(keys: K[]): WithServiceKeysScenarioExpect<K>;
+//# sourceMappingURL=scenarios.d.ts.map

package/dist/scenarios.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenarios.d.ts","sourceRoot":"","sources":["../src/scenarios.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,SAAS,OAAO,EAAE,GAAG,iBAAiB,GAAG,SAAS,iBAAiB,EAAE,GACpF,qBAAqB,CAKvB;AACD;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,GAAG,SAAS,OAAO,EAAE,GAAG,iBAAiB,GACrD,kBAAkB,CAMpB;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM;IACtD,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAClD;AACD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAUrF;AAED,MAAM,WAAW,6BAA6B,CAAC,CAAC,SAAS,MAAM;IAC7D,IAAI,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,EAAE,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;CACjG;AAED,wBAAgB,eAAe,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EACpD,IAAI,EAAE,CAAC,EAAE,GACR,6BAA6B,CAAC,CAAC,CAAC,CAUlC"}

package/dist/scenarios.js

@@ -0,0 +1,50 @@
+/**
+ * Specify that the scenario should be a `pass` if all the endpoints are called and the API response with 2xx exit code.
+ * @param apis Endpoint or List of endpoints for this scenario
+ */
+export function passOnSuccess(apis) {
+    return {
+        passCondition: "response-success",
+        apis: Array.isArray(apis) ? apis : [apis],
+    };
+}
+/**
+ * Specify that the scenario should be a `pass` if all the endpoints are called and the API response with the given exit code.
+ * @param code Status code all endpoint should return
+ * @param apis Endpoint or List of endpoints for this scenario
+ */
+export function passOnCode(code, apis) {
+    return {
+        passCondition: "status-code",
+        code,
+        apis: Array.isArray(apis) ? apis : [apis],
+    };
+}
+/**
+ * Specify a list of keys that must be hit to this scenario to pass
+ * @param keys List of keys
+ * @param api Mock api that in the MockResponse can return a pass key.
+ */
+export function withKeys(keys) {
+    return {
+        pass: (api) => {
+            return {
+                passCondition: "by-key",
+                keys,
+                apis: [api],
+            };
+        },
+    };
+}
+export function withServiceKeys(keys) {
+    return {
+        pass: (api) => {
+            return {
+                passCondition: "by-key",
+                keys,
+                apis: Array.isArray(api) ? api : [api],
+            };
+        },
+    };
+}
+//# sourceMappingURL=scenarios.js.map

package/dist/scenarios.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenarios.js","sourceRoot":"","sources":["../src/scenarios.ts"],"names":[],"mappings":"AAWA;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAqF;IAErF,OAAO;QACL,aAAa,EAAE,kBAAkB;QACjC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;KAC1C,CAAC;AACJ,CAAC;AACD;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,IAAY,EACZ,IAAsD;IAEtD,OAAO;QACL,aAAa,EAAE,aAAa;QAC5B,IAAI;QACJ,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;KAC1C,CAAC;AACJ,CAAC;AAKD;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAyB,IAAS;IACxD,OAAO;QACL,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;YACZ,OAAO;gBACL,aAAa,EAAE,QAAQ;gBACvB,IAAI;gBACJ,IAAI,EAAE,CAAC,GAAG,CAAC;aACZ,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAMD,MAAM,UAAU,eAAe,CAC7B,IAAS;IAET,OAAO;QACL,IAAI,EAAE,CAAC,GAA4D,EAAE,EAAE;YACrE,OAAO;gBACL,aAAa,EAAE,QAAQ;gBACvB,IAAI;gBACJ,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;aACvC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,96 @@
+import type { Request } from "express";
+import { MockRequest } from "./mock-request.js";
+/**
+ * Extension of the express.js request which include a rawBody.
+ */
+export interface RequestExt extends Request {
+    rawBody?: string | Buffer;
+    files?: {
+        [fieldname: string]: Express.Multer.File[];
+    } | Express.Multer.File[] | undefined;
+}
+export type ScenarioPassCondition = "response-success" | "status-code";
+export interface PassOnSuccessScenario {
+    passCondition: "response-success";
+    apis: MockApi[] | MockApiDefinition[];
+}
+export interface PassOnCodeScenario {
+    passCondition: "status-code";
+    code: number;
+    apis: MockApi[] | MockApiDefinition[];
+}
+export interface PassByKeyScenario<K extends string = string> {
+    passCondition: "by-key";
+    keys: K[];
+    apis: KeyedMockApi<K>[];
+}
+export interface PassByServiceKeyScenario<K extends string = string> {
+    passCondition: "by-key";
+    keys: K[];
+    apis: KeyedMockApiDefinition<K>[];
+}
+export type ScenarioMockApi = PassOnSuccessScenario | PassOnCodeScenario | PassByKeyScenario | PassByServiceKeyScenario;
+export type MockRequestHandler = SimpleMockRequestHandler | KeyedMockRequestHandler;
+export type SimpleMockRequestHandler = (req: MockRequest) => MockResponse | Promise<MockResponse>;
+export type KeyedMockRequestHandler<T extends string = string> = (req: MockRequest) => KeyedMockResponse<T> | Promise<KeyedMockResponse<T>>;
+export type KeyedServiceRequestHandler<T extends string = string> = (req: ServiceRequest) => KeyedMockResponse<T> | Promise<KeyedMockResponse<T>>;
+export type HttpMethod = "get" | "post" | "put" | "patch" | "delete" | "head" | "options";
+export type MockApiForHandler<Handler extends MockRequestHandler> = Handler extends KeyedMockRequestHandler<infer K> ? KeyedMockApi<K> : MockApi;
+export interface MockApi {
+    method: HttpMethod;
+    uri: string;
+    handler: MockRequestHandler;
+    kind: "MockApi";
+}
+export interface MockApiDefinition {
+    uri: string;
+    method: HttpMethod;
+    request: ServiceRequest;
+    response: MockResponse;
+    handler?: MockRequestHandler;
+    kind: "MockApiDefinition";
+}
+export interface ServiceRequestFile {
+    fieldname: string;
+    originalname: string;
+    buffer: Buffer;
+    mimetype: string;
+}
+export interface ServiceRequest {
+    body?: any;
+    status?: number;
+    /**
+     * Query parameters to match to the request.
+     */
+    params?: Record<string, unknown>;
+    headers?: Record<string, unknown>;
+    files?: ServiceRequestFile[];
+}
+export declare const Fail: unique symbol;
+export interface KeyedMockApi<K extends string> extends MockApi {
+    handler: KeyedMockRequestHandler<K>;
+}
+export interface KeyedMockApiDefinition<K extends string> extends MockApiDefinition {
+    handler: KeyedMockRequestHandler<K>;
+}
+export interface MockResponse {
+    status: number;
+    headers?: {
+        [key: string]: string | null;
+    };
+    body?: MockResponseBody;
+    /**
+     * Let the mock API know that this request was successful to counting coverage regardless of the status code.
+     * By default only 2xx status code will count toward success.
+     */
+    testSuccessful?: boolean;
+}
+export interface KeyedMockResponse<K extends string = string> extends MockResponse {
+    pass: K | typeof Fail;
+}
+export interface MockResponseBody {
+    contentType: string;
+    rawContent: string | Buffer | undefined;
+}
+export type CollectionFormat = "multi" | "csv" | "ssv" | "tsv" | "pipes";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO;IACzC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,KAAK,CAAC,EACF;QACE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;KAC5C,GACD,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GACrB,SAAS,CAAC;CACf;AAED,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,GAAG,aAAa,CAAC;AAEvE,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,kBAAkB,CAAC;IAClC,IAAI,EAAE,OAAO,EAAE,GAAG,iBAAiB,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,aAAa,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,EAAE,GAAG,iBAAiB,EAAE,CAAC;CACvC;AACD,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC1D,aAAa,EAAE,QAAQ,CAAC;IACxB,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;CACzB;AACD,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACjE,aAAa,EAAE,QAAQ,CAAC;IACxB,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAAE,CAAC;CACnC;AAED,MAAM,MAAM,eAAe,GACvB,qBAAqB,GACrB,kBAAkB,GAClB,iBAAiB,GACjB,wBAAwB,CAAC;AAC7B,MAAM,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,uBAAuB,CAAC;AACpF,MAAM,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAClG,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAC/D,GAAG,EAAE,WAAW,KACb,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAClE,GAAG,EAAE,cAAc,KAChB,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1F,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,kBAAkB,IAC9D,OAAO,SAAS,uBAAuB,CAAC,MAAM,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAE/E,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,UAAU,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,kBAAkB,CAAC;IAC5B,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9B;AAED,eAAO,MAAM,IAAI,eAAqB,CAAC;AACvC,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,OAAO;IAC7D,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC;CACrC;AACD,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB;IACjF,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC;IAEF,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,YAAY;IAChF,IAAI,EAAE,CAAC,GAAG,OAAO,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export const Fail = Symbol.for("Fail");
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA4FA,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC"}

package/dist/validation-error.d.ts

@@ -0,0 +1,14 @@
+export declare class ValidationError extends Error {
+    expected: unknown | undefined;
+    actual: unknown | undefined;
+    status: number;
+    /**
+     * Error thrown there there is a validation issue.
+     * @param message Message describing the error.
+     * @param expected expected value.
+     * @param actual actual value.
+     */
+    constructor(message: string, expected: unknown | undefined, actual: unknown | undefined);
+    toJSON(): string;
+}
+//# sourceMappingURL=validation-error.d.ts.map

package/dist/validation-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error.d.ts","sourceRoot":"","sources":["../src/validation-error.ts"],"names":[],"mappings":"AAAA,qBAAa,eAAgB,SAAQ,KAAK;IAW/B,QAAQ,EAAE,OAAO,GAAG,SAAS;IAC7B,MAAM,EAAE,OAAO,GAAG,SAAS;IAX7B,MAAM,SAAO;IAEpB;;;;;OAKG;gBAED,OAAO,EAAE,MAAM,EACR,QAAQ,EAAE,OAAO,GAAG,SAAS,EAC7B,MAAM,EAAE,OAAO,GAAG,SAAS;IAK7B,MAAM,IAAI,MAAM;CAGxB"}

package/dist/validation-error.js

@@ -0,0 +1,20 @@
+export class ValidationError extends Error {
+    expected;
+    actual;
+    status = 400;
+    /**
+     * Error thrown there there is a validation issue.
+     * @param message Message describing the error.
+     * @param expected expected value.
+     * @param actual actual value.
+     */
+    constructor(message, expected, actual) {
+        super(message);
+        this.expected = expected;
+        this.actual = actual;
+    }
+    toJSON() {
+        return JSON.stringify({ message: this.message, expected: this.expected, actual: this.actual });
+    }
+}
+//# sourceMappingURL=validation-error.js.map

package/dist/validation-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error.js","sourceRoot":"","sources":["../src/validation-error.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAW/B;IACA;IAXF,MAAM,GAAG,GAAG,CAAC;IAEpB;;;;;OAKG;IACH,YACE,OAAe,EACR,QAA6B,EAC7B,MAA2B;QAElC,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,aAAQ,GAAR,QAAQ,CAAqB;QAC7B,WAAM,GAAN,MAAM,CAAqB;IAGpC,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACjG,CAAC;CACF"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@typespec/spec-api",
+  "version": "0.1.0-alpha.0",
+  "description": "Spec api to implement mock api",
+  "main": "dist/index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/typespec.git"
+  },
+  "author": "Microsoft",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/microsoft/typespec/issues"
+  },
+  "homepage": "https://github.com/microsoft/typespec#readme",
+  "dependencies": {
+    "body-parser": "^1.20.3",
+    "deep-equal": "^2.2.0",
+    "express": "^4.21.1",
+    "express-promise-router": "^4.1.1",
+    "morgan": "^1.10.0",
+    "multer": "^1.4.5-lts.1",
+    "picocolors": "~1.1.0",
+    "prettier": "~3.3.3",
+    "winston": "^3.15.0",
+    "xml2js": "^0.6.2",
+    "yargs": "~17.7.2"
+  },
+  "devDependencies": {
+    "@types/body-parser": "^1.19.2",
+    "@types/deep-equal": "^1.0.1",
+    "@types/express": "^5.0.0",
+    "@types/morgan": "^1.9.4",
+    "@types/multer": "^1.4.10",
+    "@types/node": "~22.7.5",
+    "@types/xml2js": "^0.4.11",
+    "@types/yargs": "~17.0.33",
+    "@vitest/coverage-v8": "^2.1.2",
+    "@vitest/ui": "^2.1.2",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.6.3",
+    "vitest": "^2.1.2"
+  },
+  "scripts": {
+    "watch": "tsc -p ./tsconfig.build.json --watch",
+    "build": "tsc -p ./tsconfig.build.json",
+    "clean": "rimraf dist/ temp/",
+    "test": "vitest run"
+  }
+}

package/src/expectation.ts

@@ -0,0 +1,106 @@
+import deepEqual from "deep-equal";
+import {
+  validateBodyEmpty,
+  validateBodyEquals,
+  validateBodyNotEmpty,
+  validateCoercedDateBodyEquals,
+  validateHeader,
+  validateQueryParam,
+  validateRawBodyEquals,
+  validateXmlBodyEquals,
+} from "./request-validations.js";
+import { CollectionFormat, RequestExt } from "./types.js";
+import { ValidationError } from "./validation-error.js";
+
+/**
+ * Class containing all the expectations that can be run on the request.
+ */
+export class RequestExpectation {
+  public constructor(private 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.
+   */
+  public rawBodyEquals(expectedRawBody: string | Buffer | undefined): void {
+    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.
+   */
+  public bodyEquals(expectedRawBody: unknown | undefined): void {
+    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.
+   */
+  public coercedBodyEquals(expectedRawBody: unknown | undefined): void {
+    validateCoercedDateBodyEquals(this.originalRequest, expectedRawBody);
+  }
+
+  /**
+   * Expect the body of the request to be empty.
+   * @throws {ValidationError} if there is an error.
+   */
+  public bodyEmpty(): void {
+    validateBodyEmpty(this.originalRequest);
+  }
+
+  /**
+   * Expect the body of the request to be not empty.
+   * @throws {ValidationError} if there is an error.
+   */
+  public bodyNotEmpty(): void {
+    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.
+   */
+  public containsHeader(headerName: string, expectedValue: string): void {
+    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.
+   */
+  public containsQueryParam(
+    paramName: string,
+    expectedValue: string | string[],
+    collectionFormat?: CollectionFormat,
+  ): void {
+    validateQueryParam(this.originalRequest, paramName, expectedValue, collectionFormat);
+  }
+
+  /**
+   * Check if two requests are equal
+   * @param actual Actual value
+   * @param expected Expected value
+   */
+  public deepEqual(actual: unknown, expected: unknown, message = "Values not deep equal"): void {
+    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.
+   */
+  public xmlBodyEquals(expectedBody: string): void {
+    validateXmlBodyEquals(this.originalRequest, expectedBody);
+  }
+}

package/src/index.ts

@@ -0,0 +1,48 @@
+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";

package/src/mock-request.ts

@@ -0,0 +1,31 @@
+import { RequestExpectation } from "./expectation.js";
+import { RequestExt } from "./types.js";
+
+export class MockRequest {
+  public readonly expect: RequestExpectation;
+
+  public readonly baseUrl: string;
+  public readonly headers: { [key: string]: string };
+  public readonly query: { [key: string]: string | string[] };
+  public readonly params: { [key: string]: string };
+  public readonly body: any;
+  public readonly files?:
+    | {
+        [fieldname: string]: Express.Multer.File[];
+      }
+    | Express.Multer.File[]
+    | undefined;
+
+  public constructor(public originalRequest: RequestExt) {
+    this.baseUrl = getRequestBaseUrl(originalRequest);
+    this.expect = new RequestExpectation(originalRequest);
+    this.headers = originalRequest.headers as { [key: string]: string };
+    this.query = originalRequest.query as { [key: string]: string };
+    this.params = originalRequest.params as { [key: string]: string };
+    this.body = originalRequest.body;
+    this.files = originalRequest.files;
+  }
+}
+
+const getRequestBaseUrl = (request: RequestExt): string =>
+  `${request.protocol}://${request.get("host")}`;