cozy-client 43.4.1 → 43.5.1

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.4.1";
+CozyClient.version = "43.5.1";
 
 _microee.default.mixin(CozyClient);
 

package/dist/models/note.js

@@ -45,6 +45,8 @@ var generateUrlForNote = function generateUrlForNote(notesAppUrl, file) {
  *
  * @param {object} client CozyClient instance
  * @param {object} file io.cozy.file object
+ * @param {object} options Options
+ * @param {string} [options.pathname] Pathname to use in the URL
  * @returns {Promise<string>} url
  */
 
@@ -53,18 +55,31 @@ exports.generateUrlForNote = generateUrlForNote;
 
 var fetchURL = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, file) {
-    var _yield$client$getStac, _yield$client$getStac2, note_id, subdomain, protocol, instance, sharecode, public_name, searchParams;
+    var options,
+        _yield$client$getStac,
+        _yield$client$getStac2,
+        note_id,
+        subdomain,
+        protocol,
+        instance,
+        sharecode,
+        public_name,
+        _options$pathname,
+        searchParams,
+        _options$pathname2,
+        _args = arguments;
 
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            _context.next = 2;
+            options = _args.length > 2 && _args[2] !== undefined ? _args[2] : {};
+            _context.next = 3;
             return client.getStackClient().collection('io.cozy.notes').fetchURL({
               _id: file.id
             });
 
-          case 2:
+          case 3:
             _yield$client$getStac = _context.sent;
             _yield$client$getStac2 = _yield$client$getStac.data;
             note_id = _yield$client$getStac2.note_id;
@@ -75,7 +90,7 @@ var fetchURL = /*#__PURE__*/function () {
             public_name = _yield$client$getStac2.public_name;
 
             if (!sharecode) {
-              _context.next = 17;
+              _context.next = 18;
               break;
             }
 
@@ -85,21 +100,21 @@ var fetchURL = /*#__PURE__*/function () {
             return _context.abrupt("return", (0, _helpers.generateWebLink)({
               cozyUrl: "".concat(protocol, "://").concat(instance),
               searchParams: searchParams,
-              pathname: '/public/',
+              pathname: (_options$pathname = options.pathname) !== null && _options$pathname !== void 0 ? _options$pathname : '/public/',
               slug: 'notes',
               subDomainType: subdomain
             }));
 
-          case 17:
+          case 18:
             return _context.abrupt("return", (0, _helpers.generateWebLink)({
               cozyUrl: "".concat(protocol, "://").concat(instance),
-              pathname: '',
+              pathname: (_options$pathname2 = options.pathname) !== null && _options$pathname2 !== void 0 ? _options$pathname2 : '',
               slug: 'notes',
               subDomainType: subdomain,
               hash: "/n/".concat(note_id)
             }));
 
-          case 18:
+          case 19:
           case "end":
             return _context.stop();
         }

package/dist/types.js

@@ -76,6 +76,98 @@ var _dsl = require("./queries/dsl");
  * @typedef {CozyClientDocument & KonnectorsDocument} IOCozyKonnector - An io.cozy.konnectors document
  */
 
+/**
+ * @typedef {Object} Developer - name and url for the developer
+ * @property {string} name
+ * @property {string} url
+ */
+
+/**
+ * @typedef {Object} Intent - (application specific) a list of intents provided by this app
+ * @property {string} action
+ * @property {string[]} type
+ * @property {string} href
+ */
+
+/**
+ * @typedef {Object} Locale - an object with language slug as property, each name property is an object of localized informations
+ * @property {string} long_description
+ * @property {string[]} screenshots
+ * @property {string} short_description
+ */
+
+/**
+ * @typedef {Object} Permission - a map of permissions needed by the app
+ * @property {string} type
+ * @property {string} [description]
+ * @property {string[]} [verbs]
+ * @property {string} [selector]
+ * @property {string[]} [values]
+ */
+
+/**
+ * @typedef {Object} Route - (application specific) a map of routes for the app
+ * @property {string} folder
+ * @property {string} index
+ * @property {boolean} public
+ */
+
+/**
+ * @typedef {Object} Service - (application specific) a map of the services associated with the app (see cozy-stack services doc for more details)
+ * @property {string} type
+ * @property {string} file
+ * @property {string} [debounce]
+ * @property {string} trigger
+ * @property {string} trigger_id
+ */
+
+/**
+ * @typedef {Object} Terms - 	an object defining properties for terms that need to be displayed/accepted by the user when installing the application
+ * @property {string} url
+ * @property {string} version
+ */
+
+/**
+ * @typedef {Object} AcceptDocumentsFromFlagship - The acceptance document details from cozy-flagship.
+ * @property {string[]} accepted_mime_types
+ * @property {number} max_number_of_files
+ * @property {number} max_size_per_file_in_MB
+ * @property {string} route_to_upload - The route provided by the cozy-app to trigger the upload user flow
+ */
+
+/**
+ * @typedef {Object} AppsDocument
+ * See https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.apps/
+ *
+ * @property {AcceptDocumentsFromFlagship} [accept_documents_from_flagship] - The acceptance document details from flagship.
+ * @property {boolean} [accept_from_flagship] - Whether to accept file upload from cozy-flagship.
+ * @property {string[]} categories - array of categories for your apps (see authorized categories), it will be ['others'] by default if empty
+ * @property {string} checksum
+ * @property {string} created_at
+ * @property {Developer} developer - name and url for the developer
+ * @property {string} editor - the editor’s name to display on the cozy-bar
+ * @property {string} icon - path to the icon for the home
+ * @property {Intent[]} intents - (application specific) a list of intents provided by this app
+ * @property {string[]} langs - 	Languages available in the app
+ * @property {string} licence - the SPDX license identifier
+ * @property {Object.<string, Locale>} locales - an object with language slug as property, each name property is an object of localized informations
+ * @property {string} name - the name to display on the home
+ * @property {string} name_prefix - the prefix to display with the name
+ * @property {null} notifications
+ * @property {Object.<string, Permission>} permissions - a map of permissions needed by the app
+ * @property {Object.<string, Route>} routes - (application specific) a map of routes for the app
+ * @property {string[]} screenshots - an array of paths to the screenshots of the application
+ * @property {Object.<string, Service>} services - 	(application specific) a map of the services associated with the app
+ * @property {string} slug - the default slug that should never change (alpha-numeric lowercase)
+ * @property {string} source - where the files of the app can be downloaded
+ * @property {string} state
+ * @property {Terms} terms - an object defining properties for terms that need to be displayed/accepted by the user when installing the application
+ * @property {"webapp"} type - type of application
+ * @property {string} updated_at
+ * @property {string} version - the current version number
+ * @typedef {CozyClientDocument & AppsDocument} IOCozyApp - An io.cozy.apps document
+ */
+
 /**
  * @typedef {object} TriggersDocument
  * @property {String} [_id] - document identifier

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "43.4.1",
+  "version": "43.5.1",
   "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": "aceb4eec10ed6dac61f5e6ee168be6559225ec89"
+  "gitHead": "61af4bcb1a0537b2f958cfa956298e5b537889e7"
 }

package/types/models/note.d.ts

@@ -1,3 +1,5 @@
 export function generatePrivateUrl(notesAppUrl: string, file: object, options?: {}): string;
 export function generateUrlForNote(notesAppUrl: any, file: any): string;
-export function fetchURL(client: object, file: object): Promise<string>;
+export function fetchURL(client: object, file: object, options?: {
+    pathname: string;
+}): Promise<string>;

package/types/types.d.ts

@@ -181,6 +181,182 @@ export type KonnectorsDocument = {
  * - An io.cozy.konnectors document
  */
 export type IOCozyKonnector = CozyClientDocument & KonnectorsDocument;
+/**
+ * - name and url for the developer
+ */
+export type Developer = {
+    name: string;
+    url: string;
+};
+/**
+ * - (application specific) a list of intents provided by this app
+ */
+export type Intent = {
+    action: string;
+    type: string[];
+    href: string;
+};
+/**
+ * - an object with language slug as property, each name property is an object of localized informations
+ */
+export type Locale = {
+    long_description: string;
+    screenshots: string[];
+    short_description: string;
+};
+/**
+ * - a map of permissions needed by the app
+ */
+export type Permission = {
+    type: string;
+    description?: string;
+    verbs?: string[];
+    selector?: string;
+    values?: string[];
+};
+/**
+ * - (application specific) a map of routes for the app
+ */
+export type Route = {
+    folder: string;
+    index: string;
+    public: boolean;
+};
+/**
+ * - (application specific) a map of the services associated with the app (see cozy-stack services doc for more details)
+ */
+export type Service = {
+    type: string;
+    file: string;
+    debounce?: string;
+    trigger: string;
+    trigger_id: string;
+};
+/**
+ * - 	an object defining properties for terms that need to be displayed/accepted by the user when installing the application
+ */
+export type Terms = {
+    url: string;
+    version: string;
+};
+/**
+ * - The acceptance document details from cozy-flagship.
+ */
+export type AcceptDocumentsFromFlagship = {
+    accepted_mime_types: string[];
+    max_number_of_files: number;
+    max_size_per_file_in_MB: number;
+    /**
+     * - The route provided by the cozy-app to trigger the upload user flow
+     */
+    route_to_upload: string;
+};
+/**
+ * See https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.apps/
+ */
+export type AppsDocument = {
+    /**
+     * - The acceptance document details from flagship.
+     */
+    accept_documents_from_flagship?: AcceptDocumentsFromFlagship;
+    /**
+     * - Whether to accept file upload from cozy-flagship.
+     */
+    accept_from_flagship?: boolean;
+    /**
+     * - array of categories for your apps (see authorized categories), it will be ['others'] by default if empty
+     */
+    categories: string[];
+    checksum: string;
+    created_at: string;
+    /**
+     * - name and url for the developer
+     */
+    developer: Developer;
+    /**
+     * - the editor’s name to display on the cozy-bar
+     */
+    editor: string;
+    /**
+     * - path to the icon for the home
+     */
+    icon: string;
+    /**
+     * - (application specific) a list of intents provided by this app
+     */
+    intents: Intent[];
+    /**
+     * - 	Languages available in the app
+     */
+    langs: string[];
+    /**
+     * - the SPDX license identifier
+     */
+    licence: string;
+    /**
+     * - an object with language slug as property, each name property is an object of localized informations
+     */
+    locales: {
+        [x: string]: Locale;
+    };
+    /**
+     * - the name to display on the home
+     */
+    name: string;
+    /**
+     * - the prefix to display with the name
+     */
+    name_prefix: string;
+    notifications: null;
+    /**
+     * - a map of permissions needed by the app
+     */
+    permissions: {
+        [x: string]: Permission;
+    };
+    /**
+     * - (application specific) a map of routes for the app
+     */
+    routes: {
+        [x: string]: Route;
+    };
+    /**
+     * - an array of paths to the screenshots of the application
+     */
+    screenshots: string[];
+    /**
+     * - 	(application specific) a map of the services associated with the app
+     */
+    services: {
+        [x: string]: Service;
+    };
+    /**
+     * - the default slug that should never change (alpha-numeric lowercase)
+     */
+    slug: string;
+    /**
+     * - where the files of the app can be downloaded
+     */
+    source: string;
+    state: string;
+    /**
+     * - an object defining properties for terms that need to be displayed/accepted by the user when installing the application
+     */
+    terms: Terms;
+    /**
+     * - type of application
+     */
+    type: "webapp";
+    updated_at: string;
+    /**
+     * - the current version number
+     */
+    version: string;
+};
+/**
+ * - An io.cozy.apps document
+ */
+export type IOCozyApp = CozyClientDocument & AppsDocument;
 export type TriggersDocument = {
     /**
      * - document identifier