cozy-client 60.28.2 → 60.29.0

package/dist/CozyClient.js

@@ -3126,7 +3126,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 = "60.28.2";
+CozyClient.version = "60.29.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/index.js

@@ -12,6 +12,7 @@ var _exportNames = {
   StackLink: true,
   WebFlagshipLink: true,
   DataProxyLink: true,
+  resolveForceLink: true,
   compose: true,
   QueryDefinition: true,
   Q: true,
@@ -94,6 +95,12 @@ Object.defineProperty(exports, "DataProxyLink", {
     return _DataProxyLink.default;
   }
 });
+Object.defineProperty(exports, "resolveForceLink", {
+  enumerable: true,
+  get: function get() {
+    return _forceLink.resolveForceLink;
+  }
+});
 Object.defineProperty(exports, "compose", {
   enumerable: true,
   get: function get() {
@@ -400,6 +407,8 @@ var _WebFlagshipLink = _interopRequireDefault(require("./links/WebFlagshipLink")
 
 var _DataProxyLink = _interopRequireDefault(require("./links/DataProxyLink"));
 
+var _forceLink = require("./links/forceLink");
+
 var _flow = _interopRequireDefault(require("lodash/flow"));
 
 var _dsl = require("./queries/dsl");

package/dist/index.node.js

@@ -40,7 +40,8 @@ var _exportNames = {
   models: true,
   fetchPolicies: true,
   webPerformanceApi: true,
-  defaultPerformanceApi: true
+  defaultPerformanceApi: true,
+  resolveForceLink: true
 };
 Object.defineProperty(exports, "default", {
   enumerable: true,
@@ -234,6 +235,12 @@ Object.defineProperty(exports, "defaultPerformanceApi", {
     return _defaultPerformanceApi.defaultPerformanceApi;
   }
 });
+Object.defineProperty(exports, "resolveForceLink", {
+  enumerable: true,
+  get: function get() {
+    return _forceLink.resolveForceLink;
+  }
+});
 exports.models = exports.manifest = void 0;
 
 var _CozyClient = _interopRequireDefault(require("./CozyClient"));
@@ -300,4 +307,6 @@ var _policies = _interopRequireDefault(require("./policies"));
 
 var _webPerformanceApi = require("./performances/webPerformanceApi");
 
-var _defaultPerformanceApi = require("./performances/defaultPerformanceApi");
+var _defaultPerformanceApi = require("./performances/defaultPerformanceApi");
+
+var _forceLink = require("./links/forceLink");

package/dist/links/CozyLink.js

@@ -126,6 +126,17 @@ var CozyLink = /*#__PURE__*/function () {
 
       return reset;
     }()
+    /**
+     * Stable name used to target this link via the `forceLink` query option.
+     *
+     * @returns {string|undefined}
+     */
+
+  }, {
+    key: "name",
+    get: function get() {
+      return undefined;
+    }
   }]);
   return CozyLink;
 }();

package/dist/links/CozyLink.spec.js

@@ -16,6 +16,11 @@ describe('CozyLink', () => {
     expect(link.request('dummyOperation')).toBe('foobarbaz')
   })
 
+  it('has name === undefined by default', () => {
+    const link = new CozyLink()
+    expect(link.name).toBe(undefined)
+  })
+
   describe('default last link', () => {
     it('should throw an error when called without result', () => {
       const link = chain([

package/dist/links/DataProxyLink.js

@@ -29,6 +29,8 @@ var _CozyLink2 = _interopRequireDefault(require("./CozyLink"));
 
 var _cozyLogger = _interopRequireDefault(require("cozy-logger"));
 
+var _forceLink = require("./forceLink");
+
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
@@ -124,18 +126,29 @@ var DataProxyLink = /*#__PURE__*/function (_CozyLink) {
         var _this$dataproxy,
             _this2 = this;
 
+        var forceLink;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
               case 0:
+                forceLink = (0, _forceLink.resolveForceLink)(options);
+
+                if (!(forceLink && forceLink !== this.name)) {
+                  _context2.next = 3;
+                  break;
+                }
+
+                return _context2.abrupt("return", forward(operation, options));
+
+              case 3:
                 if (!((_this$dataproxy = this.dataproxy) !== null && _this$dataproxy !== void 0 && _this$dataproxy.requestLink)) {
-                  _context2.next = 2;
+                  _context2.next = 5;
                   break;
                 }
 
                 return _context2.abrupt("return", this.doRequest(operation, options));
 
-              case 2:
+              case 5:
                 return _context2.abrupt("return", new Promise(function (resolve, reject) {
                   _this2._queue.push({
                     operation: operation,
@@ -145,7 +158,7 @@ var DataProxyLink = /*#__PURE__*/function (_CozyLink) {
                   });
                 }));
 
-              case 3:
+              case 6:
               case "end":
                 return _context2.stop();
             }
@@ -295,6 +308,11 @@ var DataProxyLink = /*#__PURE__*/function (_CozyLink) {
 
       return _flushQueue;
     }()
+  }, {
+    key: "name",
+    get: function get() {
+      return 'dataproxy';
+    }
   }]);
   return DataProxyLink;
 }(_CozyLink2.default);

package/dist/links/DataProxyLink.spec.js

@@ -1,6 +1,54 @@
 /** @jest-environment jsdom */
 import DataProxyLink from './DataProxyLink'
 
+describe('DataProxyLink name', () => {
+  it('should expose a stable name', () => {
+    expect(new DataProxyLink().name).toBe('dataproxy')
+  })
+})
+
+describe('DataProxyLink forceLink', () => {
+  it('forwards a forceStack:true query (routes away from dataproxy)', async () => {
+    const link = new DataProxyLink()
+    const forwardFn = jest.fn().mockResolvedValue(null)
+    await link.request(
+      { doctype: 'io.cozy.files' },
+      { forceStack: true },
+      null,
+      forwardFn
+    )
+    expect(forwardFn).toHaveBeenCalled()
+  })
+
+  it('handles when forceLink targets it', async () => {
+    const link = new DataProxyLink()
+    link.registerDataProxy({
+      requestLink: jest.fn().mockResolvedValue({ data: [{ _id: '1' }] })
+    })
+    const forward = jest.fn()
+    const res = await link.request(
+      { doctype: 'io.cozy.files' },
+      { forceLink: 'dataproxy' },
+      undefined,
+      forward
+    )
+    expect(forward).not.toHaveBeenCalled()
+    expect(res).toEqual({ data: [{ _id: '1' }] })
+  })
+  it('forwards when forceLink targets another link', async () => {
+    const link = new DataProxyLink()
+    const forward = jest.fn().mockResolvedValue('forwarded')
+    expect(
+      await link.request(
+        { doctype: 'io.cozy.files' },
+        { forceLink: 'stack' },
+        undefined,
+        forward
+      )
+    ).toBe('forwarded')
+  })
+})
+
 describe('DataProxyLink queueing', () => {
   it('should directly call dataproxy requestLink if available', async () => {
     const requestLink = jest.fn().mockResolvedValue('OK')

package/dist/links/StackLink.js

@@ -41,6 +41,8 @@ var _utils = require("../utils");
 
 var _defaultPerformanceApi = require("../performances/defaultPerformanceApi");
 
+var _forceLink = require("./forceLink");
+
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
@@ -176,72 +178,83 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
     key: "request",
     value: function () {
       var _request = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(operation, options, result, forward) {
+        var forceLink;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
               case 0:
-                _context2.t0 = !(options !== null && options !== void 0 && options.forceStack) && this.isOnline;
+                forceLink = (0, _forceLink.resolveForceLink)(options);
+
+                if (!(forceLink && forceLink !== this.name)) {
+                  _context2.next = 3;
+                  break;
+                }
+
+                return _context2.abrupt("return", forward(operation, options));
+
+              case 3:
+                _context2.t0 = forceLink !== 'stack' && this.isOnline;
 
                 if (!_context2.t0) {
-                  _context2.next = 5;
+                  _context2.next = 8;
                   break;
                 }
 
-                _context2.next = 4;
+                _context2.next = 7;
                 return this.isOnline();
 
-              case 4:
+              case 7:
                 _context2.t0 = !_context2.sent;
 
-              case 5:
+              case 8:
                 if (!_context2.t0) {
-                  _context2.next = 7;
+                  _context2.next = 10;
                   break;
                 }
 
                 return _context2.abrupt("return", forward(operation, options));
 
-              case 7:
-                _context2.prev = 7;
+              case 10:
+                _context2.prev = 10;
 
                 if (!operation.mutationType) {
-                  _context2.next = 12;
+                  _context2.next = 15;
                   break;
                 }
 
-                _context2.next = 11;
+                _context2.next = 14;
                 return this.executeMutation(operation, options, result, forward);
 
-              case 11:
+              case 14:
                 return _context2.abrupt("return", _context2.sent);
 
-              case 12:
-                _context2.next = 14;
+              case 15:
+                _context2.next = 17;
                 return this.executeQuery(operation);
 
-              case 14:
+              case 17:
                 return _context2.abrupt("return", _context2.sent);
 
-              case 17:
-                _context2.prev = 17;
-                _context2.t1 = _context2["catch"](7);
+              case 20:
+                _context2.prev = 20;
+                _context2.t1 = _context2["catch"](10);
 
-                if (!(!(options !== null && options !== void 0 && options.forceStack) && (0, _utils.isReactNativeOfflineError)(_context2.t1))) {
-                  _context2.next = 21;
+                if (!(forceLink !== 'stack' && (0, _utils.isReactNativeOfflineError)(_context2.t1))) {
+                  _context2.next = 24;
                   break;
                 }
 
                 return _context2.abrupt("return", forward(operation, options));
 
-              case 21:
+              case 24:
                 throw _context2.t1;
 
-              case 22:
+              case 25:
               case "end":
                 return _context2.stop();
             }
           }
-        }, _callee2, this, [[7, 17]]);
+        }, _callee2, this, [[10, 20]]);
       }));
 
       function request(_x, _x2, _x3, _x4) {
@@ -409,6 +422,11 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
 
       return executeMutation;
     }()
+  }, {
+    key: "name",
+    get: function get() {
+      return 'stack';
+    }
   }]);
   return StackLink;
 }(_CozyLink2.default);

package/dist/links/StackLink.spec.js

@@ -2,8 +2,17 @@ import { Q } from '../queries/dsl'
 import CozyClient from '../CozyClient'
 import StackLink, { transformBulkDocsResponse } from './StackLink'
 import { SCHEMA } from '../__tests__/fixtures'
+import logger from '../logger'
+// eslint-disable-next-line no-underscore-dangle
+import { _resetForceStackWarning } from './forceLink'
 
 describe('StackLink', () => {
+  describe('name', () => {
+    it('should expose a stable name', () => {
+      expect(new StackLink().name).toBe('stack')
+    })
+  })
+
   let stackClient, link, client
 
   beforeEach(() => {
@@ -12,6 +21,54 @@ describe('StackLink', () => {
     stackClient = client.getStackClient()
   })
 
+  describe('forceLink', () => {
+    let warnSpy
+
+    beforeEach(() => {
+      _resetForceStackWarning()
+      warnSpy = jest.spyOn(logger, 'warn').mockImplementation(() => {})
+    })
+
+    afterEach(() => {
+      warnSpy.mockRestore()
+    })
+
+    it('forwards when forceLink targets another link', async () => {
+      const link = new StackLink()
+      const forward = jest.fn().mockResolvedValue('forwarded')
+      expect(
+        await link.request(
+          { doctype: 'io.cozy.files' },
+          { forceLink: 'dataproxy' },
+          undefined,
+          forward
+        )
+      ).toBe('forwarded')
+    })
+
+    it('handles a forceStack:true query (legacy: does not forward, emits deprecation warning)', async () => {
+      const link = new StackLink()
+      link.executeQuery = jest.fn().mockResolvedValue({ data: [] })
+      link.isOnline = jest.fn().mockResolvedValue(false) // offline — should NOT bail because forceStack
+      const forwardFn = jest.fn()
+      const op = { doctype: 'io.cozy.files' }
+      await link.request(op, { forceStack: true }, null, forwardFn)
+      expect(forwardFn).not.toHaveBeenCalled()
+      expect(warnSpy).toHaveBeenCalledWith(
+        expect.stringContaining('forceStack is deprecated')
+      )
+    })
+
+    it('forwards a plain query when offline', async () => {
+      const link = new StackLink()
+      link.isOnline = jest.fn().mockResolvedValue(false)
+      const forwardFn = jest.fn().mockResolvedValue(null)
+      const op = { doctype: 'io.cozy.files' }
+      await link.request(op, {}, null, forwardFn)
+      expect(forwardFn).toHaveBeenCalled()
+    })
+  })
+
   describe('query execution', () => {
     it('should execute queries without a selector', async () => {
       const query = Q('io.cozy.todos')

package/dist/links/forceLink.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.resolveForceLink = exports._resetForceStackWarning = void 0;
+
+var _logger = _interopRequireDefault(require("../logger"));
+
+var hasWarnedForceStack = false; // eslint-disable-next-line no-underscore-dangle
+
+var _resetForceStackWarning = function _resetForceStackWarning() {
+  hasWarnedForceStack = false;
+};
+/* eslint-disable jsdoc/check-tag-names */
+
+/**
+ * Resolves the effective forceLink target, mapping the deprecated forceStack option onto forceLink:'stack'.
+ *
+ * @internal
+ * @param {{ forceLink?: string, forceStack?: boolean }} [options] - Query options
+ * @returns {string|undefined}
+ */
+
+
+exports._resetForceStackWarning = _resetForceStackWarning;
+
+var resolveForceLink = function resolveForceLink(options) {
+  if (options !== null && options !== void 0 && options.forceLink) return options.forceLink;
+
+  if (options !== null && options !== void 0 && options.forceStack) {
+    if (!hasWarnedForceStack) {
+      _logger.default.warn("options.forceStack is deprecated, use forceLink: 'stack' instead");
+
+      hasWarnedForceStack = true;
+    }
+
+    return 'stack';
+  }
+
+  return undefined;
+};
+/* eslint-enable jsdoc/check-tag-names */
+
+
+exports.resolveForceLink = resolveForceLink;

package/dist/types.js

@@ -315,7 +315,8 @@ var _dsl = require("./queries/dsl");
  * a single doc instead of an array for single doc queries. Defaults to false for backward
  * compatibility but will be set to true in the future.
  * @property {boolean} [executeFromStore=false] - If set to true, the query will be run directly on the current store's state
- * @property {boolean} [forceStack] - If set to true, the query will be executed through StackLink only even if there are other links available
+ * @property {boolean} [forceStack] - Deprecated: use forceLink:'stack'. Executes the query through StackLink only.
+ * @property {string} [forceLink] - Route this query exclusively to the link whose name matches (e.g. 'dataproxy').
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "60.28.2",
+  "version": "60.29.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -74,5 +74,5 @@
     "react-native-ios11-devicecheck": "^0.0.3"
   },
   "sideEffects": false,
-  "gitHead": "272fde3c9e8dc4a4472744513ace8b71a8b2c417"
+  "gitHead": "0e624ae6b3ba93c2618ba9d26f4d4f48945bf5c8"
 }

package/types/index.d.ts

@@ -3,6 +3,7 @@ export { default as CozyLink } from "./links/CozyLink";
 export { default as StackLink } from "./links/StackLink";
 export { default as WebFlagshipLink } from "./links/WebFlagshipLink";
 export { default as DataProxyLink } from "./links/DataProxyLink";
+export { resolveForceLink } from "./links/forceLink";
 export { default as compose } from "lodash/flow";
 export { default as Registry } from "./registry";
 export { default as RealTimeQueries } from "./RealTimeQueries";

package/types/index.node.d.ts

@@ -12,6 +12,7 @@ export { BulkEditError } from "./errors";
 export { default as fetchPolicies } from "./policies";
 export { webPerformanceApi } from "./performances/webPerformanceApi";
 export { defaultPerformanceApi } from "./performances/defaultPerformanceApi";
+export { resolveForceLink } from "./links/forceLink";
 import * as manifest from "./models/manifest";
 import * as models from "./models";
 export { manifest, models };

package/types/links/CozyLink.d.ts

@@ -24,5 +24,11 @@ export default class CozyLink {
      * @returns {Promise<any>}
      */
     reset(): Promise<any>;
+    /**
+     * Stable name used to target this link via the `forceLink` query option.
+     *
+     * @returns {string|undefined}
+     */
+    get name(): string;
 }
 export function chain(links: any): any;

package/types/links/forceLink.d.ts

@@ -0,0 +1,5 @@
+export function _resetForceStackWarning(): void;
+export function resolveForceLink(options?: {
+    forceLink?: string;
+    forceStack?: boolean;
+}): string | undefined;

package/types/types.d.ts

@@ -567,9 +567,13 @@ export type QueryOptions = {
      */
     executeFromStore?: boolean;
     /**
-     * - If set to true, the query will be executed through StackLink only even if there are other links available
+     * - Deprecated: use forceLink:'stack'. Executes the query through StackLink only.
      */
     forceStack?: boolean;
+    /**
+     * - Route this query exclusively to the link whose name matches (e.g. 'dataproxy').
+     */
+    forceLink?: string;
 };
 export type Query = {
     definition: QueryDefinition;