feat: rename methods

Author: javierbrea

CHANGELOG.md

@@ -11,7 +11,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 ### Breaking change
 
-## [3.0.0-beta.1] - 2021-01-15
+## [3.0.0-beta.2] - 2021-02-16
+
+### Changed
+- chore(deps): Update depedencies. Adapt tests
+- feat: Rename `apiPath` config property into `adminApiPath`
+- feat: Rename `readMockCustomRoutesVariants` method into `readCustomRoutesVariants`
+- feat: Rename `addMockCustomRouteVariant` method into `useRouteVariant`
+- feat: Rename `restoreMockRoutesVariants` method into `restoreRoutesVariants`
+
+## [3.0.0-beta.1] - 2021-02-15
 
 ### Added
 - feat: Expose one different method for each action.

README.md

@@ -63,9 +63,9 @@ example();
 * `readRoute(id)` - Returns data of a specific route.
 * `readRoutesVariants()` - Returns available routes variants.
 * `readRouteVariant(id)` - Returns data of a specific route variant.
-* `readMockCustomRoutesVariants()` - Returns current routes variants manually added to current mock.
-* `addMockCustomRouteVariant(id)` - Add a route variant to current mock.
-* `restoreMockRoutesVariants()` - Restore current mock original routes variants.
+* `readCustomRoutesVariants()` - Returns current routes variants manually added to current mock.
+* `useRouteVariant(id)` - Sets a specific route variant to be used by current mock.
+* `restoreRoutesVariants()` - Restore routes variants to those defined in current mock.
 
 ##### Legacy methods
 
@@ -78,13 +78,13 @@ example();
 
 By default, the client is configured to request to `http://localhost:3100/admin`, based in the [default options of Mocks Server](https://www.mocks-server.org/docs/configuration-options)
 
-You can change both the base url of Mocks Server, and the base api path of the Admin API plugin using the `config` method:
+You can change both the base url of Mocks Server, and the path of the [Admin API plugin][plugin-admin-api-url] using the `config` method:
 
 ```js
 import { config } from "@mocks-server/admin-api-client";
 
 config({
-  apiPath: "/foo-admin",
+  adminApiPath: "/foo-admin",
   baseUrl: "http://my-mocks-server:3000"
 });
 ```

mocks/package-lock.json

@@ -7,6 +7,6 @@
     "mocks:ci": "mocks-server --no-cli"
   },
   "devDependencies": {
-    "@mocks-server/main": "2.0.0-beta.1"
+    "@mocks-server/main": "2.0.0-beta.2"
   }
 }

mocks/package.json

@@ -15,7 +15,7 @@ import {
 } from "@mocks-server/admin-api-paths";
 
 const DEFAULT_OPTIONS = {
-  apiPath: DEFAULT_BASE_PATH,
+  adminApiPath: DEFAULT_BASE_PATH,
   baseUrl: "http://localhost:3100",
 };
 
@@ -46,7 +46,7 @@ class Fetcher {
   }
 
   get url() {
-    return `${configuration.baseUrl}${configuration.apiPath}${this._url}${this._id}`;
+    return `${configuration.baseUrl}${configuration.adminApiPath}${this._url}${this._id}`;
   }
 
   _read() {

src/entities.js

@@ -60,17 +60,17 @@ export function readRouteVariant(id) {
   return routeVariant(id).read();
 }
 
-export function readMockCustomRoutesVariants() {
+export function readCustomRoutesVariants() {
   return mockCustomRoutesVariants.read();
 }
 
-export function addMockCustomRouteVariant(id) {
+export function useRouteVariant(id) {
   return mockCustomRoutesVariants.create({
     id,
   });
 }
 
-export function restoreMockRoutesVariants() {
+export function restoreRoutesVariants() {
   return mockCustomRoutesVariants.delete();
 }
 

src/methods.js

@@ -12,9 +12,9 @@ import {
   readRoute,
   readRoutesVariants,
   readRouteVariant,
-  readMockCustomRoutesVariants,
-  addMockCustomRouteVariant,
-  restoreMockRoutesVariants,
+  readCustomRoutesVariants,
+  useRouteVariant,
+  restoreRoutesVariants,
   // legacy
   readBehaviors,
   readBehavior,
@@ -182,16 +182,31 @@ describe("react-admin-client methods used with node", () => {
     it("should return mocks", async () => {
       const mocks = await readMocks();
       expect(mocks).toEqual([
-        { id: "base", routesVariants: ["get-user:1"] },
-        { id: "user2", routesVariants: ["get-user:2"] },
+        {
+          id: "base",
+          from: null,
+          routesVariants: ["get-user:1"],
+          appliedRoutesVariants: ["get-user:1"],
+        },
+        {
+          id: "user2",
+          from: null,
+          routesVariants: ["get-user:2"],
+          appliedRoutesVariants: ["get-user:2"],
+        },
       ]);
     });
   });
 
   describe("when reading mock", () => {
     it("should return mock data", async () => {
       const mock = await readMock("base");
-      expect(mock).toEqual({ id: "base", routesVariants: ["get-user:1"] });
+      expect(mock).toEqual({
+        id: "base",
+        from: null,
+        routesVariants: ["get-user:1"],
+        appliedRoutesVariants: ["get-user:1"],
+      });
     });
   });
 
@@ -201,6 +216,7 @@ describe("react-admin-client methods used with node", () => {
       expect(data).toEqual([
         {
           id: "get-user",
+          delay: null,
           url: "/api/user",
           method: "GET",
           variants: ["get-user:1", "get-user:2"],
@@ -209,11 +225,12 @@ describe("react-admin-client methods used with node", () => {
     });
   });
 
-  describe("when reading mock", () => {
-    it("should return mock data", async () => {
+  describe("when reading route", () => {
+    it("should return route data", async () => {
       const mock = await readRoute("get-user");
       expect(mock).toEqual({
         id: "get-user",
+        delay: null,
         url: "/api/user",
         method: "GET",
         variants: ["get-user:1", "get-user:2"],
@@ -258,26 +275,26 @@ describe("react-admin-client methods used with node", () => {
 
   describe("mock custom route variants", () => {
     it("should be empty", async () => {
-      const data = await readMockCustomRoutesVariants();
+      const data = await readCustomRoutesVariants();
       expect(data).toEqual([]);
     });
 
     it("should be able to add one", async () => {
-      await addMockCustomRouteVariant("get-user:2");
-      const data = await readMockCustomRoutesVariants();
+      await useRouteVariant("get-user:2");
+      const data = await readCustomRoutesVariants();
       expect(data).toEqual(["get-user:2"]);
     });
 
     it("should reject if route variant don't exist", async () => {
       expect.assertions(1);
-      await addMockCustomRouteVariant("foo").catch((err) => {
+      await useRouteVariant("foo").catch((err) => {
         expect(err.message).toEqual('Route variant with id "foo" was not found');
       });
     });
 
     it("should be empty after restoring them to the mock defaults", async () => {
-      await restoreMockRoutesVariants();
-      const data = await readMockCustomRoutesVariants();
+      await restoreRoutesVariants();
+      const data = await readCustomRoutesVariants();
       expect(data).toEqual([]);
     });
   });