cozy-client 48.25.0 → 49.0.0

package/dist/models/instance.js

@@ -33,26 +33,26 @@ var PREMIUM_QUOTA = 50 * GB;
 // If manager URL is present, then the instance is not self-hosted
 
 var isSelfHosted = function isSelfHosted(instanceInfo) {
-  return (0, _get.default)(instanceInfo, 'context.data.attributes.manager_url') ? false : true;
+  return (0, _get.default)(instanceInfo, 'context.data.manager_url') ? false : true;
 };
 
 exports.isSelfHosted = isSelfHosted;
 
 var arePremiumLinksEnabled = function arePremiumLinksEnabled(instanceInfo) {
-  return (0, _get.default)(instanceInfo, 'context.data.attributes.enable_premium_links') ? true : false;
+  return (0, _get.default)(instanceInfo, 'context.data.enable_premium_links') ? true : false;
 };
 
 exports.arePremiumLinksEnabled = arePremiumLinksEnabled;
 
 var isFreemiumUser = function isFreemiumUser(instanceInfo) {
-  var quota = (0, _get.default)(instanceInfo, 'diskUsage.data.attributes.quota', false);
+  var quota = (0, _get.default)(instanceInfo, 'diskUsage.data.quota', false);
   return parseInt(quota) <= PREMIUM_QUOTA;
 };
 
 exports.isFreemiumUser = isFreemiumUser;
 
 var getUuid = function getUuid(instanceInfo) {
-  return (0, _get.default)(instanceInfo, 'instance.data.attributes.uuid');
+  return (0, _get.default)(instanceInfo, 'instance.data.uuid');
 };
 /**
  * Returns whether an instance is concerned by our offers
@@ -90,7 +90,7 @@ var hasAnOffer = function hasAnOffer(data) {
 exports.hasAnOffer = hasAnOffer;
 
 var buildPremiumLink = function buildPremiumLink(instanceInfo) {
-  var managerUrl = (0, _get.default)(instanceInfo, 'context.data.attributes.manager_url', false);
+  var managerUrl = (0, _get.default)(instanceInfo, 'context.data.manager_url', false);
   var uuid = getUuid(instanceInfo);
 
   if (managerUrl && uuid) {
@@ -129,7 +129,7 @@ var hasPasswordDefinedAttribute = /*#__PURE__*/function () {
 
           case 3:
             _yield$client$fetchQu = _context.sent;
-            password_defined = _yield$client$fetchQu.data.attributes.password_defined;
+            password_defined = _yield$client$fetchQu.data.password_defined;
             return _context.abrupt("return", Boolean(password_defined));
 
           case 8:

package/dist/models/instance.spec.js

@@ -3,39 +3,29 @@ import { instance } from './'
 const noSelfHostedInstance = {
   context: {
     data: {
-      attributes: {
-        manager_url: 'https://manager.cozy.cc',
-        enable_premium_links: true
-      }
+      manager_url: 'https://manager.cozy.cc',
+      enable_premium_links: true
     }
   },
   instance: {
     data: {
-      attributes: {
-        uuid: '1234'
-      }
+      uuid: '1234'
     }
   },
   diskUsage: {
     data: {
-      attributes: {
-        quota: '400000000'
-      }
+      quota: '400000000'
     }
   }
 }
 
 const selftHostedInstance = {
   context: {
-    data: {
-      attributes: {}
-    }
+    data: {}
   },
   diskUsage: {
     data: {
-      attributes: {
-        quota: '6000000000000'
-      }
+      quota: '6000000000000'
     }
   }
 }
@@ -43,24 +33,18 @@ const selftHostedInstance = {
 const hadAnOfferInstance = {
   context: {
     data: {
-      attributes: {
-        manager_url: 'https://manager.cozy.cc',
-        enable_premium_links: true
-      }
+      manager_url: 'https://manager.cozy.cc',
+      enable_premium_links: true
     }
   },
   instance: {
     data: {
-      attributes: {
-        uuid: '1234'
-      }
+      uuid: '1234'
     }
   },
   diskUsage: {
     data: {
-      attributes: {
-        quota: '60000000000'
-      }
+      quota: '60000000000'
     }
   }
 }
@@ -163,17 +147,17 @@ describe('instance', () => {
     })
 
     it('should return false if attribute password_defined is undefined', async () => {
-      const res = await setup({ attributes: { password_defined: undefined } })
+      const res = await setup({ password_defined: undefined })
       expect(res).toBe(false)
     })
 
     it('should return false if attribute password_defined is false', async () => {
-      const res = await setup({ attributes: { password_defined: false } })
+      const res = await setup({ password_defined: false })
       expect(res).toBe(false)
     })
 
     it('should return true if attribute password_defined is true', async () => {
-      const res = await setup({ attributes: { password_defined: true } })
+      const res = await setup({ password_defined: true })
       expect(res).toBe(true)
     })
   })

package/dist/types.js

@@ -426,6 +426,11 @@ var _dsl = require("./queries/dsl");
  * @property {boolean} [favorite] - Whether the document is marked as favorite
  */
 
+/**
+ * @typedef {object} CozyClientDocumentMeta - Meta object as specified by JSON-API (https://jsonapi.org/format/#document-meta)
+ * @property {string} [rev] - Current revision of the document
+ */
+
 /**
  * @typedef {object} CozyClientDocument - A document
  * @property {string} [_id] - Id of the document
@@ -436,6 +441,8 @@ var _dsl = require("./queries/dsl");
  * @property {ReferencedByRelationship} [relationships] - Relationships of the document
  * @property {Reference[]} [referenced_by] - referenced by of another document
  * @property {CozyMetadata} [cozyMetadata] - Cozy Metadata
+ * @property {CozyClientDocumentMeta} [meta] - Pouch Metadata
+ * @property {boolean} [cozyLocalOnly] - When true the document should NOT be replicated to the remote database
  */
 
 /**
@@ -470,6 +477,7 @@ var _dsl = require("./queries/dsl");
 /**
  * @typedef {object} FileDocument - An io.cozy.files document
  * @property {string} _id - Id of the file
+ * @property {string} _rev - Rev of the file
  * @property {FilesDoctype} _type - Doctype of the file
  * @property {string} dir_id - Id of the parent folder
  * @property {string} [path] - Path of the file

package/dist/utils.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.hasQueriesBeenLoaded = exports.isQueriesLoading = exports.hasQueryBeenLoaded = exports.isQueryLoading = exports.cancelable = void 0;
+exports.isReactNativeOfflineError = exports.hasQueriesBeenLoaded = exports.isQueriesLoading = exports.hasQueryBeenLoaded = exports.isQueryLoading = exports.cancelable = void 0;
 
 var _logger = _interopRequireDefault(require("./logger"));
 
@@ -89,5 +89,20 @@ var hasQueriesBeenLoaded = function hasQueriesBeenLoaded(queriesResults) {
     return hasQueryBeenLoaded(queryResult);
   });
 };
+/**
+ * Check is the error is about ReactNative not having access to internet
+ *
+ * @param {Error} err - The error to check
+ * @returns {boolean} True if the error is a network error, otherwise false
+ */
+
+
+exports.hasQueriesBeenLoaded = hasQueriesBeenLoaded;
+
+var isReactNativeOfflineError = function isReactNativeOfflineError(err) {
+  // This error message is specific to ReactNative
+  // Network errors on a browser would produce another error.message
+  return err.message === 'Network request failed';
+};
 
-exports.hasQueriesBeenLoaded = hasQueriesBeenLoaded;
+exports.isReactNativeOfflineError = isReactNativeOfflineError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "48.25.0",
+  "version": "49.0.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^48.16.0",
+    "cozy-stack-client": "^49.0.0",
     "date-fns": "2.29.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
@@ -50,7 +50,7 @@
     "btoa": "1.2.1",
     "cozy-device-helper": "2.7.0",
     "cozy-flags": "2.10.2",
-    "cozy-intent": "1.17.3",
+    "cozy-intent": "2.23.0",
     "cozy-logger": "1.7.0",
     "cozy-ui": "93.1.1",
     "jsdoc-plugin-intersection": "1.0.4",
@@ -65,7 +65,7 @@
   "peerDependencies": {
     "cozy-device-helper": ">=2.1.0",
     "cozy-flags": ">2.8.6",
-    "cozy-intent": ">=1.3.0",
+    "cozy-intent": ">=2.23.0",
     "cozy-logger": ">1.7.0",
     "cozy-ui": ">=93.1.1",
     "react": "^16.7.0",
@@ -75,5 +75,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "2335cc461075ca1fc55519bcfce80d5a9dc74c0d"
+  "gitHead": "ddf825045c0640e383b7cf89f9937ef7d44e501d"
 }

package/types/CozyClient.d.ts

@@ -1,4 +1,46 @@
 export default CozyClient;
+export type CozyClientDocument = {
+    /**
+     * - Id of the document
+     */
+    _id?: string;
+    /**
+     * - Id of the document
+     */
+    id?: string;
+    /**
+     * - Type of the document
+     */
+    _type?: string;
+    /**
+     * - Current revision of the document
+     */
+    _rev?: string;
+    /**
+     * - When the document has been deleted
+     */
+    _deleted?: boolean;
+    /**
+     * - Relationships of the document
+     */
+    relationships?: import("./types").ReferencedByRelationship;
+    /**
+     * - referenced by of another document
+     */
+    referenced_by?: import("./types").Reference[];
+    /**
+     * - Cozy Metadata
+     */
+    cozyMetadata?: import("./types").CozyMetadata;
+    /**
+     * - Pouch Metadata
+     */
+    meta?: import("./types").CozyClientDocumentMeta;
+    /**
+     * - When true the document should NOT be replicated to the remote database
+     */
+    cozyLocalOnly?: boolean;
+};
 export type ClientOptions = {
     client?: object;
     link?: object;
@@ -36,6 +78,8 @@ export type ClientOptions = {
     store?: boolean;
 };
 /**
+ * @typedef {import("./types").CozyClientDocument} CozyClientDocument
+ *
  * @typedef {object} ClientOptions
  * @property {object} [client]
  * @property {object} [link]
@@ -458,6 +502,23 @@ declare class CozyClient {
      * @returns {Promise<import("./types").ClientResponse>}
      */
     private requestQuery;
+    /**
+     * Save the document or array of documents into the persisted storage (if any)
+     *
+     * @private
+     * @param {CozyClientDocument | Array<CozyClientDocument>} data - Document or array of documents to be saved
+     * @returns {Promise<void>}
+     */
+    private persistVirtualDocuments;
+    /**
+     * Save the document or array of documents into the persisted storage (if any)
+     *
+     * @private
+     * @param {CozyClientDocument} document - Document to be saved
+     * @param {boolean} enforce - When true, save the document even if `meta.rev` or `_rev` exist
+     * @returns {Promise<void>}
+     */
+    private persistVirtualDocument;
     /**
      * Fetch relationships for a response (can be several docs).
      * Fills the `relationships` attribute of each documents.

package/types/CozyLink.d.ts

@@ -1,5 +1,27 @@
 export default class CozyLink {
-    constructor(requestHandler: any);
-    request(operation: any, result: any, forward: any): void;
+    constructor(requestHandler: any, persistHandler: any);
+    /**
+     * Request the given operation from the link
+     *
+     * @param {any} operation - The operation to request
+     * @param {any} result - The result from the previous request of the chain
+     * @param {any} forward - The next request of the chain
+     * @returns {Promise<any>}
+     */
+    request(operation: any, result: any, forward: any): Promise<any>;
+    /**
+     * Persist the given data into the links storage
+     *
+     * @param {any} data - The document to persist
+     * @param {any} forward - The next persistCozyData of the chain
+     * @returns {Promise<any>}
+     */
+    persistCozyData(data: any, forward: any): Promise<any>;
+    /**
+     * Reset the link data
+     *
+     * @returns {Promise<any>}
+     */
+    reset(): Promise<any>;
 }
 export function chain(links: any): any;

package/types/StackLink.d.ts

@@ -1,22 +1,23 @@
 export function transformBulkDocsResponse(bulkResponse: import("./types").CouchDBBulkResult[], originalDocuments: import("./types").CozyClientDocument[]): {
     data: import("./types").CozyClientDocument[];
 };
+/**
+ * @typedef {object} StackLinkOptions
+ * @property {object} [stackClient] - A StackClient
+ * @property {object} [client] - A StackClient (deprecated)
+ * @property {import('cozy-pouch-link/dist/types').LinkPlatform} [platform] - Platform specific adapters and methods
+ */
 /**
  * Transfers queries and mutations to a remote stack
  */
 export default class StackLink extends CozyLink {
     /**
-     * @param {object} [options] - Options
-     * @param  {object} [options.stackClient] - A StackClient
-     * @param  {object} [options.client] - A StackClient (deprecated)
+     * @param {StackLinkOptions} [options] - Options
      */
-    constructor({ client, stackClient }?: {
-        stackClient: object;
-        client: object;
-    });
+    constructor({ client, stackClient, platform }?: StackLinkOptions);
     stackClient: any;
+    isOnline: any;
     registerClient(client: any): void;
-    reset(): void;
     /**
      *
      * @param {QueryDefinition} query - Query to execute
@@ -25,5 +26,19 @@ export default class StackLink extends CozyLink {
     executeQuery(query: QueryDefinition): Promise<import("./types").ClientResponse>;
     executeMutation(mutation: any, result: any, forward: any): Promise<any>;
 }
+export type StackLinkOptions = {
+    /**
+     * - A StackClient
+     */
+    stackClient?: object;
+    /**
+     * - A StackClient (deprecated)
+     */
+    client?: object;
+    /**
+     * - Platform specific adapters and methods
+     */
+    platform?: any;
+};
 import CozyLink from "./CozyLink";
 import { QueryDefinition } from "./queries/dsl";

package/types/WebFlagshipLink.d.ts

@@ -0,0 +1,12 @@
+export default class WebFlagshipLink extends CozyLink {
+    /**
+     * @param {object} [options] - Options
+     * @param  {import('cozy-intent').WebviewService} [options.webviewIntent] - The webview's intent reference
+     */
+    constructor({ webviewIntent }?: {
+        webviewIntent: import('cozy-intent').WebviewService;
+    });
+    webviewIntent: import("cozy-intent").WebviewService;
+    registerClient(client: any): void;
+}
+import CozyLink from "./CozyLink";

package/types/index.d.ts

@@ -1,6 +1,7 @@
 export { default } from "./CozyClient";
 export { default as CozyLink } from "./CozyLink";
 export { default as StackLink } from "./StackLink";
+export { default as WebFlagshipLink } from "./WebFlagshipLink";
 export { default as compose } from "lodash/flow";
 export { default as Registry } from "./registry";
 export { default as RealTimeQueries } from "./RealTimeQueries";

package/types/models/file.d.ts

@@ -68,6 +68,12 @@ export function hasCertifications(file: import("../types").IOCozyFile): boolean;
 export function isFromKonnector(file: import("../types").IOCozyFile): boolean;
 export function fetchBlobFileById(client: CozyClient, fileId: string): Promise<Blob>;
 export function copy(client: object, file: object, destination: object): Promise<any>;
+export function downloadFile({ client, file, url, webviewIntent }: {
+    client: CozyClient;
+    file: import("../types").IOCozyFile;
+    url: string;
+    webviewIntent: import('cozy-intent').WebviewService;
+}): Promise<any>;
 export type FileUploadOptions = {
     /**
      * - The file name to upload

package/types/types.d.ts

@@ -705,6 +705,15 @@ export type CozyMetadata = {
      */
     favorite?: boolean;
 };
+/**
+ * - Meta object as specified by JSON-API (https://jsonapi.org/format/#document-meta)
+ */
+export type CozyClientDocumentMeta = {
+    /**
+     * - Current revision of the document
+     */
+    rev?: string;
+};
 /**
  * - A document
  */
@@ -741,6 +750,14 @@ export type CozyClientDocument = {
      * - Cozy Metadata
      */
     cozyMetadata?: CozyMetadata;
+    /**
+     * - Pouch Metadata
+     */
+    meta?: CozyClientDocumentMeta;
+    /**
+     * - When true the document should NOT be replicated to the remote database
+     */
+    cozyLocalOnly?: boolean;
 };
 /**
  * - A io.cozy.files document's metadata
@@ -813,6 +830,10 @@ export type FileDocument = {
      * - Id of the file
      */
     _id: string;
+    /**
+     * - Rev of the file
+     */
+    _rev: string;
     /**
      * - Doctype of the file
      */

package/types/utils.d.ts

@@ -2,6 +2,7 @@ export function isQueryLoading(col: any): boolean;
 export function hasQueryBeenLoaded(col: any): any;
 export function isQueriesLoading(queriesResults: any): boolean;
 export function hasQueriesBeenLoaded(queriesResults: any): boolean;
+export function isReactNativeOfflineError(err: Error): boolean;
 export type CancelablePromise = Promise<any>;
 /**
  * @typedef {Promise} CancelablePromise

package/types/devtools/Flags.d.ts

@@ -1,2 +0,0 @@
-export default Flags;
-declare function Flags(): JSX.Element;

package/types/models/doctypes/index.d.ts

@@ -1,2 +0,0 @@
-export { locales };
-import * as locales from "./locales";

package/types/models/doctypes/locales/index.d.ts

@@ -1,3 +0,0 @@
-import fr from "./fr.json";
-import en from "./en.json";
-export { fr, en };

package/types/models/document/emojiCountry.d.ts

@@ -1 +0,0 @@
-export function getEmojiByCountry(countryCode: string): string;

package/types/node.d.ts

@@ -1,15 +0,0 @@
-export { default } from "./CozyClient";
-export { default as CozyLink } from "./CozyLink";
-export { default as StackLink } from "./StackLink";
-export { default as compose } from "lodash/flow";
-export { cancelable } from "./utils";
-export { getQueryFromState } from "./store";
-export { default as Registry } from "./registry";
-export * from "./mock";
-export * from "./cli";
-import * as manifest from "./manifest";
-import * as models from "./models";
-export { manifest, models };
-export { QueryDefinition, Mutations, MutationTypes, getDoctypeFromOperation, Q } from "./queries/dsl";
-export { Association, HasMany, HasOne, HasOneInPlace, HasManyInPlace, HasManyTriggers } from "./associations";
-export { dehydrate, generateWebLink } from "./helpers";

package/types/queries/referencedBy.d.ts

@@ -1,7 +0,0 @@
-export function isReferencedBy(file: IOCozyFile, referencedBy: Doctype): boolean;
-export function isReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): boolean;
-export function getReferencedBy(file: IOCozyFile, referencedBy: Doctype): Reference[];
-export function getReferencedById(file: IOCozyFile, referencedBy: Doctype, referencedId: string): Reference[];
-import { IOCozyFile } from "../types";
-import { Doctype } from "../types";
-import { Reference } from "../types";