passbolt-browser-extension 3.0.6 → 4.6.2

package/src/all/background_page/model/entity/transfer/transferEntity.js

@@ -0,0 +1,218 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
+ *
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         2.13.0
+ */
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import AuthenticationTokenEntity from "../authenticationToken/authenticationTokenEntity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+
+const ENTITY_NAME = 'transfer';
+
+const TRANSFER_STATUS_START = 'start';
+const TRANSFER_STATUS_IN_PROGRESS = 'in progress';
+const TRANSFER_STATUS_COMPLETE = 'complete';
+const TRANSFER_STATUS_CANCEL = 'cancel';
+const TRANSFER_STATUS_ERROR = 'error';
+
+class TransferEntity extends Entity {
+  /**
+   * @inheritDoc
+   */
+  constructor(transferDto, options = {}) {
+    super(EntitySchema.validate(
+      TransferEntity.ENTITY_NAME,
+      transferDto,
+      TransferEntity.getSchema()
+    ), options);
+
+    // Associations
+    if (this._props.authentication_token) {
+      this._authentication_token = new AuthenticationTokenEntity(this._props.authentication_token, {clone: false});
+      delete this._props.authentication_token;
+    }
+  }
+
+  /**
+   * Get transfer entity schema
+   * @returns {Object} schema
+   */
+  static getSchema() {
+    return {
+      "type": "object",
+      "required": [
+        'total_pages'
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "user_id": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "hash": {
+          "type": "string"
+        },
+        "current_page": {
+          "type": "integer"
+        },
+        "total_pages": {
+          "type": "integer"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            TransferEntity.TRANSFER_STATUS_START,
+            TransferEntity.TRANSFER_STATUS_COMPLETE,
+            TransferEntity.TRANSFER_STATUS_IN_PROGRESS,
+            TransferEntity.TRANSFER_STATUS_ERROR,
+            TransferEntity.TRANSFER_STATUS_CANCEL
+          ]
+        },
+        "created": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "modified": {
+          "type": "string",
+          "format": "date-time"
+        },
+        // Associated models
+        "authentication_token": AuthenticationTokenEntity.getSchema(),
+      }
+    };
+  }
+
+  /*
+   * ==================================================
+   * Serialization
+   * ==================================================
+   */
+  /**
+   * Return a DTO ready to be sent to API
+   * @param {object} [contain] optional for example {profile: {avatar:true}}
+   * @returns {*}
+   */
+  toDto(contain) {
+    const result = Object.assign({}, this._props);
+    if (!contain) {
+      return result;
+    }
+    if (this._authentication_token && contain.authentication_token) {
+      result.authentication_token = this._authentication_token.toDto();
+    }
+    return result;
+  }
+
+  /**
+   * Customizes JSON stringification behavior
+   * @returns {*}
+   */
+  toJSON() {
+    return this.toDto(TransferEntity.ALL_CONTAIN_OPTIONS);
+  }
+
+  /**
+   * GroupEntity.ALL_CONTAIN_OPTIONS
+   * @returns {object} all contain options that can be used in toDto()
+   */
+  static get ALL_CONTAIN_OPTIONS() {
+    return {
+      'authentication_token': true,
+    };
+  }
+
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
+  /**
+   * Get transfer id
+   * @returns {string} uuid
+   */
+  get id() {
+    return this._props.id;
+  }
+
+  /**
+   * Get created date
+   * @returns {(string|null)} date
+   */
+  get created() {
+    return this._props.created || null;
+  }
+
+  /**
+   * Get modified date
+   * @returns {(string|null)} date
+   */
+  get modified() {
+    return this._props.modified || null;
+  }
+
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
+  /**
+   * TransferEntity.ENTITY_NAME
+   * @returns {string}
+   */
+  static get ENTITY_NAME() {
+    return ENTITY_NAME;
+  }
+
+  /**
+   * TransferEntity.TRANSFER_STATUS_START
+   * @returns {string}
+   */
+  static get TRANSFER_STATUS_START() {
+    return TRANSFER_STATUS_START;
+  }
+
+  /**
+   * TransferEntity.TRANSFER_STATUS_IN_PROGRESS
+   * @returns {string} in progress
+   */
+  static get TRANSFER_STATUS_IN_PROGRESS() {
+    return TRANSFER_STATUS_IN_PROGRESS;
+  }
+
+  /**
+   * TransferEntity.TRANSFER_STATUS_COMPLETE
+   * @returns {string} complete
+   */
+  static get TRANSFER_STATUS_COMPLETE() {
+    return TRANSFER_STATUS_COMPLETE;
+  }
+
+  /**
+   * TransferEntity.TRANSFER_STATUS_CANCEL
+   * @returns {string} cancel
+   */
+  static get TRANSFER_STATUS_CANCEL() {
+    return TRANSFER_STATUS_CANCEL;
+  }
+
+  /**
+   * TransferEntity.TRANSFER_STATUS_ERROR
+   * @returns {string} error
+   */
+  static get TRANSFER_STATUS_ERROR() {
+    return TRANSFER_STATUS_ERROR;
+  }
+}
+
+export default TransferEntity;

package/src/all/background_page/model/entity/transfer/transferEntity.test.js

@@ -0,0 +1,111 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
+ *
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         3.2.0
+ */
+import TransferEntity from "./transferEntity";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+
+describe("Transfer entity", () => {
+  it("schema must validate", () => {
+    EntitySchema.validateSchema(TransferEntity.ENTITY_NAME, TransferEntity.getSchema());
+  });
+
+  it("constructor works if valid minimal DTO is provided", () => {
+    const dto = {'total_pages': 3};
+    const entity = new TransferEntity(dto);
+    expect(entity.toDto()).toEqual(dto);
+  });
+
+  it("constructor works if valid DTO is provided with optional and non supported fields", () => {
+    const dto = {
+      'id': '7f077753-0835-4054-92ee-556660ea04f1',
+      'user_id': '7f077753-0835-4054-92ee-556660ea04f2',
+      'hash': '0809f23914bc27cd25196d9a968cb23a6652efa0b0233afe043bea54dc64468de952d50ffd53898098bf44a9b125b96aa5bbff7c900f36530d62b883e05afb3d',
+      'current_page': 0,
+      'total_pages': 3,
+      'created': '2020-04-25 12:52:00',
+      'modified': '2020-04-25 12:52:01',
+      'authentication_token': {
+        'id': '7f077753-0835-4054-92ee-556660ea04f3',
+        'token': '7f077753-0835-4054-92ee-556660ea04f4',
+        'active': true,
+        'type': 'mobile_transfer',
+        'created': '2020-04-25 12:52:00',
+        'modified': '2020-04-25 12:52:01',
+      },
+      '_type': 'none'
+    };
+    const filtered = {
+      'id': '7f077753-0835-4054-92ee-556660ea04f1',
+      'user_id': '7f077753-0835-4054-92ee-556660ea04f2',
+      'hash': '0809f23914bc27cd25196d9a968cb23a6652efa0b0233afe043bea54dc64468de952d50ffd53898098bf44a9b125b96aa5bbff7c900f36530d62b883e05afb3d',
+      'current_page': 0,
+      'total_pages': 3,
+      'created': '2020-04-25 12:52:00',
+      'modified': '2020-04-25 12:52:01'
+    };
+    const filteredWithAssoc = {
+      'id': '7f077753-0835-4054-92ee-556660ea04f1',
+      'user_id': '7f077753-0835-4054-92ee-556660ea04f2',
+      'hash': '0809f23914bc27cd25196d9a968cb23a6652efa0b0233afe043bea54dc64468de952d50ffd53898098bf44a9b125b96aa5bbff7c900f36530d62b883e05afb3d',
+      'current_page': 0,
+      'total_pages': 3,
+      'created': '2020-04-25 12:52:00',
+      'modified': '2020-04-25 12:52:01',
+      'authentication_token': {
+        'id': '7f077753-0835-4054-92ee-556660ea04f3',
+        'token': '7f077753-0835-4054-92ee-556660ea04f4',
+        'active': true,
+        'type': 'mobile_transfer',
+        'created': '2020-04-25 12:52:00',
+        'modified': '2020-04-25 12:52:01',
+      },
+    };
+
+    const transferEntity = new TransferEntity(dto);
+    expect(transferEntity.toDto()).toEqual(filtered);
+    expect(transferEntity.toDto({authentication_token: true})).toEqual(filteredWithAssoc);
+
+    // test getters
+    expect(transferEntity.id).toEqual('7f077753-0835-4054-92ee-556660ea04f1');
+    expect(transferEntity.created).toEqual('2020-04-25 12:52:00');
+    expect(transferEntity.modified).toEqual('2020-04-25 12:52:01');
+  });
+
+  it("constructor returns validation error if dto fields are invalid", () => {
+    let t;
+    t = () => { new TransferEntity({'id': 'nope', 'total_pages': 3}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'user_id': 'nope', 'total_pages': 3}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'hash': 3, 'total_pages': 3}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'current_page': 'nope', 'total_pages': 3}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'total_pages': 'nope'}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'created': 'nope', 'total_pages': 3}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'modified': 'nope', 'total_pages': 3}); };
+    expect(t).toThrow(EntityValidationError);
+
+    t = () => { new TransferEntity({'total_pages': 3, 'authentication_token': {id: 'nope'}}); };
+    expect(t).toThrow(EntityValidationError);
+  });
+});

package/src/all/background_page/model/entity/user/actionLog/loggedUserEntity.js

@@ -10,31 +10,28 @@
  * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
  * @link          https://www.passbolt.com Passbolt(tm)
  */
-const {Entity} = require('../../abstract/entity');
-const {EntitySchema} = require('../../abstract/entitySchema');
-const {EntityValidationError} = require('../../abstract/entityValidationError');
-const {UserEntity} = require("../userEntity");
-const {ProfileEntity} = require("../../profile/profileEntity");
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import ProfileEntity from "../../profile/profileEntity";
+import UserEntity from "../userEntity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+
 
 const ENTITY_NAME = 'LoggedUser';
 
 class LoggedUserEntity extends Entity {
   /**
-   * Logged user entity constructor
-   *
-   * @param {Object} LoggedUserDto Logged user DTO
-   * @throws EntityValidationError if the dto cannot be converted into an entity
+   * @inheritDoc
    */
-  constructor(LoggedUserDto) {
+  constructor(LoggedUserDto, options = {}) {
     super(EntitySchema.validate(
       LoggedUserEntity.ENTITY_NAME,
       LoggedUserDto,
       LoggedUserEntity.getSchema()
-    ));
+    ), options);
 
     // Associations
     if (this._props.profile) {
-      this._profile = new ProfileEntity(this._props.profile);
+      this._profile = new ProfileEntity(this._props.profile, {clone: false});
       delete this._props.profile;
     }
   }
@@ -44,7 +41,7 @@ class LoggedUserEntity extends Entity {
    * @returns {Object} schema
    */
   static getSchema() {
-    const schema = UserEntity.getSchema()
+    const schema = UserEntity.getSchema();
     schema.required = ["id", "username", "profile"];
 
     return schema;
@@ -56,7 +53,7 @@ class LoggedUserEntity extends Entity {
    * @returns {*}
    */
   toDto(contain) {
-    let result = Object.assign({}, this._props);
+    const result = Object.assign({}, this._props);
     if (!contain) {
       return result;
     }
@@ -80,9 +77,11 @@ class LoggedUserEntity extends Entity {
     return this.toDto(LoggedUserEntity.ALL_CONTAIN_OPTIONS);
   }
 
-  // ==================================================
-  // Dynamic properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
 
   /**
    * Get user id
@@ -100,9 +99,11 @@ class LoggedUserEntity extends Entity {
     return this._props.username;
   }
 
-  // ==================================================
-  // Other associated properties methods
-  // ==================================================
+  /*
+   * ==================================================
+   * Other associated properties methods
+   * ==================================================
+   */
 
   /**
    * Get the profile.
@@ -112,9 +113,11 @@ class LoggedUserEntity extends Entity {
     return this._profile || null;
   }
 
-  // ==================================================
-  // Static properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
 
   /**
    * LoggedUserEntity.ENTITY_NAME
@@ -133,4 +136,4 @@ class LoggedUserEntity extends Entity {
   }
 }
 
-exports.LoggedUserEntity = LoggedUserEntity;
+export default LoggedUserEntity;

package/src/all/background_page/model/entity/user/actionLog/loggedUserEntity.test.js

@@ -10,16 +10,9 @@
  * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
  * @link          https://www.passbolt.com Passbolt(tm)
  */
-import Validator from 'validator';
-import {EntitySchema} from "../../abstract/entitySchema";
-import {EntityValidationError} from '../../abstract/entityValidationError';
-import {LoggedUserEntity} from "./loggedUserEntity";
-
-// Reset the modules before each test.
-beforeEach(() => {
-  window.Validator = Validator;
-  jest.resetModules();
-});
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import LoggedUserEntity from "./loggedUserEntity";
 
 describe("Logged user entity", () => {
   it("schema must validate", () => {
@@ -53,11 +46,11 @@ describe("Logged user entity", () => {
 
   it("constructor works fails if not enough data is provided", () => {
     let t;
-    t = () => {new LoggedUserEntity({})};
+    t = () => { new LoggedUserEntity({}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new LoggedUserEntity({id: "f848277c-5398-58f8-a82a-72397af2d450"})};
+    t = () => { new LoggedUserEntity({id: "f848277c-5398-58f8-a82a-72397af2d450"}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new LoggedUserEntity({id: "f848277c-5398-58f8-a82a-72397af2d450", "username": "ada@passbolt.com"})};
+    t = () => { new LoggedUserEntity({id: "f848277c-5398-58f8-a82a-72397af2d450", "username": "ada@passbolt.com"}); };
     expect(t).toThrow(EntityValidationError);
   });
 });

package/src/all/background_page/model/entity/user/transfer/userDeleteTransfer.js

@@ -11,32 +11,29 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         3.0.0
  */
-const {Entity} = require('../../abstract/entity');
-const {EntityValidationError} = require('../../abstract/entityValidationError');
-const {GroupUserTransfersCollection} = require('../../groupUser/transfer/groupUserTransfersCollection');
-const {PermissionTransfersCollection} = require('../../permission/transfer/permissionTransfersCollection');
+import GroupUserTransfersCollection from "../../groupUser/transfer/groupUserTransfersCollection";
+import PermissionTransfersCollection from "../../permission/transfer/permissionTransfersCollection";
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+
 
 const ENTITY_NAME = 'UserDeleteTransfer';
 
 class UserDeleteTransferEntity extends Entity {
   /**
-   * UserDeleteTransfer entity constructor
-   *
-   * @param {Object} transferDto transfer DTO
-   * @throws EntityValidationError if the dto cannot be converted into an entity
+   * @inheritDoc
+   * @throws {EntityValidationError} Build rule checking if at least a list of owners or a list of managers is provided.
    */
-  constructor(transferDto) {
-    // cannot use default entity schema validation as there are no required field
-    // e.g. owners or managers should be set or both
-    super(UserDeleteTransferEntity.validate(transferDto));
+  constructor(transferDto, options = {}) {
+    super(UserDeleteTransferEntity.validate(transferDto), options);
 
     // Association
     if (this._props.owners) {
-      this._owners = new PermissionTransfersCollection(this._props.owners);
+      this._owners = new PermissionTransfersCollection(this._props.owners, {clone: false});
       delete this._props.owners;
     }
     if (this._props.managers) {
-      this._managers = new GroupUserTransfersCollection(this._props.managers);
+      this._managers = new GroupUserTransfersCollection(this._props.managers, {clone: false});
       delete this._props.managers;
     }
   }
@@ -69,12 +66,14 @@ class UserDeleteTransferEntity extends Entity {
         "owners": PermissionTransfersCollection.getSchema(),
         "managers": GroupUserTransfersCollection.getSchema()
       }
-    }
+    };
   }
 
-  // ==================================================
-  // Serialization
-  // ==================================================
+  /*
+   * ==================================================
+   * Serialization
+   * ==================================================
+   */
   /**
    * Return a DTO ready to be sent to API
    * @returns {Object} with owners and/or managers key set
@@ -90,9 +89,11 @@ class UserDeleteTransferEntity extends Entity {
     return result;
   }
 
-  // ==================================================
-  // Dynamic properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
   /**
    * Get the collection of resource/folder permission transfers if any
    * @returns {PermissionTransfersCollection}
@@ -111,9 +112,11 @@ class UserDeleteTransferEntity extends Entity {
     return this._managers || null;
   }
 
-  // ==================================================
-  // Static properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
   /**
    * UserDeleteTransferEntity.ENTITY_NAME
    * @returns {string}
@@ -123,4 +126,4 @@ class UserDeleteTransferEntity extends Entity {
   }
 }
 
-exports.UserDeleteTransferEntity = UserDeleteTransferEntity;
+export default UserDeleteTransferEntity;

package/src/all/background_page/model/entity/user/transfer/userDeleteTransfer.test.js

@@ -11,15 +11,8 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         3.0.0
  */
-import {UserDeleteTransferEntity} from "./userDeleteTransfer";
-import Validator from 'validator';
-import {EntityValidationError} from "../../abstract/entityValidationError";
-
-// Reset the modules before each test.
-beforeEach(() => {
-  window.Validator = Validator;
-  jest.resetModules();
-});
+import UserDeleteTransferEntity from "./userDeleteTransfer";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
 
 describe("User delete transfer entity", () => {
   it("constructor works if valid minimal DTO is provided", () => {
@@ -31,7 +24,7 @@ describe("User delete transfer entity", () => {
       managers: [{
         group_id: '47787831-f9c2-4edc-a27f-06978ac18406',
         id: '0c17f5e3-2f28-4697-9e7b-4e4943ec546a'
-      },{
+      }, {
         group_id: '47787831-f9c2-4edc-a27f-06978ac18405',
         id: '0c17f5e3-2f28-4697-9e7b-4e4943ec5465'
       }]
@@ -66,23 +59,21 @@ describe("User delete transfer entity", () => {
     expect(userDeleteTransfer.owners.length).toBe(1);
     expect(userDeleteTransfer.owners.items[0].id).toBe('898ce1d0-601f-5194-976b-147a680dd472');
     expect(userDeleteTransfer.owners.items[0].acoForeignKey).toBe('8e3874ae-4b40-590b-968a-418f704b9d9a');
-
   });
 
   it("constructor works fails if not enough data is provided", () => {
     let t;
-    t = () => {new UserDeleteTransferEntity({})};
+    t = () => { new UserDeleteTransferEntity({}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new UserDeleteTransferEntity({owners: []})};
+    t = () => { new UserDeleteTransferEntity({owners: []}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new UserDeleteTransferEntity({owners: [{}]})};
+    t = () => { new UserDeleteTransferEntity({owners: [{}]}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new UserDeleteTransferEntity({owners: [{id: '898ce1d0-601f-5194-976b-147a680dd472'}]})};
+    t = () => { new UserDeleteTransferEntity({owners: [{id: '898ce1d0-601f-5194-976b-147a680dd472'}]}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new UserDeleteTransferEntity({managers: []})};
+    t = () => { new UserDeleteTransferEntity({managers: []}); };
     expect(t).toThrow(EntityValidationError);
-    t = () => {new UserDeleteTransferEntity({managers: [{id: '898ce1d0-601f-5194-976b-147a680dd472'}]})};
+    t = () => { new UserDeleteTransferEntity({managers: [{id: '898ce1d0-601f-5194-976b-147a680dd472'}]}); };
     expect(t).toThrow(EntityValidationError);
   });
-
 });