@schmock/core 1.0.4 → 1.1.0

package/dist/types.d.ts

@@ -1,215 +1,18 @@
-/**
- * JSON Schema type (simplified for core package)
- * Full schema support available via @schmock/schema
- */
-export interface JSONSchema {
-    type?: string | string[];
-    properties?: Record<string, JSONSchema>;
-    items?: JSONSchema | JSONSchema[];
-    required?: string[];
-    enum?: any[];
-    const?: any;
-    [key: string]: any;
-}
-/**
- * HTTP methods supported by Schmock
- */
-export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
-/**
- * Route key format: 'METHOD /path'
- *
- * @example
- * 'GET /users'
- * 'POST /users/:id'
- * 'DELETE /api/posts/:postId/comments/:commentId'
- */
-export type RouteKey = `${HttpMethod} ${string}`;
-/**
- * Plugin interface for extending Schmock functionality
- */
-export interface Plugin {
-    /** Unique plugin identifier */
-    name: string;
-    /** Plugin version (semver) */
-    version?: string;
-    /**
-     * Process the request through this plugin
-     * First plugin to set response becomes the generator, others transform
-     * @param context - Plugin context with request details
-     * @param response - Response from previous plugin (if any)
-     * @returns Updated context and response
-     */
-    process(context: PluginContext, response?: unknown): PluginResult | Promise<PluginResult>;
-    /**
-     * Called when an error occurs
-     * Can handle, transform, or suppress errors
-     * @param error - The error that occurred
-     * @param context - Plugin context
-     * @returns Modified error, response data, or void to continue error propagation
-     */
-    onError?(error: Error, context: PluginContext): Error | ResponseResult | undefined | Promise<Error | ResponseResult | undefined>;
-}
-/**
- * Result returned by plugin process method
- */
-export interface PluginResult {
-    /** Updated context */
-    context: PluginContext;
-    /** Response data (if generated/modified) */
-    response?: unknown;
-}
-/**
- * Context passed through plugin pipeline
- */
-export interface PluginContext {
-    /** Request path */
-    path: string;
-    /** Matched route configuration */
-    route: RouteConfig;
-    /** HTTP method */
-    method: HttpMethod;
-    /** Route parameters */
-    params: Record<string, string>;
-    /** Query parameters */
-    query: Record<string, string>;
-    /** Request headers */
-    headers: Record<string, string>;
-    /** Request body */
-    body?: unknown;
-    /** Shared state between plugins for this request */
-    state: Map<string, unknown>;
-    /** Route-specific state */
-    routeState?: Record<string, unknown>;
-}
-/**
- * Global configuration options for the mock instance
- */
-export interface GlobalConfig {
-    /** Base path prefix for all routes */
-    namespace?: string;
-    /** Response delay in ms, or [min, max] for random delay */
-    delay?: number | [number, number];
-    /** Enable debug mode for detailed logging */
-    debug?: boolean;
-    /** Initial shared state object */
-    state?: Record<string, unknown>;
-}
-/**
- * Route-specific configuration options
- */
-export interface RouteConfig {
-    /** MIME type for content type validation (auto-detected if not provided) */
-    contentType?: string;
-    /** Additional route-specific options */
-    [key: string]: any;
-}
-/**
- * Generator types that can be passed to route definitions
- */
-export type Generator = GeneratorFunction | StaticData | JSONSchema;
-/**
- * Function that generates responses
- */
-export type GeneratorFunction = (context: RequestContext) => ResponseResult | Promise<ResponseResult>;
-/**
- * Response body type alias
- */
-export type ResponseBody = unknown;
-/**
- * Static data (non-function) that gets returned as-is
- */
-export type StaticData = string | number | boolean | null | undefined | Record<string, unknown> | unknown[];
-/**
- * Context passed to generator functions
- */
-export interface RequestContext {
-    /** HTTP method */
-    method: HttpMethod;
-    /** Request path */
-    path: string;
-    /** Route parameters (e.g., :id) */
-    params: Record<string, string>;
-    /** Query string parameters */
-    query: Record<string, string>;
-    /** Request headers */
-    headers: Record<string, string>;
-    /** Request body (for POST, PUT, PATCH) */
-    body?: unknown;
-    /** Shared mutable state */
-    state: Record<string, unknown>;
-}
-/**
- * Response result types:
- * - Any value: returns as 200 OK
- * - [status, body]: custom status with body
- * - [status, body, headers]: custom status, body, and headers
- */
-export type ResponseResult = ResponseBody | [number, ResponseBody] | [number, ResponseBody, Record<string, string>];
-/**
- * Response object returned by handle method
- */
-export interface Response {
-    status: number;
-    body: unknown;
-    headers: Record<string, string>;
-}
-/**
- * Options for handle method
- */
-export interface RequestOptions {
-    headers?: Record<string, string>;
-    body?: unknown;
-    query?: Record<string, string>;
-}
-/**
- * Main callable mock instance interface
- */
-export interface CallableMockInstance {
-    /**
-     * Define a route by calling the instance directly
-     *
-     * @param route - Route pattern in format 'METHOD /path'
-     * @param generator - Response generator (function, static data, or schema)
-     * @param config - Route-specific configuration
-     * @returns The same instance for method chaining
-     *
-     * @example
-     * ```typescript
-     * const mock = schmock()
-     * mock('GET /users', () => [...users], { contentType: 'application/json' })
-     * mock('POST /users', userData, { contentType: 'application/json' })
-     * ```
-     */
-    (route: RouteKey, generator: Generator, config?: RouteConfig): CallableMockInstance;
-    /**
-     * Add a plugin to the pipeline
-     *
-     * @param plugin - Plugin to add to the pipeline
-     * @returns The same instance for method chaining
-     *
-     * @example
-     * ```typescript
-     * mock('GET /users', generator, config)
-     *   .pipe(authPlugin())
-     *   .pipe(corsPlugin())
-     * ```
-     */
-    pipe(plugin: Plugin): CallableMockInstance;
-    /**
-     * Handle a request and return a response
-     *
-     * @param method - HTTP method
-     * @param path - Request path
-     * @param options - Request options (headers, body, query)
-     * @returns Promise resolving to response object
-     *
-     * @example
-     * ```typescript
-     * const response = await mock.handle('GET', '/users', {
-     *   headers: { 'Authorization': 'Bearer token' }
-     * })
-     * ```
-     */
-    handle(method: HttpMethod, path: string, options?: RequestOptions): Promise<Response>;
-}
+export type HttpMethod = Schmock.HttpMethod;
+export type RouteKey = Schmock.RouteKey;
+export type ResponseBody = Schmock.ResponseBody;
+export type ResponseResult = Schmock.ResponseResult;
+export type RequestContext = Schmock.RequestContext;
+export type Response = Schmock.Response;
+export type RequestOptions = Schmock.RequestOptions;
+export type GlobalConfig = Schmock.GlobalConfig;
+export type RouteConfig = Schmock.RouteConfig;
+export type Generator = Schmock.Generator;
+export type GeneratorFunction = Schmock.GeneratorFunction;
+export type CallableMockInstance = Schmock.CallableMockInstance;
+export type Plugin = Schmock.Plugin;
+export type PluginContext = Schmock.PluginContext;
+export type PluginResult = Schmock.PluginResult;
+export type StaticData = Schmock.StaticData;
+export type RequestRecord = Schmock.RequestRecord;
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACxC,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,MAAM,GACN,KAAK,GACL,QAAQ,GACR,OAAO,GACP,MAAM,GACN,SAAS,CAAC;AAEd;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,OAAO,CACL,OAAO,EAAE,aAAa,EACtB,QAAQ,CAAC,EAAE,OAAO,GACjB,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,OAAO,CAAC,CACN,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,aAAa,GAEpB,KAAK,GACL,cAAc,GACd,SAAS,GACT,OAAO,CAAC,KAAK,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,sBAAsB;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,KAAK,EAAE,WAAW,CAAC;IACnB,kBAAkB;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,mBAAmB;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,oDAAoD;IACpD,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5B,2BAA2B;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,OAAO,EAAE,cAAc,KACpB,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,OAAO,EAAE,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kBAAkB;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,0CAA0C;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GACtB,YAAY,GACZ,CAAC,MAAM,EAAE,YAAY,CAAC,GACtB,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;;;;OAcG;IACH,CACE,KAAK,EAAE,QAAQ,EACf,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,WAAW,GACnB,oBAAoB,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,oBAAoB,CAAC;IAE3C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,MAAM,EAAE,UAAU,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC,CAAC;CACtB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;AAC5C,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AACxC,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAChD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;AACpD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;AACpD,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AACxC,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAChD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;AAC9C,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;AAC1C,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;AAChE,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACpC,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;AAClD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAChD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;AAC5C,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC"}

package/dist/types.js

@@ -1 +1,2 @@
+/// <reference path="../../../types/schmock.d.ts" />
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@schmock/core",
   "description": "Core functionality for Schmock",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/src/builder.test.ts

@@ -271,9 +271,9 @@ describe("schmock callable API", () => {
       const mock = schmock();
       mock("GET /users", [{ id: 1, name: "John" }], {}).pipe({
         name: "test-plugin",
-        process: (ctx, response) => ({
+        process: (ctx, pluginResponse) => ({
           context: ctx,
-          response: { data: response, processed: true },
+          response: { data: pluginResponse, processed: true },
         }),
       });