cozy-client 27.24.0 → 27.25.0

package/dist/CozyClient.js

@@ -2537,7 +2537,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 = "27.24.0";
+CozyClient.version = "27.25.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/dacc.js

@@ -0,0 +1,109 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sendMeasureToDACC = exports.checkMeasureParams = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _cozyLogger = _interopRequireDefault(require("cozy-logger"));
+
+var _types = require("../types");
+
+/**
+ * Throw an errror if a DACC parameter is incorrect.
+ *
+ * @param { DACCMeasure} measure - The DACC measure
+ */
+var checkMeasureParams = function checkMeasureParams(measure) {
+  var createdBy = measure.createdBy,
+      measureName = measure.measureName,
+      startDate = measure.startDate,
+      value = measure.value,
+      group1 = measure.group1,
+      group2 = measure.group2,
+      group3 = measure.group3;
+
+  if (!createdBy || typeof createdBy !== 'string') {
+    throw new Error('Missing or wrong type parameter: createdBy');
+  }
+
+  if (!measureName || typeof measureName !== 'string') {
+    throw new Error('Missing or wrong type parameter: measureName');
+  }
+
+  if (!startDate) {
+    throw new Error('Missing parameter: startDate');
+  }
+
+  var parsedDate = new Date(Date.parse(startDate));
+
+  if (!parsedDate.toISOString().startsWith(startDate)) {
+    throw new Error('Date should be in YYYY-MM-DD format');
+  }
+
+  if (!value || typeof value !== 'number') {
+    throw new Error('Missing or wrong type parameter: value');
+  }
+
+  if (group1 && (typeof group1 !== 'object' || Object.keys(group1).length === 0) || group2 && (typeof group2 !== 'object' || Object.keys(group2).length === 0) || group3 && (typeof group3 !== 'object' || Object.keys(group3).length === 0)) {
+    throw new Error('Groups should be key-value objects');
+  }
+
+  if (group3 && (!group2 || !group1) || group2 && !group1) {
+    throw new Error('Group order must be respected');
+  }
+};
+/**
+ * Send measures to a DACC through a remote doctype
+ *
+ * @param {object} client - The CozyClient instance
+ * @param {string} remoteDoctype - The remote doctype to use
+ * @param {DACCMeasure} measure - The DACC measure
+ */
+
+
+exports.checkMeasureParams = checkMeasureParams;
+
+var sendMeasureToDACC = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, remoteDoctype, measure) {
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.prev = 0;
+            checkMeasureParams(measure);
+            _context.next = 4;
+            return client.getStackClient().fetchJSON('POST', "/remote/".concat(remoteDoctype), {
+              data: JSON.stringify(measure)
+            });
+
+          case 4:
+            _context.next = 10;
+            break;
+
+          case 6:
+            _context.prev = 6;
+            _context.t0 = _context["catch"](0);
+            (0, _cozyLogger.default)('error', "Error while sending measure to remote doctype: ".concat(_context.t0.message));
+            throw _context.t0;
+
+          case 10:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[0, 6]]);
+  }));
+
+  return function sendMeasureToDACC(_x, _x2, _x3) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.sendMeasureToDACC = sendMeasureToDACC;

package/dist/models/dacc.spec.js

@@ -0,0 +1,99 @@
+import { checkMeasureParams } from './dacc'
+
+describe('dacc', () => {
+  const measure = {
+    value: 42,
+    measureName: 'theanswer',
+    startDate: '2022-01-01',
+    createdBy: 'DeepThought'
+  }
+
+  it('should not throw when all params are corrects', () => {
+    expect(() => checkMeasureParams(measure)).not.toThrow()
+  })
+
+  it('should not throw when all params are corrects with groups', () => {
+    const measureWithGroups = {
+      ...measure,
+      group1: { a: 1 },
+      group2: { b: 1 },
+      group3: { c: 1 }
+    }
+    expect(() => checkMeasureParams(measureWithGroups)).not.toThrow()
+  })
+
+  it('should throw an error when createdBy is missing or malformed', () => {
+    expect(() => checkMeasureParams({ ...measure, createdBy: null })).toThrow()
+    expect(() => checkMeasureParams({ ...measure, createdBy: 123 })).toThrow()
+  })
+
+  it('should throw an error when value is missing or malformed', () => {
+    expect(() => checkMeasureParams({ ...measure, value: null })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, value: 'notacorrectvalue' })
+    ).toThrow()
+  })
+
+  it('should throw an error when measureName is missing or malformed', () => {
+    expect(() =>
+      checkMeasureParams({ ...measure, measureName: null })
+    ).toThrow()
+    expect(() => checkMeasureParams({ ...measure, measureName: 10 })).toThrow()
+  })
+
+  it('should throw an error when startDate is missing or malformed', () => {
+    expect(() => checkMeasureParams({ ...measure, startDate: null })).toThrow()
+    expect(() => checkMeasureParams({ ...measure, startDate: 123 })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, startDate: '01 January 2012' })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, startDate: '2022:01:01' })
+    ).toThrow()
+  })
+
+  it('should throw an error when groups are not objects', () => {
+    expect(() => checkMeasureParams({ ...measure, group1: '123' })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, group1: { a: 1 }, group2: '456' })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({
+        ...measure,
+        group1: { a: 1 },
+        group2: { b: 1 },
+        group3: '789'
+      })
+    ).toThrow()
+  })
+
+  it('should throw an error when groups are empty objects', () => {
+    expect(() => checkMeasureParams({ ...measure, group1: {} })).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, group1: { a: 1 }, group2: {} })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({
+        ...measure,
+        group1: { a: 1 },
+        group2: { b: 1 },
+        group3: {}
+      })
+    ).toThrow()
+  })
+
+  it('should throw an error when groups order is not respected', () => {
+    expect(() => checkMeasureParams({ ...measure, group2: { b: 1 } })).toThrow()
+    expect(() => checkMeasureParams({ ...measure, group3: { c: 1 } })).toThrow()
+    expect(() =>
+      checkMeasureParams({
+        ...measure,
+        group1: { a: 1 },
+        group3: { c: 1 }
+      })
+    ).toThrow()
+    expect(() =>
+      checkMeasureParams({ ...measure, group2: { b: 1 }, group3: { c: 1 } })
+    ).toThrow()
+  })
+})

package/dist/types.js

@@ -308,6 +308,19 @@ var _dsl = require("./queries/dsl");
  * @typedef {IdentityLabel|FamilyLabel|WorkStudyLabels|HealthLabels|HomeLabels|TransportLabels|FinanceLabels|InvoiceLabels|ActivityLabels} ItemsLabels
  */
 
+/**
+ * @typedef {object} DACCMeasure
+ * See https://github.com/cozy/DACC
+ *
+ * @property {string} measureName - It must match an existing measure name on the DACC server
+ * @property {string} startDate - Start of the aggregation period. Should be in YYYY-MM-DD format
+ * @property {number} value - The measured value on the aggregation period
+ * @property {string} createdBy - The slug of the app creating the measure
+ * @property {object} group1 - Should be a {key: value} where the key is set in the measure definition.
+ * @property {object} group2 - Should be a {key: value} where the key is set in the measure definition.
+ * @property {object} group3 - Should be a {key: value} where the key is set in the measure definition.
+ */
+
 /**
  * Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.24.0",
+  "version": "27.25.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -71,5 +71,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "1b797059e18e7acfca9666ae8292dabe05a4eaff"
+  "gitHead": "5fdb483852d6bd711dac46ff00734b853d118741"
 }