API Packages

MockMaster is composed of five packages, each serving a specific purpose in the mocking ecosystem.

Package Overview

@mockmaster/core

Path matching & HTTP routing engine

npm install @mockmaster/core

Use for:

Path matching with parameters
Wildcard routing
Parameter extraction
HTTP routing utilities

@mockmaster/data

Factories & Faker.js integration

npm install @mockmaster/data

Use for:

Generating realistic test data
Building objects with factories
Faker.js integration
Sequence generation

@mockmaster/openapi

OpenAPI parsing & mock generation

npm install @mockmaster/openapi

Use for:

Parsing OpenAPI 3.0 specs (JSON & YAML)
Generating mock data from schemas
Extracting operations
Schema validation

@mockmaster/msw-adapter

Record & replay engine

npm install @mockmaster/msw-adapter

Use for:

Creating scenarios and recordings
Replay handlers
Request matching
Response generation

@mockmaster/cli

File system operations & CLI tools

npm install @mockmaster/cli

Use for:

Reading/writing scenarios to disk
Generating scenarios from OpenAPI specs
Scenario management
File system utilities

Installation

Install All Packages

npm install @mockmaster/core @mockmaster/data @mockmaster/openapi @mockmaster/msw-adapter @mockmaster/cli

Install Individual Packages

Install only what you need:

# Just core routing
npm install @mockmaster/core
 
# Add data generation
npm install @mockmaster/core @mockmaster/data
 
# Full OpenAPI support
npm install @mockmaster/core @mockmaster/data @mockmaster/openapi
 
# Complete setup
npm install @mockmaster/core @mockmaster/data @mockmaster/openapi @mockmaster/msw-adapter @mockmaster/cli

Package Dependencies

@mockmaster/cli
├── @mockmaster/openapi
│   ├── @mockmaster/data
│   │   └── @mockmaster/core
│   └── @mockmaster/msw-adapter
│       └── @mockmaster/core

Dependency Notes

@mockmaster/core - No dependencies (base package)
@mockmaster/data - Depends on @mockmaster/core
@mockmaster/openapi - Depends on @mockmaster/data and @mockmaster/msw-adapter
@mockmaster/msw-adapter - Depends on @mockmaster/core
@mockmaster/cli - Depends on @mockmaster/openapi and @mockmaster/msw-adapter

Quick Reference

Common Imports

// Path matching
import { matchPath, extractParams, createMatcher } from '@mockmaster/core'
 
// Data generation
import { defineFactory, build, buildList, fake } from '@mockmaster/data'
 
// OpenAPI
import { parseSpec, parseYaml, generateFromSchema, getAllOperations } from '@mockmaster/openapi'
 
// Record & Replay
import { createScenario, createRecording, addRecordingToScenario, createReplayHandler } from '@mockmaster/msw-adapter'
 
// File operations
import { writeScenario, readScenario, generateScenariosFromSpec } from '@mockmaster/cli'

Package Documentation

Explore detailed documentation for each package:

@mockmaster/core - Path matching and routing
@mockmaster/data - Data factories and generation
@mockmaster/openapi - OpenAPI integration
@mockmaster/msw-adapter - Record and replay
@mockmaster/cli - CLI tools and file operations

TypeScript Support

All packages are written in TypeScript and include type definitions:

import type { Scenario, Recording, ReplayHandler } from '@mockmaster/msw-adapter'
import type { Factory, FactoryDefinition } from '@mockmaster/data'
import type { OpenAPISpec, SchemaObject } from '@mockmaster/openapi'

Version Compatibility

All packages are version-locked for compatibility. Always install matching versions:

{
  "dependencies": {
    "@mockmaster/core": "^2.0.0",
    "@mockmaster/data": "^2.0.0",
    "@mockmaster/openapi": "^2.0.0",
    "@mockmaster/msw-adapter": "^2.0.0",
    "@mockmaster/cli": "^2.0.0"
  }
}

Path Matching @mockmaster/core