cozy-client 59.0.0 → 59.1.0

package/dist/links/StackLink.js

@@ -327,7 +327,7 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
               case 0:
                 mutationType = mutation.mutationType, doc = mutation.document, docs = mutation.documents, props = (0, _objectWithoutProperties2.default)(mutation, ["mutationType", "document", "documents"]);
                 _context4.t0 = mutationType;
-                _context4.next = _context4.t0 === _dsl.MutationTypes.CREATE_DOCUMENT ? 4 : _context4.t0 === _dsl.MutationTypes.UPDATE_DOCUMENTS ? 5 : _context4.t0 === _dsl.MutationTypes.UPDATE_DOCUMENT ? 9 : _context4.t0 === _dsl.MutationTypes.DELETE_DOCUMENT ? 10 : _context4.t0 === _dsl.MutationTypes.ADD_REFERENCES_TO ? 11 : _context4.t0 === _dsl.MutationTypes.REMOVE_REFERENCES_TO ? 12 : _context4.t0 === _dsl.MutationTypes.ADD_REFERENCED_BY ? 13 : _context4.t0 === _dsl.MutationTypes.REMOVE_REFERENCED_BY ? 18 : _context4.t0 === _dsl.MutationTypes.UPLOAD_FILE ? 23 : 24;
+                _context4.next = _context4.t0 === _dsl.MutationTypes.CREATE_DOCUMENT ? 4 : _context4.t0 === _dsl.MutationTypes.UPDATE_DOCUMENTS ? 5 : _context4.t0 === _dsl.MutationTypes.UPDATE_DOCUMENT ? 9 : _context4.t0 === _dsl.MutationTypes.DELETE_DOCUMENT ? 10 : _context4.t0 === _dsl.MutationTypes.DELETE_DOCUMENTS ? 11 : _context4.t0 === _dsl.MutationTypes.ADD_REFERENCES_TO ? 12 : _context4.t0 === _dsl.MutationTypes.REMOVE_REFERENCES_TO ? 13 : _context4.t0 === _dsl.MutationTypes.ADD_REFERENCED_BY ? 14 : _context4.t0 === _dsl.MutationTypes.REMOVE_REFERENCED_BY ? 19 : _context4.t0 === _dsl.MutationTypes.UPLOAD_FILE ? 24 : 25;
                 break;
 
               case 4:
@@ -348,40 +348,43 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
                 return _context4.abrupt("return", this.stackClient.collection(doc._type).destroy(doc));
 
               case 11:
-                return _context4.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).addReferencesTo(doc, props.referencedDocuments));
+                return _context4.abrupt("return", this.stackClient.collection(doc._type).destroyAll(docs));
 
               case 12:
-                return _context4.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).removeReferencesTo(doc, props.referencedDocuments));
+                return _context4.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).addReferencesTo(doc, props.referencedDocuments));
 
               case 13:
+                return _context4.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).removeReferencesTo(doc, props.referencedDocuments));
+
+              case 14:
                 if (!(doc._type === _const.DOCTYPE_FILES)) {
-                  _context4.next = 17;
+                  _context4.next = 18;
                   break;
                 }
 
                 return _context4.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).addReferencedBy(doc, props.referencedDocuments));
 
-              case 17:
+              case 18:
                 throw new Error('The document type should be io.cozy.files');
 
-              case 18:
+              case 19:
                 if (!(doc._type === _const.DOCTYPE_FILES)) {
-                  _context4.next = 22;
+                  _context4.next = 23;
                   break;
                 }
 
                 return _context4.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).removeReferencedBy(doc, props.referencedDocuments));
 
-              case 22:
+              case 23:
                 throw new Error('The document type should be io.cozy.files');
 
-              case 23:
+              case 24:
                 return _context4.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).upload(props.file, props.dirPath));
 
-              case 24:
+              case 25:
                 return _context4.abrupt("return", forward(mutation, options, result));
 
-              case 25:
+              case 26:
               case "end":
                 return _context4.stop();
             }

package/dist/queries/dsl.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.QueryDefinition = exports.MutationTypes = exports.Mutations = exports.getDoctypeFromOperation = exports.uploadFile = exports.removeReferencedBy = exports.addReferencedBy = exports.removeReferencesTo = exports.addReferencesTo = exports.deleteDocument = exports.updateDocuments = exports.updateDocument = exports.createDocument = exports.isAGetByIdQuery = exports.Q = void 0;
+exports.QueryDefinition = exports.MutationTypes = exports.Mutations = exports.getDoctypeFromOperation = exports.uploadFile = exports.removeReferencedBy = exports.addReferencedBy = exports.removeReferencesTo = exports.addReferencesTo = exports.deleteDocuments = exports.deleteDocument = exports.updateDocuments = exports.updateDocument = exports.createDocuments = exports.createDocument = exports.isAGetByIdQuery = exports.Q = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -513,9 +513,11 @@ var isAGetByIdQuery = function isAGetByIdQuery(queryDefinition) {
 
 exports.isAGetByIdQuery = isAGetByIdQuery;
 var CREATE_DOCUMENT = 'CREATE_DOCUMENT';
+var CREATE_DOCUMENTS = 'CREATE_DOCUMENTS';
 var UPDATE_DOCUMENT = 'UPDATE_DOCUMENT';
 var UPDATE_DOCUMENTS = 'UPDATE_DOCUMENTS';
 var DELETE_DOCUMENT = 'DELETE_DOCUMENT';
+var DELETE_DOCUMENTS = 'DELETE_DOCUMENTS';
 var ADD_REFERENCES_TO = 'ADD_REFERENCES_TO';
 var REMOVE_REFERENCES_TO = 'REMOVE_REFERENCES_TO';
 var ADD_REFERENCED_BY = 'ADD_REFERENCED_BY';
@@ -531,6 +533,15 @@ var createDocument = function createDocument(document) {
 
 exports.createDocument = createDocument;
 
+var createDocuments = function createDocuments(documents) {
+  return {
+    mutationType: MutationTypes.CREATE_DOCUMENTS,
+    documents: documents
+  };
+};
+
+exports.createDocuments = createDocuments;
+
 var updateDocument = function updateDocument(document) {
   return {
     mutationType: MutationTypes.UPDATE_DOCUMENT,
@@ -558,6 +569,15 @@ var deleteDocument = function deleteDocument(document) {
 
 exports.deleteDocument = deleteDocument;
 
+var deleteDocuments = function deleteDocuments(documents) {
+  return {
+    mutationType: MutationTypes.DELETE_DOCUMENTS,
+    documents: documents
+  };
+};
+
+exports.deleteDocuments = deleteDocuments;
+
 var addReferencesTo = function addReferencesTo(document, referencedDocuments) {
   return {
     mutationType: MutationTypes.ADD_REFERENCES_TO,
@@ -616,6 +636,9 @@ var getDoctypeFromOperation = function getDoctypeFromOperation(operation) {
       case CREATE_DOCUMENT:
         return operation.document._type;
 
+      case CREATE_DOCUMENTS:
+        return operation.documents[0]._type;
+
       case UPDATE_DOCUMENT:
         return operation.document._type;
 
@@ -625,6 +648,9 @@ var getDoctypeFromOperation = function getDoctypeFromOperation(operation) {
       case DELETE_DOCUMENT:
         return operation.document._type;
 
+      case DELETE_DOCUMENTS:
+        return operation.documents[0]._type;
+
       case ADD_REFERENCES_TO:
         throw new Error('Not implemented');
 
@@ -642,9 +668,11 @@ var getDoctypeFromOperation = function getDoctypeFromOperation(operation) {
 exports.getDoctypeFromOperation = getDoctypeFromOperation;
 var Mutations = {
   createDocument: createDocument,
+  createDocuments: createDocuments,
   updateDocument: updateDocument,
   updateDocuments: updateDocuments,
   deleteDocument: deleteDocument,
+  deleteDocuments: deleteDocuments,
   addReferencesTo: addReferencesTo,
   removeReferencesTo: removeReferencesTo,
   addReferencedBy: addReferencedBy,
@@ -654,9 +682,11 @@ var Mutations = {
 exports.Mutations = Mutations;
 var MutationTypes = {
   CREATE_DOCUMENT: CREATE_DOCUMENT,
+  CREATE_DOCUMENTS: CREATE_DOCUMENTS,
   UPDATE_DOCUMENT: UPDATE_DOCUMENT,
   UPDATE_DOCUMENTS: UPDATE_DOCUMENTS,
   DELETE_DOCUMENT: DELETE_DOCUMENT,
+  DELETE_DOCUMENTS: DELETE_DOCUMENTS,
   ADD_REFERENCES_TO: ADD_REFERENCES_TO,
   REMOVE_REFERENCES_TO: REMOVE_REFERENCES_TO,
   ADD_REFERENCED_BY: ADD_REFERENCED_BY,

package/dist/types.js

@@ -401,9 +401,9 @@ var _dsl = require("./queries/dsl");
 
 /**
  * @typedef {object} MutationOptions
- * @property {string} [as]
- * @property {Function} [update]
- * @property {Function} [updateQueries]
+ * @property {string} as - Mutation id
+   @property  {Function} update - Function to update the document
+ * @property  {Function} updateQueries - Function to update queries
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "59.0.0",
+  "version": "59.1.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": "a3891d561020d049699296c3cb694e81dd9aa595"
+  "gitHead": "b1b84902b2139a368f54b6ffaee654fe6cb1b03e"
 }

package/types/CozyClient.d.ts

@@ -362,6 +362,7 @@ declare class CozyClient {
     all(doctype: any): QueryDefinition;
     find(doctype: any, selector?: any): QueryDefinition;
     get(doctype: any, id: any): QueryDefinition;
+    validate(document: any): Promise<{}>;
     /**
      * Creates a document and saves it on the server
      *
@@ -387,32 +388,46 @@ declare class CozyClient {
      * @returns {Promise}
      */
     create(type: string, doc: object, references?: import("./types").ReferenceMap, options?: object): Promise<any>;
-    validate(document: any): Promise<{}>;
     /**
-     * Create or update a document on the server
+     * Create multiple documents in one batch.
+     * WARNING: this method is currently not supported by the stack, but
+     * works with PouchDB
+     *
+     * @param  {import("./types").CozyClientDocument[]} docs - Documents to create. Should not have _id nor _rev
+     * @param {object} [options] - options
+     * @returns {Promise}
+     */
+    createAll(docs: import("./types").CozyClientDocument[], options?: object): Promise<any>;
+    /**
+     * Create or update a document
      *
      * @param  {object} doc - Document to save
-     * @param  {object} mutationOptions - Mutation options
+     * @param {object} [options] - options
      * @returns {Promise}
      */
-    save(doc: object, mutationOptions?: object): Promise<any>;
+    save(doc: object, options?: object): Promise<any>;
     /**
-     * Saves multiple documents in one batch
+     * Updates multiple documents in one batch. Should have _id and _rev
+     *
+     * @param  {import("./types").CozyClientDocument[]} docs - Documents from the same doctype
+     * @param {object} [options] - options
+     * @returns {Promise<void>}
+     */
+    updateAll(docs: import("./types").CozyClientDocument[], options?: object): Promise<void>;
+    /**
+     * Create or update multiple documents in one batch
      * - Can only be called with documents from the same doctype
+     * - Can either be creation (no _id nor _rev) or update, not both
      * - Does not support automatic creation of references
      *
+     * WARNING: multiple creations is currently not supported by the stack, but
+     * works with PouchDB
+     *
      * @param  {import("./types").CozyClientDocument[]} docs - Documents from the same doctype
-     * @param  {Object} mutationOptions - Mutation Options
-     * @param  {string}    [mutationOptions.as] - Mutation id
-     * @param  {Function}    [mutationOptions.update] - Function to update the document
-     * @param  {Function}    [mutationOptions.updateQueries] - Function to update queries
+     * @param {object} [options] - options
      * @returns {Promise<void>}
      */
-    saveAll(docs: import("./types").CozyClientDocument[], mutationOptions?: {
-        as?: string;
-        update?: Function;
-        updateQueries?: Function;
-    }): Promise<void>;
+    saveAll(docs: import("./types").CozyClientDocument[], options?: object): Promise<void>;
     /**
      * @param  {import("./types").CozyClientDocument} document - Document that will be saved
      * @param {object} [options={event: DOC_CREATION}] - Event
@@ -456,10 +471,27 @@ declare class CozyClient {
      * Destroys a document. {before,after}:destroy hooks will be fired.
      *
      * @param  {import("./types").CozyClientDocument} document - Document to be deleted
+     * @param {object} [options] - options
      * @returns {Promise<import("./types").CozyClientDocument>} The document that has been deleted
      */
-    destroy(document: import("./types").CozyClientDocument, mutationOptions?: {}): Promise<import("./types").CozyClientDocument>;
-    upload(file: any, dirPath: any, mutationOptions?: {}): Promise<any>;
+    destroy(document: import("./types").CozyClientDocument, options?: object): Promise<import("./types").CozyClientDocument>;
+    /**
+     * Destroy multiple documents
+     *
+     * @param  {Array<import("./types").CozyClientDocument>} documents - Documents to be deleted
+     * @param {object} [options] - options
+     * @returns {Promise<Array<import("./types").CozyClientDocument>>} The deleted documents
+     */
+    destroyAll(documents: Array<import("./types").CozyClientDocument>, options?: object): Promise<Array<import("./types").CozyClientDocument>>;
+    /**
+     * Upload a file
+     *
+     * @param  {File|Blob|import('cozy-stack-client/dist/FileCollection').Stream|string|ArrayBuffer} file - File to be uploaded
+     * @param {string} dirPath - Path to upload the file to. ie : /Administative/XXX/
+     * @param {object} [options] - Optionnal request options
+     * @returns {Promise<object>} Created io.cozy.files
+     */
+    upload(file: File | Blob | import('cozy-stack-client/dist/FileCollection').Stream | string | ArrayBuffer, dirPath: string, options?: object): Promise<object>;
     /**
      * Makes sure that the query exists in the store
      *
@@ -499,17 +531,19 @@ declare class CozyClient {
     /**
      * Mutate a document
      *
-     * @param  {object}    mutationDefinition - Describe the mutation
-     * @param {object} [options] - Options
-     * @param  {string}    [options.as] - Mutation id
-     * @param  {Function}    [options.update] - Function to update the document
-     * @param  {Function}    [options.updateQueries] - Function to update queries
+     * @param  {object} mutationDefinition - Describe the mutation
+     * @param {object} [params] The mutation params
+     * @param {function} [params.update] - update function from MutationOptions
+     * @param {function} [params.updateQueries] - updateQueries function from MutationOptions
+     * @param {string} [params.as] - Mutation id
+     * @param {Object} [params.options={}] - Additional options
      * @returns {Promise}
      */
     mutate(mutationDefinition: object, { update, updateQueries, ...options }?: {
-        as?: string;
         update?: Function;
         updateQueries?: Function;
+        as?: string;
+        options?: any;
     }): Promise<any>;
     /**
      * Executes a query through links and fetches relationships

package/types/queries/dsl.d.ts

@@ -4,6 +4,10 @@ export function createDocument(document: any): {
     mutationType: string;
     document: any;
 };
+export function createDocuments(documents: any): {
+    mutationType: string;
+    documents: any;
+};
 export function updateDocument(document: any): {
     mutationType: string;
     document: any;
@@ -16,6 +20,10 @@ export function deleteDocument(document: any): {
     mutationType: string;
     document: any;
 };
+export function deleteDocuments(documents: any): {
+    mutationType: string;
+    documents: any;
+};
 export function addReferencesTo(document: any, referencedDocuments: any): {
     mutationType: string;
     referencedDocuments: any;
@@ -44,9 +52,11 @@ export function uploadFile(file: any, dirPath: any): {
 export function getDoctypeFromOperation(operation: any): any;
 export namespace Mutations {
     export { createDocument };
+    export { createDocuments };
     export { updateDocument };
     export { updateDocuments };
     export { deleteDocument };
+    export { deleteDocuments };
     export { addReferencesTo };
     export { removeReferencesTo };
     export { addReferencedBy };
@@ -55,9 +65,11 @@ export namespace Mutations {
 }
 export namespace MutationTypes {
     export { CREATE_DOCUMENT };
+    export { CREATE_DOCUMENTS };
     export { UPDATE_DOCUMENT };
     export { UPDATE_DOCUMENTS };
     export { DELETE_DOCUMENT };
+    export { DELETE_DOCUMENTS };
     export { ADD_REFERENCES_TO };
     export { REMOVE_REFERENCES_TO };
     export { ADD_REFERENCED_BY };
@@ -297,9 +309,11 @@ export class QueryDefinition {
     };
 }
 declare const CREATE_DOCUMENT: "CREATE_DOCUMENT";
+declare const CREATE_DOCUMENTS: "CREATE_DOCUMENTS";
 declare const UPDATE_DOCUMENT: "UPDATE_DOCUMENT";
 declare const UPDATE_DOCUMENTS: "UPDATE_DOCUMENTS";
 declare const DELETE_DOCUMENT: "DELETE_DOCUMENT";
+declare const DELETE_DOCUMENTS: "DELETE_DOCUMENTS";
 declare const ADD_REFERENCES_TO: "ADD_REFERENCES_TO";
 declare const REMOVE_REFERENCES_TO: "REMOVE_REFERENCES_TO";
 declare const ADD_REFERENCED_BY: "ADD_REFERENCED_BY";

package/types/types.d.ts

@@ -649,9 +649,18 @@ export type ReferenceMap = {
     [x: string]: Reference[];
 };
 export type MutationOptions = {
-    as?: string;
-    update?: Function;
-    updateQueries?: Function;
+    /**
+     * - Mutation id
+     */
+    as: string;
+    /**
+     * - Function to update the document
+     */
+    update: Function;
+    /**
+     * - Function to update queries
+     */
+    updateQueries: Function;
 };
 export type UpdatedByApp = {
     /**