Merge pull request #3 from mocks-server/release

Release

Author: javierbrea

.travis.yml

@@ -1,36 +1,2 @@
-language: node_js
-
-node_js:
-  - 10.8
-
-cache:
-  directories:
-    - ~/.npm
-    - ~/.cache
-    - ~/.sonar/cache
-
-addons:
-  apt:
-    packages:
-      - libgconf-2-4
-  sonarcloud:
-    organization: "mocks-server"
-    branch:
-      name: "$TRAVIS_CURRENT_BRANCH"
-
-script:
-  - npm run lint
-  - npm run test
-  - npm run build
-  - npm run test:e2e:ci
-  - npm run coveralls
-  - 'if [ -n "$SONAR_TOKEN" ]; then sonar-scanner -Dsonar.login=${SONAR_TOKEN}; fi'
-
-deploy:
-  provider: npm
-  email: "[email protected]"
-  api_key: "$NPM_TOKEN"
-  edge: true
-  on:
-    tags: true
-  skip_cleanup: true
+version: ~> 1.0
+import: mocks-server/ci-cd:.travis-build-deploy.yml@master

CHANGELOG.md

@@ -10,6 +10,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 ### Removed
 
+## [2.0.0] - 2020-03-01
+### Changed
+- chore: Project migrated from @mocks-server/admin-api-client
+- chore(deps): [BREAKING CHANGE] Updated @data-provider/core to v2. Not compatible with projects using v1.
+- chore(deps): [BREAKING CHANGE] Moved @data-provider/axios dependency to peer-dependencies.
+- chore(umd): [BREAKING CHANGE] Renamed umd global variable to "mocksServerAdminApiClientDataProvider"
+
+## [1.0.3] - 2020-01-26
+### Changed
+- Update dependencies
+
 ## [1.0.2] - 2020-01-12
 ### Changed
 - Update dependencies

README.md

@@ -1,22 +1,28 @@
 [![Build status][travisci-image]][travisci-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Quality Gate][quality-gate-image]][quality-gate-url]
 
-[![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Greenkeeper badge](https://badges.greenkeeper.io/mocks-server/admin-api-client.svg)](https://greenkeeper.io/) [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url] 
+[![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url] 
 
 [![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url]
 
 
-# Mocks-server administration api client
+# Mocks-server administration api client built with @data-provider
 
 This package contains methods for administrating the mocks-server _(through the [@mocks-server/plugin-admin-api](https://github.com/mocks-server/plugin-admin-api) RESTful API)_.
 
-Built using [@data-provider](https://github.com/data-provider), it can be used in Node.js, browsers, and is also compatible with @data-provider connectors, such as [@data-provider/connector-react](https://github.com/data-provider/connector-react), so can be easily integrated with frameworks.
+Built using [@data-provider](https://github.com/data-provider), it can be used in Node.js, browsers, and it is also compatible with other @data-provider packages, such as [@data-provider/react](https://github.com/data-provider/react), so can be easily integrated with frameworks.
+
+## Installation
+
+```bash
+npm i --save redux @data-provider/core @data-provider/axios @mocks-server/admin-api-client-data-provider
+```
 
 ## Usage with promises
 
 All methods described in the [Api](#api) (expect the `config` method) return Promises when executed:
 
 ```js
-import { about, settings } from "@mocks-server/admin-api-client";
+import { about, settings } from "@mocks-server/admin-api-client-data-provider";
 
 const example = async () => {
   const { version } = await about.read();
@@ -37,7 +43,7 @@ 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 @data-provider connectors, such as [@data-provider/connector-react](https://github.com/data-provider/connector-react).
+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).
 
 ## Api
 
@@ -46,10 +52,10 @@ Exported properties `about`, `settings`, `behaviors`, `behaviorsModel`, `fixture
 * `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.
 * `behaviors.read()` - Returns collection of available behaviors.
 * `behavior(behaviorName).read()` - Returns an specific behavior.
-* `behaviorsModel.byName(behaviorName).read()` - Returns an specific behavior.
+* `behaviorsModel.queries.byName(behaviorName).read()` - Returns an specific behavior.
 * `fixtures.read()` - Returns collection of available fixtures.
 * `fixture(fixtureId).read()` - Returns an specific fixture.
-* `fixturesModel.byId(fixtureId).read()` - Returns an specific fixture.
+* `fixturesModel.queries.byId(fixtureId).read()` - Returns an specific fixture.
 
 ## Configuration
 
@@ -58,7 +64,7 @@ By default, the client is configured to request to http://localhost:3100/admin,
 You can change both the base url of the "@mocks-server", and the base api path of the "@mocks-server/plugin-admin-api" using the `config` method:
 
 ```js
-import { config } from "@mocks-server/admin-api-client";
+import { config } from "@mocks-server/admin-api-client-data-provider";
 
 config({
   apiPath: "/foo-admin",
@@ -73,19 +79,19 @@ Please read the [contributing guidelines](.github/CONTRIBUTING.md) and [code of
 
 [plugin-admin-api-url]: https://github.com/mocks-server/plugin-admin-api
 
-[coveralls-image]: https://coveralls.io/repos/github/mocks-server/admin-api-client/badge.svg
-[coveralls-url]: https://coveralls.io/github/mocks-server/admin-api-client
-[travisci-image]: https://travis-ci.com/mocks-server/admin-api-client.svg?branch=master
-[travisci-url]: https://travis-ci.com/mocks-server/admin-api-client
-[last-commit-image]: https://img.shields.io/github/last-commit/mocks-server/admin-api-client.svg
-[last-commit-url]: https://github.com/mocks-server/admin-api-client/commits
-[license-image]: https://img.shields.io/npm/l/@mocks-server/admin-api-client.svg
-[license-url]: https://github.com/mocks-server/admin-api-client/blob/master/LICENSE
-[npm-downloads-image]: https://img.shields.io/npm/dm/@mocks-server/admin-api-client.svg
-[npm-downloads-url]: https://www.npmjs.com/package/@mocks-server/admin-api-client
-[npm-dependencies-image]: https://img.shields.io/david/mocks-server/admin-api-client.svg
-[npm-dependencies-url]: https://david-dm.org/mocks-server/admin-api-client
-[quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=mocks-server-admin-api-client&metric=alert_status
-[quality-gate-url]: https://sonarcloud.io/dashboard?id=mocks-server-admin-api-client
-[release-image]: https://img.shields.io/github/release-date/mocks-server/admin-api-client.svg
-[release-url]: https://github.com/mocks-server/admin-api-client/releases
+[coveralls-image]: https://coveralls.io/repos/github/mocks-server/admin-api-client-data-provider/badge.svg
+[coveralls-url]: https://coveralls.io/github/mocks-server/admin-api-client-data-provider
+[travisci-image]: https://travis-ci.com/mocks-server/admin-api-client-data-provider.svg?branch=master
+[travisci-url]: https://travis-ci.com/mocks-server/admin-api-client-data-provider
+[last-commit-image]: https://img.shields.io/github/last-commit/mocks-server/admin-api-client-data-provider.svg
+[last-commit-url]: https://github.com/mocks-server/admin-api-client-data-provider/commits
+[license-image]: https://img.shields.io/npm/l/@mocks-server/admin-api-client-data-provider.svg
+[license-url]: https://github.com/mocks-server/admin-api-client-data-provider/blob/master/LICENSE
+[npm-downloads-image]: https://img.shields.io/npm/dm/@mocks-server/admin-api-client-data-provider.svg
+[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
+[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