field-sync

name	field-sync
description	Synchronizes entity field changes across DTOs, services, frontend, and dictionary seeds. Invoke when adding/removing fields from entities.

Field Sync

Synchronizes entity field changes across the entire codebase including DTOs, Service implementations, frontend API and views, and dictionary seed data.

When to Use

• When adding new fields to an entity
• When removing fields from an entity
• When changing field types (e.g., int to bool, adding enum)
• When renaming entity fields

Workflow

Step 1: Understand the Changes

Ask the user to clarify:

• Which entity is being modified?
• What fields are being added/removed/changed?
• What are the new field types?
• Any new enums that need to be created?

Step 2: Update Backend DTOs

2.1 Find DTO Location

DTOs are located in: Yi.Abp/module/{module-name}/Yi.Module.{ModuleName}.Application.Contracts/Dtos/{EntityName}/

2.2 Update 5 DTO Files

For each of the following files, add/remove/update the corresponding field:

1. {EntityName}GetOutputDto.cs - Single entity retrieval output
2. {EntityName}GetListOutputDto.cs - List query output
3. {EntityName}CreateInputVo.cs - Creation input
4. {EntityName}UpdateInputVo.cs - Update input
5. {EntityName}GetListInputVo.cs - Query parameters (remove if field no longer needed for filtering)

Type Mapping:

• C# bool → TypeScript boolean
• C# int → TypeScript number
• C# Guid → TypeScript string
• C# Guid? → TypeScript string | null
• C# Enum → TypeScript number (use enum name in imports)
• New Enum → Add import: import type { EnumName } from '{module-path}/enums';

Step 3: Update Service Implementation

Location: Yi.Abp/module/{module-name}/Yi.Module.{ModuleName}.Application/Services/{EntityName}Service.cs

3.1 Update GetListAsync Method

• Update WhereIF conditions in the query
• Update Select mapping to include new fields or remove old fields

Step 4: Update Frontend API Model

Location: Yi.Vben5/apps/web-antd/src/api/{module-name}/{entity-name}/model.d.ts

Update the TypeScript interface to match the DTO changes.

Step 5: Update Frontend View Data

Location: Yi.Vben5/apps/web-antd/src/views/{module-name}/{entity-name}/data.ts

5.1 Update columns (for table display)

Add or remove column definitions:

{
  field: 'fieldName',
  title: 'Display Name',
  minWidth: 100,
  formatter({ cellValue }) {
    // For booleans
    return cellValue ? 'Yes' : 'No';
    // For enums
    return cellValue === 1 ? 'Value1' : 'Value0';
  },
}

5.2 Update drawerSchema (for create/edit form)

Add or remove form field definitions:

// Boolean field
{
  component: 'Switch',  // or 'Select' with options
  fieldName: 'fieldName',
  label: 'Display Name',
}

// Enum field
{
  component: 'Select',
  componentProps: {
    options: [
      { label: 'Option 1', value: 0 },
      { label: 'Option 2', value: 1 },
    ],
  },
  fieldName: 'fieldName',
  label: 'Display Name',
}

// Foreign key field (Guid)
{
  component: 'Input',  // or ApiSelect for dropdown
  fieldName: 'fieldName',
  label: 'Display Name',
}

5.3 Update querySchema (for search filters)

Add or remove query conditions.

Step 6: Add Dictionary Seed Data (If Needed)

If the field is a boolean or enum used in dropdowns, add dictionary data.

6.1 Update DictionaryTypeDataSeed.cs

Location: Yi.Abp/module/rbac/Yi.Module.Rbac.SqlSugarCore/DataSeeds/DictionaryTypeDataSeed.cs

Add new dictionary type:

DictionaryTypeAggregateRoot dictNew = new DictionaryTypeAggregateRoot()
{
    DictName = "Dictionary Type Name",
    DictType = "dict_type_key",
    OrderNum = 100,
    Remark = "Description",
    IsDeleted = false,
    State = true
};
entities.Add(dictNew);

6.2 Update DictionaryDataSeed.cs

Location: Yi.Abp/module/rbac/Yi.Module.Rbac.SqlSugarCore/DataSeeds/DictionaryDataSeed.cs

Add dictionary data entries:

DictionaryEntity dictData1 = new DictionaryEntity()
{
    DictLabel = "Label 1",
    DictValue = "Value1",
    DictType = "dict_type_key",
    OrderNum = 100,
    Remark = "Description",
    IsDeleted = false,
    State = true,
    ListClass = "default"  // success, danger, warning, info, primary, default
};
entities.Add(dictData1);

DictionaryEntity dictData2 = new DictionaryEntity()
{
    DictLabel = "Label 2",
    DictValue = "Value2",
    DictType = "dict_type_key",
    OrderNum = 99,
    Remark = "Description",
    IsDeleted = false,
    State = true,
    ListClass = "primary"
};
entities.Add(dictData2);

Step 7: Verification

Run build and typecheck to verify changes:

# Backend
dotnet build Yi.Abp/module/{module-name}/Yi.Module.{ModuleName}.Application/Yi.Module.{ModuleName}.Application.csproj

# Frontend
cd Yi.Vben5/apps/web-antd
npm run typecheck

Example: Adding Remark and PhoneNumber Fields to Role Entity

This example shows the changes needed for adding Remark (string) and PhoneNumber (string?) to the RoleAggregateRoot entity.

Backend Changes:

RoleGetOutputDto.cs:

• Add: public string? Remark { get; set; }
• Add: public string? PhoneNumber { get; set; }

RoleGetListOutputDto.cs:

• Add: public string? Remark { get; set; }

RoleCreateInputVo.cs / RoleUpdateInputVo.cs:

• Add: public string? Remark { get; set; }
• Add: public string? PhoneNumber { get; set; }

RoleGetListInputVo.cs:

• Add (if needed for filtering): public string? Remark { get; set; }

RoleService.cs:

• Add WhereIF: .WhereIF(!string.IsNullOrEmpty(input.Remark), x => x.Remark.Contains(input.Remark!))
• Add to Select mapping: Remark = x.Remark, PhoneNumber = x.PhoneNumber

Frontend Changes:

api/system/role/model.d.ts:

• Add: remark?: string | null;
• Add: phoneNumber?: string | null;

views/system/role/data.ts:

• Add columns entry:

  { field: 'remark', title: '备注' }
  

• Add drawerSchema entry:

  { component: 'Input', fieldName: 'remark', label: '备注' }
  

Dictionary Seeds (Not needed for this example):

No dictionary seeds required as both fields are plain strings.