Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

7.5 KB
Raw Blame
import { FieldCategories } from '@aliasvault/models/vault';
import React, { useState, useCallback, useMemo } from 'react';
import { useTranslation } from 'react-i18next';

import Icon from '@/entrypoints/popup/components/Icons/Icon';

import CustomFieldModal from './CustomFieldModal';

import type { FieldType, SystemFieldDefinition } from '@aliasvault/models/vault';

/**
 * Configuration for an optional section (not field-based).
 */
type OptionalSection = {
  /** Unique key for this section */
  key: string;
  /** Whether this section is currently visible */
  isVisible: boolean;
  /** Callback to add/show this section */
  onAdd: () => void;
};

/**
 * Callbacks for adding custom fields.
 */
type AddFieldMenuCallbacks = {
  /** Callback when a system field is added */
  onAddSystemField: (fieldKey: string) => void;
  /** Callback when a custom field is added */
  onAddCustomField: (label: string, fieldType: FieldType) => void;
};

type AddFieldMenuProps = {
  /**
   * Optional system fields for the current item type.
   * These are fields with ShowByDefault: false that can be added via the menu.
   */
  optionalSystemFields: SystemFieldDefinition[];
  /**
   * Field keys that are currently visible (either have a value or were manually added).
   */
  visibleFieldKeys: Set<string>;
  /**
   * Optional sections (like 2FA, Attachments) that are not field-based.
   */
  optionalSections: OptionalSection[];
  /**
   * Callbacks for adding fields.
   */
  callbacks: AddFieldMenuCallbacks;
};

/**
 * Menu option for internal use.
 */
type MenuOption = {
  key: string;
  label: string;
  icon: React.ReactNode;
  action: () => void;
};

/**
 * Notes icon for menu option.
 */
const NotesIcon: React.FC = () => (
  <Icon name="document-text" className="w-5 h-5" />
);

/**
 * Lock icon for 2FA menu option.
 */
const LockIcon: React.FC = () => (
  <Icon name="lock-closed" className="w-5 h-5" />
);

/**
 * Attachment icon for menu option.
 */
const AttachmentIcon: React.FC = () => (
  <Icon name="paper-clip" className="w-5 h-5" />
);

/**
 * Plus icon for add button and custom field option.
 */
const PlusIcon: React.FC = () => (
  <Icon name="plus-sm" className="w-5 h-5" />
);

/**
 * Get icon for a field category.
 */
const getFieldIcon = (category: string): React.ReactNode => {
  switch (category) {
    case FieldCategories.Notes:
      return <NotesIcon />;
    default:
      return <PlusIcon />;
  }
};

/**
 * Get icon for optional sections.
 */
const getSectionIcon = (key: string): React.ReactNode => {
  switch (key) {
    case '2fa':
      return <LockIcon />;
    case 'attachments':
      return <AttachmentIcon />;
    default:
      return <PlusIcon />;
  }
};

/**
 * A dropdown menu for adding optional fields and sections to an item.
 * Dynamically determines which options to show based on system field registry
 * and current field visibility.
 */
const AddFieldMenu: React.FC<AddFieldMenuProps> = ({
  optionalSystemFields,
  visibleFieldKeys,
  optionalSections,
  callbacks
}) => {
  const { t } = useTranslation();
  const [isOpen, setIsOpen] = useState(false);
  const [showCustomFieldModal, setShowCustomFieldModal] = useState(false);

  /**
   * Handle opening the custom field modal.
   */
  const handleOpenCustomFieldModal = useCallback((): void => {
    setShowCustomFieldModal(true);
    setIsOpen(false);
  }, []);

  /**
   * Handle adding a system field and closing menu.
   */
  const handleAddSystemField = useCallback((fieldKey: string): void => {
    callbacks.onAddSystemField(fieldKey);
    setIsOpen(false);
  }, [callbacks]);

  /**
   * Handle adding an optional section and closing menu.
   */
  const handleAddSection = useCallback((onAdd: () => void): void => {
    onAdd();
    setIsOpen(false);
  }, []);

  /**
   * Build menu options based on optional system fields and sections.
   */
  const menuOptions = useMemo((): MenuOption[] => {
    const options: MenuOption[] = [];

    // Add optional system fields that are not currently visible
    optionalSystemFields.forEach(field => {
      if (!visibleFieldKeys.has(field.FieldKey)) {
        options.push({
          key: field.FieldKey,
          label: t(`fieldLabels.${field.FieldKey}`, { defaultValue: field.FieldKey }),
          icon: getFieldIcon(field.Category),
          /**
           * Handle adding an optional system field.
           */
          action: () => handleAddSystemField(field.FieldKey)
        });
      }
    });

    // Add optional sections that are not currently visible
    optionalSections.forEach(section => {
      if (!section.isVisible) {
        options.push({
          key: section.key,
          label: t(`common.${section.key === '2fa' ? 'twoFactorAuthentication' : section.key}`),
          icon: getSectionIcon(section.key),
          /**
           * Handle adding an optional section.
           */
          action: () => handleAddSection(section.onAdd)
        });
      }
    });

    return options;
  }, [optionalSystemFields, visibleFieldKeys, optionalSections, t, handleAddSystemField, handleAddSection]);

  return (
    <>
      <div className="relative">
        <button
          type="button"
          id="add-field-menu"
          onClick={() => setIsOpen(!isOpen)}
          className="w-full px-4 py-2 border-2 border-dashed border-gray-300 dark:border-gray-600 text-gray-600 dark:text-gray-400 rounded-md hover:border-primary-500 hover:text-primary-600 dark:hover:text-primary-400 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-primary-500 transition-colors flex items-center justify-center gap-2"
        >
          <PlusIcon />
        </button>

        {/* Dropdown Menu */}
        {isOpen && (
          <>
            {/* Dark overlay backdrop for better visibility */}
            <div
              className="fixed inset-0 z-10 bg-gray-600/50 backdrop-blur-sm dark:bg-black/70"
              onClick={() => setIsOpen(false)}
            />
            <div className="absolute bottom-full left-0 right-0 mb-1 z-20 bg-white dark:bg-gray-800 border border-gray-200 dark:border-gray-700 rounded-md shadow-lg overflow-hidden">
              {menuOptions.map((option) => (
                <button
                  key={option.key}
                  type="button"
                  onClick={option.action}
                  className="w-full px-4 py-3 text-left hover:bg-gray-50 dark:hover:bg-gray-700 flex items-center gap-3 border-b border-gray-100 dark:border-gray-700 last:border-b-0 text-gray-700 dark:text-gray-300"
                >
                  <span className="text-gray-500 dark:text-gray-400">
                    {option.icon}
                  </span>
                  <span>{option.label}</span>
                </button>
              ))}
              {/* Custom field option - always available */}
              <button
                type="button"
                onClick={handleOpenCustomFieldModal}
                className="w-full px-4 py-3 text-left hover:bg-gray-50 dark:hover:bg-gray-700 flex items-center gap-3 border-b border-gray-100 dark:border-gray-700 last:border-b-0 text-gray-700 dark:text-gray-300"
              >
                <span className="text-gray-500 dark:text-gray-400">
                  <PlusIcon />
                </span>
                <span>{t('itemTypes.addCustomField')}</span>
              </button>
            </div>
          </>
        )}
      </div>

      {/* Custom Field Modal */}
      <CustomFieldModal
        isOpen={showCustomFieldModal}
        onClose={() => setShowCustomFieldModal(false)}
        onSubmit={callbacks.onAddCustomField}
      />
    </>
  );
};

export default AddFieldMenu;
export type { OptionalSection };