@box/metadata-template-editor 1.19.0

package/dist/types/lib/utils/field-options/useFieldOptions.d.ts

@@ -0,0 +1,34 @@
+import { FieldType } from '../../types';
+/**
+ * Represents the structure of a field type for displaying in the field picker.
+ */
+export type FieldOptionType = {
+    /** The type of the field (e.g., "text", "number", etc.) */
+    type: FieldType;
+    /** The localized label for the field type */
+    label: string;
+    /** The localized description for the field type */
+    description: string;
+    /** The associated icon component for the field type */
+    Icon: (props: React.SVGProps<SVGSVGElement>) => React.JSX.Element;
+};
+/**
+ * Return type for the useFieldOptions hook.
+ * Note: This shared implementation does not perform taxonomy availability checks.
+ * Consumers that need to hide the Taxonomy type (e.g. when no taxonomies exist)
+ * should filter availableFieldTypes or provide their own data source.
+ */
+export type FieldOptionTypes = {
+    /** Array of metadata for all available field types */
+    availableFieldTypes: FieldOptionType[];
+};
+/**
+ * Provides a list of available metadata field types with localized labels,
+ * descriptions, and icons. Both FieldTypeTiles and FieldTypeDropdown
+ * use this hook as their single field-type source.
+ *
+ * This shared implementation returns all field types and does not depend on
+ * app-specific logic (e.g. taxonomy availability). Host apps can filter the list
+ * or pass a custom source when integrating.
+ */
+export declare function useFieldOptions(): FieldOptionTypes;

package/dist/types/lib/utils/key-generation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generate a camelCase all alphanumeric key out of a display name. Key cannot start with a numeral
+ * If no key name can be created, return default key.
+ * @param displayName - The display name to generate the key from
+ * @param defaultKey - The default key to use if no valid key can be generated
+ * @returns The key generated from the display name
+ */
+export declare function displayNameToKey(displayName: string, defaultKey: string): string;
+/**
+ * Generate a unique camelCase all alphanumeric key out of a display name which is less than a max key length.
+ * Key generated will likely be shorter than the max key length to provide space for uniqueness token.
+ * Unique among existing keys.
+ * @param displayName - The display name to generate the key from
+ * @param existingKeys - The list of existing keys to ensure uniqueness
+ * @param defaultKey - The default key to use if no valid key can be generated
+ * @param maxKeyLength - The maximum allowed length for the key
+ * @returns A unique key generated from the display name
+ */
+export declare const generateKey: ({ displayName, existingKeys, defaultKey, maxKeyLength, }: {
+    displayName: string;
+    existingKeys: string[];
+    defaultKey: string;
+    maxKeyLength: number;
+}) => string;

package/dist/types/lib/utils/template-type-conversion/convertLocalConfiguratorToTemplateField.d.ts

@@ -0,0 +1,25 @@
+import { FieldData, MetadataTemplateFieldCreateBody } from '../../types';
+/**
+ * Extracts the selectable taxonomy levels based on the field configuration.
+ *
+ * This function determines which hierarchy levels users can select from a taxonomy
+ * based on the configured selection rules. It supports two modes:
+ * - "AllowAny": Users can select from any available level in the taxonomy
+ * - Specific selection: Users can only select from explicitly configured levels
+ *
+ * @param field - The field configuration data containing taxonomy settings
+ * @returns Array of level numbers that users can select from. Returns empty array
+ *          if taxonomy is not found or no levels are configured.
+ */
+export declare const resolveSelectableLevels: (field: FieldData) => number[];
+/**
+ * Converts a FieldData type from FieldConfigurator back to a MetadataTemplateFieldCreateBody.
+ *
+ * @param field - The field from FieldConfigurator.
+ * @param existingKeys - The list of keys already generated to ensure uniqueness.
+ * @returns An object containing the converted field and the updated list of generated keys.
+ */
+export declare const convertLocalConfiguratorToTemplateField: (field: FieldData, existingKeys?: string[]) => {
+    field: MetadataTemplateFieldCreateBody;
+    updatedKeys: string[];
+};

package/dist/types/lib/utils/template-type-conversion/convertTemplateFieldToLocalConfigurator.d.ts

@@ -0,0 +1,8 @@
+import { ApiMetadataTemplateField, FieldData } from '../../types';
+/**
+ * Converts a ApiMetadataTemplateField to a FieldData type required by FieldConfigurator component.
+ *
+ * @param field - The field from ApiMetadataTemplate.
+ * @returns The converted field as FieldData.
+ */
+export declare const convertApiMetadataTemplateFieldToLocalConfiguratorField: (field: ApiMetadataTemplateField, isReadOnly?: boolean) => FieldData;

package/dist/types/lib/utils/template-type-conversion/generateJSONPatchTemplateOperations.d.ts

@@ -0,0 +1,16 @@
+import { ApiMetadataTemplateFieldType, MetadataTemplateEditorFormValues, MetadataTemplatePatchItem } from '../../types';
+export declare const configuratorFieldTypeToMetadataFieldTypeMap: {
+    readonly text: ApiMetadataTemplateFieldType.String;
+    readonly date: ApiMetadataTemplateFieldType.Date;
+    readonly number: ApiMetadataTemplateFieldType.Float;
+};
+/**
+ * Generate MetadataTemplatePatchItem array for all operations made to the template schema.
+ */
+export declare function generateJSONPatchTemplateOperations(initialTemplate: MetadataTemplateEditorFormValues, updatedTemplate: MetadataTemplateEditorFormValues): MetadataTemplatePatchItem[];
+/**
+ * Convenience helper that produces a single EditTemplate patch operation
+ * to update only the template's display name.
+ * Use when the caller needs to rename a template without running a full form diff.
+ */
+export declare function generateJSONPatchTemplateOperationToUpdateTemplateName(displayName: string): MetadataTemplatePatchItem[];

package/dist/types/lib/utils/template-type-conversion/mapFieldsWithUniqueKeys.d.ts

@@ -0,0 +1,8 @@
+import { FieldData, MetadataTemplateFieldCreateBody } from '../../types';
+/**
+ * Maps a list of configurator fields to template fields with unique keys.
+ *
+ * @param fields - The list of configurator fields to process.
+ * @returns An array of template fields with unique keys.
+ */
+export declare const mapFieldsWithUniqueKeys: (fields: FieldData[]) => MetadataTemplateFieldCreateBody[];

package/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "@box/metadata-template-editor",
+    "version": "1.19.0",
+    "license": "SEE LICENSE IN LICENSE",
+    "peerDependencies": {
+        "@box/blueprint-web": "^14.1.0",
+        "@box/blueprint-web-assets": "^4.111.18",
+        "@dnd-kit/core": "^6.1.0",
+        "@dnd-kit/sortable": "^8.0.0",
+        "@dnd-kit/utilities": "^3.2.2",
+        "clsx": "^1.2.1",
+        "formik": "^2.0.3",
+        "lodash": "^4.17.15",
+        "react": "^18.0.0",
+        "react-dom": "^18.0.0",
+        "react-intl": "^6.4.2",
+        "yup": "^1.6.1"
+    },
+    "devDependencies": {
+        "@box/blueprint-web": "^14.1.0",
+        "@box/blueprint-web-assets": "^4.111.18",
+        "@box/eslint-plugin-blueprint": "1.1.9",
+        "@box/storybook-utils": "0.17.18",
+        "@dnd-kit/core": "^6.1.0",
+        "@dnd-kit/sortable": "^8.0.0",
+        "@dnd-kit/utilities": "^3.2.2",
+        "clsx": "^1.2.1",
+        "formik": "^2.0.3",
+        "lodash": "^4.17.15",
+        "react-intl": "^6.4.2",
+        "yup": "^1.6.1"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/esm/index.js",
+    "module": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/esm/index.js",
+            "import": "./dist/esm/index.js",
+            "types": "./dist/types/index.d.ts"
+        },
+        "./*": {
+            "require": "./dist/esm/*",
+            "import": "./dist/esm/*",
+            "types": "./dist/types/*"
+        },
+        "./i18n/*": {
+            "require": "./dist/i18n/*",
+            "import": "./dist/i18n/*"
+        }
+    },
+    "sideEffects": [
+        "**/*.css"
+    ]
+}