cozy-client 38.9.1 → 38.10.0

package/dist/CozyClient.js

@@ -2677,7 +2677,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 = "38.9.1";
+CozyClient.version = "38.10.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/index.js

@@ -5,7 +5,7 @@ var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWild
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.paper = exports.dacc = exports.sharing = exports.timeseries = exports.document = exports.contact = exports.utils = exports.permission = exports.note = exports.account = exports.folder = exports.file = exports.applications = exports.instance = exports.trigger = exports.accounts = exports.triggers = void 0;
+exports.user = exports.paper = exports.dacc = exports.sharing = exports.timeseries = exports.document = exports.contact = exports.utils = exports.permission = exports.note = exports.account = exports.folder = exports.file = exports.applications = exports.instance = exports.trigger = exports.accounts = exports.triggers = void 0;
 
 var trigger = _interopRequireWildcard(require("./trigger"));
 
@@ -66,6 +66,10 @@ exports.dacc = dacc;
 var paper = _interopRequireWildcard(require("./paper"));
 
 exports.paper = paper;
+
+var user = _interopRequireWildcard(require("./user"));
+
+exports.user = user;
 // For backward compatibility before 9.0.0
 var triggers = trigger;
 exports.triggers = triggers;

package/dist/models/instance.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.hasPasswordDefinedAttribute = exports.buildPremiumLink = exports.hasAnOffer = exports.shouldDisplayOffers = exports.getUuid = exports.isFreemiumUser = exports.arePremiumLinksEnabled = exports.isSelfHosted = void 0;
+exports.makeDiskInfos = exports.hasPasswordDefinedAttribute = exports.buildPremiumLink = exports.hasAnOffer = exports.shouldDisplayOffers = exports.getUuid = exports.isFreemiumUser = exports.arePremiumLinksEnabled = exports.isSelfHosted = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -15,6 +15,7 @@ var _get = _interopRequireDefault(require("lodash/get"));
 
 var _dsl = require("../queries/dsl");
 
+var FallbackQuota = 1e11;
 var GB = 1000 * 1000 * 1000;
 var PREMIUM_QUOTA = 50 * GB;
 /**
@@ -148,5 +149,83 @@ var hasPasswordDefinedAttribute = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
+/**
+ * @typedef DiskInfosRaw
+ * @property diskQuota {number} - Space used in GB
+ * @property diskUsage {number} -  Maximum space available in GB
+ * @property percentUsage {number} - Usage percent of the disk
+ */
+
+/**
+ * @typedef DiskInfos
+ * @property humanDiskQuota {string} - Space used in GB rounded
+ * @property humanDiskUsage {string} - Maximum space available in GB rounded
+ * @property percentUsage {string} - Usage percent of the disk rounded
+ */
+
+/**
+ * Convert input value into GB
+ *
+ * @param {number} bytes - Value in bytes
+ * @returns {number} - Returns the value in GB
+ */
+
+
+exports.hasPasswordDefinedAttribute = hasPasswordDefinedAttribute;
+
+var convertBytesToGB = function convertBytesToGB(bytes) {
+  return bytes * 1e-9;
+};
+/**
+ * Computes `value` rounded to `fractionDigits`.
+ *
+ * @param {number} value - Value to format
+ * @param {number} fractionDigits - Number of decimal numbers
+ * @returns {string} - Returns the rounded number as a string
+ */
+
+
+var formatDecimals = function formatDecimals(value) {
+  var fractionDigits = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 2;
+  return "".concat(value % 1 ? value.toFixed(fractionDigits) : value);
+};
+/**
+ * Transform bytes data to GB data and compute percent usage
+ *
+ * @param {number} usage - Value in bytes representing the space used
+ * @param {number} quota - Value in bytes representing the maximum space available
+ * @returns {DiskInfosRaw} - Returns an transform data to GB and usage percent of the disk
+ */
+
+
+var computeDiskInfos = function computeDiskInfos(usage) {
+  var quota = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : FallbackQuota;
+  return {
+    diskQuota: convertBytesToGB(quota),
+    diskUsage: convertBytesToGB(usage),
+    percentUsage: usage / quota * 100
+  };
+};
+/**
+ * Make human readable information from disk information (usage, quota)
+ *
+ * @param {number|string} usage - Value in bytes representing the space used
+ * @param {number|string} [quota] - Value in bytes representing the maximum space available
+ * @returns {DiskInfos} - Return a set of human readable information about disk
+ */
+
+
+var makeDiskInfos = function makeDiskInfos(usage, quota) {
+  var _computeDiskInfos = computeDiskInfos(+usage, quota ? +quota : undefined),
+      diskQuota = _computeDiskInfos.diskQuota,
+      diskUsage = _computeDiskInfos.diskUsage,
+      percentUsage = _computeDiskInfos.percentUsage;
+
+  return {
+    humanDiskQuota: formatDecimals(diskQuota),
+    humanDiskUsage: formatDecimals(diskUsage),
+    percentUsage: Math.round(percentUsage).toString()
+  };
+};
 
-exports.hasPasswordDefinedAttribute = hasPasswordDefinedAttribute;
+exports.makeDiskInfos = makeDiskInfos;

package/dist/models/instance.spec.js

@@ -102,4 +102,49 @@ describe('instance', () => {
     expect(instance.hasAnOffer(hadAnOfferInstance)).toBe(true)
     expect(instance.hasAnOffer(selftHostedInstance)).toBe(false)
   })
+
+  describe('makeDiskInfos', () => {
+    it('computes disk percent with a quota', () => {
+      expect(instance.makeDiskInfos('0', '5000000000')).toStrictEqual({
+        humanDiskQuota: '5',
+        humanDiskUsage: '0',
+        percentUsage: '0'
+      })
+      expect(instance.makeDiskInfos('115600793', '5000000000')).toStrictEqual({
+        humanDiskQuota: '5',
+        humanDiskUsage: '0.12',
+        percentUsage: '2'
+      })
+      expect(
+        instance.makeDiskInfos('22115600793', '90000000000')
+      ).toStrictEqual({
+        humanDiskQuota: '90',
+        humanDiskUsage: '22.12',
+        percentUsage: '25'
+      })
+      expect(instance.makeDiskInfos('5000000000', '5000000000')).toStrictEqual({
+        humanDiskQuota: '5',
+        humanDiskUsage: '5',
+        percentUsage: '100'
+      })
+    })
+
+    it('computes disk percent without a quota', () => {
+      expect(instance.makeDiskInfos('1156007930', '')).toStrictEqual({
+        humanDiskQuota: '100',
+        humanDiskUsage: '1.16',
+        percentUsage: '1'
+      })
+      expect(instance.makeDiskInfos('0', undefined)).toStrictEqual({
+        humanDiskQuota: '100',
+        humanDiskUsage: '0',
+        percentUsage: '0'
+      })
+      expect(instance.makeDiskInfos('0', 0)).toStrictEqual({
+        humanDiskQuota: '100',
+        humanDiskUsage: '0',
+        percentUsage: '0'
+      })
+    })
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "38.9.1",
+  "version": "38.10.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": "^38.7.1",
+    "cozy-stack-client": "^38.9.2",
     "date-fns": "2.29.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "1cbcf96b66232b564d465ea9878ab2fee96fa403"
+  "gitHead": "a2a811593b4181f559583c994a91d95cf3f7e289"
 }

package/types/models/index.d.ts

@@ -15,4 +15,5 @@ import * as timeseries from "./timeseries";
 import * as sharing from "./sharing";
 import * as dacc from "./dacc";
 import * as paper from "./paper";
-export { trigger, instance, applications, file, folder, note, account, permission, utils, contact, document, timeseries, sharing, dacc, paper };
+import * as user from "./user";
+export { trigger, instance, applications, file, folder, note, account, permission, utils, contact, document, timeseries, sharing, dacc, paper, user };

package/types/models/instance.d.ts

@@ -6,6 +6,7 @@ export function shouldDisplayOffers(data: SettingsInfo): boolean;
 export function hasAnOffer(data: SettingsInfo): boolean;
 export function buildPremiumLink(instanceInfo: InstanceInfo): string;
 export function hasPasswordDefinedAttribute(client: import("../CozyClient").default): Promise<boolean>;
+export function makeDiskInfos(usage: number | string, quota?: number | string): DiskInfos;
 export type InstanceInfo = any;
 export type ContextInfo = any;
 export type DiskUsageInfo = any;
@@ -23,3 +24,31 @@ export type SettingsInfo = {
      */
     diskUsage: DiskUsageInfo;
 };
+export type DiskInfosRaw = {
+    /**
+     * - Space used in GB
+     */
+    diskQuota: number;
+    /**
+     * -  Maximum space available in GB
+     */
+    diskUsage: number;
+    /**
+     * - Usage percent of the disk
+     */
+    percentUsage: number;
+};
+export type DiskInfos = {
+    /**
+     * - Space used in GB rounded
+     */
+    humanDiskQuota: string;
+    /**
+     * - Maximum space available in GB rounded
+     */
+    humanDiskUsage: string;
+    /**
+     * - Usage percent of the disk rounded
+     */
+    percentUsage: string;
+};