passbolt-styleguide/src/shared/models/entity/folder/folderEntity.test.data.js

Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.

/**
 * 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         4.1.0
 */
import { v4 as uuidv4 } from "uuid";
import { ownerPermissionDto, readPermissionDto, updatePermissionDto } from "../permission/permissionEntity.test.data";
import { defaultPermissionsDtos } from "../permission/permissionCollection.test.data";
import { defaultUserDto } from "../user/userEntity.test.data";

export const minimalFolderDto = (data = {}) => ({
  name: "Folder name",
  ...data,
});

/**
 * Build default folder dto.
 * @param {object} data The data to override the default dto.
 * @param {Object} [options]
 * @param {boolean|integer} [options.withPermissions=0] Add permission default dtos.
 * @param {boolean|integer} [options.withCreator=0] Add creator default dto.
 * @param {boolean|integer} [options.withModifier=0] Add modifier default dto.
 * @returns {object}
 */
export const defaultFolderDto = (data = {}, options = {}) => {
  const id = data?.id || uuidv4();

  const defaultData = {
    id: id,
    name: "Accounting",
    created: "2020-02-01T00:00:00+00:00",
    modified: "2020-02-01T00:00:00+00:00",
    created_by: "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
    modified_by: "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
    permission: ownerPermissionDto({
      aco: "Folder",
      aco_foreign_key: id,
    }),
    folder_parent_id: null,
    personal: false,
    ...data,
  };

  if (!data.permissions && options.withPermissions) {
    defaultData.permissions = defaultPermissionsDtos({ aco: "Folder", aco_foreign_key: id }, options.withPermissions);
  }

  if (!data.creator && options?.withCreator) {
    defaultData.creator = defaultUserDto();
  }

  if (!data.modifier && options?.withModifier) {
    defaultData.modifier = defaultUserDto();
  }

  return defaultData;
};

export const folderWithReadPermissionDto = (data = {}) => {
  const id = data?.id || uuidv4();

  return defaultFolderDto({
    id: id,
    permission: readPermissionDto({ aco_foreign_key: id, aco: "Folder" }),
    ...data,
  });
};

export const folderWithUpdatePermissionDto = (data = {}) => {
  const id = data?.id || uuidv4();

  return defaultFolderDto({
    id: id,
    permission: updatePermissionDto({ aco_foreign_key: id, aco: "Folder" }),
    ...data,
  });
};