cozy-client 46.7.1 → 46.9.0

package/dist/helpers/settings.spec.js

@@ -0,0 +1,493 @@
+import {
+  editSettings,
+  getSettings,
+  normalizeSettings,
+  saveAfterFetchSettings
+} from './settings'
+import { Q } from '../queries/dsl'
+
+import * as mocks from '../__tests__/mocks'
+
+describe('settings', () => {
+  describe('getSettings', () => {
+    it('should get settings for cozy-home', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            some_key: 'some_value'
+          }
+        ]
+      })
+
+      // @ts-ignore
+      const result = await getSettings(client, 'home', ['some_key'])
+
+      const query = {
+        definition: Q('io.cozy.home.settings').limitBy(1),
+        options: {
+          as: 'io.cozy.home.settings',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(result.some_key).toEqual('some_value')
+    })
+
+    it('should get settings for mespapiers', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            some_mespapiers_key: 'some_mespapiers_value'
+          }
+        ]
+      })
+
+      const result = await getSettings(
+        // @ts-ignore
+        client,
+        'mespapiers',
+        ['some_mespapiers_key']
+      )
+
+      const query = {
+        definition: Q('io.cozy.mespapiers.settings').limitBy(1),
+        options: {
+          as: 'io.cozy.mespapiers.settings',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(result.some_mespapiers_key).toEqual('some_mespapiers_value')
+    })
+
+    it('should get settings for instance', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            some_global_key: 'some_global_value'
+          }
+        ]
+      })
+
+      // @ts-ignore
+      const result = await getSettings(client, 'instance', ['some_global_key'])
+
+      const query = {
+        definition: Q('io.cozy.settings').getById('io.cozy.settings.instance'),
+        options: {
+          as: 'io.cozy.settings/io.cozy.settings.instance',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(result.some_global_key).toEqual('some_global_value')
+    })
+
+    it('should get settings for passwords', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            some_pass_key: 'some_pass_value'
+          }
+        ]
+      })
+
+      // @ts-ignore
+      const result = await getSettings(client, 'passwords', ['some_pass_key'])
+
+      const query = {
+        definition: Q('io.cozy.settings').getById('io.cozy.settings.bitwarden'),
+        options: {
+          as: 'io.cozy.settings/io.cozy.settings.bitwarden',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(result.some_pass_key).toEqual('some_pass_value')
+    })
+
+    it('should return undefined if no setting is found in database', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            some_other_key: 'some_other_value'
+          }
+        ]
+      })
+
+      // @ts-ignore
+      const result = await getSettings(client, 'home', ['some_key'])
+
+      expect(result.some_key).toBeUndefined()
+    })
+
+    it('should get settings for multiple keys', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            some_key_1: 'some_value_1',
+            some_key_2: 'some_value_2',
+            some_key_3: 'some_value_3'
+          }
+        ]
+      })
+
+      // @ts-ignore
+      const result = await getSettings(client, 'home', [
+        'some_key_1',
+        'some_key_2'
+      ])
+
+      const query = {
+        definition: Q('io.cozy.home.settings').limitBy(1),
+        options: {
+          as: 'io.cozy.home.settings',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(result.some_key_1).toEqual('some_value_1')
+      expect(result.some_key_2).toEqual('some_value_2')
+      // @ts-ignore
+      expect(result.some_key_3).toBeUndefined()
+    })
+  })
+
+  describe('saveAfterFetchSettings', () => {
+    it('should set settings for instance', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            id: 'io.cozy.settings.instance',
+            _id: 'io.cozy.settings.instance',
+            _type: 'io.cozy.settings',
+            type: 'io.cozy.settings',
+            attributes: {
+              some_setting: 'some_setting_value',
+              some_instance_key: 'some_instance_value'
+            },
+            meta: {
+              rev: 'SOME_UNIQ_REV_NUMBER'
+            },
+            some_setting: 'some_setting_value',
+            some_instance_key: 'some_instance_value'
+          }
+        ]
+      })
+
+      await saveAfterFetchSettings(
+        // @ts-ignore
+        client,
+        'instance',
+        {
+          some_instance_key: 'some_new_instance_value'
+        }
+      )
+
+      const query = {
+        definition: Q('io.cozy.settings').getById('io.cozy.settings.instance'),
+        options: {
+          as: 'io.cozy.settings/io.cozy.settings.instance',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(client.save).toHaveBeenCalledWith({
+        id: 'io.cozy.settings.instance',
+        _id: 'io.cozy.settings.instance',
+        _type: 'io.cozy.settings',
+        type: 'io.cozy.settings',
+        _rev: 'SOME_UNIQ_REV_NUMBER',
+        attributes: {
+          some_setting: 'some_setting_value',
+          some_instance_key: 'some_new_instance_value'
+        },
+        some_setting: 'some_setting_value',
+        some_instance_key: 'some_new_instance_value',
+        meta: {
+          rev: 'SOME_UNIQ_REV_NUMBER'
+        }
+      })
+    })
+
+    it('should set settings for passwords', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            _type: 'io.cozy.passwords.settings',
+            some_pass_key: 'some_pass_value'
+          }
+        ]
+      })
+
+      await saveAfterFetchSettings(
+        // @ts-ignore
+        client,
+        'passwords',
+        { some_pass_key: 'some_new_pass_value' }
+      )
+
+      const query = {
+        definition: Q('io.cozy.settings').getById('io.cozy.settings.bitwarden'),
+        options: {
+          as: 'io.cozy.settings/io.cozy.settings.bitwarden',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(client.save).toHaveBeenCalledWith({
+        _type: 'io.cozy.passwords.settings',
+        some_pass_key: 'some_new_pass_value'
+      })
+    })
+
+    it('should set settings for passwords even if key does not exist', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            _type: 'io.cozy.passwords.settings',
+            some_existing_pass_key: 'some_pass_value'
+          }
+        ]
+      })
+
+      await saveAfterFetchSettings(
+        // @ts-ignore
+        client,
+        'passwords',
+        { some_new_pass_key: 'some_new_pass_value' }
+      )
+
+      const query = {
+        definition: Q('io.cozy.settings').getById('io.cozy.settings.bitwarden'),
+        options: {
+          as: 'io.cozy.settings/io.cozy.settings.bitwarden',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(client.save).toHaveBeenCalledWith({
+        _type: 'io.cozy.passwords.settings',
+        some_existing_pass_key: 'some_pass_value',
+        some_new_pass_key: 'some_new_pass_value'
+      })
+    })
+
+    it('should set settings for passwords using method', async () => {
+      const client = mocks.client()
+
+      client.fetchQueryAndGetFromState.mockResolvedValue({
+        data: [
+          {
+            _type: 'io.cozy.passwords.settings',
+            some_pass_key: 1
+          }
+        ]
+      })
+
+      await saveAfterFetchSettings(
+        // @ts-ignore
+        client,
+        'passwords',
+        currentValue => ({
+          ...currentValue,
+          some_pass_key: currentValue.some_pass_key + 1
+        }),
+        ['some_pass_key']
+      )
+
+      const query = {
+        definition: Q('io.cozy.settings').getById('io.cozy.settings.bitwarden'),
+        options: {
+          as: 'io.cozy.settings/io.cozy.settings.bitwarden',
+          fetchPolicy: expect.anything(),
+          singleDocData: true
+        }
+      }
+      expect(client.fetchQueryAndGetFromState).toHaveBeenCalledWith({
+        definition: query.definition,
+        options: query.options
+      })
+      expect(client.save).toHaveBeenCalledWith({
+        _type: 'io.cozy.passwords.settings',
+        some_pass_key: 2
+      })
+    })
+  })
+
+  describe('normalizeSettings', () => {
+    it('should normalize data array into object', () => {
+      const result = normalizeSettings([
+        {
+          id: 'SOME_DOCUMENT_ID',
+          _id: 'SOME_DOCUMENT_ID',
+          _type: 'io.cozy.home.settings',
+          _rev: 'SOME_DOCUMENT_REV',
+          cozyMetadata: {
+            createdAt: '2024-04-03T15:00:48.961Z',
+            metadataVersion: 1,
+            updatedAt: '2024-04-03T15:00:48.961Z',
+            updatedByApps: []
+          },
+          some_attribue: true
+        }
+      ])
+
+      expect(result).toStrictEqual({
+        id: 'SOME_DOCUMENT_ID',
+        _id: 'SOME_DOCUMENT_ID',
+        _type: 'io.cozy.home.settings',
+        _rev: 'SOME_DOCUMENT_REV',
+        cozyMetadata: {
+          createdAt: '2024-04-03T15:00:48.961Z',
+          metadataVersion: 1,
+          updatedAt: '2024-04-03T15:00:48.961Z',
+          updatedByApps: []
+        },
+        some_attribue: true
+      })
+    })
+
+    it('should normalize data object into object', () => {
+      const result = normalizeSettings({
+        id: 'io.cozy.settings.instance',
+        _id: 'io.cozy.settings.instance',
+        _type: 'io.cozy.settings',
+        type: 'io.cozy.settings',
+        attributes: {
+          some_attributes: 'some_value'
+        },
+        meta: {
+          rev: '2-8803d6fda4bd3216e3fbeb0a181979d5'
+        },
+        links: {
+          self: '/settings/instance'
+        },
+        some_attributes: 'some_value'
+      })
+
+      expect(result).toStrictEqual({
+        id: 'io.cozy.settings.instance',
+        _id: 'io.cozy.settings.instance',
+        _type: 'io.cozy.settings',
+        type: 'io.cozy.settings',
+        attributes: {
+          some_attributes: 'some_value'
+        },
+        meta: {
+          rev: '2-8803d6fda4bd3216e3fbeb0a181979d5'
+        },
+        links: {
+          self: '/settings/instance'
+        },
+        some_attributes: 'some_value'
+      })
+    })
+  })
+  describe('editSettings', () => {
+    it('should inject value into settings', () => {
+      const result = editSettings(
+        'passwords',
+        {
+          _type: 'io.cozy.passwords.settings',
+          some_pass_key: 'some_pass_value'
+        },
+        { some_pass_key: 'some_new_pass_value' }
+      )
+
+      expect(result).toStrictEqual({
+        _type: 'io.cozy.passwords.settings',
+        some_pass_key: 'some_new_pass_value'
+      })
+    })
+
+    it('should inject _rev value and edit attributes for instance settings', () => {
+      const result = editSettings(
+        'instance',
+        {
+          id: 'io.cozy.settings.instance',
+          _id: 'io.cozy.settings.instance',
+          _type: 'io.cozy.settings',
+          type: 'io.cozy.settings',
+          attributes: {
+            some_setting: 'some_setting_value',
+            some_instance_key: 'some_instance_value'
+          },
+          meta: {
+            rev: 'SOME_UNIQ_REV_NUMBER'
+          },
+          some_setting: 'some_setting_value',
+          some_instance_key: 'some_instance_value'
+        },
+        { some_instance_key: 'some_new_instance_value' }
+      )
+
+      expect(result).toStrictEqual({
+        id: 'io.cozy.settings.instance',
+        _id: 'io.cozy.settings.instance',
+        _type: 'io.cozy.settings',
+        type: 'io.cozy.settings',
+        _rev: 'SOME_UNIQ_REV_NUMBER',
+        attributes: {
+          some_setting: 'some_setting_value',
+          some_instance_key: 'some_new_instance_value'
+        },
+        some_setting: 'some_setting_value',
+        some_instance_key: 'some_new_instance_value',
+        meta: {
+          rev: 'SOME_UNIQ_REV_NUMBER'
+        }
+      })
+    })
+  })
+})

package/dist/hooks/index.js

@@ -67,6 +67,12 @@ Object.defineProperty(exports, "useInstanceInfo", {
     return _useInstanceInfo.useInstanceInfo;
   }
 });
+Object.defineProperty(exports, "useSettings", {
+  enumerable: true,
+  get: function get() {
+    return _useSetting.useSettings;
+  }
+});
 
 var _useAppLinkWithStoreFallback = _interopRequireDefault(require("./useAppLinkWithStoreFallback"));
 
@@ -84,4 +90,6 @@ var _useQueryAll = _interopRequireDefault(require("./useQueryAll"));
 
 var _useMutation = require("./useMutation");
 
-var _useInstanceInfo = require("./useInstanceInfo");
+var _useInstanceInfo = require("./useInstanceInfo");
+
+var _useSetting = require("./useSetting");

package/dist/hooks/useSetting.js

@@ -0,0 +1,64 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useSettings = void 0;
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = require("react");
+
+var _helpers = require("../helpers");
+
+var _useMutation2 = require("./useMutation");
+
+var _useQuery2 = _interopRequireDefault(require("./useQuery"));
+
+var _utils = require("../utils");
+
+var _settings = require("../helpers/settings");
+
+/**
+ * Query the cozy-app settings corresponding to the given slug and
+ * return:
+ * - the values corresponding to the given `keys`
+ * - the `save()` method that can be used to edit the setting's value
+ * - the query that manages the state during the fetching of the setting
+ * - the mutation that manages the state during the saving of the setting
+ *
+ * @template {string} T
+ *
+ * @param {string} slug - the cozy-app's slug containing the setting (special cases are: 'instance' for global settings and 'passwords' for bitwarden settings)
+ * @param {T[]} keys - The name of the setting to retrieve
+ * @returns {import("../types").UseSettingsReturnValue<T>}
+ */
+var useSettings = function useSettings(slug, keys) {
+  var query = (0, _helpers.getQuery)(slug);
+
+  var _useQuery = (0, _useQuery2.default)(query.definition, query.options),
+      settingsData = _useQuery.data,
+      settingsQuery = (0, _objectWithoutProperties2.default)(_useQuery, ["data"]);
+
+  var _useMutation = (0, _useMutation2.useMutation)(),
+      mutate = _useMutation.mutate,
+      mutation = (0, _objectWithoutProperties2.default)(_useMutation, ["mutate"]);
+
+  var save = (0, _react.useCallback)(function (items) {
+    var settings = (0, _helpers.normalizeSettings)(settingsData);
+    var newSettings = (0, _helpers.editSettings)(slug, settings, items);
+    return mutate(newSettings);
+  }, [mutate, settingsData, slug]);
+  var settings = (0, _helpers.normalizeSettings)(settingsData);
+  var settingValue = (0, _utils.hasQueryBeenLoaded)(settingsQuery) ? (0, _settings.extractKeys)(settings, keys) : undefined;
+  return {
+    query: settingsQuery,
+    values: settingValue,
+    save: save,
+    mutation: mutation
+  };
+};
+
+exports.useSettings = useSettings;

package/dist/models/document/locales/fr.json

@@ -62,7 +62,7 @@
       "mechanic_invoice": "Facture de réparation |||| Factures de réparation",
       "motivation_letter": "Lettre de motivation |||| Lettres de motivation",
       "national_health_insurance_card": "Carte vitale |||| Cartes vitales",
-      "national_health_insurance_right_certificate": "Attestation de droits de l'Assurance Maladie (vitale) |||| Attestations de droits de l'Assurance Maladie (vitale)",
+      "national_health_insurance_right_certificate": "Attestation de droits de l'Assurance Maladie |||| Attestations de droits de l'Assurance Maladie",
       "national_id_card": "Carte d'identité |||| Cartes d'identité",
       "note_identity_document": "Note Identité |||| Notes Identité",
       "note_family_document": "Note Famille |||| Notes Famille",

package/dist/types.js

@@ -250,7 +250,7 @@ var _dsl = require("./queries/dsl");
  */
 
 /**
- * @typedef {object} QueryState
+ * @typedef {object} QueryStateWithoutData
  * @property {string} id
  * @property {QueryDefinition} definition
  * @property {QueryFetchStatus} fetchStatus
@@ -262,12 +262,20 @@ var _dsl = require("./queries/dsl");
  * @property {boolean} hasMore
  * @property {number} count
  * @property {number} fetchedPagesCount
- * @property {object|Array} data
  * @property {string} bookmark
  * @property {object} [execution_stats]
  * @property {QueryOptions} [options]
  */
 
+/**
+ * @typedef {object} QueryStateData
+ * @property {object|Array} data
+ */
+
+/**
+ * @typedef {QueryStateWithoutData & QueryStateData} QueryState
+ */
+
 /**
  * @typedef {object} AutoUpdateOptions
  * @param {boolean} update - Should documents be updated in the query (default: true)
@@ -290,6 +298,12 @@ var _dsl = require("./queries/dsl");
  * compatibility but will be set to true in the future.
  */
 
+/**
+ * @typedef {object} Query
+ * @property {QueryDefinition} definition
+ * @property {QueryOptions} options
+ */
+
 /**
  * @typedef {object} FetchMoreAble
  * @property {Function} fetchMore
@@ -305,13 +319,39 @@ var _dsl = require("./queries/dsl");
  */
 
 /**
- * @typedef {object} UseMutationReturnValue
- * @property {Function} mutate - Function to save the document
+ * @typedef {object} UseMutationWithoutMutate
  * @property {QueryFetchStatus} mutationStatus - Status of the current mutation
  * @property {object} [error] - Error if the mutation failed
  * @property {object} [data] - Data return after the mutation
  */
 
+/**
+ * @typedef {object} UseMutationMutate
+ * @property {Function} mutate - Function to save the document
+ */
+
+/**
+ * @typedef {UseMutationWithoutMutate & UseMutationMutate} UseMutationReturnValue
+ */
+
+/**
+ * Update the setting with corresponding value and save it.
+ *
+ * @template {string} T
+ *
+ * @callback SaveSettingsFunction
+ * @param {Partial<Record<T, any>>} items - The new setting's value
+ */
+
+/**
+ * @template {string} T
+ * @typedef {object} UseSettingsReturnValue
+ * @property {Record<T, any> | undefined} values - The setting's value
+ * @property {SaveSettingsFunction<T>} save - Function to edit the setting
+ * @property {QueryStateWithoutData} query - Function to edit the setting
+ * @property {UseMutationWithoutMutate} mutation - Status of the current mutation
+ */
+
 /**
  * A reference to a document
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "46.7.1",
+  "version": "46.9.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -75,5 +75,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "462bc3a07416daf84b5b14beac5e1f06000d162a"
+  "gitHead": "69f0df2adc776ecec40b14eaae495b544d42963f"
 }