cozy-client 38.4.0 → 38.5.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.4.0";
+CozyClient.version = "38.5.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/types.js

@@ -37,9 +37,42 @@ var _dsl = require("./queries/dsl");
 
 /**
  * @typedef {object} KonnectorsDocument
- * @property {String} slug - slug of konnector
- * @property {ManifestFields} fields - konnector fields
- * @property {Boolean} clientSide - whether the konnector runs on client or not
+ * See https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.konnectors/
+ *
+ * @property {object} [aggregator] - object containing aggregator data
+ * @property {String[]} [categories] - list of categories (default: ['others'])
+ * @property {Boolean} [clientSide] - whether the konnector runs on client or not
+ * @property {String[]} [data_types] - list of data types managed by the connector
+ * @property {object} [developer] - identity information on the connector developer
+ * @property {String} [developer.name] - name of the developer
+ * @property {String} [developer.url] - url of the developer
+ * @property {String} editor - name of the editor
+ * @property {object[]} [features] - list of features added in the konnector
+ * @property {ManifestFields} [fields] - konnector fields
+ * @property {object[]} [folders] - list of folders required by the konnector to store files according to data types
+ * @property {"monthly"|"weekly"|"daily"} [frequency] - interval of time between two runs of the konnector (default: weekly)
+ * @property {String} [icon] - path to the icon for the cozy-home
+ * @property {string[]} [langs] - available languages (may differ from local)
+ * @property {object} [locales] - an object with language slug as property, each name property is an object of localized informations
+ * @property {String} [language] - konnector development language used (ex: node)
+ * @property {String} [manifest_version] - current manifest version number
+ * @property {String[]} [measures] - list of message identifiers, which can be used to display information in known zones
+ * @property {String} name - name of the konnector
+ * @property {String} [name_prefix] - prefix to display with the name
+ * @property {object} [oauth] - object containing oAuth information, like scope
+ * @property {object} [parameters] - additional parameters which should be passed to the konnector
+ * @property {object} [partnership] - object to provide informations about a partnership related to the konnector
+ * @property {object} [permissions] - map of permissions needed by the konnector
+ * @property {String[]} [qualification_labels] - list of one or more cozy-client qualification labels that the connector will associate with the files it retrieves
+ * @property {String[]} [screenshots] - 	an array of paths to the screenshots of the konnector (paths in the build)
+ * @property {String} slug - slug of the konnector
+ * @property {String} state -	installation state of the konnector
+ * @property {String} [source] - where the files of the konnector can be downloaded (default: build branch)
+ * @property {object} [terms] - object defining properties for terms that need to be displayed/accepted by the user when installing the konnector
+ * @property {number[]} [time_interval] - list of two values, first is the interval start hour, second is the interval end hour (ex: [15, 21]) based on GMT time zone
+ * @property {String} type - type of application (konnector or webapp)
+ * @property {String} [vendor_link] - Store the installation state of the konnector
+ * @property {String} version - current version number of the konnector
  * @typedef {CozyClientDocument & KonnectorsDocument} IOCozyKonnector - An io.cozy.konnectors document
  */
 
@@ -51,7 +84,7 @@ var _dsl = require("./queries/dsl");
  * @property {object} message - Parameters to pass to the the worker. For example, when the worker is set to konnector, message contains the related konnector and the related account.
  * @property {TriggerState} [current_state] - state of the last executed jobs related to this trigger
  * @property {String} [arguments] - Arguments related to the type attribute. For example it's a cron configuration when the type is set to @cron.
- * @typedef {CozyClientDocument & TriggersDocument} IOCozyTrigger - An io.cozy.konnectors document
+ * @typedef {CozyClientDocument & TriggersDocument} IOCozyTrigger - An io.cozy.triggers document
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "38.4.0",
+  "version": "38.5.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "18fc2cfe800c7bb20290e2c2402ea2104b52e668"
+  "gitHead": "c14ae8fe2ea2a6f5d8936696ba9521e545722d01"
 }

package/types/types.d.ts

@@ -41,19 +41,141 @@ export type AccountsDocument = {
  * - An io.cozy.accounts document
  */
 export type IOCozyAccount = CozyClientDocument & AccountsDocument;
+/**
+ * See https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.konnectors/
+ */
 export type KonnectorsDocument = {
     /**
-     * - slug of konnector
+     * - object containing aggregator data
      */
-    slug: string;
+    aggregator?: object;
     /**
-     * - konnector fields
+     * - list of categories (default: ['others'])
      */
-    fields: ManifestFields;
+    categories?: string[];
     /**
      * - whether the konnector runs on client or not
      */
-    clientSide: boolean;
+    clientSide?: boolean;
+    /**
+     * - list of data types managed by the connector
+     */
+    data_types?: string[];
+    /**
+     * - identity information on the connector developer
+     */
+    developer?: {
+        name: string;
+        url: string;
+    };
+    /**
+     * - name of the editor
+     */
+    editor: string;
+    /**
+     * - list of features added in the konnector
+     */
+    features?: object[];
+    /**
+     * - konnector fields
+     */
+    fields?: ManifestFields;
+    /**
+     * - list of folders required by the konnector to store files according to data types
+     */
+    folders?: object[];
+    /**
+     * - interval of time between two runs of the konnector (default: weekly)
+     */
+    frequency?: "monthly" | "weekly" | "daily";
+    /**
+     * - path to the icon for the cozy-home
+     */
+    icon?: string;
+    /**
+     * - available languages (may differ from local)
+     */
+    langs?: string[];
+    /**
+     * - an object with language slug as property, each name property is an object of localized informations
+     */
+    locales?: object;
+    /**
+     * - konnector development language used (ex: node)
+     */
+    language?: string;
+    /**
+     * - current manifest version number
+     */
+    manifest_version?: string;
+    /**
+     * - list of message identifiers, which can be used to display information in known zones
+     */
+    measures?: string[];
+    /**
+     * - name of the konnector
+     */
+    name: string;
+    /**
+     * - prefix to display with the name
+     */
+    name_prefix?: string;
+    /**
+     * - object containing oAuth information, like scope
+     */
+    oauth?: object;
+    /**
+     * - additional parameters which should be passed to the konnector
+     */
+    parameters?: object;
+    /**
+     * - object to provide informations about a partnership related to the konnector
+     */
+    partnership?: object;
+    /**
+     * - map of permissions needed by the konnector
+     */
+    permissions?: object;
+    /**
+     * - list of one or more cozy-client qualification labels that the connector will associate with the files it retrieves
+     */
+    qualification_labels?: string[];
+    /**
+     * - 	an array of paths to the screenshots of the konnector (paths in the build)
+     */
+    screenshots?: string[];
+    /**
+     * - slug of the konnector
+     */
+    slug: string;
+    /**
+     * -	installation state of the konnector
+     */
+    state: string;
+    /**
+     * - where the files of the konnector can be downloaded (default: build branch)
+     */
+    source?: string;
+    /**
+     * - object defining properties for terms that need to be displayed/accepted by the user when installing the konnector
+     */
+    terms?: object;
+    /**
+     * - list of two values, first is the interval start hour, second is the interval end hour (ex: [15, 21]) based on GMT time zone
+     */
+    time_interval?: number[];
+    /**
+     * - type of application (konnector or webapp)
+     */
+    type: string;
+    /**
+     * - Store the installation state of the konnector
+     */
+    vendor_link?: string;
+    /**
+     * - current version number of the konnector
+     */
+    version: string;
 };
 /**
  * - An io.cozy.konnectors document
@@ -86,7 +208,7 @@ export type TriggersDocument = {
     arguments?: string;
 };
 /**
- * - An io.cozy.konnectors document
+ * - An io.cozy.triggers document
  */
 export type IOCozyTrigger = CozyClientDocument & TriggersDocument;
 export type TriggerState = {