@schmock/core 2.3.0 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +35 -0
- package/dist/abort.d.ts +3 -0
- package/dist/abort.d.ts.map +1 -0
- package/dist/abort.js +30 -0
- package/dist/builder.d.ts +31 -10
- package/dist/builder.d.ts.map +1 -1
- package/dist/builder.js +760 -190
- package/dist/constants.d.ts +38 -0
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +123 -2
- package/dist/errors.d.ts +14 -3
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +41 -6
- package/dist/helpers.d.ts +9 -0
- package/dist/helpers.d.ts.map +1 -1
- package/dist/helpers.js +18 -2
- package/dist/http-helpers.d.ts +39 -4
- package/dist/http-helpers.d.ts.map +1 -1
- package/dist/http-helpers.js +147 -49
- package/dist/index.d.ts +292 -34
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -3
- package/dist/interceptor.d.ts +11 -1
- package/dist/interceptor.d.ts.map +1 -1
- package/dist/interceptor.js +316 -169
- package/dist/parser.d.ts.map +1 -1
- package/dist/parser.js +12 -3
- package/dist/plugin-pipeline.d.ts +3 -3
- package/dist/plugin-pipeline.d.ts.map +1 -1
- package/dist/plugin-pipeline.js +29 -14
- package/dist/response-normalizer.d.ts +16 -0
- package/dist/response-normalizer.d.ts.map +1 -0
- package/dist/response-normalizer.js +316 -0
- package/dist/response-parser.d.ts.map +1 -1
- package/dist/response-parser.js +39 -2
- package/dist/route-matcher.d.ts +3 -0
- package/dist/route-matcher.d.ts.map +1 -1
- package/dist/route-matcher.js +12 -6
- package/dist/types.d.ts +7 -2
- package/dist/types.d.ts.map +1 -1
- package/package.json +14 -6
- package/src/audit-core-builder.test.ts +0 -218
- package/src/audit-response-guard.test.ts +0 -38
- package/src/binary.test.ts +0 -126
- package/src/binary.ts +0 -11
- package/src/builder.test.ts +0 -289
- package/src/builder.ts +0 -748
- package/src/constants.test.ts +0 -99
- package/src/constants.ts +0 -73
- package/src/debug.test.ts +0 -241
- package/src/delay.test.ts +0 -319
- package/src/dist-shape.test.ts +0 -35
- package/src/errors.test.ts +0 -223
- package/src/errors.ts +0 -130
- package/src/factory.test.ts +0 -133
- package/src/helpers.test.ts +0 -147
- package/src/helpers.ts +0 -58
- package/src/http-helpers.test.ts +0 -39
- package/src/http-helpers.ts +0 -149
- package/src/index.ts +0 -152
- package/src/interceptor.test.ts +0 -488
- package/src/interceptor.ts +0 -407
- package/src/namespace.test.ts +0 -274
- package/src/parser.property.test.ts +0 -630
- package/src/parser.test.ts +0 -148
- package/src/parser.ts +0 -64
- package/src/plugin-pipeline.ts +0 -208
- package/src/plugin-system.test.ts +0 -697
- package/src/response-parser.ts +0 -114
- package/src/response-parsing.test.ts +0 -333
- package/src/route-matcher.ts +0 -69
- package/src/route-matching.test.ts +0 -394
- package/src/server.test.ts +0 -234
- package/src/smart-defaults.test.ts +0 -361
- package/src/steps/async-support.steps.ts +0 -421
- package/src/steps/audit-core-builder.steps.ts +0 -188
- package/src/steps/audit-onerror-tuple.steps.ts +0 -83
- package/src/steps/basic-usage.steps.ts +0 -245
- package/src/steps/developer-experience.steps.ts +0 -204
- package/src/steps/error-handling.steps.ts +0 -555
- package/src/steps/fetch-interceptor.steps.ts +0 -457
- package/src/steps/fluent-api.steps.ts +0 -255
- package/src/steps/http-methods.steps.ts +0 -342
- package/src/steps/lifecycle-events.steps.ts +0 -149
- package/src/steps/performance-reliability.steps.ts +0 -90
- package/src/steps/plugin-integration.steps.ts +0 -334
- package/src/steps/request-history.steps.ts +0 -458
- package/src/steps/response-delay.steps.ts +0 -88
- package/src/steps/route-key-format.steps.ts +0 -99
- package/src/steps/standalone-server.steps.ts +0 -227
- package/src/steps/state-concurrency.steps.ts +0 -167
- package/src/types.ts +0 -36
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Khalic Lab
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# @schmock/core
|
|
2
|
+
|
|
3
|
+
Core mock builder, routing, and plugin pipeline for Schmock.
|
|
4
|
+
|
|
5
|
+
Part of [Schmock](https://github.com/khalic-lab/schmock) — mock APIs from OpenAPI specs or hand-crafted routes.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bun add -d @schmock/core
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { schmock } from "@schmock/core";
|
|
17
|
+
|
|
18
|
+
const mock = schmock();
|
|
19
|
+
|
|
20
|
+
mock("GET /users", [{ id: 1, name: "Alice" }]);
|
|
21
|
+
mock("POST /users", ({ body }) => [201, body]);
|
|
22
|
+
|
|
23
|
+
const response = await mock.handle("GET", "/users");
|
|
24
|
+
// → { status: 200, body: [{ id: 1, name: "Alice" }] }
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Documentation
|
|
28
|
+
|
|
29
|
+
- [Getting started](https://github.com/khalic-lab/schmock/blob/main/docs/getting-started.md)
|
|
30
|
+
- [API reference](https://github.com/khalic-lab/schmock/blob/main/docs/api.md)
|
|
31
|
+
- [Plugin development](https://github.com/khalic-lab/schmock/blob/main/docs/plugins.md)
|
|
32
|
+
|
|
33
|
+
## License
|
|
34
|
+
|
|
35
|
+
MIT © Khalic Lab
|
package/dist/abort.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"abort.d.ts","sourceRoot":"","sources":["../src/abort.ts"],"names":[],"mappings":"AASA,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAEzD;AAED,wBAAgB,cAAc,CAAC,CAAC,EAC9B,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EACzB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,CAAC,CAAC,CAmBZ"}
|
package/dist/abort.js
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
function abortReason(signal) {
|
|
2
|
+
if ("reason" in signal && signal.reason !== undefined) {
|
|
3
|
+
return signal.reason;
|
|
4
|
+
}
|
|
5
|
+
const error = new Error("Request aborted");
|
|
6
|
+
error.name = "AbortError";
|
|
7
|
+
return error;
|
|
8
|
+
}
|
|
9
|
+
export function throwIfAborted(signal) {
|
|
10
|
+
if (signal?.aborted)
|
|
11
|
+
throw abortReason(signal);
|
|
12
|
+
}
|
|
13
|
+
export function awaitWithAbort(value, signal) {
|
|
14
|
+
if (!signal)
|
|
15
|
+
return Promise.resolve(value);
|
|
16
|
+
throwIfAborted(signal);
|
|
17
|
+
return new Promise((resolve, reject) => {
|
|
18
|
+
let settled = false;
|
|
19
|
+
const finish = (action) => {
|
|
20
|
+
if (settled)
|
|
21
|
+
return;
|
|
22
|
+
settled = true;
|
|
23
|
+
signal.removeEventListener("abort", abort);
|
|
24
|
+
action();
|
|
25
|
+
};
|
|
26
|
+
const abort = () => finish(() => reject(abortReason(signal)));
|
|
27
|
+
signal.addEventListener("abort", abort, { once: true });
|
|
28
|
+
Promise.resolve(value).then((result) => finish(() => resolve(result)), (error) => finish(() => reject(error)));
|
|
29
|
+
});
|
|
30
|
+
}
|
package/dist/builder.d.ts
CHANGED
|
@@ -1,3 +1,20 @@
|
|
|
1
|
+
import type { CompiledCallableRoute } from "./route-matcher.js";
|
|
2
|
+
interface RequestAdmission {
|
|
3
|
+
readonly requestGeneration: RequestGeneration;
|
|
4
|
+
readonly historyGeneration: symbol;
|
|
5
|
+
readonly plugins: readonly Schmock.Plugin[];
|
|
6
|
+
readonly routes: CompiledCallableRoute[];
|
|
7
|
+
readonly staticRoutes: Map<string, CompiledCallableRoute>;
|
|
8
|
+
readonly state: Record<string, unknown>;
|
|
9
|
+
readonly namespace?: string;
|
|
10
|
+
readonly globalDelay?: number | [number, number];
|
|
11
|
+
readonly maxHistorySize?: number;
|
|
12
|
+
released: boolean;
|
|
13
|
+
}
|
|
14
|
+
interface RequestGeneration {
|
|
15
|
+
activeAdmissions: number;
|
|
16
|
+
retiredPlugins?: readonly Schmock.Plugin[];
|
|
17
|
+
}
|
|
1
18
|
/**
|
|
2
19
|
* Callable mock instance that implements the new API.
|
|
3
20
|
*
|
|
@@ -5,7 +22,6 @@
|
|
|
5
22
|
*/
|
|
6
23
|
export declare class CallableMockInstance {
|
|
7
24
|
#private;
|
|
8
|
-
private globalConfig;
|
|
9
25
|
private routes;
|
|
10
26
|
private staticRoutes;
|
|
11
27
|
private plugins;
|
|
@@ -13,19 +29,19 @@ export declare class CallableMockInstance {
|
|
|
13
29
|
private requestHistory;
|
|
14
30
|
private callableRef;
|
|
15
31
|
private server;
|
|
16
|
-
private
|
|
17
|
-
private
|
|
32
|
+
private pendingServerStart;
|
|
33
|
+
private serverCloseBarrier;
|
|
34
|
+
private interceptHandles;
|
|
35
|
+
private requestGeneration;
|
|
36
|
+
private historyGeneration;
|
|
37
|
+
private interceptOwner;
|
|
38
|
+
private globalConfig;
|
|
18
39
|
private listeners;
|
|
19
40
|
constructor(globalConfig?: Schmock.GlobalConfig);
|
|
20
41
|
defineRoute(route: Schmock.RouteKey, generator: Schmock.Generator, config: Schmock.RouteConfig): this;
|
|
21
42
|
setCallableRef(ref: Schmock.CallableMockInstance): void;
|
|
22
43
|
pipe(plugin: Schmock.Plugin): this;
|
|
23
|
-
|
|
24
|
-
* FIX 2.3: Deep-clone a request record so callers cannot corrupt internal
|
|
25
|
-
* history by mutating nested body/response objects.
|
|
26
|
-
* Falls back to a shallow spread for bodies that are not structuredClone-able
|
|
27
|
-
* (e.g. Buffers, streams — rare in practice but defensively handled).
|
|
28
|
-
*/
|
|
44
|
+
private uninstallPlugins;
|
|
29
45
|
private cloneRecord;
|
|
30
46
|
history(method?: Schmock.HttpMethod, path?: string): Schmock.RequestRecord[];
|
|
31
47
|
called(method?: Schmock.HttpMethod, path?: string): boolean;
|
|
@@ -39,10 +55,14 @@ export declare class CallableMockInstance {
|
|
|
39
55
|
reset(): void;
|
|
40
56
|
resetHistory(): void;
|
|
41
57
|
resetState(): void;
|
|
58
|
+
createRequestAdmission(): {
|
|
59
|
+
handle: (method: Schmock.HttpMethod, path: string, options?: Schmock.RequestOptions) => Promise<Schmock.Response>;
|
|
60
|
+
release: () => void;
|
|
61
|
+
};
|
|
42
62
|
listen(port?: number, hostname?: string): Promise<Schmock.ServerInfo>;
|
|
43
63
|
close(): void;
|
|
44
64
|
intercept(options?: Schmock.InterceptOptions): Schmock.InterceptHandle;
|
|
45
|
-
handle(method: Schmock.HttpMethod, path: string, options?: Schmock.RequestOptions): Promise<Schmock.Response>;
|
|
65
|
+
handle(method: Schmock.HttpMethod, path: string, options?: Schmock.RequestOptions, admission?: RequestAdmission): Promise<Schmock.Response>;
|
|
46
66
|
/**
|
|
47
67
|
* Apply configured response delay
|
|
48
68
|
* Supports both fixed delays and random delays within a range
|
|
@@ -50,4 +70,5 @@ export declare class CallableMockInstance {
|
|
|
50
70
|
*/
|
|
51
71
|
private applyDelay;
|
|
52
72
|
}
|
|
73
|
+
export {};
|
|
53
74
|
//# sourceMappingURL=builder.d.ts.map
|
package/dist/builder.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"AAiCA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAqBhE,UAAU,gBAAgB;IACxB,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,SAAS,OAAO,CAAC,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,CAAC;IACzC,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC1D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,iBAAiB;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,SAAS,OAAO,CAAC,MAAM,EAAE,CAAC;CAC5C;AA+KD;;;;GAIG;AACH,qBAAa,oBAAoB;;IAC/B,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,WAAW,CAA2C;IAC9D,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,kBAAkB,CAAiC;IAC3D,OAAO,CAAC,kBAAkB,CAA4B;IACtD,OAAO,CAAC,gBAAgB,CAAsC;IAC9D,OAAO,CAAC,iBAAiB,CAA8C;IACvE,OAAO,CAAC,iBAAiB,CAAwC;IACjE,OAAO,CAAC,cAAc,CAAqC;IAC3D,OAAO,CAAC,YAAY,CAAuB;IAE3C,OAAO,CAAC,SAAS,CAAoC;gBAEzC,YAAY,GAAE,OAAO,CAAC,YAAiB;IAkBnD,WAAW,CACT,KAAK,EAAE,OAAO,CAAC,QAAQ,EACvB,SAAS,EAAE,OAAO,CAAC,SAAS,EAC5B,MAAM,EAAE,OAAO,CAAC,WAAW,GAC1B,IAAI;IAsFP,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,oBAAoB,GAAG,IAAI;IAIvD,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI;IA8GlC,OAAO,CAAC,gBAAgB;IA8BxB,OAAO,CAAC,WAAW;IAkCnB,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE;IAS5E,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAO3D,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAQ7D,WAAW,CACT,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAC3B,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,aAAa,GAAG,SAAS;IAgBpC,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE;IAQhC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAMnC,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,YAAY,EAC/B,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GACnD,IAAI;IAUP,GAAG,CAAC,CAAC,SAAS,OAAO,CAAC,YAAY,EAChC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GACnD,IAAI;IAKP,OAAO,CAAC,IAAI;IAsCZ,KAAK,IAAI,IAAI;IAgBb,YAAY,IAAI,IAAI;IAMpB,UAAU,IAAI,IAAI;IAiDlB,sBAAsB;yBAIR,OAAO,CAAC,UAAU,QACpB,MAAM,YACF,OAAO,CAAC,cAAc;;;IAQtC,MAAM,CAAC,IAAI,SAAI,EAAE,QAAQ,SAAc,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;IAsNrE,KAAK,IAAI,IAAI;IAYb,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe;IAwChE,MAAM,CACV,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,EAChC,SAAS,CAAC,EAAE,gBAAgB,GAC3B,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IA2c5B;;;;OAIG;YACW,UAAU;CAmCzB"}
|