box-ui-elements/es/elements/content-explorer/stories/tests/MetadataView-visual.stories.js

Box UI Elements

function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
import { http, HttpResponse } from 'msw';
import { Download, SignMeOthers } from '@box/blueprint-web-assets/icons/Fill/index';
import { Sign } from '@box/blueprint-web-assets/icons/Line';
import { expect, userEvent, waitFor, within } from 'storybook/test';
import noop from 'lodash/noop';
import ContentExplorer from '../../ContentExplorer';
import { DEFAULT_HOSTNAME_API } from '../../../../constants';
import { mockMetadata, mockSchema } from '../../../common/__mocks__/mockMetadata';

// The intent behind relying on mockMetadata is to allow a developer to paste in their own metadata template schema for use with live API calls.
const {
  scope: templateScope,
  templateKey
} = mockSchema;
const metadataScopeAndKey = `${templateScope}.${templateKey}`;
const metadataFieldNamePrefix = `metadata.${metadataScopeAndKey}`;

// This is the body of the metadata query API call.
// https://developer.box.com/guides/metadata/queries/syntax/
const metadataQuery = {
  from: metadataScopeAndKey,
  ancestor_folder_id: '0',
  sort_by: [{
    field_key: `${metadataFieldNamePrefix}.${mockSchema.fields[0].key}`,
    // Default to sorting by the first field in the schema
    direction: 'asc'
  }],
  fields: [
  // Default to returning all fields in the metadata template schema, and name as a standalone (non-metadata) field
  ...mockSchema.fields.map(field => `${metadataFieldNamePrefix}.${field.key}`), 'name']
};

// Used for metadata view v1
const fieldsToShow = [{
  key: `${metadataFieldNamePrefix}.name`,
  canEdit: false,
  displayName: 'Alias'
}, {
  key: `${metadataFieldNamePrefix}.industry`,
  canEdit: true
}, {
  key: `${metadataFieldNamePrefix}.last_contacted_at`,
  canEdit: true
}, {
  key: `${metadataFieldNamePrefix}.role`,
  canEdit: true
}];

// Used for metadata view v2
const columns = [{
  // Always include the name column
  textValue: 'Name',
  id: 'name',
  type: 'string',
  allowSorting: true,
  minWidth: 150,
  maxWidth: 150
}, ...mockSchema.fields.map(field => ({
  textValue: field.displayName,
  id: `${metadataFieldNamePrefix}.${field.key}`,
  type: field.type,
  allowSorting: true,
  minWidth: 150,
  maxWidth: 150
}))];

// Switches ContentExplorer to use Metadata View over standard, folder-based view.
const defaultView = 'metadata';
export const metadataView = {
  args: {
    metadataQuery,
    fieldsToShow,
    defaultView
  }
};
const metadataViewV2ElementProps = {
  metadataViewProps: {
    columns
  },
  metadataQuery,
  fieldsToShow,
  defaultView,
  features: {
    contentExplorer: {
      metadataViewV2: true
    }
  }
};
export const metadataViewV2 = {
  args: metadataViewV2ElementProps
};
export const metadataViewV2WithCustomActions = {
  args: _objectSpread(_objectSpread({}, metadataViewV2ElementProps), {}, {
    metadataViewProps: {
      columns,
      tableProps: {
        isSelectAllEnabled: true
      },
      itemActionMenuProps: {
        actions: [{
          label: 'Download',
          onClick: noop,
          icon: Download
        }],
        subMenuTrigger: {
          label: 'Sign',
          icon: Sign
        },
        subMenuActions: [{
          label: 'Request Signature',
          onClick: noop,
          icon: SignMeOthers
        }]
      }
    }
  }),
  play: async ({
    canvas
  }) => {
    await waitFor(() => {
      expect(canvas.getByRole('row', {
        name: /Child 2/i
      })).toBeInTheDocument();
    });
    const firstRow = canvas.getByRole('row', {
      name: /Child 2/i
    });
    const ellipsesButton = within(firstRow).getByRole('button', {
      name: 'Action menu'
    });
    userEvent.click(ellipsesButton);
  }
};
const meta = {
  title: 'Elements/ContentExplorer/tests/MetadataView/visual',
  component: ContentExplorer,
  args: {
    features: global.FEATURE_FLAGS,
    rootFolderId: global.FOLDER_ID,
    token: global.TOKEN
  },
  parameters: {
    msw: {
      handlers: [http.post(`${DEFAULT_HOSTNAME_API}/2.0/metadata_queries/execute_read`, () => {
        return HttpResponse.json(mockMetadata);
      }), http.get(`${DEFAULT_HOSTNAME_API}/2.0/metadata_templates/enterprise/templateName/schema`, () => {
        return HttpResponse.json(mockSchema);
      })]
    }
  }
};
export default meta;
//# sourceMappingURL=MetadataView-visual.stories.js.map