@box/metadata-editor 2.9.1 → 2.10.0

package/README.md

@@ -5,6 +5,7 @@
     -   [Running commands](#running-commands)
     -   [Available commands](#available-commands)
     -   [Ownership](#ownership)
+    -   [Item type](#item-type)
     -   [Translations](#translations)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -45,10 +46,25 @@ All commands used with Nx can be found in `project.json` file within your packag
 
 ## Ownership
 
-Code of the feature belongs to @Box/role_metadata. Responsibilities of owning team include control over code quality, providing guidelines for changes, and alignment with other teams regarding changes. 
+Code of the feature belongs to @Box/role_metadata. Responsibilities of owning team include control over code quality, providing guidelines for changes, and alignment with other teams regarding changes.
 
 If you have any questions or needs related to this feature, please reach out to the Metadata team on Slack: [#eng-metadata-team](https://grid-box.enterprise.slack.com/archives/C16HCR4QG)
 
+## Item type
+
+`itemType` selects item-specific copy only; it does not gate any feature. Autofill, confidence score review, and bounding boxes are controlled solely by their own flags. Those features are supported for files only, so folder hosts should leave their flags off.
+
+`MetadataInstanceForm` accepts an optional `itemType` of `'file' | 'folder'`. It defaults to `'file'` and is passed through to `DeleteConfirmationModal`. `MetadataInstanceList` does not take `itemType`.
+
+Folder empty-state copy is a separate prop. Pass `level="folder"` on `MetadataEmptyState` together with `itemType="folder"` on the form, so the delete modal and the empty state describe the same item.
+
+```tsx
+import { MetadataEmptyState, MetadataInstanceForm } from '@box/metadata-editor';
+
+<MetadataInstanceForm itemType="folder" {...formProps} />
+<MetadataEmptyState level="folder" />
+```
+
 ## Translations
 
 Per-locale `i18n/*.js` files are generated and committed by the Moji Jenkins pipeline. The shared-feature builder copies them into `dist/i18n/` during `build`. Consuming applications list this package in `i18n.config.js` under `translationDependencies`.

package/dist/chunks/delete-confirmation-modal.js

@@ -1 +1 @@
-import messages from"../esm/lib/components/metadata-instance-editor/subcomponents/delete-confirmation-modal/messages.js";import{useState}from"react";import{FormattedMessage,useIntl}from"react-intl";import{jsx,jsxs}from"react/jsx-runtime";import{Checkbox,Modal,Text,TextInput}from"@box/blueprint-web";import '../styles/delete-confirmation-modal.css';var delete_confirmation_modal_module_default={modalBody:`_modalBody_1wc7x_1`},DeleteConfirmationModal=({onConfirm,templateName,onDismiss,open,isCheckboxEnabled})=>{let intl=useIntl(),[inputValue,setInputValue]=useState(``),[isChecked,setIsChecked]=useState(!1),handleOpenChange=openState=>{openState||(onDismiss(),setInputValue(``),setIsChecked(!1))},formattedTemplateName=templateName||intl.formatMessage(messages.deleteConfirmationModalCustomMetadata),isInputValueValid=inputValue===formattedTemplateName,handleCheckboxChange=()=>{setIsChecked(!isChecked)},handleConfirm=()=>{onConfirm(),handleOpenChange(!1)};return jsx(Modal,{onOpenChange:handleOpenChange,open,children:jsxs(Modal.Content,{onEscapeKeyDown:e=>e.stopPropagation(),size:`small`,children:[jsx(Modal.Header,{"aria-label":intl.formatMessage(messages.deleteConfirmationModalHeaderAriaLabel),children:jsx(FormattedMessage,{...messages.deleteConfirmationModalHeader,values:{templateName:formattedTemplateName}})}),jsx(Modal.ScrollableContainer,{children:jsxs(Modal.Body,{className:delete_confirmation_modal_module_default.modalBody,children:[jsx(Text,{as:`p`,children:isCheckboxEnabled?jsx(FormattedMessage,{...messages.deleteConfirmationModalBodyFirstParagraphCheckboxVersion,values:{templateName:formattedTemplateName}}):jsx(FormattedMessage,{...messages.deleteConfirmationModalBodyFirstParagraph,values:{templateName:formattedTemplateName}})}),!isCheckboxEnabled&&jsx(Text,{as:`p`,children:jsx(FormattedMessage,{...messages.deleteConfirmationModalBodySecondParagraph})}),isCheckboxEnabled?jsx(Checkbox.Item,{checked:isChecked,"data-resin-target":`checkbox`,label:intl.formatMessage(messages.deleteConfirmationModalBodyCheckboxLabel),onCheckedChange:handleCheckboxChange,value:`overageCheckbox`}):jsx(TextInput,{label:intl.formatMessage(messages.deleteConfirmationModalBodyInputFieldLabel),onChange:event=>setInputValue(event.target.value),placeholder:formattedTemplateName,required:!0,value:inputValue})]})}),jsxs(Modal.Footer,{children:[jsx(Modal.Footer.SecondaryButton,{onClick:()=>handleOpenChange(!1),size:`large`,"data-target-id":`Modal.Footer.SecondaryButton-deleteConfirmationModalCancelButton`,children:intl.formatMessage(messages.deleteConfirmationModalCancelButton)}),jsx(Modal.Footer.PrimaryButton,{disabled:isCheckboxEnabled?!isChecked:!isInputValueValid,onClick:handleConfirm,size:`large`,children:intl.formatMessage(isCheckboxEnabled?messages.deleteConfirmationModalConfirmButtonCheckboxVersion:messages.deleteConfirmationModalConfirmButton)})]}),jsx(Modal.Close,{"aria-label":intl.formatMessage(messages.deleteConfirmationModalDismissButton)})]})})};export{DeleteConfirmationModal as t};
+import messages from"../esm/lib/components/metadata-instance-editor/subcomponents/delete-confirmation-modal/messages.js";import{useState}from"react";import{FormattedMessage,useIntl}from"react-intl";import{jsx,jsxs}from"react/jsx-runtime";import{Checkbox,Modal,Text,TextInput}from"@box/blueprint-web";import '../styles/delete-confirmation-modal.css';var delete_confirmation_modal_module_default={modalBody:`_modalBody_1wc7x_1`},getDeleteConfirmationBodyMessage=itemType=>itemType===`folder`?messages.deleteConfirmationModalBodyFirstParagraphFolder:messages.deleteConfirmationModalBodyFirstParagraph,DeleteConfirmationModal=({onConfirm,templateName,onDismiss,open,isCheckboxEnabled,itemType=`file`})=>{let intl=useIntl(),[inputValue,setInputValue]=useState(``),[isChecked,setIsChecked]=useState(!1),handleOpenChange=openState=>{openState||(onDismiss(),setInputValue(``),setIsChecked(!1))},formattedTemplateName=templateName||intl.formatMessage(messages.deleteConfirmationModalCustomMetadata),isInputValueValid=inputValue===formattedTemplateName,handleCheckboxChange=()=>{setIsChecked(!isChecked)},handleConfirm=()=>{onConfirm(),handleOpenChange(!1)};return jsx(Modal,{onOpenChange:handleOpenChange,open,children:jsxs(Modal.Content,{onEscapeKeyDown:e=>e.stopPropagation(),size:`small`,children:[jsx(Modal.Header,{"aria-label":intl.formatMessage(messages.deleteConfirmationModalHeaderAriaLabel),children:jsx(FormattedMessage,{...messages.deleteConfirmationModalHeader,values:{templateName:formattedTemplateName}})}),jsx(Modal.ScrollableContainer,{children:jsxs(Modal.Body,{className:delete_confirmation_modal_module_default.modalBody,children:[jsx(Text,{as:`p`,children:isCheckboxEnabled?jsx(FormattedMessage,{...messages.deleteConfirmationModalBodyFirstParagraphCheckboxVersion,values:{templateName:formattedTemplateName}}):jsx(FormattedMessage,{...getDeleteConfirmationBodyMessage(itemType),values:{templateName:formattedTemplateName}})}),!isCheckboxEnabled&&jsx(Text,{as:`p`,children:jsx(FormattedMessage,{...messages.deleteConfirmationModalBodySecondParagraph})}),isCheckboxEnabled?jsx(Checkbox.Item,{checked:isChecked,"data-resin-target":`checkbox`,label:intl.formatMessage(messages.deleteConfirmationModalBodyCheckboxLabel),onCheckedChange:handleCheckboxChange,value:`overageCheckbox`}):jsx(TextInput,{label:intl.formatMessage(messages.deleteConfirmationModalBodyInputFieldLabel),onChange:event=>setInputValue(event.target.value),placeholder:formattedTemplateName,required:!0,value:inputValue})]})}),jsxs(Modal.Footer,{children:[jsx(Modal.Footer.SecondaryButton,{onClick:()=>handleOpenChange(!1),size:`large`,"data-target-id":`Modal.Footer.SecondaryButton-deleteConfirmationModalCancelButton`,children:intl.formatMessage(messages.deleteConfirmationModalCancelButton)}),jsx(Modal.Footer.PrimaryButton,{disabled:isCheckboxEnabled?!isChecked:!isInputValueValid,onClick:handleConfirm,size:`large`,children:intl.formatMessage(isCheckboxEnabled?messages.deleteConfirmationModalConfirmButtonCheckboxVersion:messages.deleteConfirmationModalConfirmButton)})]}),jsx(Modal.Close,{"aria-label":intl.formatMessage(messages.deleteConfirmationModalDismissButton)})]})})};export{DeleteConfirmationModal as t};

package/dist/esm/lib/components/metadata-empty-state/messages.js

@@ -1 +1 @@
-import{defineMessages}from"react-intl";var messages=defineMessages({managerLevelEmptyStateHeading:{id:`metadataEditor.managerLevel.emptyState.heading`,defaultMessage:`Apply Metadata Templates`},managerLevelEmptyStateBody:{id:`metadataEditor.managerLevel.emptyState.body`,defaultMessage:`Browse or search for your items to apply and edit metadata`},fileLevelEmptyStateBoxAiEnabledHeading:{id:`metadataEditor.fileLevel.emptyState.boxAiEnabled.heading`,defaultMessage:`Autofill Metadata with Box AI`},fileLevelEmptyStateBoxAiEnabledBody:{id:`metadataEditor.fileLevel.emptyState.boxAiEnabled.body`,defaultMessage:`Use the power of Box AI to quickly capture  document metadata, with ever-increasing accuracy.`},fileLevelEmptyStateDefaultHeading:{id:`metadataEditor.fileLevel.emptyState.default.heading`,defaultMessage:`Add Metadata Templates`},fileLevelEmptyStateDefaultBody:{id:`metadataEditor.fileLevel.emptyState.default.body`,defaultMessage:`Add Metadata to your file to support business operations, workflows, and more!`},instanceLevelEmptyStateHeading:{id:`metadataEditor.instanceLevel.emptyState.heading`,defaultMessage:`This template has no values`},instanceLevelEmptyStateHeadingNoAttributes:{id:`metadataEditor.instanceLevel.emptyState.noAttributes.heading`,defaultMessage:`This template has no attributes`},instanceLevelEmptyStateNoEmptyValuesBody:{id:`metadataEditor.instanceLevel.emptyState.noEmptyValues.body`,defaultMessage:`This template has no values`},instanceLevelSeeEmptyValuesCTA:{id:`metadataEditor.instanceLevel.emptyState.emptyValues.Cta`,defaultMessage:`See empty values`}});export{messages as default};
+import{defineMessages}from"react-intl";var messages=defineMessages({managerLevelEmptyStateHeading:{id:`metadataEditor.managerLevel.emptyState.heading`,defaultMessage:`Apply Metadata Templates`},managerLevelEmptyStateBody:{id:`metadataEditor.managerLevel.emptyState.body`,defaultMessage:`Browse or search for your items to apply and edit metadata`},fileLevelEmptyStateBoxAiEnabledHeading:{id:`metadataEditor.fileLevel.emptyState.boxAiEnabled.heading`,defaultMessage:`Autofill Metadata with Box AI`},fileLevelEmptyStateBoxAiEnabledBody:{id:`metadataEditor.fileLevel.emptyState.boxAiEnabled.body`,defaultMessage:`Use the power of Box AI to quickly capture  document metadata, with ever-increasing accuracy.`},fileLevelEmptyStateDefaultHeading:{id:`metadataEditor.fileLevel.emptyState.default.heading`,defaultMessage:`Add Metadata Templates`},fileLevelEmptyStateDefaultBody:{id:`metadataEditor.fileLevel.emptyState.default.body`,defaultMessage:`Add Metadata to your file to support business operations, workflows, and more!`},folderLevelEmptyStateDefaultHeading:{id:`metadataEditor.folderLevel.emptyState.default.heading`,defaultMessage:`Add Metadata Templates`},folderLevelEmptyStateDefaultBody:{id:`metadataEditor.folderLevel.emptyState.default.body`,defaultMessage:`Add Metadata to your folder to support business operations, workflows, and more!`},instanceLevelEmptyStateHeading:{id:`metadataEditor.instanceLevel.emptyState.heading`,defaultMessage:`This template has no values`},instanceLevelEmptyStateHeadingNoAttributes:{id:`metadataEditor.instanceLevel.emptyState.noAttributes.heading`,defaultMessage:`This template has no attributes`},instanceLevelEmptyStateNoEmptyValuesBody:{id:`metadataEditor.instanceLevel.emptyState.noEmptyValues.body`,defaultMessage:`This template has no values`},instanceLevelSeeEmptyValuesCTA:{id:`metadataEditor.instanceLevel.emptyState.emptyValues.Cta`,defaultMessage:`See empty values`}});export{messages as default};

package/dist/esm/lib/components/metadata-empty-state/metadata-empty-state.js

@@ -1 +1 @@
-import messages from"./messages.js";import{useCallback}from"react";import{useIntl}from"react-intl";import{jsx}from"react/jsx-runtime";import{EmptyState,Text}from"@box/blueprint-web";import{JobAnalyzeData}from"@box/blueprint-web-assets/illustrations/Small";function MetadataEmptyState({isAnyEmptyValueHidden=!1,isBoxAiSuggestionsFeatureEnabled=!1,level,onShowEmptyValues}){let intl=useIntl(),getBody=useCallback(()=>level===`manager`?jsx(Text,{as:`p`,children:intl.formatMessage(messages.managerLevelEmptyStateBody)}):level===`instance`?isAnyEmptyValueHidden?jsx(EmptyState.PrimaryAction,{onClick:onShowEmptyValues,children:intl.formatMessage(messages.instanceLevelSeeEmptyValuesCTA)}):jsx(Text,{as:`h1`,variant:`titleSmall`,children:intl.formatMessage(messages.instanceLevelEmptyStateHeadingNoAttributes)}):jsx(Text,{as:`p`,children:intl.formatMessage(messages.fileLevelEmptyStateDefaultBody)}),[intl,isAnyEmptyValueHidden,level,onShowEmptyValues]),getHeading=useCallback(()=>level===`manager`?jsx(Text,{as:`h2`,children:intl.formatMessage(messages.managerLevelEmptyStateHeading)}):level===`instance`?isAnyEmptyValueHidden?jsx(Text,{as:`h2`,children:intl.formatMessage(messages.instanceLevelEmptyStateHeading)}):null:jsx(Text,{as:`h2`,children:intl.formatMessage(messages.fileLevelEmptyStateDefaultHeading)}),[intl,isAnyEmptyValueHidden,level]);return jsx(EmptyState,{body:getBody(),heading:getHeading(),illustration:JobAnalyzeData,size:`small`})}export{MetadataEmptyState,MetadataEmptyState as default};
+import messages from"./messages.js";import{useCallback}from"react";import{useIntl}from"react-intl";import{jsx}from"react/jsx-runtime";import{EmptyState,Text}from"@box/blueprint-web";import{JobAnalyzeData}from"@box/blueprint-web-assets/illustrations/Small";function MetadataEmptyState({isAnyEmptyValueHidden=!1,isBoxAiSuggestionsFeatureEnabled=!1,level,onShowEmptyValues}){let intl=useIntl(),getBody=useCallback(()=>level===`manager`?jsx(Text,{as:`p`,children:intl.formatMessage(messages.managerLevelEmptyStateBody)}):level===`instance`?isAnyEmptyValueHidden?jsx(EmptyState.PrimaryAction,{onClick:onShowEmptyValues,children:intl.formatMessage(messages.instanceLevelSeeEmptyValuesCTA)}):jsx(Text,{as:`h1`,variant:`titleSmall`,children:intl.formatMessage(messages.instanceLevelEmptyStateHeadingNoAttributes)}):jsx(Text,{as:`p`,children:level===`folder`?intl.formatMessage(messages.folderLevelEmptyStateDefaultBody):intl.formatMessage(messages.fileLevelEmptyStateDefaultBody)}),[intl,isAnyEmptyValueHidden,level,onShowEmptyValues]),getHeading=useCallback(()=>level===`manager`?jsx(Text,{as:`h2`,children:intl.formatMessage(messages.managerLevelEmptyStateHeading)}):level===`instance`?isAnyEmptyValueHidden?jsx(Text,{as:`h2`,children:intl.formatMessage(messages.instanceLevelEmptyStateHeading)}):null:jsx(Text,{as:`h2`,children:level===`folder`?intl.formatMessage(messages.folderLevelEmptyStateDefaultHeading):intl.formatMessage(messages.fileLevelEmptyStateDefaultHeading)}),[intl,isAnyEmptyValueHidden,level]);return jsx(EmptyState,{body:getBody(),heading:getHeading(),illustration:JobAnalyzeData,size:`small`})}export{MetadataEmptyState,MetadataEmptyState as default};

package/dist/esm/lib/components/metadata-instance-editor/subcomponents/delete-confirmation-modal/messages.js

@@ -1 +1 @@
-import{defineMessages}from"react-intl";var messages=defineMessages({deleteConfirmationModalCustomMetadata:{id:`metadataEditor.editInstance.deleteConfirmationModal.customMedatata`,defaultMessage:`Custom Metadata`},deleteConfirmationModalHeader:{id:`metadataEditor.editInstance.deleteConfirmationModal.header`,defaultMessage:`Delete "{templateName}"`},deleteConfirmationModalHeaderAriaLabel:{id:`metadataEditor.editInstance.deleteConfirmationModal.headerAriaLabel`,defaultMessage:`Delete Metadata Template`},deleteConfirmationModalBodyFirstParagraph:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.firstParagraph`,defaultMessage:`Are you sure you want to delete the "{templateName}" Metadata template, and all of its values from this file?`},deleteConfirmationModalBodyFirstParagraphCheckboxVersion:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.firstParagraphCheckboxVersion`,defaultMessage:`Are you sure you want to delete the "{templateName}" Metadata instance, and its values?`},deleteConfirmationModalBodySecondParagraph:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.secondParagraph`,defaultMessage:`Once deleted, Metadata values cannot be restored.`},deleteConfirmationModalBodyInputFieldLabel:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.inputFieldLabel`,defaultMessage:`Type the Metadata Template’s name to confirm deletion`},deleteConfirmationModalBodyCheckboxLabel:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.checkboxLabel`,defaultMessage:`Confirm deletion of Metadata instance`},deleteConfirmationModalCancelButton:{id:`metadataEditor.editInstance.deleteConfirmationModal.cancelButton`,defaultMessage:`Cancel`},deleteConfirmationModalConfirmButton:{id:`metadataEditor.editInstance.deleteConfirmationModal.confirmButton`,defaultMessage:`Confirm`},deleteConfirmationModalConfirmButtonCheckboxVersion:{id:`metadataEditor.editInstance.deleteConfirmationModal.confirmButtonCheckboxVersion`,defaultMessage:`Delete`},deleteConfirmationModalDismissButton:{id:`metadataEditor.editInstance.deleteConfirmationModal.dismissButton`,defaultMessage:`Dismiss`}});export{messages as default};
+import{defineMessages}from"react-intl";var messages=defineMessages({deleteConfirmationModalCustomMetadata:{id:`metadataEditor.editInstance.deleteConfirmationModal.customMedatata`,defaultMessage:`Custom Metadata`},deleteConfirmationModalHeader:{id:`metadataEditor.editInstance.deleteConfirmationModal.header`,defaultMessage:`Delete "{templateName}"`},deleteConfirmationModalHeaderAriaLabel:{id:`metadataEditor.editInstance.deleteConfirmationModal.headerAriaLabel`,defaultMessage:`Delete Metadata Template`},deleteConfirmationModalBodyFirstParagraph:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.firstParagraph`,defaultMessage:`Are you sure you want to delete the "{templateName}" Metadata template, and all of its values from this file?`},deleteConfirmationModalBodyFirstParagraphFolder:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.firstParagraph.folder`,defaultMessage:`Are you sure you want to delete the "{templateName}" Metadata template, and all of its values from this folder?`},deleteConfirmationModalBodyFirstParagraphCheckboxVersion:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.firstParagraphCheckboxVersion`,defaultMessage:`Are you sure you want to delete the "{templateName}" Metadata instance, and its values?`},deleteConfirmationModalBodySecondParagraph:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.secondParagraph`,defaultMessage:`Once deleted, Metadata values cannot be restored.`},deleteConfirmationModalBodyInputFieldLabel:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.inputFieldLabel`,defaultMessage:`Type the Metadata Template’s name to confirm deletion`},deleteConfirmationModalBodyCheckboxLabel:{id:`metadataEditor.editInstance.deleteConfirmationModal.body.checkboxLabel`,defaultMessage:`Confirm deletion of Metadata instance`},deleteConfirmationModalCancelButton:{id:`metadataEditor.editInstance.deleteConfirmationModal.cancelButton`,defaultMessage:`Cancel`},deleteConfirmationModalConfirmButton:{id:`metadataEditor.editInstance.deleteConfirmationModal.confirmButton`,defaultMessage:`Confirm`},deleteConfirmationModalConfirmButtonCheckboxVersion:{id:`metadataEditor.editInstance.deleteConfirmationModal.confirmButtonCheckboxVersion`,defaultMessage:`Delete`},deleteConfirmationModalDismissButton:{id:`metadataEditor.editInstance.deleteConfirmationModal.dismissButton`,defaultMessage:`Dismiss`}});export{messages as default};

package/dist/esm/lib/components/metadata-instance-editor/subcomponents/metadata-instance-form/metadata-instance-form.js

@@ -1 +1 @@
-import{TEMPLATE_CUSTOM_PROPERTIES}from"../../../../constants.js";import{MetadataEmptyState}from"../../../metadata-empty-state/metadata-empty-state.js";import{useMetadataEditorAnalytics}from"../../../../utils/analytics/analytics-context.js";import{useAutofill}from"../../../../utils/autofill-context.js";import{TemplateInstance}from"../../../metadata-editor-fields/metadata-editor-fields.js";import{UnsavedChangesModal}from"../../../unsaved-changes-modal/unsaved-changes-modal.js";import{t as AutofillOverlay}from"../../../../../../chunks/autofill-overlay.js";import{t as CustomInstance}from"../../../../../../chunks/custom-instance.js";import{t as DeleteConfirmationModal}from"../../../../../../chunks/delete-confirmation-modal.js";import{t as createJSONPatch}from"../../../../../../chunks/utils2.js";import{n as metadata_instance_form_module_default,t as MetadataInstanceFormCardWrapper}from"../../../../../../chunks/metadata-instance-form-card-wrapper.js";import{useEffect,useMemo,useRef,useState}from"react";import{jsx,jsxs}from"react/jsx-runtime";import clsx from"clsx";import{Form,Formik}from"formik";import isEqual from"lodash/isEqual";var FormikObserver=({dirty,onChange,values})=>{let prevValuesRef=useRef(values);return dirty&&!isEqual(prevValuesRef.current.metadata.fields,values.metadata.fields)&&(prevValuesRef.current=values,onChange(values)),null},MetadataInstanceForm=props=>{let{areAiSuggestionsAvailable,customRef,isLargeFile,errorCode,isAiSuggestionsFeatureEnabled,isAdvancedExtractAgentEnabled=!1,isBetaLanguageEnabled,isDeleteButtonDisabled,isDeleteConfirmationModalCheckboxEnabled,isMultilevelTaxonomyFieldEnabled,isTaxonomyPickerEnabled,createTaxonomyItemsService,isUnsavedChangesModalOpen=!1,MetadataInstanceFormCustomWrapper,selectedTemplateInstance,onCancel,onChange,onDelete,onDiscardUnsavedChanges,onSubmit,onToggleReviewFilter,setIsUnsavedChangesModalOpen,shouldShowOnlyReviewFields=!1,taxonomyOptionsFetcher,isConfidenceScoreReviewEnabled=!1,isBoundingBoxEnabled=!1,onSelectMetadataField,selectedMetadataFieldId,isUserFieldEnabled=!1,fetchUsers,fetchAvatarUrls,resolveUsersByEmail}=props,isBoundingBoxOrConfidenceScoreReviewEnabled=isBoundingBoxEnabled||isConfidenceScoreReviewEnabled,FormWrapper=MetadataInstanceFormCustomWrapper??MetadataInstanceFormCardWrapper,[isDeleteConfirmationModalOpen,setIsDeleteConfirmationModalOpen]=useState(!1),{isFetchingSuggestions,isLongLoading,getAiSuggestions,clearState,suggestions}=useAutofill(),{trackEvent}=useMetadataEditorAnalytics();useEffect(()=>()=>{clearState()},[clearState,selectedTemplateInstance?.id]);let isCustomMetadata=selectedTemplateInstance?.templateKey===TEMPLATE_CUSTOM_PROPERTIES,handleSubmit=async values=>{await onSubmit(values,createJSONPatch(values,selectedTemplateInstance))},handleCancel=isFormDirty=>{isFormDirty?setIsUnsavedChangesModalOpen(!0):onCancel()},handleDelete=()=>{setIsDeleteConfirmationModalOpen(!0)},initialValues={metadata:{...selectedTemplateInstance}},formRef=useRef(null),[portalElement,setPortalElement]=useState(null);useEffect(()=>{setPortalElement(customRef??formRef.current)},[customRef,selectedTemplateInstance?.templateKey,selectedTemplateInstance?.scope]);let content=useMemo(()=>{let isEmpty=selectedTemplateInstance?.fields.length===0;if(isCustomMetadata)return jsx(CustomInstance,{isLoading:isFetchingSuggestions});if(isEmpty)return jsx(MetadataEmptyState,{isBoxAiSuggestionsFeatureEnabled:isAiSuggestionsFeatureEnabled,level:`instance`});let showOverlay=!!(isFetchingSuggestions||errorCode);return jsxs(`div`,{className:clsx(metadata_instance_form_module_default.metadataInstanceFormContent,showOverlay&&metadata_instance_form_module_default.showOverlay,isBoundingBoxOrConfidenceScoreReviewEnabled&&metadata_instance_form_module_default.metadataInstanceFormContentReducedGap),children:[jsx(AutofillOverlay,{errorCode,isFetchingSuggestions,isLongLoading}),jsx(TemplateInstance,{disableForm:isFetchingSuggestions,isConfidenceScoreReviewEnabled,isBoundingBoxEnabled,isExternallyOwned:selectedTemplateInstance?.isExternallyOwned,isMultilevelTaxonomyFieldEnabled,isTaxonomyPickerEnabled,isUserFieldEnabled,createTaxonomyItemsService,onSelectMetadataField,selectedMetadataFieldId,portalElement:customRef??portalElement,shouldShowOnlyReviewFields,taxonomyOptionsFetcher,fetchAvatarUrls,fetchUsers,resolveUsersByEmail})]})},[selectedTemplateInstance?.fields.length,selectedTemplateInstance?.isExternallyOwned,isCustomMetadata,isFetchingSuggestions,isLongLoading,customRef,portalElement,taxonomyOptionsFetcher,isAiSuggestionsFeatureEnabled,isConfidenceScoreReviewEnabled,isBoundingBoxEnabled,isMultilevelTaxonomyFieldEnabled,isTaxonomyPickerEnabled,createTaxonomyItemsService,errorCode,shouldShowOnlyReviewFields,onSelectMetadataField,selectedMetadataFieldId,isUserFieldEnabled,fetchUsers,fetchAvatarUrls,resolveUsersByEmail]);return jsx(Formik,{initialValues,onSubmit:handleSubmit,children:({values,dirty})=>jsxs(Form,{children:[jsx(FormWrapper,{areAiSuggestionsAvailable,className:metadata_instance_form_module_default.metadataInstanceForm,formRef,formValues:values,getAiSuggestions,handleCancel,handleDelete,isAdvancedExtractAgentEnabled,isAiSuggestionsFeatureEnabled,isBetaLanguageEnabled,isConfidenceScoreReviewEnabled,isBoundingBoxEnabled,isDeleteButtonDisabled,isFetchingSuggestions,isFormDirty:dirty,isLargeFile,onToggleReviewFilter,selectedTemplateInstance,shouldShowOnlyReviewFields,suggestions,children:selectedTemplateInstance&&content}),onChange&&jsx(FormikObserver,{dirty,onChange,values}),jsx(UnsavedChangesModal,{onBackToEdit:()=>setIsUnsavedChangesModalOpen(!1),onDiscardChanges:onDiscardUnsavedChanges,open:isUnsavedChangesModalOpen,trackEvent}),jsx(DeleteConfirmationModal,{isCheckboxEnabled:isDeleteConfirmationModalCheckboxEnabled,onConfirm:()=>onDelete(selectedTemplateInstance),onDismiss:()=>setIsDeleteConfirmationModalOpen(!1),open:isDeleteConfirmationModalOpen,templateName:selectedTemplateInstance?.displayName})]})},`${selectedTemplateInstance?.scope}.${selectedTemplateInstance?.templateKey}`)};export{MetadataInstanceForm};
+import{TEMPLATE_CUSTOM_PROPERTIES}from"../../../../constants.js";import{MetadataEmptyState}from"../../../metadata-empty-state/metadata-empty-state.js";import{useMetadataEditorAnalytics}from"../../../../utils/analytics/analytics-context.js";import{useAutofill}from"../../../../utils/autofill-context.js";import{TemplateInstance}from"../../../metadata-editor-fields/metadata-editor-fields.js";import{UnsavedChangesModal}from"../../../unsaved-changes-modal/unsaved-changes-modal.js";import{t as AutofillOverlay}from"../../../../../../chunks/autofill-overlay.js";import{t as CustomInstance}from"../../../../../../chunks/custom-instance.js";import{t as DeleteConfirmationModal}from"../../../../../../chunks/delete-confirmation-modal.js";import{t as createJSONPatch}from"../../../../../../chunks/utils2.js";import{n as metadata_instance_form_module_default,t as MetadataInstanceFormCardWrapper}from"../../../../../../chunks/metadata-instance-form-card-wrapper.js";import{useEffect,useMemo,useRef,useState}from"react";import{jsx,jsxs}from"react/jsx-runtime";import clsx from"clsx";import{Form,Formik}from"formik";import isEqual from"lodash/isEqual";var FormikObserver=({dirty,onChange,values})=>{let prevValuesRef=useRef(values);return dirty&&!isEqual(prevValuesRef.current.metadata.fields,values.metadata.fields)&&(prevValuesRef.current=values,onChange(values)),null},MetadataInstanceForm=props=>{let{itemType=`file`,areAiSuggestionsAvailable,customRef,isLargeFile,errorCode,isAiSuggestionsFeatureEnabled,isAdvancedExtractAgentEnabled=!1,isBetaLanguageEnabled,isDeleteButtonDisabled,isDeleteConfirmationModalCheckboxEnabled,isMultilevelTaxonomyFieldEnabled,isTaxonomyPickerEnabled,createTaxonomyItemsService,isUnsavedChangesModalOpen=!1,MetadataInstanceFormCustomWrapper,selectedTemplateInstance,onCancel,onChange,onDelete,onDiscardUnsavedChanges,onSubmit,onToggleReviewFilter,setIsUnsavedChangesModalOpen,shouldShowOnlyReviewFields=!1,taxonomyOptionsFetcher,isConfidenceScoreReviewEnabled=!1,isBoundingBoxEnabled=!1,onSelectMetadataField,selectedMetadataFieldId,isUserFieldEnabled=!1,fetchUsers,fetchAvatarUrls,resolveUsersByEmail}=props,isBoundingBoxOrConfidenceScoreReviewEnabled=isBoundingBoxEnabled||isConfidenceScoreReviewEnabled,FormWrapper=MetadataInstanceFormCustomWrapper??MetadataInstanceFormCardWrapper,[isDeleteConfirmationModalOpen,setIsDeleteConfirmationModalOpen]=useState(!1),{isFetchingSuggestions,isLongLoading,getAiSuggestions,clearState,suggestions}=useAutofill(),{trackEvent}=useMetadataEditorAnalytics();useEffect(()=>()=>{clearState()},[clearState,selectedTemplateInstance?.id]);let isCustomMetadata=selectedTemplateInstance?.templateKey===TEMPLATE_CUSTOM_PROPERTIES,handleSubmit=async values=>{await onSubmit(values,createJSONPatch(values,selectedTemplateInstance))},handleCancel=isFormDirty=>{isFormDirty?setIsUnsavedChangesModalOpen(!0):onCancel()},handleDelete=()=>{setIsDeleteConfirmationModalOpen(!0)},initialValues={metadata:{...selectedTemplateInstance}},formRef=useRef(null),[portalElement,setPortalElement]=useState(null);useEffect(()=>{setPortalElement(customRef??formRef.current)},[customRef,selectedTemplateInstance?.templateKey,selectedTemplateInstance?.scope]);let content=useMemo(()=>{let isEmpty=selectedTemplateInstance?.fields.length===0;if(isCustomMetadata)return jsx(CustomInstance,{isLoading:isFetchingSuggestions});if(isEmpty)return jsx(MetadataEmptyState,{isBoxAiSuggestionsFeatureEnabled:isAiSuggestionsFeatureEnabled,level:`instance`});let showOverlay=!!(isFetchingSuggestions||errorCode);return jsxs(`div`,{className:clsx(metadata_instance_form_module_default.metadataInstanceFormContent,showOverlay&&metadata_instance_form_module_default.showOverlay,isBoundingBoxOrConfidenceScoreReviewEnabled&&metadata_instance_form_module_default.metadataInstanceFormContentReducedGap),children:[jsx(AutofillOverlay,{errorCode,isFetchingSuggestions,isLongLoading}),jsx(TemplateInstance,{disableForm:isFetchingSuggestions,isConfidenceScoreReviewEnabled,isBoundingBoxEnabled,isExternallyOwned:selectedTemplateInstance?.isExternallyOwned,isMultilevelTaxonomyFieldEnabled,isTaxonomyPickerEnabled,isUserFieldEnabled,createTaxonomyItemsService,onSelectMetadataField,selectedMetadataFieldId,portalElement:customRef??portalElement,shouldShowOnlyReviewFields,taxonomyOptionsFetcher,fetchAvatarUrls,fetchUsers,resolveUsersByEmail})]})},[selectedTemplateInstance?.fields.length,selectedTemplateInstance?.isExternallyOwned,isCustomMetadata,isFetchingSuggestions,isLongLoading,customRef,portalElement,taxonomyOptionsFetcher,isAiSuggestionsFeatureEnabled,isConfidenceScoreReviewEnabled,isBoundingBoxEnabled,isBoundingBoxOrConfidenceScoreReviewEnabled,isMultilevelTaxonomyFieldEnabled,isTaxonomyPickerEnabled,createTaxonomyItemsService,errorCode,shouldShowOnlyReviewFields,onSelectMetadataField,selectedMetadataFieldId,isUserFieldEnabled,fetchUsers,fetchAvatarUrls,resolveUsersByEmail]);return jsx(Formik,{initialValues,onSubmit:handleSubmit,children:({values,dirty})=>jsxs(Form,{children:[jsx(FormWrapper,{areAiSuggestionsAvailable,className:metadata_instance_form_module_default.metadataInstanceForm,formRef,formValues:values,getAiSuggestions,handleCancel,handleDelete,isAdvancedExtractAgentEnabled,isAiSuggestionsFeatureEnabled,isBetaLanguageEnabled,isConfidenceScoreReviewEnabled,isBoundingBoxEnabled,isDeleteButtonDisabled,isFetchingSuggestions,isFormDirty:dirty,isLargeFile,onToggleReviewFilter,selectedTemplateInstance,shouldShowOnlyReviewFields,suggestions,children:selectedTemplateInstance&&content}),onChange&&jsx(FormikObserver,{dirty,onChange,values}),jsx(UnsavedChangesModal,{onBackToEdit:()=>setIsUnsavedChangesModalOpen(!1),onDiscardChanges:onDiscardUnsavedChanges,open:isUnsavedChangesModalOpen,trackEvent}),jsx(DeleteConfirmationModal,{isCheckboxEnabled:isDeleteConfirmationModalCheckboxEnabled,itemType,onConfirm:()=>onDelete(selectedTemplateInstance),onDismiss:()=>setIsDeleteConfirmationModalOpen(!1),open:isDeleteConfirmationModalOpen,templateName:selectedTemplateInstance?.displayName})]})},`${selectedTemplateInstance?.scope}.${selectedTemplateInstance?.templateKey}`)};export{MetadataInstanceForm};

package/dist/types/lib/components/metadata-empty-state/messages.d.ts

@@ -29,6 +29,16 @@ declare const messages: {
         description: string;
         id: string;
     };
+    folderLevelEmptyStateDefaultHeading: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    folderLevelEmptyStateDefaultBody: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
     instanceLevelEmptyStateHeading: {
         defaultMessage: string;
         description: string;

package/dist/types/lib/components/metadata-instance-editor/subcomponents/delete-confirmation-modal/delete-confirmation-modal.d.ts

@@ -1,2 +1,2 @@
 import { DeleteConfirmationModalProps } from './types';
-export declare const DeleteConfirmationModal: ({ onConfirm, templateName, onDismiss, open, isCheckboxEnabled, }: DeleteConfirmationModalProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DeleteConfirmationModal: ({ onConfirm, templateName, onDismiss, open, isCheckboxEnabled, itemType, }: DeleteConfirmationModalProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/metadata-instance-editor/subcomponents/delete-confirmation-modal/messages.d.ts

@@ -19,6 +19,11 @@ declare const messages: {
         description: string;
         id: string;
     };
+    deleteConfirmationModalBodyFirstParagraphFolder: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
     deleteConfirmationModalBodyFirstParagraphCheckboxVersion: {
         defaultMessage: string;
         description: string;

package/dist/types/lib/components/metadata-instance-editor/subcomponents/delete-confirmation-modal/types.d.ts

@@ -1,5 +1,8 @@
+import { MetadataItemType } from '../../../../types';
 export type DeleteConfirmationModalProps = {
     isCheckboxEnabled: boolean;
+    /** Item metadata is being removed from. Defaults to `file`. */
+    itemType?: MetadataItemType;
     onConfirm: () => void | Promise<void>;
     onDismiss: () => void;
     open: boolean;

package/dist/types/lib/components/metadata-instance-editor/subcomponents/metadata-instance-form/types.d.ts

@@ -1,10 +1,16 @@
-import { AutofillSuggestions, MetadataTemplateField, MetadataTemplateInstance } from '../../../../types';
+import { AutofillSuggestions, MetadataItemType, MetadataTemplateField, MetadataTemplateInstance } from '../../../../types';
 import { CreateTaxonomyItemsService, TaxonomyOptionsFetcher } from '../../../metadata-editor-fields/components/metadata-taxonomy-field/types';
 import { FetchAvatarUrls, FetchUsers, ResolveUsersByEmail } from '../../../metadata-editor-fields/components/metadata-user-field/types';
 import { FormValues } from '../../types';
 import { ERROR_CODE_METADATA_AUTOFILL_TIMEOUT, ERROR_CODE_METADATA_PRECONDITION_FAILED, ERROR_CODE_MISSING_PERMISSIONS, ERROR_CODE_UNKNOWN } from './constants';
 export type errorCodeTypes = typeof ERROR_CODE_METADATA_AUTOFILL_TIMEOUT | typeof ERROR_CODE_METADATA_PRECONDITION_FAILED | typeof ERROR_CODE_MISSING_PERMISSIONS | typeof ERROR_CODE_UNKNOWN;
 export type MetadataInstanceFormProps = {
+    /**
+     * Selects item-specific copy, including the delete confirmation. Defaults to `file`.
+     * Does not gate any feature: autofill, confidence score review, and bounding boxes are
+     * controlled solely by their own flags, and are supported for files only.
+     */
+    itemType?: MetadataItemType;
     areAiSuggestionsAvailable: boolean;
     errorCode?: errorCodeTypes;
     isAiSuggestionsFeatureEnabled: boolean;

package/dist/types/lib/types.d.ts

@@ -3,6 +3,8 @@ import { UserContactType } from '@box/user-selector';
 import { default as React } from 'react';
 import { BaseOptionType } from './components/combobox-with-api-pagination/types';
 export type { FormValues } from './components/metadata-instance-editor/types';
+/** Host item the editor is bound to. Defaults to `file` when omitted. */
+export type MetadataItemType = 'file' | 'folder';
 export type StoredAgentType = 'standard' | 'enhanced' | null;
 export type ExtractAgent = {
     AGENT_TYPE: StoredAgentType;
@@ -13,7 +15,11 @@ export type ExtractAgent = {
 export type MetadataEmptyStateProps = {
     isBoxAiSuggestionsFeatureEnabled?: boolean;
     isAnyEmptyValueHidden?: boolean;
-    level: 'manager' | 'file' | 'instance';
+    /**
+     * Surface copy. For a file or folder, use the same item as `itemType` on `MetadataInstanceForm`
+     * (`level="file"` or `level="folder"`) so the empty state and the delete modal agree.
+     */
+    level: 'manager' | 'file' | 'folder' | 'instance';
     onShowEmptyValues?: () => void;
 };
 export type MetadataFormFieldValue = string | Array<string> | number | Array<BaseOptionType> | Array<UserContactType>;

package/package.json

@@ -1,15 +1,15 @@
 {
     "name": "@box/metadata-editor",
-    "version": "2.9.1",
+    "version": "2.10.0",
     "peerDependencies": {
         "@ariakit/react": "0.4.21",
-        "@box/blueprint-web": "^17.18.1",
-        "@box/blueprint-web-assets": "^5.11.1",
-        "@box/box-ai-agent-selector": "^2.3.1",
-        "@box/combobox-with-api": "^2.3.1",
-        "@box/metadata-taxonomy-picker": "^3.4.1",
-        "@box/metadata-template-browser": "^2.5.1",
-        "@box/user-selector": "^3.1.1",
+        "@box/blueprint-web": "^17.18.2",
+        "@box/blueprint-web-assets": "^5.11.2",
+        "@box/box-ai-agent-selector": "^2.3.2",
+        "@box/combobox-with-api": "^2.3.2",
+        "@box/metadata-taxonomy-picker": "^3.4.2",
+        "@box/metadata-template-browser": "^2.5.2",
+        "@box/user-selector": "^3.1.2",
         "formik": "^2.0.3",
         "lodash": "^4.17.15",
         "react": "^17.0.0 || ^18.0.0",
@@ -19,12 +19,12 @@
     "devDependencies": {
         "@ariakit/react": "0.4.21",
         "@box/babel-plugin-target-attributes": "2.2.25",
-        "@box/blueprint-web": "^17.18.1",
-        "@box/blueprint-web-assets": "^5.11.1",
-        "@box/box-ai-agent-selector": "^2.3.1",
-        "@box/metadata-taxonomy-picker": "^3.4.1",
-        "@box/storybook-utils": "^1.3.1",
-        "@box/user-selector": "^3.1.1",
+        "@box/blueprint-web": "^17.18.2",
+        "@box/blueprint-web-assets": "^5.11.2",
+        "@box/box-ai-agent-selector": "^2.3.2",
+        "@box/metadata-taxonomy-picker": "^3.4.2",
+        "@box/storybook-utils": "^1.3.2",
+        "@box/user-selector": "^3.1.2",
         "@testing-library/react": "^15.0.6",
         "react": "^18.3.0",
         "react-dom": "^18.3.0",