Merge pull request #2 from mocks-server/v2.0.0

Project migration. Update data-provider

Author: javierbrea

CHANGELOG.md

@@ -10,6 +10,13 @@ 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

README.md

@@ -5,18 +5,24 @@
 [![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
 
@@ -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

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "@mocks-server/admin-api-client",
-  "version": "1.0.3",
-  "description": "Client of @mocks-server/plugin-admin-api",
+  "name": "@mocks-server/admin-api-client-data-provider",
+  "version": "2.0.0",
+  "description": "Client of @mocks-server/plugin-admin-api built with @data-provider",
   "keywords": [
     "mocks-server-plugin",
     "administration",
@@ -12,7 +12,7 @@
   ],
   "author": "Javier Brea",
   "license": "MIT",
-  "repository": "https://github.com/mocks-server/admin-api-client",
+  "repository": "https://github.com/mocks-server/admin-api-client-data-provider",
   "homepage": "https://www.mocks-server.org",
   "publishConfig": {
     "access": "public"
@@ -37,15 +37,16 @@
     "test:ci": "npm run build && npm run test:coverage && npm run test:e2e:ci"
   },
   "peerDependencies": {
-    "@data-provider/core": "^1.7.0"
+    "@data-provider/axios": "^2.0.0"
   },
   "dependencies": {
-    "@data-provider/axios": "1.6.1",
     "@mocks-server/admin-api-paths": "1.0.4"
   },
   "devDependencies": {
     "@babel/preset-env": "7.8.4",
-    "@data-provider/core": "1.8.0",
+    "redux": "4.0.5",
+    "@data-provider/core": "2.0.0-alpha.6",
+    "@data-provider/axios": "2.0.0-alpha.2",
     "@rollup/plugin-commonjs": "11.0.1",
     "@rollup/plugin-node-resolve": "7.0.0",
     "babel-eslint": "10.0.3",

package.json

@@ -43,7 +43,7 @@ module.exports = [
     output: {
       file: "dist/index.umd.js",
       format: "umd",
-      name: "mocksServerAdminApiClient",
+      name: "mocksServerAdminApiClientDataProvider",
       globals: GLOBALS
     },
     plugins: [...BASE_PLUGINS, uglifier.uglify()]

rollup.config.js

@@ -1,6 +1,6 @@
 sonar.organization=mocks-server
-sonar.projectKey=mocks-server-admin-api-client
-sonar.projectVersion=1.0.3
+sonar.projectKey=mocks-server-admin-api-client-data-provider
+sonar.projectVersion=2.0.0
 
 sonar.javascript.file.suffixes=.js
 sonar.sourceEncoding=UTF-8

sonar-project.properties

@@ -1,4 +1,4 @@
-import { instances } from "@data-provider/core";
+import { providers } from "@data-provider/core";
 import { DEFAULT_BASE_PATH } from "@mocks-server/admin-api-paths";
 import TAG from "./tag";
 
@@ -13,7 +13,7 @@ export const config = options => {
     ...options
   };
 
-  instances.getByTag(TAG).config({
+  providers.getByTag(TAG).config({
     baseUrl: `${finalOptions.baseUrl}${finalOptions.apiPath}`
   });
 };