cozy-client 32.3.2 → 32.3.3

package/dist/CozyClient.js

@@ -189,35 +189,38 @@ var CozyClient = /*#__PURE__*/function () {
     var rawOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     (0, _classCallCheck2.default)(this, CozyClient);
     (0, _defineProperty2.default)(this, "fetchQueryAndGetFromState", /*#__PURE__*/function () {
-      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(query) {
+      var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref) {
+        var definition, options;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                _context.prev = 0;
-                _context.next = 3;
-                return _this.query(query.definition, query.options);
+                definition = _ref.definition, options = _ref.options;
+                _context.prev = 1;
+                _context.next = 4;
+                return _this.query(definition, options);
 
-              case 3:
-                return _context.abrupt("return", _this.getQueryFromState(query.options.as));
+              case 4:
+                return _context.abrupt("return", _this.getQueryFromState(options.as));
 
-              case 6:
-                _context.prev = 6;
-                _context.t0 = _context["catch"](0);
+              case 7:
+                _context.prev = 7;
+                _context.t0 = _context["catch"](1);
                 throw _context.t0;
 
-              case 9:
+              case 10:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, null, [[0, 6]]);
+        }, _callee, null, [[1, 7]]);
       }));
 
       return function (_x) {
-        return _ref.apply(this, arguments);
+        return _ref2.apply(this, arguments);
       };
     }());
+
     var link = rawOptions.link,
         links = rawOptions.links,
         _rawOptions$schema = rawOptions.schema,
@@ -225,15 +228,15 @@ var CozyClient = /*#__PURE__*/function () {
         _rawOptions$appMetada = rawOptions.appMetadata,
         appMetadata = _rawOptions$appMetada === void 0 ? {} : _rawOptions$appMetada,
         capabilities = rawOptions.capabilities,
-        options = (0, _objectWithoutProperties2.default)(rawOptions, ["link", "links", "schema", "appMetadata", "capabilities"]);
+        _options = (0, _objectWithoutProperties2.default)(rawOptions, ["link", "links", "schema", "appMetadata", "capabilities"]);
 
     if (link) {
       console.warn('`link` is deprecated, use `links`');
     }
 
     this.appMetadata = appMetadata;
-    options.uri = securiseUri(options.uri);
-    this.options = options;
+    _options.uri = securiseUri(_options.uri);
+    this.options = _options;
     this.queryIdGenerator = new _queries.QueryIDGenerator();
     this.isLogged = false;
     this.instanceOptions = {}; // Bind handlers
@@ -266,7 +269,7 @@ var CozyClient = /*#__PURE__*/function () {
     } catch (err) {// not a critical error, we may be in node or the instance options are not on the default HTML element
     }
 
-    if (options.uri && options.token) {
+    if (_options.uri && _options.token) {
       this.login();
     }
     /**
@@ -276,7 +279,7 @@ var CozyClient = /*#__PURE__*/function () {
 
     this.storeAccesors = null;
 
-    if (options.store !== false) {
+    if (_options.store !== false) {
       this.ensureStore();
     }
     /**
@@ -951,6 +954,13 @@ var CozyClient = /*#__PURE__*/function () {
 
       return saveAll;
     }()
+    /**
+     * @param  {CozyClientDocument} document - Document that will be saved
+     * @param {object} [options={event: DOC_CREATION}] - Event
+     * @param {string} [options.event] - Mutation type
+     * @returns {CozyClientDocument}
+     */
+
   }, {
     key: "ensureCozyMetadata",
     value: function ensureCozyMetadata(document) {
@@ -1035,7 +1045,7 @@ var CozyClient = /*#__PURE__*/function () {
      * ```
      *
      *
-     * @param  {object} document - Document to create
+     * @param  {CozyClientDocument} document - Document to create
      * @param  {ReferenceMap} [referencesByName] - References to the created document. The
      * relationship class associated to each reference list should support references, otherwise this
      * method will throw.
@@ -1077,10 +1087,10 @@ var CozyClient = /*#__PURE__*/function () {
       return [saveMutation, function (response) {
         var doc = _this3.hydrateDocument(response.data);
 
-        return Object.entries(referencesByName).map(function (_ref2) {
-          var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
-              relName = _ref3[0],
-              references = _ref3[1];
+        return Object.entries(referencesByName).map(function (_ref3) {
+          var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+              relName = _ref4[0],
+              references = _ref4[1];
 
           var relationship = doc[relName];
           return relationship.addReferences(references);
@@ -1217,7 +1227,7 @@ var CozyClient = /*#__PURE__*/function () {
       var _query = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(queryDefinition) {
         var _this4 = this;
 
-        var _ref4,
+        var _ref5,
             update,
             options,
             queryId,
@@ -1230,8 +1240,8 @@ var CozyClient = /*#__PURE__*/function () {
           while (1) {
             switch (_context8.prev = _context8.next) {
               case 0:
-                _ref4 = _args8.length > 1 && _args8[1] !== undefined ? _args8[1] : {};
-                update = _ref4.update, options = (0, _objectWithoutProperties2.default)(_ref4, ["update"]);
+                _ref5 = _args8.length > 1 && _args8[1] !== undefined ? _args8[1] : {};
+                update = _ref5.update, options = (0, _objectWithoutProperties2.default)(_ref5, ["update"]);
                 this.ensureStore();
                 queryId = options.as || this.queryIdGenerator.generateId(queryDefinition);
                 existingQuery = this.getQueryFromState(queryId);
@@ -1449,7 +1459,7 @@ var CozyClient = /*#__PURE__*/function () {
     key: "mutate",
     value: function () {
       var _mutate = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(mutationDefinition) {
-        var _ref5,
+        var _ref6,
             update,
             updateQueries,
             options,
@@ -1461,8 +1471,8 @@ var CozyClient = /*#__PURE__*/function () {
           while (1) {
             switch (_context10.prev = _context10.next) {
               case 0:
-                _ref5 = _args10.length > 1 && _args10[1] !== undefined ? _args10[1] : {};
-                update = _ref5.update, updateQueries = _ref5.updateQueries, options = (0, _objectWithoutProperties2.default)(_ref5, ["update", "updateQueries"]);
+                _ref6 = _args10.length > 1 && _args10[1] !== undefined ? _args10[1] : {};
+                update = _ref6.update, updateQueries = _ref6.updateQueries, options = (0, _objectWithoutProperties2.default)(_ref6, ["update", "updateQueries"]);
                 this.ensureStore();
                 mutationId = options.as || this.queryIdGenerator.generateId(mutationDefinition);
                 this.dispatch((0, _store.initMutation)(mutationId, mutationDefinition));
@@ -1931,6 +1941,8 @@ var CozyClient = /*#__PURE__*/function () {
      * Has a behavior close to <Query /> or useQuery
      *
      * @param {object} query - Query with definition and options
+     * @param {QueryDefinition} query.definition - Query Definition
+     * @param {QueryOptions} query.options - Query Options
      * @returns {Promise<QueryState>} Query state
      */
 
@@ -2053,12 +2065,12 @@ var CozyClient = /*#__PURE__*/function () {
     key: "authorize",
     value: function () {
       var _authorize = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16() {
-        var _ref6,
-            _ref6$openURLCallback,
+        var _ref7,
+            _ref7$openURLCallback,
             openURLCallback,
-            _ref6$sessionCode,
+            _ref7$sessionCode,
             sessionCode,
-            _ref6$pkceCodes,
+            _ref7$pkceCodes,
             pkceCodes,
             codeVerifier,
             codeChallenge,
@@ -2075,7 +2087,7 @@ var CozyClient = /*#__PURE__*/function () {
           while (1) {
             switch (_context16.prev = _context16.next) {
               case 0:
-                _ref6 = _args16.length > 0 && _args16[0] !== undefined ? _args16[0] : {}, _ref6$openURLCallback = _ref6.openURLCallback, openURLCallback = _ref6$openURLCallback === void 0 ? _mobile.authFunction : _ref6$openURLCallback, _ref6$sessionCode = _ref6.sessionCode, sessionCode = _ref6$sessionCode === void 0 ? undefined : _ref6$sessionCode, _ref6$pkceCodes = _ref6.pkceCodes, pkceCodes = _ref6$pkceCodes === void 0 ? {} : _ref6$pkceCodes;
+                _ref7 = _args16.length > 0 && _args16[0] !== undefined ? _args16[0] : {}, _ref7$openURLCallback = _ref7.openURLCallback, openURLCallback = _ref7$openURLCallback === void 0 ? _mobile.authFunction : _ref7$openURLCallback, _ref7$sessionCode = _ref7.sessionCode, sessionCode = _ref7$sessionCode === void 0 ? undefined : _ref7$sessionCode, _ref7$pkceCodes = _ref7.pkceCodes, pkceCodes = _ref7$pkceCodes === void 0 ? {} : _ref7$pkceCodes;
                 _context16.prev = 1;
                 codeVerifier = pkceCodes.codeVerifier, codeChallenge = pkceCodes.codeChallenge;
                 stackClient = this.getStackClient();
@@ -2172,9 +2184,9 @@ var CozyClient = /*#__PURE__*/function () {
   }, {
     key: "setStore",
     value: function setStore(store) {
-      var _ref7 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
-          _ref7$force = _ref7.force,
-          force = _ref7$force === void 0 ? false : _ref7$force;
+      var _ref8 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+          _ref8$force = _ref8.force,
+          force = _ref8$force === void 0 ? false : _ref8$force;
 
       if (store === undefined) {
         throw new Error('Store is undefined');
@@ -2368,10 +2380,10 @@ var CozyClient = /*#__PURE__*/function () {
       var _this10 = this;
 
       this.ensureStore();
-      Object.entries(data).forEach(function (_ref8) {
-        var _ref9 = (0, _slicedToArray2.default)(_ref8, 2),
-            doctype = _ref9[0],
-            data = _ref9[1];
+      Object.entries(data).forEach(function (_ref9) {
+        var _ref10 = (0, _slicedToArray2.default)(_ref9, 2),
+            doctype = _ref10[0],
+            data = _ref10[1];
 
         _this10.dispatch((0, _store.receiveQueryResult)(null, {
           data: data
@@ -2553,7 +2565,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 = "32.3.2";
+CozyClient.version = "32.3.3";
 
 _microee.default.mixin(CozyClient);
 

package/dist/flagship-certification/flagship-certification.js

@@ -17,6 +17,8 @@ var _logger = _interopRequireDefault(require("../logger"));
 
 var _storeAttestation = require("./store-attestation");
 
+var _typedefs = require("./typedefs");
+
 /**
  * Request a challenge from the Stack that can be used to request the app attestation from the app store
  *

package/dist/flagship-certification/store-attestation.android.js

@@ -13,7 +13,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 
 var _reactNativeGoogleSafetynet = _interopRequireDefault(require("react-native-google-safetynet"));
 
-//@ts-ignore
+var _typedefs = require("./typedefs");
+
+//@ts-ignore next-line
 
 /**
  * Retrieve the app's attestation from the Google Play store

package/dist/flagship-certification/store-attestation.ios.js

@@ -13,7 +13,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 
 var _reactNativeIos11Devicecheck = _interopRequireDefault(require("react-native-ios11-devicecheck"));
 
-//@ts-ignore
+var _typedefs = require("./typedefs");
+
+//@ts-ignore next-line
 
 /**
  * Retrieve the app's attestation from the Apple AppStore

package/dist/flagship-certification/store-attestation.js

@@ -11,6 +11,8 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
+var _typedefs = require("./typedefs");
+
 /**
  * Retrieve the app's attestation from the app's store
  * /!\ This is a mock implementation that should never be called

package/dist/flagship-certification/typedefs.js

@@ -1,3 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
 /**
  * @typedef {string} jws - A JSON Web Signature
  */
@@ -17,4 +24,5 @@
  * @typedef {object} CertificationConfig - Configuration to access the stores certification API
  * @property {string} androidSafetyNetApiKey
  */
-"use strict";
+var _default = {};
+exports.default = _default;

package/dist/types.js

@@ -158,6 +158,7 @@ var _dsl = require("./queries/dsl");
  * @property {boolean} [_deleted] - When the document has been deleted
  * @property {ReferencedByRelationship} [relationships] - Relationships of the document
  * @property {Reference[]} [referenced_by] - referenced by of another document
+ * @property {object} [cozyMetadata] - Cozy Metadata
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "32.3.2",
+  "version": "32.3.3",
   "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": "^32.3.2",
+    "cozy-stack-client": "^32.3.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "5517f3f84a4d9d3e129f7bb74ea7d44dd66fa1a0"
+  "gitHead": "e8d0916a43759433221c24dc62c48ca1627b5f96"
 }

package/types/CozyClient.d.ts

@@ -343,9 +343,15 @@ declare class CozyClient {
         update?: Function;
         updateQueries?: Function;
     }): Promise<void>;
-    ensureCozyMetadata(document: any, options?: {
-        event: string;
-    }): any;
+    /**
+     * @param  {CozyClientDocument} document - Document that will be saved
+     * @param {object} [options={event: DOC_CREATION}] - Event
+     * @param {string} [options.event] - Mutation type
+     * @returns {CozyClientDocument}
+     */
+    ensureCozyMetadata(document: CozyClientDocument, options?: {
+        event?: string;
+    }): CozyClientDocument;
     /**
      * Dehydrates and adds metadata before saving a document
      *
@@ -367,14 +373,14 @@ declare class CozyClient {
      * ```
      *
      *
-     * @param  {object} document - Document to create
+     * @param  {CozyClientDocument} document - Document to create
      * @param  {ReferenceMap} [referencesByName] - References to the created document. The
      * relationship class associated to each reference list should support references, otherwise this
      * method will throw.
      *
      * @returns {Mutation[]|Mutation}  One or more mutation to execute
      */
-    getDocumentSavePlan(document: object, referencesByName?: ReferenceMap): Mutation[] | Mutation;
+    getDocumentSavePlan(document: CozyClientDocument, referencesByName?: ReferenceMap): Mutation[] | Mutation;
     triggerHook(name: any, document: any): void;
     /**
      * Destroys a document. {before,after}:destroy hooks will be fired.
@@ -549,9 +555,14 @@ declare class CozyClient {
      * Has a behavior close to <Query /> or useQuery
      *
      * @param {object} query - Query with definition and options
+     * @param {QueryDefinition} query.definition - Query Definition
+     * @param {QueryOptions} query.options - Query Options
      * @returns {Promise<QueryState>} Query state
      */
-    fetchQueryAndGetFromState: (query: object) => Promise<QueryState>;
+    fetchQueryAndGetFromState: ({ definition, options }: {
+        definition: QueryDefinition;
+        options: QueryOptions;
+    }) => Promise<QueryState>;
     /**
      * Performs a complete OAuth flow using a Cordova webview
      * or React Native WebView for auth.

package/types/flagship-certification/flagship-certification.d.ts

@@ -1,2 +1,3 @@
 export function certifyFlagship(certificationConfig: CertificationConfig, client: CozyClient): Promise<void>;
+import { CertificationConfig } from "./typedefs";
 import CozyClient from "../CozyClient";

package/types/flagship-certification/store-attestation.android.d.ts

@@ -1 +1,3 @@
 export function getAppAttestationFromStore(nonce: string, certificationConfig: CertificationConfig): Promise<AttestationResult>;
+import { CertificationConfig } from "./typedefs";
+import { AttestationResult } from "./typedefs";

package/types/flagship-certification/store-attestation.d.ts

@@ -7,3 +7,5 @@
  * @returns {Promise<AttestationResult>} the app's attestation
  */
 export function getAppAttestationFromStore(nonce: string, certificationConfig: CertificationConfig): Promise<AttestationResult>;
+import { CertificationConfig } from "./typedefs";
+import { AttestationResult } from "./typedefs";

package/types/flagship-certification/store-attestation.ios.d.ts

@@ -1 +1,3 @@
 export function getAppAttestationFromStore(nonce: string, certificationConfig: CertificationConfig): Promise<AttestationResult>;
+import { CertificationConfig } from "./typedefs";
+import { AttestationResult } from "./typedefs";

package/types/flagship-certification/typedefs.d.ts

@@ -1,15 +1,17 @@
+declare var _default: {};
+export default _default;
 /**
  * - A JSON Web Signature
  */
-type jws = string;
+export type jws = string;
 /**
  * - A JSON Web Signature
  */
-type base64string = string;
+export type base64string = string;
 /**
  * - An app attestation from the app store
  */
-type AttestationResult = {
+export type AttestationResult = {
     platform: string;
     attestation: jws | base64string;
     keyId?: string;
@@ -17,6 +19,6 @@ type AttestationResult = {
 /**
  * - Configuration to access the stores certification API
  */
-type CertificationConfig = {
+export type CertificationConfig = {
     androidSafetyNetApiKey: string;
 };

package/types/types.d.ts

@@ -164,6 +164,10 @@ export type CozyClientDocument = {
      * - referenced by of another document
      */
     referenced_by?: Reference[];
+    /**
+     * - Cozy Metadata
+     */
+    cozyMetadata?: object;
 };
 /**
  * - An io.cozy.files document