box-ui-elements/src/common/types/metadata.js

Box UI Elements

// @flow strict
import {
    FIELD_TYPE_DATE,
    FIELD_TYPE_ENUM,
    FIELD_TYPE_FLOAT,
    FIELD_TYPE_MULTISELECT,
    FIELD_TYPE_STRING,
    FIELD_TYPE_TAXONOMY,
} from '../../features/metadata-instance-fields/constants';
import type { SkillCards } from './skills';

type MetadataFieldType =
    | typeof FIELD_TYPE_DATE
    | typeof FIELD_TYPE_ENUM
    | typeof FIELD_TYPE_FLOAT
    | typeof FIELD_TYPE_MULTISELECT
    | typeof FIELD_TYPE_STRING
    | typeof FIELD_TYPE_TAXONOMY;

type MetadataTemplateFieldOption = {
    id?: string,
    key: string,
};

export type TaxonomyLevel = {
    description: string,
    displayName: string,
    level: number,
};

type MetadataTemplateField = {
    description?: string,
    displayName: string,
    hidden?: boolean,
    id: string,
    isHidden?: boolean,
    key: string, // V2
    options?: Array<MetadataTemplateFieldOption>, // V3
    type: MetadataFieldType,
    levels?: Array<TaxonomyLevel>,
    namespace?: string,
    taxonomyKey?: string,
    taxonomy_key?: string,
};

type MetadataTemplate = {
    displayName?: string,
    fields?: Array<MetadataTemplateField>,
    hidden?: boolean,
    id: string,
    isHidden?: boolean,
    scope: string, // V2
    templateKey: string, // V3
};

type MetadataTemplateSchemaResponse = {
    data?: MetadataTemplate,
};

type MetadataSkillsTemplate = {
    archivedItemTemplate?: {
        archiveDate: string,
    },
    boxSkillsCards?: SkillCards,
};

// $FlowFixMe flow strict doesn't like use of "any"
type MetadataFieldValue = string | number | Array<any>;

type MetadataFields = { [string]: MetadataFieldValue };

type MetadataQueryInstanceTypeField = {
    displayName: string,
    key: string,
    options?: MetadataTemplateFieldOption,
    type: string,
    value: ?MetadataFieldValue,
};

type MetadataQueryInstanceTemplate = {
    fields: Array<MetadataQueryInstanceTypeField>,
    id: string,
};

type MetadataType = {
    enterprise?: MetadataQueryInstanceTemplate,
    global?: MetadataSkillsTemplate,
};

type MetadataCascadePolicyConfiguration = {
    agent: string,
};

type MetadataCascadePolicy = {
    canEdit?: boolean,
    id?: string,
    cascadePolicyType?: string,
    cascadePolicyConfiguration?: MetadataCascadePolicyConfiguration,
};

type MetadataCascadingPolicyData = {
    id?: string,
    isEnabled: boolean,
    overwrite: boolean,
    cascadePolicyConfiguration: MetadataCascadePolicyConfiguration | null,
};

type MetadataInstance = {
    canEdit: boolean,
    cascadePolicy?: MetadataCascadePolicy,
    data: MetadataFields,
    id: string,
};

type MetadataInstanceV2 = {
    $canEdit: boolean,
    $id: string,
    $parent: string,
    $scope: string,
    $template: string,
    $type: string,
    $typeVersion: number,
    $version: number,
};

type MetadataEditor = {
    hasError?: boolean,
    instance: MetadataInstance,
    isDirty?: boolean,
    template: MetadataTemplate,
};

type MetadataSuggestion = {
    $scope: string,
    $templateKey: string,
    suggestions: { [key: string]: string | number | string[] },
};

type MetadataOptionEntryAncestor = {
    id: string,
    display_name: string,
    level: string,
};

type MetadataOptionEntry = {
    id: string,
    display_name: string,
    level: number,
    ancestors: MetadataOptionEntryAncestor[],
    deprecated: boolean,
    selectable: boolean,
};

type MetadataOptions = {
    entries: MetadataOptionEntry[],
    next_marker: string | null,
    result_count: number,
};

type MetadataTemplateInstanceField = {
    description?: string,
    displayName?: string,
    hidden?: boolean,
    id?: string,
    key: string, // V2
    levels?: Array<TaxonomyLevel>,
    options?: Array<MetadataTemplateFieldOption>, // V3
    type: MetadataFieldType,
    value: MetadataFieldValue,
};

type MetadataTemplateInstance = {
    canEdit: boolean,
    displayName?: string,
    hidden?: boolean,
    id: string,
    fields: MetadataTemplateInstanceField[],
    scope: string,
    templateKey: string,
    type: string,
};

export type {
    MetadataTemplateInstanceField,
    MetadataTemplateInstance,
    MetadataFieldType,
    MetadataTemplateFieldOption,
    MetadataTemplateField,
    MetadataTemplate,
    MetadataTemplateSchemaResponse,
    MetadataFieldValue,
    MetadataFields,
    MetadataQueryInstanceTypeField,
    MetadataType,
    MetadataCascadePolicy,
    MetadataCascadePolicyConfiguration,
    MetadataCascadingPolicyData,
    MetadataInstanceV2,
    MetadataEditor,
    MetadataSuggestion,
    MetadataOptions,
};