cozy-client 43.2.0 → 43.3.0

package/dist/CozyClient.js

@@ -2703,7 +2703,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 = "43.2.0";
+CozyClient.version = "43.3.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/hooks/index.js

@@ -61,6 +61,12 @@ Object.defineProperty(exports, "useMutation", {
     return _useMutation.useMutation;
   }
 });
+Object.defineProperty(exports, "useInstanceInfo", {
+  enumerable: true,
+  get: function get() {
+    return _useInstanceInfo.useInstanceInfo;
+  }
+});
 
 var _useAppLinkWithStoreFallback = _interopRequireDefault(require("./useAppLinkWithStoreFallback"));
 
@@ -76,4 +82,6 @@ var _useAppsInMaintenance = _interopRequireDefault(require("./useAppsInMaintenan
 
 var _useQueryAll = _interopRequireDefault(require("./useQueryAll"));
 
-var _useMutation = require("./useMutation");
+var _useMutation = require("./useMutation");
+
+var _useInstanceInfo = require("./useInstanceInfo");

package/dist/hooks/useInstanceInfo.js

@@ -0,0 +1,56 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useInstanceInfo = void 0;
+
+var _useQuery = _interopRequireDefault(require("./useQuery"));
+
+var _CozyClient = _interopRequireDefault(require("../CozyClient"));
+
+var _dsl = require("../queries/dsl");
+
+var _utils = require("../utils");
+
+/**
+ * Retrieve intance info like context, uuid, disk usage etc
+ *
+ * @returns {import("../types").InstanceInfo}
+ */
+var useInstanceInfo = function useInstanceInfo() {
+  var instanceQuery = buildSettingsByIdQuery('io.cozy.settings.instance');
+  var instanceResult = (0, _useQuery.default)(instanceQuery.definition, instanceQuery.options);
+  var contextQuery = buildSettingsByIdQuery('context');
+  var contextResult = (0, _useQuery.default)(contextQuery.definition, contextQuery.options);
+  var diskUsageQuery = buildSettingsByIdQuery('disk-usage');
+  var diskUsageResult = (0, _useQuery.default)(diskUsageQuery.definition, diskUsageQuery.options);
+  return {
+    isLoaded: !!(0, _utils.hasQueryBeenLoaded)(instanceResult) !== null && !!(0, _utils.hasQueryBeenLoaded)(contextResult) !== null && !!(0, _utils.hasQueryBeenLoaded)(diskUsageResult) !== null,
+    instance: {
+      data: instanceResult.data
+    },
+    context: {
+      data: contextResult.data
+    },
+    diskUsage: {
+      data: diskUsageResult.data
+    }
+  };
+};
+
+exports.useInstanceInfo = useInstanceInfo;
+var DEFAULT_CACHE_TIMEOUT_QUERIES = 9 * 60 * 1000;
+
+var buildSettingsByIdQuery = function buildSettingsByIdQuery(id) {
+  return {
+    definition: (0, _dsl.Q)('io.cozy.settings').getById(id),
+    options: {
+      as: "io.cozy.settings/".concat(id),
+      fetchPolicy: _CozyClient.default.fetchPolicies.olderThan(DEFAULT_CACHE_TIMEOUT_QUERIES),
+      singleDocData: true
+    }
+  };
+};

package/dist/types.js

@@ -566,5 +566,76 @@ var _dsl = require("./queries/dsl");
  * @template T
  * @typedef {[T, import('react').Dispatch<import('react').SetStateAction<T>>]} useState
  */
+
+/**
+ * Represents the Cozy's instance parameters
+ *
+ * @typedef {object} InstanceData
+ * @property {string} email - The email of the instance
+ * @property {string} locale - The locale used on the server
+ * @property {string} [public_name] - The public displayed name of the instance
+ * @property {string} [uuid] - UUID associated with the instance
+ * @property {string} [context] - The name of the context attached to the instance
+ * @property {string} [default_redirection] - Redirect to a specific route after the login (format: 'appslug/#/path/to/route'). This value has priority over the Context's default_redirection
+ * @property {boolean} [onboarding_finished] - Whether or not the onboarding is complete
+ * @property {boolean} [password_defined] - Whether or not the Cozy has a password defined (i.e. may be false for OIDC instances)
+ * @property {'basic' | 'two_factor_mail'} [auth_mode] - Authentication type (basic or 2FA)
+ * @property {string} [oidc_id] - An identifier to check authentication from OIDC
+ * @property {string} [tos] - Terms of Service signed version
+ * @property {string} [tos_latest] - Terms of Service latest version
+ */
+
+/**
+ * Represents the Cozy's instance parameters
+ *
+ * @typedef {object} Instance
+ * @property {InstanceData} data - data from Instance Query
+ */
+
+/**
+ * Represents the Cozy's context parameters
+ *
+ * @typedef {object} ContextData
+ * @property {string} [default_redirection] - Redirect to a specific route after the login (format: 'appslug/#/path/to/route')
+ * @property {string} [onboarded_redirection] - Redirect to a specific route after the onboarding (format: appslug/#/path/to/route')
+ * @property {string} [help_link] - Link that the user can use to get help (i.e. 'https://forum.cozy.io/')
+ * @property {string} [manager_url] - Url of the instance's Manager that can be use to enable/disable premium features
+ * @property {boolean} [enable_premium_links] - Whether or not the Cozy can show links to the Manager in order to enable/disable premium features
+ */
+
+/**
+ * Represents the Cozy's context parameters
+ *
+ * @typedef {object} Context
+ * @property {ContextData} data - data from Context Query
+ */
+
+/**
+ * Represents the Cozy's disk usage
+ *
+ * @typedef {object} DiskUsageData
+ * @property {string} [quota] - Value in bytes representing the maximum space available. Omitted means unlimited
+ * @property {string} used - Value in bytes representing the space used
+ * @property {string} files - Value in bytes representing the space used by files in their last version
+ * @property {string} versions - Value in bytes representing the space used by files in their older version
+ * @property {string} [trash] - Value in bytes representing the space used by files in the trash
+ */
+
+/**
+ * Represents the Cozy's disk usage
+ *
+ * @typedef {object} DiskUsage
+ * @property {DiskUsageData} data - data from DiskUsage Query
+ */
+
+/**
+ * Represents the Cozy's instance info (instance level parameters, context level parameters and disk usage)
+ *
+ * @typedef {object} InstanceInfo
+ * @property {boolean} isLoaded - Whether or not the queries have been loaded
+ * @property {Instance} instance - The Cozy's instance parameters
+ * @property {Context} context - The Cozy's context parameters
+ * @property {DiskUsage} diskUsage - The Cozy's disk usage
+ */
 var _default = {};
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "43.2.0",
+  "version": "43.3.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": "22a2cc2fd135eb337ddc918a4a69c2390978fb37"
+  "gitHead": "eeefc22374dbb95969c385ca383b7d6ee8a1a58f"
 }

package/types/hooks/index.d.ts

@@ -5,4 +5,5 @@ export { default as useClient } from "./useClient";
 export { default as useAppsInMaintenance } from "./useAppsInMaintenance";
 export { default as useQueryAll } from "./useQueryAll";
 export { useMutation } from "./useMutation";
+export { useInstanceInfo } from "./useInstanceInfo";
 export { default as useQuery, useQueries } from "./useQuery";

package/types/hooks/useInstanceInfo.d.ts

@@ -0,0 +1 @@
+export function useInstanceInfo(): import("../types").InstanceInfo;

package/types/types.d.ts

@@ -920,4 +920,155 @@ export type RedirectLinkData = {
  * Template to type useState
  */
 export type useState<T> = [T, import("react").Dispatch<import("react").SetStateAction<T>>];
+/**
+ * Represents the Cozy's instance parameters
+ */
+export type InstanceData = {
+    /**
+     * - The email of the instance
+     */
+    email: string;
+    /**
+     * - The locale used on the server
+     */
+    locale: string;
+    /**
+     * - The public displayed name of the instance
+     */
+    public_name?: string;
+    /**
+     * - UUID associated with the instance
+     */
+    uuid?: string;
+    /**
+     * - The name of the context attached to the instance
+     */
+    context?: string;
+    /**
+     * - Redirect to a specific route after the login (format: 'appslug/#/path/to/route'). This value has priority over the Context's default_redirection
+     */
+    default_redirection?: string;
+    /**
+     * - Whether or not the onboarding is complete
+     */
+    onboarding_finished?: boolean;
+    /**
+     * - Whether or not the Cozy has a password defined (i.e. may be false for OIDC instances)
+     */
+    password_defined?: boolean;
+    /**
+     * - Authentication type (basic or 2FA)
+     */
+    auth_mode?: 'basic' | 'two_factor_mail';
+    /**
+     * - An identifier to check authentication from OIDC
+     */
+    oidc_id?: string;
+    /**
+     * - Terms of Service signed version
+     */
+    tos?: string;
+    /**
+     * - Terms of Service latest version
+     */
+    tos_latest?: string;
+};
+/**
+ * Represents the Cozy's instance parameters
+ */
+export type Instance = {
+    /**
+     * - data from Instance Query
+     */
+    data: InstanceData;
+};
+/**
+ * Represents the Cozy's context parameters
+ */
+export type ContextData = {
+    /**
+     * - Redirect to a specific route after the login (format: 'appslug/#/path/to/route')
+     */
+    default_redirection?: string;
+    /**
+     * - Redirect to a specific route after the onboarding (format: appslug/#/path/to/route')
+     */
+    onboarded_redirection?: string;
+    /**
+     * - Link that the user can use to get help (i.e. 'https://forum.cozy.io/')
+     */
+    help_link?: string;
+    /**
+     * - Url of the instance's Manager that can be use to enable/disable premium features
+     */
+    manager_url?: string;
+    /**
+     * - Whether or not the Cozy can show links to the Manager in order to enable/disable premium features
+     */
+    enable_premium_links?: boolean;
+};
+/**
+ * Represents the Cozy's context parameters
+ */
+export type Context = {
+    /**
+     * - data from Context Query
+     */
+    data: ContextData;
+};
+/**
+ * Represents the Cozy's disk usage
+ */
+export type DiskUsageData = {
+    /**
+     * - Value in bytes representing the maximum space available. Omitted means unlimited
+     */
+    quota?: string;
+    /**
+     * - Value in bytes representing the space used
+     */
+    used: string;
+    /**
+     * - Value in bytes representing the space used by files in their last version
+     */
+    files: string;
+    /**
+     * - Value in bytes representing the space used by files in their older version
+     */
+    versions: string;
+    /**
+     * - Value in bytes representing the space used by files in the trash
+     */
+    trash?: string;
+};
+/**
+ * Represents the Cozy's disk usage
+ */
+export type DiskUsage = {
+    /**
+     * - data from DiskUsage Query
+     */
+    data: DiskUsageData;
+};
+/**
+ * Represents the Cozy's instance info (instance level parameters, context level parameters and disk usage)
+ */
+export type InstanceInfo = {
+    /**
+     * - Whether or not the queries have been loaded
+     */
+    isLoaded: boolean;
+    /**
+     * - The Cozy's instance parameters
+     */
+    instance: Instance;
+    /**
+     * - The Cozy's context parameters
+     */
+    context: Context;
+    /**
+     * - The Cozy's disk usage
+     */
+    diskUsage: DiskUsage;
+};
 import { QueryDefinition } from "./queries/dsl";