twenty/packages/twenty-front/src/modules/page-layout/widgets/hooks/useWidgetActions.ts

import { useFieldMetadataItemById } from '@/object-metadata/hooks/useFieldMetadataItemById';
import { useGetIsMetadataItemFromStandardApplication } from '@/object-metadata/hooks/useGetIsMetadataItemFromStandardApplication';
import { useObjectMetadataItem } from '@/object-metadata/hooks/useObjectMetadataItem';
import { formatFieldMetadataItemAsColumnDefinition } from '@/object-metadata/utils/formatFieldMetadataItemAsColumnDefinition';
import { useObjectPermissions } from '@/object-record/hooks/useObjectPermissions';
import { useIsRecordReadOnly } from '@/object-record/read-only/hooks/useIsRecordReadOnly';
import { isRecordFieldReadOnly } from '@/object-record/read-only/utils/isRecordFieldReadOnly';
import { isFieldRelation } from '@/object-record/record-field/ui/types/guards/isFieldRelation';
import { useResolveFieldMetadataIdFromNameOrId } from '@/page-layout/hooks/useResolveFieldMetadataIdFromNameOrId';
import { type PageLayoutWidget } from '@/page-layout/types/PageLayoutWidget';
import { isFieldWidget } from '@/page-layout/widgets/field/utils/isFieldWidget';
import { type WidgetAction } from '@/page-layout/widgets/types/WidgetAction';
import { getObjectPermissionsFromMapByObjectMetadataId } from '@/settings/roles/role-permissions/objects-permissions/utils/getObjectPermissionsFromMapByObjectMetadataId';
import { useTargetRecord } from '@/ui/layout/contexts/useTargetRecord';
import { isDefined } from 'twenty-shared/utils';
import { RelationType } from '~/generated-metadata/graphql';

type UseWidgetActionsParams = {
  widget: PageLayoutWidget;
};

export const useWidgetActions = ({
  widget,
}: UseWidgetActionsParams): WidgetAction[] => {
  const targetRecord = useTargetRecord();

  const { objectMetadataItem } = useObjectMetadataItem({
    objectNameSingular: targetRecord.targetObjectNameSingular,
  });

  const fieldMetadataId = isFieldWidget(widget)
    ? widget.configuration.fieldMetadataId
    : undefined;

  const resolvedFieldMetadataId = useResolveFieldMetadataIdFromNameOrId(
    fieldMetadataId ?? '',
  );

  const { fieldMetadataItem } = useFieldMetadataItemById(
    resolvedFieldMetadataId ?? '',
  );

  const { objectPermissionsByObjectMetadataId } = useObjectPermissions();
  const getIsMetadataItemFromStandardApplication =
    useGetIsMetadataItemFromStandardApplication();

  const isRecordReadOnly = useIsRecordReadOnly({
    recordId: targetRecord.id,
    objectMetadataId: objectMetadataItem.id,
  });

  const actions: WidgetAction[] = [];

  if (
    !isFieldWidget(widget) ||
    !isDefined(fieldMetadataItem) ||
    !fieldMetadataItem.isActive
  ) {
    return actions;
  }

  const fieldDefinition = formatFieldMetadataItemAsColumnDefinition({
    field: fieldMetadataItem,
    position: 0,
    objectMetadataItem,
    showLabel: true,
    labelWidth: 90,
  });

  const isOneToManyRelation =
    isFieldRelation(fieldDefinition) &&
    fieldDefinition.metadata.relationType === RelationType.ONE_TO_MANY;

  // "See all" links to the relation field's own index, which lists the first
  // hop. A nested widget lists the second hop, so the link would point at a
  // different object than the widget shows.
  const isNestedRelationWidget =
    isFieldWidget(widget) &&
    isDefined(widget.configuration.nestedRelationFieldMetadataId);

  if (isOneToManyRelation && !isNestedRelationWidget) {
    actions.push({
      id: 'see-all',
      position: 0,
    });
  }

  const isFieldReadOnly = isRecordFieldReadOnly({
    isRecordReadOnly,
    isSystemObject: objectMetadataItem.isSystem,
    objectPermissions: getObjectPermissionsFromMapByObjectMetadataId({
      objectPermissionsByObjectMetadataId,
      objectMetadataId: objectMetadataItem.id,
    }),
    isFieldFromStandardApplication:
      getIsMetadataItemFromStandardApplication(fieldMetadataItem),
    fieldMetadataItem: {
      id: fieldMetadataItem.id,
      isUIEditable: fieldMetadataItem.isUIEditable ?? true,
    },
    fieldDefinition,
    objectPermissionsByObjectMetadataId,
  });

  if (!isFieldReadOnly) {
    actions.push({
      id: 'edit',
      position: 1,
    });
  }

  return actions.sort((a, b) => a.position - b.position);
};