npmpackage.info

stubsy

A mock server that ships with a UI to allow configuration during runtime.

1.3.4

TypeScript

544.89 kB

Installations

npm install stubsy

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.18.0

NPM Version

10.8.2 Pull Requests

Open

5

Total

29

Closed

5

Merged

19

Issues

Open

2

Total

9

Closed

7

Releases

v1.2.4

Published on 15 Mar 2022

v1.2.3

Published on 11 Jan 2022

v1.2.2

Published on 05 Jan 2022

v1.2.1

Published on 29 Jun 2021

v1.2.0

Published on 23 Jun 2021

v1.1.0

Published on 05 Jun 2021

View all 7 releases

Contributors

View all 3 contributors

Languages

TypeScript

JavaScript

HTML

Shell

TypeScript (95.87%)

JavaScript (3.26%)

HTML (0.57%)

Shell (0.3%)

Developer

MkMan

Download Statistics

Total Downloads

18,615

Last Day

Last Week

Last Month

Last Year

365

GitHub Statistics

4 Stars

88 Commits

1 Forks

3 Watching

6 Branches

3 Contributors

Maintainers

Package Meta Information

Latest Version

1.3.4

Package Id

stubsy@1.3.4

Unpacked Size

544.89 kB

Size

153.52 kB

File Count

NPM Version

10.8.2

Node Version

20.18.0

Publised On

19 Oct 2024

Total Downloads

Cumulative downloads

Total Downloads

18,615

Last day

Compared to previous day

Last week

Compared to previous week

Last month

-86.9%

Compared to previous month

Last year

-96.8%

365

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Stubsy

Installation
Usage
- Definitions
- API
- Example

Stubsy is a Node server built using Express. Its main goal is to allow developers to easily set up the server but more importantly change its behaviour after launch. This can be useful to test how the UI behaves when an endpoint's response is 404 instead 200 for example.

Stubsy ships with a UI to show the set up of the server and allow changing endpoint's behaviour.

animated demo of Stubsy

Installation

1npm install --save-dev stubsy

Usage

Definitions

Endpoint

An Endpoint is REST endpoint, that is set up with a default behaviour. An endpoint's behaviour is defined as follows.

1type EndpointBehaviour = {
2  path: string; // the route at which the endpoint is accessed
3  responseBody: unknown;
4  status: number;
5  type: 'get' | 'post' | 'put' | 'delete' | 'patch';
6  delay?: number;
7};

Note: the path field can be any valid Express path.

Override

An Override is an overriding behaviour for an Endpoint to alter its response. The override behaviour is defined as follows. The path and type of the endpoint cannot be changed in an Override.

1type OverrideBehaviour = {
2  responseBody: unknown;
3  status: number;
4  delay?: number;
5};

API

`new Stubsy(portNumber)`

Creates an instance of Stubsy.

portNumber <Number>: the port for the server to run on

`stubsy.app`

The underlying Express app. Use this instance variable to add more endpoints if needed and to start the server.

`stubsy.registerEndpoint(endpointId, endpointBehaviour)`

Registers endpoints to be accessed on the server.

endpointId <String> required: a unique identifier for the endpoint
endpointBehaviour <EndpointBehaviour> required: the endpoint's behaviour

`stubsy.registerOverride(endpointId, overrideId, overrideBehaviour)`

Registers override behaviour for a previously defined endpoint.

endpointId <String> required: the id of the endpoint to register an override for
overrideId <String> required: a unique identifier for the override
overrideBehaviour <OverrideBehaviour> required: the override's behaviour

`stubsy.activateOverride(endpointId, overrideId)`

Activates the specified override on the endpoint.

endpointId <String> required: the id of the endpoint to activate the override on
overrideId <String>: the id of the override to activate. If omitted restores the override to the default behaviour.

`stubsy.start()` Deprecated

Starts the server on the port number specified.

Example

1// server.js
2import { Stubsy } from 'stubsy';
3
4const stubsyPortNumber = 3000;
5const stubsy = new Stubsy();
6
7stubsy.registerEndpoint('films', {
8  path: '/films',
9  status: 200,
10  type: 'get',
11  responseBody: [{ title: 'Inception' }, { title: 'Tenet' }],
12});
13
14stubsy.registerOverride('films', 'error', { status: 404, responseBody: {} });
15stubsy.registerOverride('films', 'outage', { status: 500, responseBody: {} });
16
17stubsy.activateOverride('films', 'outage');
18
19stubsy.app.listen(stubsyPortNumber);

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

8

SAST

Determines if the project uses static code analysis.

5

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/main.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/MkMan/stubsy/main.yml/main?enable=pin
Warn: downloadThenRun not pinned by hash: .github/workflows/main.yml:66
Warn: downloadThenRun not pinned by hash: .github/workflows/main.yml:68
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 0 out of 2 downloadThenRun dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.6

/10

Last Scanned on 2024-12-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

stubsy

Installations

Developer Guide

Yes

CommonJS

20.18.0

10.8.2

Pull Requests

5

29

5

19

Issues

2

9

7

Releases

Contributors

Languages

Developer

MkMan

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

18,615

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Stubsy

Installation

Usage

Definitions

Endpoint

Override

API

new Stubsy(portNumber)

stubsy.app

stubsy.registerEndpoint(endpointId, endpointBehaviour)

stubsy.registerOverride(endpointId, overrideId, overrideBehaviour)

stubsy.activateOverride(endpointId, overrideId)

stubsy.start() Deprecated

Example

10

10

10

8

5

0

0

0

0

0

0

0

0

0

3.6

/10

`new Stubsy(portNumber)`

`stubsy.app`

`stubsy.registerEndpoint(endpointId, endpointBehaviour)`

`stubsy.registerOverride(endpointId, overrideId, overrideBehaviour)`

`stubsy.activateOverride(endpointId, overrideId)`

`stubsy.start()` Deprecated