passbolt-styleguide/src/shared/models/entity/resource/resourceEntity.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 { defaultFavoriteDto } from "../favorite/favoriteEntity.test.data";
import {
  TEST_RESOURCE_TYPE_PASSWORD_AND_DESCRIPTION,
  TEST_RESOURCE_TYPE_PASSWORD_DESCRIPTION_TOTP,
  TEST_RESOURCE_TYPE_PASSWORD_STRING,
  TEST_RESOURCE_TYPE_TOTP,
} from "../resourceType/resourceTypeEntity.test.data";
import { defaultUserDto } from "../user/userEntity.test.data";
import { defaultPermissionsDtos } from "../permission/permissionCollection.test.data";
import { defaultTagsDtos } from "../tag/tagCollection.test.data";
import { defaultResourceMetadataDto } from "./metadata/resourceMetadataEntity.test.data";

/**
 * Build default resource dto.
 * @param {object} data The data to override the default dto.
 * @param {Object} [options]
 * @param {boolean} [options.withModifier=false] Add modifier default dto.
 * @param {boolean} [options.withCreator=false] Add creator default dto.
 * @param {boolean|integer} [options.withPermissions=0] Add permission default dtos.
 * @param {boolean|integer} [options.withFavorite=false] Add favorite default dto.
 * @param {boolean|integer} [options.withTags=false] Add favorite default dto.
 * @returns {object}
 */
export const defaultResourceDto = (data = {}, options = {}) => {
  const id = data?.id || uuidv4();
  const defaultData = {
    id: id,
    resource_type_id:
      data?.metadata?.resource_type_id || data?.resource_type_id || TEST_RESOURCE_TYPE_PASSWORD_AND_DESCRIPTION,
    expired: null,
    deleted: false,
    created: "2022-03-04T13:59:11+00:00",
    modified: "2022-03-04T13:59:11+00:00",
    created_by: uuidv4(),
    modified_by: uuidv4(),
    folder_parent_id: null,
    personal: false,
    favorite: null,
    /*
     * @todo there should be default metadata properties for v5 resource types.
     * metadata_key_id: uuidv4(),
     * metadata_key_type: METADATA_KEY_TYPE_METADATA_KEY,
     */
    metadata: defaultResourceMetadataDto({
      resource_type_id:
        data?.metadata?.resource_type_id || data?.resource_type_id || TEST_RESOURCE_TYPE_PASSWORD_AND_DESCRIPTION,
    }),
    permission: ownerPermissionDto({ aco_foreign_key: id }),
    ...data,
  };

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

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

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

  if (!data.favorite && options?.withFavorite) {
    defaultData.favorite = defaultFavoriteDto({ foreign_key: id });
  }

  if (!data.tags && options?.withTags) {
    defaultData.tags = defaultTagsDtos();
  }

  return defaultData;
};

export const defaultResourceV4Dto = (data = {}, options = {}) => {
  const defaultData = defaultResourceDto(
    {
      name: "Passbolt",
      username: "admin@passbolt.com",
      uri: "https://passbolt.com",
      description: "",
      metadata_key_id: null,
      metadata_key_type: null,
      ...data,
    },
    options,
  );
  //Remove metadata to match v4 format
  delete defaultData.metadata;

  return defaultData;
};

export const resourceWithUpdatePermissionDto = (data = {}, options = {}) => {
  const id = data?.id || uuidv4();

  return defaultResourceDto(
    {
      id: id,
      permission: updatePermissionDto({ aco_foreign_key: id }),
      ...data,
    },
    options,
  );
};

export const resourceWithReadPermissionDto = (data = {}, options = {}) => {
  const id = data?.id || uuidv4();

  return defaultResourceDto(
    {
      id: id,
      permission: readPermissionDto({ aco_foreign_key: id }),
      ...data,
    },
    options,
  );
};

export const resourceWithFavoriteDto = (data = {}, options = {}) => {
  const id = data?.id || uuidv4();

  return defaultResourceDto(
    {
      id: id,
      favorite: defaultFavoriteDto({ foreign_key: id }),
      ...data,
    },
    options,
  );
};

export const resourceLegacyDto = (data = {}, options = {}) =>
  defaultResourceDto(
    {
      resource_type_id: TEST_RESOURCE_TYPE_PASSWORD_STRING,
      ...data,
    },
    options,
  );

export const resourceWithTotpDto = (data = {}, options = {}) =>
  defaultResourceDto(
    {
      resource_type_id: TEST_RESOURCE_TYPE_PASSWORD_DESCRIPTION_TOTP,
      ...data,
    },
    options,
  );

export const resourceStandaloneTotpDto = (data = {}, options = {}) =>
  defaultResourceDto(
    {
      resource_type_id: TEST_RESOURCE_TYPE_TOTP,
      metadata: defaultResourceMetadataDto({
        resource_type_id: TEST_RESOURCE_TYPE_TOTP,
        username: null,
      }),
      ...data,
    },
    options,
  );

export const resourceUnknownResourceTypeDto = (data = {}, options = {}) =>
  defaultResourceDto(
    {
      resource_type_id: uuidv4(),
      ...data,
    },
    options,
  );

export const resourceExpiredDto = (data = {}, options = {}) =>
  defaultResourceDto(
    {
      expired: "2022-03-04T13:59:11+00:00",
      ...data,
    },
    options,
  );