Merge pull request #118 from mocks-server/release

Release v3.0.0

Author: javierbrea

.eslintrc.json

@@ -4,7 +4,7 @@
     "node": true
   },
   "parserOptions": { 
-    "ecmaVersion": "2018",
+    "ecmaVersion": 2018,
     "sourceType": "module"
   },
   "plugins": ["prettier"],
@@ -16,6 +16,7 @@
         "parser": "flow"
       }
     ],
+    "no-shadow": "error",
     "no-undef": "error",
     "no-unused-vars": ["error", { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }]
   },

.github/workflows/build.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ["12.19.0", "14.15.0", "15.2.0"]
+        node: ["12.22.1", "14.17.0", "15.14.0", "16.1.0"]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -19,7 +19,7 @@ jobs:
         run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF##*/})"
         id: extract-branch
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
       - name: Cache node modules
@@ -64,10 +64,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Download test results
         uses: actions/download-artifact@v2
         with:
-          name: coverage-15.2.0
+          name: coverage-16.1.0
           path: coverage
       - name: Coveralls
         uses: coverallsapp/github-action@master

.github/workflows/check-package-version.yml

@@ -11,7 +11,7 @@ jobs:
         uses: actions/checkout@v2
       - name: Get NPM version is new
         id: check
-        uses: EndBug/version-check@v1.6.0
+        uses: EndBug/version-check@v2.0.1
         with:
           diff-search: true
           file-name: ./package.json

.github/workflows/publish-to-github.yml

@@ -9,9 +9,9 @@ jobs:
     - uses: actions/checkout@v2
     - run: npm ci
     - run: npm run build
-    - uses: actions/setup-node@v1
+    - uses: actions/setup-node@v2
       with:
-        node-version: '12.x'
+        node-version: '14.x'
         registry-url: 'https://npm.pkg.github.com'
         # Defaults to the user or organization that owns the workflow file
         scope: '@mocks-server'

.github/workflows/publish-to-npm.yml

@@ -7,9 +7,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/setup-node@v1
+    - uses: actions/setup-node@v2
       with:
-        node-version: '12.x'
+        node-version: '14.x'
         registry-url: 'https://registry.npmjs.org/'
     - run: npm ci
     - run: npm run build

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint-staged

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "sonarlint.connectedMode.project": {
+      "connectionId": "mocks-server",
+      "projectKey": "mocks-server_admin-api-client-data-provider"
+  }
+}

CHANGELOG.md

@@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 ### Fixed
 ### Removed
+### BREAKING CHANGES
+
+## [3.0.0] - 2021-05-25
+
+### Added
+- feat: Support node 16
+- feat: Add client methods for Mocks Server v2 API
+
+### Changed
+- chore(deps): Update devDependencies
+
+### BREAKING CHANGES
+- chore(deps): Update to data-provider v3
+- chore(deps): Update to mocks-server v2
 
 ## [2.1.0] - 2020-12-26
 

README.md

@@ -32,33 +32,49 @@ const example = async () => {
   console.log("Current mocks-server settings are", currentSettings);
 
   await settings.update({
-    behavior: "user-super-admin",
+    mock: "user-super-admin",
     delay: 1000
   });
-  console.log("Behavior and delay changed");
+  console.log("Mock and delay changed");
 };
 
 example();
 ```
 
 ## Usage with data-provider
 
-Exported properties `about`, `settings`, `behaviors`, `behaviorsModel`, `fixtures` and `fixturesModel` are [`@data-provider/axios`](https://github.com/data-provider/axios) providers, so can be used to define @data-provider Selectors. Methods can also be connected to frameworks using another `data-provider` packages, such as [`@data-provider/react`](https://github.com/data-provider/react).
+Exported properties `about`, `settings`, `mocks`, `mocksModel`, `routes`, `routesModel`, `routesVariants` and `routesVariantsModel` are [`@data-provider/axios`](https://github.com/data-provider/axios) providers, so can be used to define @data-provider Selectors. Methods can also be connected to frameworks using another `data-provider` packages, such as [`@data-provider/react`](https://github.com/data-provider/react).
 
 ## Api
 
 * `about.read()` - Returns info about `mocks-server/plugin-admin-api`, such as current version.
 * `settings.read()` - Returns current `mocks-server` settings.
 * `settings.update(settingsObject)` - Updates `mocks-server` settings. A settings object has to be provided. Read the [`mocks-server` configuration documentation](https://www.mocks-server.org/docs/configuration-options) for further info.
+* `alerts.read()` - Returns collection of current alerts.
+* `alert(id).read()` - Returns a specific alert.
+* `alertsModel.queries.byId(id).read()` - Returns a specific alert.
+* `mocks.read()` - Returns collection of available mocks.
+* `mock(mockId).read()` - Returns a specific mock.
+* `mocksModel.queries.byId(mockId).read()` - Returns a specific mock.
+* `routes.read()` - Returns collection of available routes.
+* `route(id).read()` - Returns a specific route.
+* `routes.queries.byId(id).read()` - Returns an specific route.
+* `routesVariants.read()` - Returns collection of available routes variants.
+* `routeVariant(id).read()` - Returns a specific route variant.
+* `routesVariants.queries.byId(id).read()` - Returns an specific route variant.
+* `customRouteVariants.read()` - Returns collection of current custom route variants.
+* `customRouteVariants.create(id)` - Sets a specific route variant to be used by current mock.
+* `customRouteVariants.delete()` - Restore routes variants to those defined in current mock.
+
+### Legacy methods
+Next methods correspond to Mocks Server legacy methods
+
 * `behaviors.read()` - Returns collection of available behaviors.
-* `behavior(behaviorName).read()` - Returns an specific behavior.
-* `behaviorsModel.queries.byName(behaviorName).read()` - Returns an specific behavior.
+* `behavior(behaviorName).read()` - Returns a specific behavior.
+* `behaviorsModel.queries.byName(behaviorName).read()` - Returns a specific behavior.
 * `fixtures.read()` - Returns collection of available fixtures.
-* `fixture(id).read()` - Returns an specific fixture.
-* `fixturesModel.queries.byId(id).read()` - Returns an specific fixture.
-* `alerts.read()` - Returns collection of current alerts.
-* `alert(id).read()` - Returns an specific alert.
-* `alertsModel.queries.byId(id).read()` - Returns an specific alert.
+* `fixture(id).read()` - Returns a specific fixture.
+* `fixturesModel.queries.byId(id).read()` - Returns a specific fixture.
 
 ## Configuration
 
@@ -94,7 +110,7 @@ Please read the [contributing guidelines](.github/CONTRIBUTING.md) and [code of
 [npm-downloads-url]: https://www.npmjs.com/package/@mocks-server/admin-api-client-data-provider
 [npm-dependencies-image]: https://img.shields.io/david/mocks-server/admin-api-client-data-provider.svg
 [npm-dependencies-url]: https://david-dm.org/mocks-server/admin-api-client-data-provider
-[quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=mocks-server-admin-api-client-data-provider&metric=alert_status
-[quality-gate-url]: https://sonarcloud.io/dashboard?id=mocks-server-admin-api-client-data-provider
+[quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=mocks-server_admin-api-client-data-provider&metric=alert_status
+[quality-gate-url]: https://sonarcloud.io/dashboard?id=mocks-server_admin-api-client-data-provider
 [release-image]: https://img.shields.io/github/release-date/mocks-server/admin-api-client-data-provider.svg
 [release-url]: https://github.com/mocks-server/admin-api-client-data-provider/releases