@box/metadata-editor 2.0.1 → 2.2.0

package/dist/types/lib/components/metadata-editor-fields/components/metadata-taxonomy-field/types.d.ts

@@ -1,7 +1,19 @@
 import { TreeOptionType, TreeQueryInput } from '@box/combobox-with-api';
+import { TaxonomyItemsService } from '@box/metadata-taxonomy-picker';
 import { FetcherResponse, PaginationQueryInput } from '../../../combobox-with-api-pagination/types';
 import { MetadataFieldProps } from '../../types';
 export type MetadataTaxonomyFieldProps = Omit<MetadataFieldProps, 'portalElement'> & {
     portalElement?: HTMLElement | (() => HTMLElement);
 };
 export type TaxonomyOptionsFetcher = (scope: string, templateKey: string, fieldKey: string, level: number, options: PaginationQueryInput | TreeQueryInput) => Promise<FetcherResponse<TreeOptionType>>;
+/**
+ * Builds the per-field `TaxonomyItemsService` consumed by the new
+ * `MetadataTaxonomyPicker` experience. Called once per taxonomy field with that
+ * field's identity; browse/search level scoping is supplied by the picker per
+ * request, so it is intentionally not a parameter here.
+ */
+export type CreateTaxonomyItemsService = (params: {
+    scope: string;
+    templateKey: string;
+    fieldKey: string;
+}) => TaxonomyItemsService;

package/dist/types/lib/components/metadata-editor-fields/types.d.ts

@@ -1,12 +1,16 @@
 import { Level } from '@box/combobox-with-api';
 import { ConfidenceScoreData, MetadataTemplateField, MetadataTemplateFieldOption } from '../../types';
-import { TaxonomyOptionsFetcher } from './components/metadata-taxonomy-field/types';
+import { CreateTaxonomyItemsService, TaxonomyOptionsFetcher } from './components/metadata-taxonomy-field/types';
 export type TemplateInstanceProps = {
     disableForm: boolean;
     portalElement?: HTMLElement;
     taxonomyOptionsFetcher: TaxonomyOptionsFetcher;
     isExternallyOwned?: boolean;
     isMultilevelTaxonomyFieldEnabled: boolean;
+    /** When true, taxonomy fields render the new `MetadataTaxonomyPicker` experience instead of the legacy comboboxes. */
+    isTaxonomyPickerEnabled?: boolean;
+    /** Builds the per-field `TaxonomyItemsService` for the new picker experience. Required when `isTaxonomyPickerEnabled` is true. */
+    createTaxonomyItemsService?: CreateTaxonomyItemsService;
     isConfidenceScoreReviewEnabled?: boolean;
     isBoundingBoxEnabled?: boolean;
     shouldShowOnlyReviewFields?: boolean;
@@ -29,6 +33,10 @@ export type MetadataFieldProps = {
     onValueEdited: () => void;
     isExternallyOwned?: boolean;
     isMultilevelTaxonomyFieldEnabled: boolean;
+    /** When true, taxonomy fields render the new `MetadataTaxonomyPicker` experience instead of the legacy comboboxes. */
+    isTaxonomyPickerEnabled?: boolean;
+    /** Builds the per-field `TaxonomyItemsService` for the new picker experience. Required when `isTaxonomyPickerEnabled` is true. */
+    createTaxonomyItemsService?: CreateTaxonomyItemsService;
 };
 export type MetadataEditorFieldWrapperProps = TemplateInstanceProps & {
     field: MetadataTemplateField;

package/dist/types/lib/components/metadata-editor-fields/utils.d.ts

@@ -1,4 +1,12 @@
 import { Labelable, TextProps } from '@box/blueprint-web';
+import { ReactNode } from 'react';
 import { ConfidenceScoreData } from '../../types';
 export declare const getFieldLabel: (fieldName: string, fieldDescription: string | undefined, isAiSuggestionApplied?: boolean, as?: TextProps["as"], confidenceScore?: ConfidenceScoreData) => Labelable["label"];
+/**
+ * Returns the decorated field label as a `ReactNode` (field name + ellipsis/description
+ * tooltips + AI/confidence badge), rendered with a `<span>` root so it can be embedded
+ * inside a caller-owned `<label htmlFor>` without producing nested `<label>` elements.
+ * Used by the taxonomy picker field, where `MetadataTaxonomyPicker` owns the label element.
+ */
+export declare const getFieldLabelContent: (fieldName: string, fieldDescription: string | undefined, isAiSuggestionApplied?: boolean, confidenceScore?: ConfidenceScoreData) => ReactNode;
 export declare const tryParseDateSuggestion: (suggestedDate: string) => string;

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

@@ -1,5 +1,5 @@
 import { AutofillSuggestions, MetadataTemplateField, MetadataTemplateInstance } from '../../../../types';
-import { TaxonomyOptionsFetcher } from '../../../metadata-editor-fields/components/metadata-taxonomy-field/types';
+import { CreateTaxonomyItemsService, TaxonomyOptionsFetcher } from '../../../metadata-editor-fields/components/metadata-taxonomy-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;
@@ -13,6 +13,10 @@ export type MetadataInstanceFormProps = {
     isLargeFile: boolean;
     /** When true enables the multilevel taxonomy filed component with tree selection */
     isMultilevelTaxonomyFieldEnabled: boolean;
+    /** When true, taxonomy fields render the new `MetadataTaxonomyPicker` experience instead of the legacy comboboxes. Requires `createTaxonomyItemsService`. */
+    isTaxonomyPickerEnabled?: boolean;
+    /** Builds the per-field `TaxonomyItemsService` for the new picker experience. Required when `isTaxonomyPickerEnabled` is true. */
+    createTaxonomyItemsService?: CreateTaxonomyItemsService;
     isUnsavedChangesModalOpen: boolean;
     selectedTemplateInstance: MetadataTemplateInstance | null;
     onCancel: () => void;

package/dist/types/lib/test-utils/index.d.ts

@@ -3,4 +3,5 @@ export * from './formik-wrapper';
 export * from './mock-resize-observer';
 export * from './pending-promise';
 export * from './sample-data';
+export * from './taxonomy-items-service.mock';
 export * from './test-utils';

package/dist/types/lib/test-utils/taxonomy-items-service.mock.d.ts

@@ -0,0 +1,7 @@
+import { CreateTaxonomyItemsService } from '../components/metadata-editor-fields/components/metadata-taxonomy-field/types';
+/**
+ * Builds a demo `TaxonomyItemsService` for Storybook. Single-level taxonomy fields
+ * (keys containing `SingleLevel`) serve a flat country list; everything else serves
+ * a Country -> Region -> City hierarchy with `hasChildren` and search ancestors.
+ */
+export declare const createMockTaxonomyItemsService: CreateTaxonomyItemsService;

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "@box/metadata-editor",
-    "version": "2.0.1",
+    "version": "2.2.0",
     "peerDependencies": {
         "@ariakit/react": "0.4.21",
-        "@box/blueprint-web": "^16.0.0",
-        "@box/blueprint-web-assets": "^5.0.0",
-        "@box/box-ai-agent-selector": "^2.0.0",
-        "@box/combobox-with-api": "^2.0.0",
-        "@box/metadata-template-browser": "^2.0.0",
+        "@box/blueprint-web": "^16.1.1",
+        "@box/blueprint-web-assets": "^5.1.1",
+        "@box/box-ai-agent-selector": "^2.1.1",
+        "@box/combobox-with-api": "^2.1.1",
+        "@box/metadata-taxonomy-picker": "^3.1.1",
+        "@box/metadata-template-browser": "^2.1.1",
         "formik": "^2.0.3",
         "lodash": "^4.17.15",
         "react": "^17.0.0 || ^18.0.0",
@@ -16,11 +17,12 @@
     },
     "devDependencies": {
         "@ariakit/react": "0.4.21",
-        "@box/babel-plugin-target-attributes": "2.0.0",
-        "@box/blueprint-web": "^16.0.0",
-        "@box/blueprint-web-assets": "^5.0.0",
-        "@box/box-ai-agent-selector": "^2.0.0",
-        "@box/storybook-utils": "^1.0.0",
+        "@box/babel-plugin-target-attributes": "2.1.1",
+        "@box/blueprint-web": "^16.1.1",
+        "@box/blueprint-web-assets": "^5.1.1",
+        "@box/box-ai-agent-selector": "^2.1.1",
+        "@box/metadata-taxonomy-picker": "^3.1.1",
+        "@box/storybook-utils": "^1.1.1",
         "@testing-library/react": "^15.0.6",
         "react": "^18.3.0",
         "react-dom": "^18.3.0",