@box/metadata-editor 0.63.0 → 0.64.1

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

@@ -1,4 +1,5 @@
 export declare const MetadataEditorFieldWrapper: import("react").ForwardRefExoticComponent<import("./types").TemplateInstanceProps & {
     field: import("../../types").MetadataTemplateField;
     index: number;
+    taxonomyOptionsFetcher: import("./components/metadata-taxonomy-field/types").TaxonomyOptionsFetcher;
 } & import("react").RefAttributes<HTMLInputElement>>;

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

@@ -1,18 +1,23 @@
 import { type MetadataTemplateField, type MetadataTemplateFieldOption } from '../../types';
+import { type TaxonomyOptionsFetcher } from './components/metadata-taxonomy-field/types';
 export type TemplateInstanceProps = {
     disableForm: boolean;
     portalElement?: HTMLElement;
+    taxonomyOptionsFetcher: TaxonomyOptionsFetcher;
 };
 export type MetadataFieldProps = {
     description?: string | null;
     label: string;
     fieldNamePrefix: string;
+    updateModePrefix?: string;
     disableForm: boolean;
     portalElement?: HTMLElement;
     options?: Array<MetadataTemplateFieldOption>;
+    taxonomyOptionsFetcher: TaxonomyOptionsFetcher;
     className?: string;
 };
 export type MetadataEditorFieldWrapperProps = TemplateInstanceProps & {
     field: MetadataTemplateField;
     index: number;
+    taxonomyOptionsFetcher: TaxonomyOptionsFetcher;
 };

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

@@ -0,0 +1,3 @@
+export declare const getFieldLabel: (label: string, description?: string) => string | (({ ...rest }: {
+    [x: string]: any;
+}) => import("react/jsx-runtime").JSX.Element);

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

@@ -1,5 +1,6 @@
 import { type MetadataFormFieldValue, type MetadataTemplateInstance } from '../../../../types';
 import { type FormValues } from '../../types';
+import { type TaxonomyOptionsFetcher } from '../../../metadata-editor-fields/components/metadata-taxonomy-field/types';
 export type MetadataInstanceFormProps = {
     areAiSuggestionsAvailable: boolean;
     isAiSuggestionsFeatureEnabled: boolean;
@@ -8,10 +9,11 @@ export type MetadataInstanceFormProps = {
     selectedTemplateInstance: MetadataTemplateInstance;
     onCancel: () => void;
     onDelete: (templateInstance: MetadataTemplateInstance) => void;
-    onSubmit: (values: FormValues, operations: JSONPatchOperations) => Promise<void>;
-    setIsUnsavedChangesModalOpen: (isUnsavedChangesModalOpen: boolean) => void;
     /** Callback invoked when clicking Discard Changes button on the UnsavedChangesModal - can be used to reset form values */
     onDiscardUnsavedChanges?: () => void;
+    onSubmit: (values: FormValues, operations: JSONPatchOperations) => Promise<void>;
+    setIsUnsavedChangesModalOpen: (isUnsavedChangesModalOpen: boolean) => void;
+    taxonomyOptionsFetcher: TaxonomyOptionsFetcher;
 };
 export declare const JSONPatchOp: {
     readonly ADD: "add";

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

@@ -1,6 +1,4 @@
-import { type MetadataTemplateField } from '../../types';
+import { type MetadataTemplateInstance } from '../../types';
 export type FormValues = {
-    metadata: {
-        fields: MetadataTemplateField[];
-    };
+    metadata: MetadataTemplateInstance;
 };

package/types/lib/messages.d.ts

@@ -74,6 +74,11 @@ declare const messages: {
         description: string;
         id: string;
     };
+    taxonomyPlaceholder: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
     templateSelectorModalHeader: {
         defaultMessage: string;
         description: string;

package/types/lib/test-utils/sample-data.d.ts

@@ -4,10 +4,13 @@ declare const dateField: MetadataTemplateField;
 declare const enumField: MetadataTemplateField;
 declare const floatField: MetadataTemplateField;
 declare const multiSelectField: MetadataTemplateField;
+declare const taxonomySingleSelectSingleLevelField: MetadataTemplateField;
+declare const taxonomyMultiSelectSingleLevelField: MetadataTemplateField;
 declare const hiddenField: MetadataTemplateField;
 declare const noValueField: MetadataTemplateField;
 declare const allFieldsTemplate: MetadataTemplate;
 declare const nonHiddenFieldsTemplate: MetadataTemplate;
+declare const nonHiddenFieldsWithValuesTemplate: MetadataTemplate;
 declare const noFieldsTemplate: MetadataTemplate;
 declare const templates: MetadataTemplate[];
 declare const customTemplate: MetadataTemplate;
@@ -30,4 +33,4 @@ declare const firstTemplateInstanceFieldsWithSuggestions: MetadataTemplateField[
 declare const secondTemplateInstance: MetadataTemplate;
 declare const secondTemplateSuggestions: AutofillSuggestions;
 declare const secondTemplateInstanceFieldsWithSuggestions: MetadataTemplateField[];
-export { allFieldsTemplate, allFieldsTemplateInstance, customTemplate, customTemplateInstance, customTemplateInstanceWithAllFieldsEmpty, customTemplateInstanceWithoutEmptyValues, dateField, emptyCustomTemplateInstance, emptyTemplateInstance, enumField, fields, floatField, hiddenField, multiSelectField, noFieldsTemplate, nonHiddenFieldsTemplate, noValueField, stringField, templateInstancesList, templateInstanceWithAllFieldsEmpty, templateInstanceWithoutEmptyValues, templateOptions, templates, allFieldsWithAiSuggestions, allFieldsSuggestions, firstTemplateInstance, firstTemplateInstanceFieldsWithSuggestions, secondTemplateInstance, firstTemplateSuggestions, secondTemplateSuggestions, secondTemplateInstanceFieldsWithSuggestions, };
+export { allFieldsTemplate, allFieldsTemplateInstance, customTemplate, customTemplateInstance, customTemplateInstanceWithAllFieldsEmpty, customTemplateInstanceWithoutEmptyValues, dateField, emptyCustomTemplateInstance, emptyTemplateInstance, enumField, fields, floatField, hiddenField, multiSelectField, noFieldsTemplate, nonHiddenFieldsTemplate, nonHiddenFieldsWithValuesTemplate, noValueField, stringField, taxonomySingleSelectSingleLevelField, taxonomyMultiSelectSingleLevelField, templateInstancesList, templateInstanceWithAllFieldsEmpty, templateInstanceWithoutEmptyValues, templateOptions, templates, allFieldsWithAiSuggestions, allFieldsSuggestions, firstTemplateInstance, firstTemplateInstanceFieldsWithSuggestions, secondTemplateInstance, firstTemplateSuggestions, secondTemplateSuggestions, secondTemplateInstanceFieldsWithSuggestions, };

package/types/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { type BaseOptionType } from './components/combobox-with-api-pagination/types';
 export type { JSONPatchOperations } from './components/metadata-instance-editor/subcomponents/metadata-instance-form/types';
 export type { FormValues } from './components/metadata-instance-editor/types';
 export type MetadataEmptyStateProps = {
@@ -6,7 +7,7 @@ export type MetadataEmptyStateProps = {
     level: 'manager' | 'file' | 'instance';
     onShowEmptyValues?: () => void;
 };
-export type MetadataFormFieldValue = string | Array<string> | number;
+export type MetadataFormFieldValue = string | Array<string> | number | Array<BaseOptionType>;
 export type MetadataFields = Record<string, MetadataFieldValue>;
 export interface MetadataTemplateFieldOption {
     key: string;
@@ -24,7 +25,11 @@ export interface MetadataUpdateMode {
     /** Extra data e.g. replace field value for 'replaceEntered' mode */
     value?: MetadataFormFieldValue;
 }
-export type MetadataTemplateFieldType = 'string' | 'date' | 'enum' | 'float' | 'multiSelect';
+export type MetadataTemplateFieldType = 'string' | 'date' | 'enum' | 'float' | 'multiSelect' | 'taxonomy';
+export type TaxonomyOptionsRules = {
+    multiSelect: boolean;
+    selectableLevels: number[];
+};
 export type MetadataTemplateField = {
     description?: string;
     aiSuggestion?: MetadataFieldValue;
@@ -33,6 +38,9 @@ export type MetadataTemplateField = {
     id?: string;
     key: string;
     options?: MetadataTemplateFieldOption[];
+    optionsRules?: TaxonomyOptionsRules;
+    taxonomyKey?: string;
+    taxonomyId?: string;
     type: MetadataTemplateFieldType;
     updateMode?: MetadataUpdateMode;
     value?: MetadataFormFieldValue;
@@ -53,7 +61,7 @@ export type MetadataTemplateOption = {
     hidden: boolean;
     scope: string;
 };
-export type MetadataFieldValue = string | number | Array<string> | null;
+export type MetadataFieldValue = string | number | Array<string> | null | BaseOptionType[];
 export type MetadataTemplateInstance = {
     canEdit: boolean;
     displayName?: string;

package/esm/lib/components/metadata-editor-fields/components/metadata-taxonomy-field/index.js

@@ -1,4 +0,0 @@
-import { SingleLevelTaxonomyField as l } from "./single-level-taxonomy-field.js";
-export {
-  l as SingleLevelTaxonomyField
-};

package/esm/lib/components/metadata-editor-fields/components/metadata-taxonomy-field/single-level-taxonomy-field.js

@@ -1,8 +0,0 @@
-import { ComboboxWithApiPagination as i } from "../../../combobox-with-api-pagination/combobox-with-api-pagination.js";
-import { jsx as r } from "react/jsx-runtime";
-const m = (o) => /* @__PURE__ */ r(i, {
-  ...o
-});
-export {
-  m as SingleLevelTaxonomyField
-};

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

@@ -1,2 +0,0 @@
-export { SingleLevelTaxonomyField } from './single-level-taxonomy-field';
-export type { SingleLevelTaxonomyFieldProps } from './types';

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

@@ -1,5 +0,0 @@
-import { type SingleLevelTaxonomyFieldProps } from './types';
-/**
- * The Single Level Taxonomy Field component
- */
-export declare const SingleLevelTaxonomyField: (props: SingleLevelTaxonomyFieldProps) => import("react/jsx-runtime").JSX.Element;