cozy-client 45.0.1 → 45.1.0

package/dist/CozyClient.js

@@ -2703,7 +2703,7 @@ var CozyClient = /*#__PURE__*/function () {
 CozyClient.hooks = CozyClient.hooks || {};
 CozyClient.fetchPolicies = _policies.default; //COZY_CLIENT_VERSION_PACKAGE in replaced by babel. See babel config
 
-CozyClient.version = "45.0.1";
+CozyClient.version = "45.1.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/mock.js

@@ -5,14 +5,20 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createMockClient = void 0;
+exports.createFakeClient = exports.createMockClient = void 0;
 
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 
+var _merge = _interopRequireDefault(require("lodash/merge"));
+
 var _CozyClient = _interopRequireDefault(require("./CozyClient"));
 
 var _store = require("./store");
@@ -45,23 +51,48 @@ var fillQueryInsideClient = function fillQueryInsideClient(client, queryName, qu
 };
 
 var mockedQueryFromMockedRemoteData = function mockedQueryFromMockedRemoteData(remoteData) {
-  return function (qdef) {
-    if (!remoteData) {
-      return {
-        data: null
-      };
-    }
-
-    if (remoteData[qdef.doctype]) {
-      return {
-        data: remoteData[qdef.doctype]
-      };
-    } else {
-      return {
-        data: []
-      };
-    }
-  };
+  return /*#__PURE__*/function () {
+    var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(qdef) {
+      return _regenerator.default.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              if (remoteData) {
+                _context.next = 2;
+                break;
+              }
+
+              return _context.abrupt("return", {
+                data: null
+              });
+
+            case 2:
+              if (!remoteData[qdef.doctype]) {
+                _context.next = 6;
+                break;
+              }
+
+              return _context.abrupt("return", {
+                data: remoteData[qdef.doctype]
+              });
+
+            case 6:
+              return _context.abrupt("return", {
+                data: []
+              });
+
+            case 7:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
 };
 /**
  * Creates a client suitable for use in tests
@@ -73,14 +104,59 @@ var mockedQueryFromMockedRemoteData = function mockedQueryFromMockedRemoteData(r
  * @param  {object} [options.queries] Prefill queries inside the store
  * @param  {object} [options.remote] Mock data from the server
  * @param  {object} [options.clientOptions] Options passed to the client
+ * @param  {object} [options.clientFunctions] Functions to overide client functions
  * @returns {CozyClient}
  */
 
 
-var createMockClient = function createMockClient(_ref) {
-  var queries = _ref.queries,
-      remote = _ref.remote,
-      clientOptions = _ref.clientOptions;
+var createMockClient = function createMockClient() {
+  var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+      queries = _ref2.queries,
+      remote = _ref2.remote,
+      clientOptions = _ref2.clientOptions,
+      clientFunctions = _ref2.clientFunctions;
+
+  var mockedQuery = jest.fn().mockImplementation(mockedQueryFromMockedRemoteData(remote));
+  var clientFunctionsMerge = (0, _merge.default)({
+    query: mockedQuery,
+    save: jest.fn(),
+    saveAll: jest.fn(),
+    stackClient: {
+      fetchJSON: jest.fn()
+    }
+  }, clientFunctions);
+  return createFakeClient({
+    queries: queries,
+    remote: remote,
+    clientOptions: clientOptions,
+    clientFunctions: clientFunctionsMerge
+  });
+};
+/**
+ * Creates a client with pre-filled store
+ * This can be useful for demo in documentation (e.g. storybook)
+ *
+ * - client.{query,save} are replaced with empty functions
+ * - client.stackClient.fetchJSON is replaced with empty functions
+ *
+ * @param  {object} options Options
+ * @param  {object} [options.queries] Prefill queries inside the store
+ * @param  {object} [options.remote] Mock data from the server
+ * @param  {object} [options.clientOptions] Options passed to the client
+ * @param  {object} [options.clientFunctions] Functions to overide client functions useful for testing
+ * @returns {CozyClient}
+ */
+
+
+exports.createMockClient = createMockClient;
+
+var createFakeClient = function createFakeClient() {
+  var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+      queries = _ref3.queries,
+      remote = _ref3.remote,
+      clientOptions = _ref3.clientOptions,
+      clientFunctions = _ref3.clientFunctions;
+
   var client = new _CozyClient.default(clientOptions || {});
   client.ensureStore();
 
@@ -92,11 +168,9 @@ var createMockClient = function createMockClient(_ref) {
     fillQueryInsideClient(client, queryName, queryOptions);
   }
 
-  client.query = jest.fn().mockImplementation(mockedQueryFromMockedRemoteData(remote));
-  client.save = jest.fn();
-  client.saveAll = jest.fn();
-  client.stackClient.fetchJSON = jest.fn();
+  client.query = mockedQueryFromMockedRemoteData(remote);
+  (0, _merge.default)(client, clientFunctions);
   return client;
 };
 
-exports.createMockClient = createMockClient;
+exports.createFakeClient = createFakeClient;

package/dist/mock.spec.js

@@ -1,15 +1,15 @@
-import { createMockClient } from './mock'
+import { createFakeClient, createMockClient } from './mock'
 
 import { Q } from 'cozy-client'
 
-describe('createMockClient', () => {
+describe('createFakeClient', () => {
   const simpsonsFixture = [
     { _id: 'homer', name: 'Homer' },
     { _id: 'marge', name: 'Marge' }
   ]
 
   it('should mock queries inside the store', () => {
-    const client = createMockClient({
+    const client = createFakeClient({
       queries: {
         simpsons: {
           data: simpsonsFixture,
@@ -34,7 +34,7 @@ describe('createMockClient', () => {
   })
 
   it('should mock query with data passed in "remote" option', async () => {
-    const client = createMockClient({
+    const client = createFakeClient({
       remote: {
         'io.cozy.simpsons': simpsonsFixture
       }
@@ -44,7 +44,7 @@ describe('createMockClient', () => {
   })
 
   it('should mock query even if the doctype has not been mocked', async () => {
-    const client = createMockClient({
+    const client = createFakeClient({
       remote: {
         'io.cozy.simpsons': simpsonsFixture
       }
@@ -52,4 +52,31 @@ describe('createMockClient', () => {
     const simpsons = await client.query(Q('io.cozy.adams'))
     await expect(simpsons.data.map(x => x._id)).toEqual([])
   })
+
+  it('should mock function with clientFunctions', async () => {
+    const client = createFakeClient({
+      clientFunctions: {
+        stackClient: {
+          fetchJSON: () =>
+            Promise.resolve({ data: [{ _id: 'homer', name: 'Homer' }] })
+        }
+      }
+    })
+
+    const simpsons = await client.stackClient.fetchJSON('io.cozy.simpsons')
+    expect(simpsons.data).toEqual([{ _id: 'homer', name: 'Homer' }])
+  })
+
+  describe('createMockClient', () => {
+    it('should mock basic client functions', async () => {
+      const client = createMockClient()
+
+      expect(JSON.stringify(client.query)).toEqual(JSON.stringify(jest.fn()))
+      expect(JSON.stringify(client.save)).toEqual(JSON.stringify(jest.fn()))
+      expect(JSON.stringify(client.saveAll)).toEqual(JSON.stringify(jest.fn()))
+      expect(JSON.stringify(client.stackClient.fetchJSON)).toEqual(
+        JSON.stringify(jest.fn())
+      )
+    })
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "45.0.1",
+  "version": "45.1.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -75,5 +75,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "ece1e7dd986a3d7f6bca32ce8749837b8953fea5"
+  "gitHead": "383cfd5460d7bd48de61f135d9972c019bfc2f83"
 }

package/types/mock.d.ts

@@ -8,11 +8,33 @@
  * @param  {object} [options.queries] Prefill queries inside the store
  * @param  {object} [options.remote] Mock data from the server
  * @param  {object} [options.clientOptions] Options passed to the client
+ * @param  {object} [options.clientFunctions] Functions to overide client functions
  * @returns {CozyClient}
  */
-export function createMockClient({ queries, remote, clientOptions }: {
+export function createMockClient({ queries, remote, clientOptions, clientFunctions }?: {
     queries: object;
     remote: object;
     clientOptions: object;
+    clientFunctions: object;
+}): CozyClient;
+/**
+ * Creates a client with pre-filled store
+ * This can be useful for demo in documentation (e.g. storybook)
+ *
+ * - client.{query,save} are replaced with empty functions
+ * - client.stackClient.fetchJSON is replaced with empty functions
+ *
+ * @param  {object} options Options
+ * @param  {object} [options.queries] Prefill queries inside the store
+ * @param  {object} [options.remote] Mock data from the server
+ * @param  {object} [options.clientOptions] Options passed to the client
+ * @param  {object} [options.clientFunctions] Functions to overide client functions useful for testing
+ * @returns {CozyClient}
+ */
+export function createFakeClient({ queries, remote, clientOptions, clientFunctions }?: {
+    queries: object;
+    remote: object;
+    clientOptions: object;
+    clientFunctions: object;
 }): CozyClient;
 import CozyClient from "./CozyClient";