mockoon / commons

Mockoon's commons library. Used in Mockoon desktop application and CLI.

📦This repository has been archived. You will find Mockoon's new monorepo here.

@Mockoon/commons

Mockoon's Commons library regroups Mockoon's shared code used in the main application and the CLI. It contains mostly typings and is designed to be used in both the browser and Node.js environments.

---

Support/feedback

You can discuss all things related to Mockoon, and ask for help, on the main application community or the CLI community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our Discord server.

Contributing

If you are interested in contributing to Mockoon, please take a look at the main contributing guidelines and the ones specific to this repository.

Please also take a look at our Code of Conduct.

Documentation

You will find Mockoon's documentation on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.

Roadmap

If you want to know what will be coming in the next release you can check the global Roadmap.

New releases will be announced on Mockoon's Twitter account @GetMockoon and through the newsletter to which you can subscribe here.

commons's Issues

Make Joi schemas stricts

Is your feature request related to a problem? Please describe.
When adding new props to the schemas (in ./constants folder: Environment, Route, etc.), the Joi schema validator do not show any error as the property is missing.

Describe the solution you'd like
Make all Joi schema stricts using TS generics.

Add new `concat` helper

See mockoon/mockoon#391

Add new `setVar` helper

Is your feature request related to a problem? Please describe.
Synchronizing templating helpers ({{faker ...}}) is not possible yet and quite complicated to achieve.

Describe the solution you'd like
One alternative could be to create a var or setVar helper that allows to create a local variable that can be reused later.
Like {{setVar 'newUUID' (faker 'random.uuid')}}.
To be used later as {{vars 'newUUID'}}.
We should avoid setting a var to be used like this: {{newUUID}} as it could override existing variables or helpers with the same name.

Automate NPM publication

Rule interpreter fails when comparing against a null body value

Describe the bug
Rule interpreter fails when comparing against a null body value

To Reproduce
Create a rule: Body | propertyName | value
Call with following body:

{"propertyName": null}

Expected behavior
Shouldn't have a null pointer

Extract commons classes and utils to be shared with the CLI

Following items need to be extracted:

• types
• templating helpers
• most of server.service
• some utils
• expressjs middlewares

Improve `MockoonResponse` typings

Is your feature request related to a problem? Please describe.
Usage of type alias for MockoonServer in https://github.com/mockoon/commons/blob/main/src/models/server.model.ts#L16 break the typing in mockoon/cli and mockoon/mockoon.

Describe the solution you'd like
Replace MockoonServer type alias by a regular object built in logRequest commons server method, containing all the required properties used in app and CLI (body, bodyJSON, etc).

Add Server constructor param to use a different logger in http-proxy-middleware

Add ESlint

Is your feature request related to a problem? Please describe.
We should add a linter.

Describe the solution you'd like
TSlint is deprecated, so we should add ESlint.
Maybe migrate mockoon/mockoon tslint config: https://code.visualstudio.com/api/advanced-topics/tslint-eslint-migration

Run linting in CI

Is your feature request related to a problem? Please describe.
We have no linting

Describe the solution you'd like
Lint should be run in the CI