cozy-client 28.0.0 → 28.1.0

package/dist/CozyClient.js

@@ -2537,7 +2537,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 = "28.0.0";
+CozyClient.version = "28.1.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/const.js

@@ -3,8 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DOCTYPE_FILES = exports.REGISTRATION_ABORT = void 0;
+exports.DOCTYPE_PERMISSIONS = exports.DOCTYPE_FILES = exports.REGISTRATION_ABORT = void 0;
 var REGISTRATION_ABORT = 'REGISTRATION_ABORT';
 exports.REGISTRATION_ABORT = REGISTRATION_ABORT;
 var DOCTYPE_FILES = 'io.cozy.files';
-exports.DOCTYPE_FILES = DOCTYPE_FILES;
+exports.DOCTYPE_FILES = DOCTYPE_FILES;
+var DOCTYPE_PERMISSIONS = 'io.cozy.permissions';
+exports.DOCTYPE_PERMISSIONS = DOCTYPE_PERMISSIONS;

package/dist/models/index.js

@@ -5,7 +5,7 @@ var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWild
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-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.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"));
 
@@ -54,6 +54,10 @@ exports.document = document;
 var timeseries = _interopRequireWildcard(require("./timeseries"));
 
 exports.timeseries = timeseries;
+
+var sharing = _interopRequireWildcard(require("./sharing"));
+
+exports.sharing = sharing;
 // For backward compatibility before 9.0.0
 var triggers = trigger;
 exports.triggers = triggers;

package/dist/models/sharing.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getSharingLink = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _const = require("../const");
+
+var _CozyClient = _interopRequireDefault(require("../CozyClient"));
+
+var _helpers = require("../helpers");
+
+/**
+ * Generate Sharing link for one or many files
+ *
+ * @param {CozyClient} client - Instance of CozyClient
+ * @param {string[]} filesIds - Array of io.cozy.files ids
+ * @param {boolean} [isFlatDomain] -
+ * @returns {Promise<string>} Shared link
+ */
+var getSharingLink = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, filesIds, isFlatDomain) {
+    var _sharedLink$attribute, _sharedLink$attribute2;
+
+    var PERMS, _yield$client$save, sharedLink, webLink;
+
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            PERMS = {
+              _type: _const.DOCTYPE_PERMISSIONS,
+              permissions: {
+                files: {
+                  type: _const.DOCTYPE_FILES,
+                  values: filesIds,
+                  verbs: ['GET']
+                }
+              }
+            };
+            _context.next = 3;
+            return client.save(PERMS);
+
+          case 3:
+            _yield$client$save = _context.sent;
+            sharedLink = _yield$client$save.data;
+            webLink = (0, _helpers.generateWebLink)({
+              cozyUrl: client.getStackClient().uri,
+              searchParams: [['sharecode', sharedLink === null || sharedLink === void 0 ? void 0 : (_sharedLink$attribute = sharedLink.attributes) === null || _sharedLink$attribute === void 0 ? void 0 : (_sharedLink$attribute2 = _sharedLink$attribute.shortcodes) === null || _sharedLink$attribute2 === void 0 ? void 0 : _sharedLink$attribute2.code]],
+              pathname: '/public',
+              slug: 'drive',
+              subDomainType: isFlatDomain ? 'flat' : 'nested'
+            });
+            return _context.abrupt("return", webLink);
+
+          case 7:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getSharingLink(_x, _x2, _x3) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.getSharingLink = getSharingLink;

package/dist/models/sharing.spec.js

@@ -0,0 +1,53 @@
+import { getSharingLink } from './sharing'
+
+describe('getSharingLink', () => {
+  const mockSharecode = { attributes: { shortcodes: { code: 'shortcode' } } }
+  const mockClient = {
+    save: jest.fn(() => ({ data: mockSharecode })),
+    getStackClient: jest.fn(() => ({ uri: 'http://cozy.cloud' }))
+  }
+  const mockFiles = [
+    { id: 'fileId01', name: 'File 01' },
+    { id: 'fileId02', name: 'File 02' }
+  ]
+
+  it('should generate the right share link if "isFlatDomain" param is not defined', async () => {
+    const sharingLink = await getSharingLink(mockClient, mockFiles)
+
+    expect(sharingLink).toBe(
+      'http://drive.cozy.cloud/public?sharecode=shortcode#/'
+    )
+  })
+
+  it('should generate the right share link to a nested cozy', async () => {
+    const isFlatDomain = false
+    const sharingLink = await getSharingLink(
+      mockClient,
+      mockFiles,
+      isFlatDomain
+    )
+
+    expect(sharingLink).toBe(
+      'http://drive.cozy.cloud/public?sharecode=shortcode#/'
+    )
+  })
+
+  it('should generate the right share link to a flat cozy', async () => {
+    const isFlatDomain = true
+    const sharingLink = await getSharingLink(
+      mockClient,
+      mockFiles,
+      isFlatDomain
+    )
+
+    expect(sharingLink).toBe(
+      'http://cozy-drive.cloud/public?sharecode=shortcode#/'
+    )
+  })
+
+  it('should generate the right share link with an correct sharecode', async () => {
+    const sharingLink = await getSharingLink(mockClient, mockFiles)
+
+    expect(sharingLink).toContain('sharecode=shortcode')
+  })
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "28.0.0",
+  "version": "28.1.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": "^28.0.0",
+    "cozy-stack-client": "^28.0.1",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "68e2573b4bb28622c41d468f35371d92ce30fb4b"
+  "gitHead": "77128534f1e28d493230263b56521f08d17a3247"
 }

package/types/const.d.ts

@@ -1,2 +1,3 @@
 export const REGISTRATION_ABORT: "REGISTRATION_ABORT";
 export const DOCTYPE_FILES: "io.cozy.files";
+export const DOCTYPE_PERMISSIONS: "io.cozy.permissions";

package/types/models/dacc.d.ts

@@ -0,0 +1,3 @@
+export function checkMeasureParams(measure: DACCMeasure): void;
+export function sendMeasureToDACC(client: object, remoteDoctype: string, measure: DACCMeasure): Promise<void>;
+import { DACCMeasure } from "../types";

package/types/models/index.d.ts

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

package/types/models/sharing.d.ts

@@ -0,0 +1,2 @@
+export function getSharingLink(client: CozyClient, filesIds: string[], isFlatDomain?: boolean): Promise<string>;
+import CozyClient from "../CozyClient";

package/types/types.d.ts

@@ -86,7 +86,10 @@ export type QueryOptions = {
 export type FetchMoreAble = {
     fetchMore: Function;
 };
-export type UseQueryReturnValue = QueryState & FetchMoreAble;
+export type FetchAble = {
+    fetch: Function;
+};
+export type UseQueryReturnValue = QueryState & FetchMoreAble & FetchAble;
 /**
  * A reference to a document
  */
@@ -342,6 +345,39 @@ export type FinanceLabels = "payment_proof_family_allowance" | "pay_sheet" | "ta
 export type InvoiceLabels = "health_invoice" | "phone_invoice" | "isp_invoice" | "telecom_invoice" | "energy_invoice" | "water_invoice" | "work_invoice" | "transport_invoice" | "appliance_invoice" | "web_service_invoice" | "restaurant_invoice" | "other_invoice";
 export type ActivityLabels = "personal_sporting_licence" | "other_activity_document";
 export type ItemsLabels = "resume" | "identity_photo" | "national_id_card" | "passport" | "residence_permit" | "family_record_book" | "birth_certificate" | "driver_license" | "other_identity_document" | "citizen_registration_certificate" | "personal_sporting_licence" | "wedding" | "pacs" | "divorce" | "large_family_card" | "caf" | "other_family_document" | "payment_proof_family_allowance" | "diploma" | "work_contract" | "pay_sheet" | "unemployment_benefit" | "pension" | "gradebook" | "student_card" | "motivation_letter" | "other_work_document" | "work_disability_recognition" | "school_attendance_certificate" | "health_certificate" | "health_book" | "national_health_insurance_card" | "health_insurance_card" | "prescription" | "health_invoice" | "national_health_insurance_right_certificate" | "pregnancy_medical_certificate" | "other_health_document" | "phone_invoice" | "isp_invoice" | "telecom_invoice" | "energy_invoice" | "water_invoice" | "house_sale_agreeement" | "building_permit" | "technical_diagnostic_record" | "lease" | "rent_receipt" | "house_insurance" | "work_quote" | "work_invoice" | "other_house_document" | "unfit_for_habitation_declaration" | "accommodation_proof" | "vehicle_registration" | "car_insurance" | "mechanic_invoice" | "transport_invoice" | "other_transport_document" | "tax_return" | "tax_notice" | "tax_timetable" | "receipt" | "other_tax_document" | "bank_details" | "bank_statement" | "loan_agreement" | "other_bank_document" | "other_revenue" | "appliance_invoice" | "web_service_invoice" | "restaurant_invoice" | "other_invoice" | "other_activity_document";
+/**
+ * See https://github.com/cozy/DACC
+ */
+export type DACCMeasure = {
+    /**
+     * - It must match an existing measure name on the DACC server
+     */
+    measureName: string;
+    /**
+     * - Start of the aggregation period. Should be in YYYY-MM-DD format
+     */
+    startDate: string;
+    /**
+     * - The measured value on the aggregation period
+     */
+    value: number;
+    /**
+     * - The slug of the app creating the measure
+     */
+    createdBy: string;
+    /**
+     * - Should be a {key: value} where the key is set in the measure definition.
+     */
+    group1: object;
+    /**
+     * - Should be a {key: value} where the key is set in the measure definition.
+     */
+    group2: object;
+    /**
+     * - Should be a {key: value} where the key is set in the measure definition.
+     */
+    group3: object;
+};
 /**
  * Receives the URL to present to the user as a parameter, and should return a promise that resolves with the URL the user was redirected to after accepting the permissions.
  */