Skip to content

Latest commit

 

History

History
968 lines (733 loc) · 30.3 KB

CHANGELOG.md

File metadata and controls

968 lines (733 loc) · 30.3 KB

v19.1.0

  • Added - Added _group in param. Helps to filter data list by group.
  • Fixed - Route param filter issue.
  • Updated - README.md

v19.0.0

  • Modified - Optimized code.
  • Added - Added .json5 and .jsonc file support.
  • Added - JSDoc

v18.1.1

  • Fixed - Home Page sample db route issue.
  • Updated - Readme file.

v18.1.0

  • Added - /_db?_config=true - Gives you only db route configs without any mock or fetch data.
  • Fixed - sample server.js throws error on file change issue fixed.
  • modified - optimized the CRUD operations on the route.

v18.0.1

  • Added - mock-server --init - Generates sample server files
  • Added - cosmiconfig package which helps get use config file in different names. Now we can use .mockserverrc<.js|.cjs|.json>, .mock-serverrc<.js|.cjs|.json>, mockserver.config<.js|.cjs|.json> or mock-server.config<.js|.cjs|.json> as a config file name.
  • Added - withHelperWrappers method to wrap user middlewares with helper middlewares.
  • Added - eslint and prettier for code standardizations.
  • Fixed - test case issues.

v17.1.0

  • Fixed - Crud Operation and Search Operation issue fixed.

v17.0.1

  • Fixed - Api not returning response by given param id issue fixed.

v17.0.0

  • Removed - expose of _CrudOperation and _AdvancedSearch middlewares and removed and added implicitly. Now all of our routes can have the CRUD operations and Advanced Search
  • Modified - Only express.static() method is used as app.use() and all other routes with directUse: true is used using app.all().
  • Modified - Now in createExpressApp and launchServer method an additional param is added where we can pass our own express app (express()) as an optional param the sets to the mockServer app instance.

v16.1.0

  • Fixed - Restarting server on file change event takes long time issue fixed.
  • Fixed - On Calling next method in direct use of a middleware sends empty object issue fixed.
  • Modified - CLI optimized.

v16.0.0

  • Added - Support for .cjs file extension. When package.json has a type module then provide a .cjs file extension path to require a javascript file.
  • Added - dbMode: "config". If dbMode is config then it expects always a config object to a route and setting _config: true is an optional attribute when dbMode is in config.
    • For Example: If dbMode is config then in db.json
    const db = {
  '/user': { mock: { id: 1, user: 'foo' } }, // -> "/user": { _config: true, "mock": { "id": 1, "user": "foo" } }
  '/users': [
    { id: 1, user: 'foo' },
    { id: 2, user: 'bar' },
  ], // -> "/user": { _config: true, "mock": { } }.
  '/auth': (req, res, next) => {
    next();
  }, // -> This route directly uses the middleware without any helper middleware wrappers.
};
  • Removed - Edit, Refresh, Reset etc.. Action buttons for a direct use route in a Home Page.
  • Fixed - Calling next middleware sends Page not found issue resolved.
  • Code optimized.

v15.1.0

  • Fixed - Transfer Encoding header issue fixed.

v15.0.0

  • Updated - axios node package to version 1.3.2.
  • Added - noCache in Mock Server CLI options.
  • Added - locals.statusCode - Directly set any statuscode to locals using middleware.
  • Added - locals.headers - Directly set any response headers to locals using middleware.
  • Added - Editing Headers, Fetch Headers, Fetch StatusCode in Mock Server Homepage.
  • Fixed - Checkbox in Home page Modal not setting to false value issue fixed.

v14.2.0

  • Fixed - Cache Control header issue fixed.

v14.1.1

  • Fixed - Types issue fixes

v14.1.0

  • Fixed - response is delayed issue fixed by adding Transfer-Encoding: chunked in response headers.
  • Fixed - _IterateResponse middleware not working issue fixed.
  • Added - On Ctrl+Click or Cmd+Click the link in home page will open the link in new tab.
  • Added - noCache option to config. Default to true. Set to false to enable cache.
  • Added - /:id params will to added to route if the the route has a _AdvancedSearch or _CrudOperation middleware and don't have ends with a param.

v14.0.1

  • Fixed - setConfig not merging new config with existing config object if merge option is set to true issue fixed
  • Fixed - mockServer.defaults not merging new config with existing config object issue fixed
  • Added - Error logs are added if an invalid path is specified

v14.0.0

  • Added - homePage in config. Set to false to disable Mock Server Homepage.
  • Fixed - Fetching image response getting as a image tag string instead of blob.
  • Fixed - Giving Enter in search textbox in Mock Server Homepage keeps on loading the page.
  • Added - Shows number of routes hosted in a server after starting the server.
  • Removed - Hi text in terminal if quiet flag is set to true.

v13.1.0

  • Added - Type for CLI options.

v13.0.3

  • set process.env.NODE_ENV to test to remove all console logs.
  • Fixed - If already a server is running at a same port cli throws error twice issue fixed.

v13.0.2

  • Fixed - Parse Error: Content-Length can't be present with Transfer-Encoding.

v13.0.1

  • Build issue fix.

v13.0.0

  • Supported JSON with comments.
  • Added bootstrap css and js file inbuilt for Homepage stylings.
  • code structural changes.

v12.2.1

  • Readme update.

v12.2.0

  • CLI breaking for an invalid path issue fixed.

v12.1.0

  • import other useful node packages as follows

    const {
  MockServer,
  express, // express
  lodash, // lodash
  nanoid, // nanoid
  spinner, // ora
  pathToRegexp, // path-to-regexp
  chalk, // chalk
  axios, // axios
  watcher, // chokidar.
} = require('@r35007/mock-server');

  • renamed mockserver.setExpressApp() to mockserver.createExpressApp()

  • fixed - MockServer.Destroy() resets server config to default config which makes us to recreate the mockServer using MockServer.Create() method. Now we don't want to recreate MockServer instance after destroy. MockServer.Destroy() destroys the express server and resets all the data to defaults except server config.

v12.0.0

  • added node packages in MockServer instance

    • MockServer._ - lodash.
    • MockServer.axios - axios.
    • MockServer.express - express.
    • MockServer.chalk - chalk.
    • MockServer.watcher - chokidar.
    • MockServer.pathToRegexp - pathToRegexp.
    • MockServer.nanoid - nanoid.
    • MockServer.ora - ora

  • added setter methods to reset to defaults

    • mockserver.setDefaults() - sets default db, injectors, middlewares, store, rewriters, config
    • mockserver.setDefaultData() - sets default injectors, middlewares, store, config
    • mockserver.setDefaultDb() - sets default db
    • mockserver.setDefaultInjectors() - sets default injectors
    • mockserver.setDefaultMiddlewares() - sets default middlewares
    • mockserver.setDefaultRewriters() - sets default rewriters
    • mockserver.setDefaultStore() - sets default store
    • mockserver.setDefaultConfig() - sets default config

  • added more methods

    • mockserver.clearServerAddress() - sets current port, address, listeningTo, server to undefined
    • mockserver.setExpressApp() - create a new express app to the MockServer instance.

v11.2.0

  • added - log in CLI param and Config - Helps to added setter logs in console.
  • added - reply as alias for send in create router config method
const resources = mockServer.resources();
resources.create('/post').send({ name: 'foo', id: 1 });
resources.create('/comment').reply({ name: 'foo', id: 1 }); // reply is alias for send
app.use(resources.router);

v11.1.0

  • added - headers in routeConfigs. Now we can add custom response headers in routeConfig For Example: db.json 
    {
  "/route": {
    "_config": true,
    "mock": "My Response",
    "headers": { "Content-Type": "test/plain" }
  }
}
  • added - send(), status(), headers() in mockServer.resources().create() method. For Example: 
    const resources = mockServer.resources();
resources.create('/new/route/1').send('My Response').status(200).done();
resources
  .create('/new/route/2')
  .send('https://jsonplaceholder.typicode.com/posts') //  will set to `mock` or `fetch` based on dbMode
  .headers({ 'Content-Type': 'application/json' })
  .headers('Content-Length', 123)
  .done();
app.use(resources.router);

v11.0.0

  • renamed - _globals to globals in middlewares.

  • removed - mockServer.setDb method. Use mockServer.rewriters to set rewriters.

  • removed - mockServer.setRewriters method. Use mockServer.resources to set Db.

  • updated - mockServer.resources will now return { create, router}.

  • updated - res.locals.getDb accepts a routePath as a param. Type:

    getDb(routePath?: string | string[]): ValidTypes.RouteConfig | ValidTypes.Db;

  • added - mockServer.resources().create. Helps to create new route with config and mocks. For Example: server.js

    const resources = mockServer.resources();

resources
  .create('/new/route', (req, res, next) => {
    next();
  })
  .mock('My Response')
  .delay(2000)
  .done();

app.use(resources.router);

v10.3.3

  • Bug Fixes and code improvements

v10.3.2

  • CLI Snapshot not working issue fixed

v10.3.1

  • CLI file watcher fix

v10.3.0

  • CLI --config fix

v10.2.0

  • CLI improved. Please give mock-server --help in terminal for help
  • renamed - config.rootPath to config.root.
  • renamed - config.staticDir to config.static.
  • renamed - ignoreMiddlewareWrappers to directUse.
  • added - config.quiet to suppress console logs. The error logs will still show.

v10.1.0

  • fixed - CLI not working issue fixed.
  • improved Mock Server CLI.
  • added - --quite to prevent from printing messages through the console.
  • removed - --sample.

v10.0.0

  • reduced - Build size.

  • removed - createSampleFiles from utils.

  • renamed - config.root to config.rootPath.

  • added - bootstrap package for HomePage ui.

  • renamed - /_reset/db/:id? to /_reset/:id?.

  • added - /_routes in HomePage - Gives list of routes used by Mock Server.

  • updated - Following type in utility methods

    requireFile(
  directoryPath: string,
  { exclude, recursive, isList, onlyIndex }?: { exclude?: string[]; recursive?: boolean; isList?: boolean; onlyIndex?: boolean; }
);

getFilesList(
  directoryPath: string,
  { exclude, recursive, onlyIndex }?: { exclude?: string[]; recursive?: boolean; onlyIndex?: boolean;}
):PathDetails[];

requireData(
  data?: any,
  { rootPath, isList, onlyIndex, recursive, exclude, }?: { exclude?: string[]; rootPath?: string; isList?: boolean; onlyIndex?: boolean; recursive?: boolean;}
);

v9.2.2

  • Build Fix

v9.2.1

  • Build Fix

v9.2.0

  • added - log in options - If true it logs the details.
  • removed - mockServer in options from launchServer, resources and all Setters.
  • fixed - passing a method to set data requires a instance of the mockserver explicitly - Fixed
  • added - terminal spinners.
  • added - prefixed method in utils. Helps to add route prefix for all the all the routes in the given Db.

v9.1.0

  • revoked - mockServer.rewriterwont't setrewriters`. - Now It will set to the global rewriters
  • update - config.host - Set to empty string to set the host as your Local Ip Address.

v9.0.1

  • If methods passed as a param not working - Fixed.
  • Update - mockServer.default wont't set config.
  • Update - mockServer.rewriter wont't set rewriters.
  • Always use only Setter methods to set any data.

v9.0.0

  • Renamed - _getDb(), _getStore to getDb(), getStore().
  • Added- Now it automatically picks the index.js file from the given folder path instead of getting all the files from the folder.
  • Added- Now we can give a method as a param to set any config, rewriter, injectors, store, sb etc... For example: db.js
const { MockServer } = require('@r35007/mock-server');
module.exports = (mockServer) => {
  if (mockServer) {
    // This can be undefined If you don't pass the mockServer instance.
  }
  return {
    // Your Db here
    '/post': { id: 1, name: 'foo' },
  };
};

const mockServer = MockServer.Create();
const resources = mockServer.resource(db, { mockServer });
mockServer.app.use(resources);

Note: For now it cant handle async methods.

  • Updated following method params.
// launchServer sets all the resource data. It sets db, injectors, middlewares, store, rewriters, middlewares.
launchServer(db?: ParamTypes.Db, { injectors, middlewares, store, rewriters, router }?: LaunchServerOptions): Promise<Server | undefined>;
// Resources sets only db and it will not set injectors, middlewares or any other options provided. This db will be added to the existing db.
resources(db?: ParamTypes.Db, { injectors, middlewares, mockServer, reverse, rootPath, dbMode, router }?: ResourceOptions): express.Router;

// Setters
setData(data?: SetData, options?: SetterOptions): void;
setConfig(config?: Params.Config, { rootPath, merge, mockServer }?: SetterOptions): void;
setRewriters(rewriters?: Params.Rewriters, { rootPath, merge, mockServer }?: SetterOptions): void;
setMiddlewares(middleware?: Params.Middlewares, { rootPath, merge, mockServer }?: SetterOptions): void;
setInjectors(injectors?: Params.Injectors, { rootPath, merge, mockServer }?: SetterOptions): void;
setStore(store?: Params.Store, { rootPath, merge, mockServer }?: SetterOptions): void;
setDb(db?: Params.Db, { injectors, rootPath, reverse, dbMode, merge, mockServer }?: SetterOptions): void;

// Validators
getValidConfig(config?: ParamTypes.Config | undefined, { rootPath, mockServer }?: SetterOptions): ValidTypes.Config;
getValidMiddlewares(middlewares?: ParamTypes.Middlewares | undefined, { rootPath, mockServer }?: SetterOptions): ValidTypes.Middlewares;
getValidInjectors(injectors?: ParamTypes.Injectors | undefined, { rootPath, mockServer }?: SetterOptions): ValidTypes.Injectors;
getValidStore(store?: ParamTypes.Store | undefined, { rootPath, mockServer }?: SetterOptions): ValidTypes.Store;
getValidRewriters(rewriters?: ParamTypes.Rewriters | undefined, { rootPath, mockServer }?: SetterOptions): ValidTypes.Rewriters;
getValidDb(data?: ParamTypes.Db | undefined, { mockServer, injectors, rootPath, reverse, dbMode }?: SetterOptions): ValidTypes.Db;

v8.0.1

  • removed unwanted console logs.

v8.0.0

  • added merge param in all setters. If true it merges the data with the existing. For Example:

    mockServer.setDb({ user:{ id: 1, name: "foo" } });
mockServer.setDb({ post:{ id: 1, name: "bar" } }); // replaces the previous one
mockServer.setDb({ comment:{ id: 1, comment: "I am Happy !" } }, true); // adds to the previous one

mockServer.db
{
  "/post":{_config: true, mock: { id: 1, name:"bar" } }
  "/comment":{_config: true, mock: { id: 1, comment: "I am Happy !" } }
}

  • renamed defaultRoutes to homePage. Now we can use mockServer.homePage which returns the hoePage router.

  • removed - mockServer.router

  • removed - mockServer.addDb instead use mockServer.resource

  • update - mockServer.resources will always return the new router and if repeated it will add the resource to the existing resources. For Example:

    const user = mockServer.resources({ user:{ id: 1, name: "foo" } }); // creates user resource
mockServer.app.use(user);
const post = mockServer.resources({ post:{ id: 1, name: "bar" } }); // creates post resource. this resource will be added in db with the existing resources.
mockServer.app.use(post);

mockServer.db
{
  "/user":{_config: true, mock: { id: 1, name:"foo" } }
  "/post":{_config: true, mock: { id: 1, name:"bar" } }
}

  • updated config.staticDir - It uses ./public directory as the default static host directory. Set it to empty string to avoid hosting static dir.

v7.3.0

  • renamed mode to dbMode in config.

  • added multi dbMode in config.

    dbMode :

    • multi - Only direct sting value sets to fetch attribute. All other direct values will be set to - mock attribute.
    • fetch - All other direct values will be set to fetch attribute.
    • mock - All other direct values will be set to mock attribute.

  • Fetch not showing any error on a invalid file path - Fixed

v7.2.1

  • rewriters not working - Fixed

v7.2.0

  • added mockServer.port - Gives the current running port. This will be undefined if server is stopped.

  • added mockServer.address - Gives the current running server ip address. This will be undefined if server is stopped.

  • Set Port to 0(zero) to pick a dynamic available port

  • Now we can do default import Example of imports :

    const { MockServer } = require('@r35007/mock-server');
const MockServer = require('@r35007/mock-server').default;

import MockServer from '@r35007/mock-server';
import { MockServer } from '@r35007/mock-server';

v7.1.0

  • added cookieParser in config and defaults. Enables the cookie parser. Click here for more details

v7.0.1

  • toBase64 - method throws error on invalid route - Fixed

v7.0.0

  • added ignoreMiddleWrappers in routeConfig. If a direct method is set to route, then it wont be wrapped by helper middlewares and so no other route config would work except the given middleware if provided.
  • added mockServer.listeningTo - give the homepage path only if the server is running.
  • updated sample db.json to db.js

v6.1.0

  • Implemented mode in config. This helps to define on what attribute does the direct route value to be set. For Example:

    • If mode is mock by default

      const db = {
  route1: 'My Response',
  route2: { _config: true, fetch: './path/to/fetch/data' },
};

// The above db will be transformed to
const validDb = getValidDb(db, './', { mode: 'mock' });
console.log(validDb);
/* 
{ 
  "/route1":{ _config: true, mock: "My Response" },
  "/route2":{ _config: true, fetch: "./path/to/fetch/data" } ,
}
*/

    • If mode is fetch

      // Note: If the mode is `fetch` then the direct route value will be set to fetch attribute in the routeConfig

const db = {
  route1: './path/to/fetch/data',
  route2: { _config: true, mock: 'My Response' },
};

// The above db will be transformed to
const validDb = getValidDb(db, './', { mode: 'fetch' });
console.log(validDb);
/* 
{ 
  "/route1":{ _config: true, fetch: "./path/to/fetch/data" } ,
  "/route2":{ _config: true, mock: "My Response" },
}
*/

  • Now we can give middleware directly to the route. For Example:

    const db = {
  route1: (req, res) => {
    res.send('My Response');
  },
};

// The above db will be transformed to
const validDb = getValidDb(db);
console.log(validDb);
/*
{
  "/route1":{
    _config: true,
    middlewares: [(req, res) => { res.send("My Response") }]
  }
}
*/

v6.0.5

  • Renamed addDbData to addDb
  • Home page ui improvements

v6.0.4

  • Implemented Dark and Light mode in Homepage.
  • Added page loader in Homepage.
  • Performance improvement.
  • Added editing Fetch Data Response in homepage.
  • removed resetting store

v6.0.3

  • Performance improvement.
  • Homepage ui improvements.
  • Removed editing Fetch Data Response in homepage.

v6.0.2

  • Now getValidDb can't transform HAR to db instead we need to use extractDbFromHAR method explicitly fom utils.
  • Added extractDbFromKibana method in utils which helps to extract db from Kibana response.

v6.0.1

  • Bug fix in cleanDb method.

v6.0.0

  • Bug Fixes
  • Added _Fetch, _FetchUrl, _FetchFile middlewares.
  • Now injectors comes as a second pram in both launchServer and resource since db is dependant on injectors.
  • In setDb method we cannot pass the injectors and reverse option to set the db. both injectors and reverse are used from internal values. So please make sure you use setInjectors first before setting the db.
  • All the validators are moved in to utils. Now instead of mockServer.getValidDb please import validator methods from @r35007/mock-server/dist/server/utils/validators
  • getValidDb params has been changed to the following
const getValidDb: (
  data?: ParamTypes.Db | undefined,
  injectors?: UserTypes.Injectors,
  rootPath?: string,
  { reverse, _harEntryCallback, _harDbCallback }?: GetValidDbOptions
) => ValidTypes.Db;
  • Introduced more types. Example
// Types that you get in mockServer.data or from validator methods
import * as ValidTypes from '@r35007/mock-server/dist/server/types/valid.types';
// Types that you can give to the methods and apis
import * as UserTypes from '@r35007/mock-server/dist/server/types/user.types';
// Other Common Types
import * as CommonTypes from '@r35007/mock-server/dist/server/types/common.types';
// Types that you can give to give to the methods and apis. mostly combination of string and UserTypes
import * as ParamTypes from '@r35007/mock-server/dist/server/types/param.types';

// Example
const config: UserTypes.Config = { port: 4000 };
const validConfig: ValidTypes.Config = getValidConfig(config); // gives you a valid config type
  • middlewareNames is removed. Now we can give both middleware method and middleware reference name in middlewares. Example db.json
const db = {
  user: {
    _config: true,
    mock: [1,2,3,4,5]
    middlewares: [
      (req, res, next) => {
        console.log(req.path);
        next()
      },
      "_IterateResponse"
    ]
  }
}

v5.0.1

  • Readme update

v5.0.0

  • Added more Test cases ans stabilized this version with more minor bug fixes
  • UserConfig, UserMiddleware, UserDb, UserInjectors, UserStore, UserRewriters types are removed
    • Instead we can use Partial<Config>, Db, Middlewares, Injectors, Store, Rewriters
  • Now we can also provide a .js path to any of the data for db, injectors, config, rewriters, store, middlewares
  • Now we can get the response time from a response headers of x-response-time in milliseconds
  • The middlewares that are need to be used as a global middleware before start of all middlewares can be given as _globals : [...your middlewares] in middleware.js file
  • Now injectors accepts only list as follows
[
  {
    "routes": ["/injectors/1", "/injectors/2"],
    "override": true,
    "mock": "This data is injected using the injectors by matching the pattern '/injectors/1', '/injectors/1'."
  },
  {
    "routes": ["/(.*)"],
    "override": true,
    "middlewareNames": ["...", "CustomLog"]
  }
]

v4.5.1

  • Now we can access config and req variable on a fetch url. Example : 
    {
  "/posts/:id?": {
    "_config": true,
    "fetch": "http://jsonplaceholder.typicode.com${req.url}" // will become http://jsonplaceholder.typicode.com/posts/1
  },
  "/comments/:id?": {
    "_config": true,
    "fetch": "http://jsonplaceholder.typicode.com/comments/${req.params.id}" // will become http://jsonplaceholder.typicode.com/comments/:id
  },
  "/pageNotFound": {
    "_config": true,
    "fetch": "http://${config.host}:${config.port}/404"
  }
}
    • Inject any global middleware at the start of the express app by exporting globals in the middleware.js file. Example : 
      /* 
  Global Middlewares
  These middlewares will be added to start of the the express app 
*/
exports.globals = [
  (req, res, next) => {
    console.log(req.path);
  },
];

v4.4.2

  • getJSON can now able to fetch mock data from .js file. Make sure you do module.exports the mock object

v4.4.0

  • mockFirst is added to RouteConfig
  • Home Page update Bug Fixed.

v4.3.1

  • Enabled resource url edit in Home Page.
  • removed fetchError attribute in routeConfig.
  • _CrudOperation bug fixed.
  • If any fetch error the isError flag is set to true in fetchData.
  • Sample Files are updated with more examples.

v4.3.0

  • Rewriters list, ui issue in Home page resolved.
  • Set exact flag to true in injectors to exactly match the route.
  • Sample files are updated with new data.
  • Attribute middlewares is renamed to middlewareNames.
  • Storing Fetch data bug fixed.
  • Now we can get image from image url as an img tag.
  • Now injectors can be given in both the ways as shown below.

way 1:

{
  "/(.*)": {
    "fetchCount": 2
  },
  // Again we cannot give the same route match over here by this structure.
  "/(.*)": {
    "override": true,
    "statusCode": 200
  }
}

way 2:

[
  {
    "routeToMatch": "/(.*)",
    "fetchCount": 2
  },
  {
    "routeToMatch": "/(.*)",
    "override": true,
    "statusCode": 200
  }
]

v4.2.0

  • added server.js in samples
  • removed id attribute in db snapshot.

v4.1.2

  • added isSnapshot options in getValidDb method.
  • Bug Fix

v4.1.0

  • Injectors not applied properly- Bug Fixed.
  • added Create method which returns the single instance of the MockServer.
  • added Destroy method which stops the server and clears the instance of the MockServer.

v4.0.0

  • Improved CLI.
  • --snapshot flag in CLI will create a snapshot of db in a .json file
  • --watch will automatically restarts the db on changes.
  • --sample - creates a sample db.json, middleware.json, injectors.json, rewrites.json files
  • Code refactoring
  • Set _config to true to set any route config like delay, statusCode etc...

v3.0.9

  • Home Page Bug Fix
  • Implemented Home Page Screen inside the VS Code

v3.0.8

  • Bug Fix
  • Ui update in Home Page
  • Implemented Route Config Clone in Home page

v3.0.7

  • Bug Fix
  • Readme Update

v3.0.0

  • generateMockFromHAR - removed. instead use getValidRoutes method
  • specific method handler is removed in routeConfigs
  • implemented defaults methods with some options like compression, readOnly, staticDir etc..
  • Bug Fix
  • Code refactoring and organized
  • Middleware Utils are added and renamed
  • Added Url rewrites
  • Advanced Search operation is added in CRUD Operation middleware
  • Sample Routes Data is updated
  • many options are added to CLI
  • Now can able to modify routeConfig and add new routes using the new Home Page.

v2.4.2

  • drag handle has been provided in homepage to resize the routes view an data view.

v2.4.1

  • Now has ability to render image and other files as a response in homepage
  • Download option is given near the redirect link in homepage.
  • renamed transformHar to generateMockFromHAR
  • Ui improvements
  • finalCallback in generateMockFromHAR now has the harData as the first param
  type generateMockFromHAR = (
    harData?: HAR | string,
    config?: TransformHARConfig,
    entryCallback?: (
      entry: object,
      routePath: string,
      routeConfig: RouteConfig,
      pathToRegexp: pathToRegexp
    ) => Routes,
    finalCallback?: (
      harData: any
      generatedMock: Routes,
      pathToRegexp: pathToRegexp
    ) => any
  ) => Routes;
  • The finalCallback will always be called even if it went to catch block if anything went wrong.
  • CLI default routes is changed from https://jsonplaceholder.typicode.com/db to http://jsonplaceholder.typicode.com/db

v2.3.1

  • transformHar bug fix

v2.3.0

  • Bug Fix
  • added CLI Usage with options.
  • excludeRoutes(routes, routesToExclude) - returns routes with unExcluded routes.
  • transformHar now has excludedRoutes in a config. This helps to excluded routes while generating mock from HAR.
  type transformHar = (
    harData?: HAR | string,
    config?: TransformHARConfig,
    ...
  ) => Routes;

  export type TransformHARConfig = {
    routesToLoop?: string[];
    routesToGroup?: string[];
    routeRewrite?: KeyValString;
    excludeRoutes?: string[];
  }

v2.2.2

  • Readme update

v2.2.0

  • added
    • methods in routeConfig. Now we can set a route to a specific methods.
    • mockServer.getRewrittenRoutes(routes, routeRewrite) - returns routes with rewritten route path.
    • mockServer.getRouteMatchList(routeToMatch, routes) - returns list of matched routes to the given pattern
    • transformHar method with additional options. pathToRegexp - gives the methods available in path-to-regexp npm package
    type transformHar = (
  harData?: HAR | string,
  config?: {
    routesToLoop?: string[];
    routesToGroup?: string[];
    routeRewrite?: KeyValString;
  },
  entryCallback?: (entry: object, routePath: string, routeConfig: RouteConfig, pathToRegexp: pathToRegexp) => Routes,
  finalCallback?: (generatedMock: Routes, pathToRegexp: pathToRegexp) => Routes
) => Routes;

v2.1.1

  • Bug Fix

v2.1.0

  • removed
    • res.locals.store.get
    • res.locals.store.set
    • res.locals.store.clear
    • res.locals.store.remove
  • added
    • res.locals.store - now you can directly assign values to store.
    • Dynamic routConfig - Now the routeConfigs are mutable - means you can change the routeConfig inside a middleware using res.locals.routeConfig
    • fetchOnce - predefined middleware. Helps to get fetchData only once and returns the existing fetchData for every other api hit.

v2.0.7,v2.0.8,v2.0.9,v2.0.10

  • Bug Fix.
  • Now we can also send empty string as a response.

v2.0.6

  • added res.locals.store.remove("") && res.locals.store.clear()
  • Bug fix.

v2.0.3,v2.0.4,v2.0.5

  • Bug fix.

v2.0.1,v2.0.2

  • Readme Update.

v2.0.0

Welcome to v2.0. There are many major changes and bug fix has been done. Please follow the list below

  • renamed
    • config.proxy to config.pathRewrite
    • middleware params is reset to express middleware params. ex : log = (req, res, next) => {next()};
  • removed
    • initialMock, alternateMock are removed and introduced fetch
    • globals, data, locals params are removed in middleware method.
  • added
    • fetch in routeConfig. Helps to fetch data from Url.
    • mockFirst in routeConfig. If true, it send you the mock data first. If mock not available then try to fetch the data from fetch url. By default its false.
    • res.locals.store.get(key?) and res.locals.store.store(key, value) - Helps to store the and share the values between routes inside a middleware.
    • transformHar method now accepts config of { routesToLoop?: string[], routesToGroup?: string[] } as a second param. It helps to set loop and group mock as per the routes provided.

v1.0.3

  • bug fix

v1.0.2

  • added statusCode to entryCallBack in transformHar

v1.0.1

  • transformHar Bug fix.
  • added finalCallBack to transformHar(harData, entryCallBack, finalCallBack)

v1.0.0

  • initial release