ไฟล์ร่าง (draft) — generate docx จาก template แบบ stateless ไม่สร้าง
Document/version; stamp เฉพาะ custom property TemplateId เพื่อให้ add-in
เห็นเป็น untracked; Start Versioning ส่ง form field templateId ให้ backend
ผูก template ตอน auto-create — เอกสารเริ่มที่ v1 (ไม่มี v0) + field sync เต็มระบบ
- Backend: POST /api/templates/{id}/generate-draft (200 คืนไฟล์) +
DocxGenerationService.GenerateDraft + แยก TemplateFieldValidation ใช้ร่วมกับ
generate + UploadVersion รับ templateId (non-GUID/unknown → 400,
deactivated → ผูกได้, document เดิม → เฉย) + CORS expose Content-Disposition
- Add-in: readTrackedProperties อ่าน TemplateId + ส่ง templateId เฉพาะ
startVersioning + hint ไฟล์ร่างใน task pane
- Web: ปุ่ม "สร้างไฟล์ร่าง" บนฟอร์มเดิม + downloadFile รับ init (POST → blob)
- Docs: spec v8 (FR-16, AC-19) + Phase 12 + CONTEXT.md + ADR 0002 +
acceptance-review AC-19
- Tests: backend 82 / add-in 66 / web 59 + build ครบ; QA reviewer PASS
(2 rounds); ค้าง manual บน Word จริง
Co-Authored-By: Claude Code <noreply@anthropic.com>
93 lines
3.4 KiB
C#
93 lines
3.4 KiB
C#
using System.ComponentModel.DataAnnotations;
|
|
using System.Text.Json;
|
|
|
|
namespace WordVersioning.Api.Models;
|
|
|
|
/// <summary>body ของ POST /api/templates (multipart/form-data)</summary>
|
|
public class CreateTemplateRequest
|
|
{
|
|
[Required]
|
|
public string Name { get; set; } = string.Empty;
|
|
|
|
public string? Description { get; set; }
|
|
|
|
[Required]
|
|
public IFormFile File { get; set; } = null!;
|
|
}
|
|
|
|
/// <summary>body ของ PUT /api/templates/{id} — Fields เป็น optional (ไม่ส่ง = แก้ metadata อย่างเดียว)</summary>
|
|
public class UpdateTemplateRequest
|
|
{
|
|
public string? Name { get; set; }
|
|
|
|
public string? Description { get; set; }
|
|
|
|
public bool? IsActive { get; set; }
|
|
|
|
public List<TemplateFieldDefinition>? Fields { get; set; }
|
|
}
|
|
|
|
/// <summary>นิยาม field หนึ่งตัวที่ admin ตั้ง — Key ต้องตรงกับที่ detect จากไฟล์ (เพิ่ม/ลบ key ต้องผ่าน replace ไฟล์)</summary>
|
|
public class TemplateFieldDefinition
|
|
{
|
|
[Required]
|
|
public string Key { get; set; } = string.Empty;
|
|
|
|
public string Label { get; set; } = string.Empty;
|
|
|
|
/// <summary>text | number | date</summary>
|
|
public string Type { get; set; } = "text";
|
|
|
|
/// <summary>editor ต่อ field (FR-14) — textbox|textarea ตาม type · ไม่ส่ง/ว่าง = default ของ type</summary>
|
|
public string? Editor { get; set; }
|
|
|
|
public bool IsRequired { get; set; }
|
|
|
|
public int SortOrder { get; set; }
|
|
}
|
|
|
|
/// <summary>body ของ PUT /api/templates/{id}/file (multipart/form-data)</summary>
|
|
public class ReplaceTemplateFileRequest
|
|
{
|
|
[Required]
|
|
public IFormFile File { get; set; } = null!;
|
|
}
|
|
|
|
/// <summary>body ของ POST /api/templates/{id}/generate-draft (FR-16) — ไม่มี message เพราะไฟล์ร่างยังไม่เกิด version</summary>
|
|
public class GenerateDraftRequest
|
|
{
|
|
/// <summary>map fieldKey → value (ค่า scalar ทั้งหมด) — pattern เดียวกับ GenerateDocumentRequest</summary>
|
|
[Required]
|
|
public JsonElement Values { get; set; }
|
|
}
|
|
|
|
public record TemplateFieldDto(Guid Id, string Key, string Label, string Type, string Editor, bool IsRequired, int SortOrder);
|
|
|
|
public record TemplateListItem(
|
|
Guid Id,
|
|
string Name,
|
|
string? Description,
|
|
bool IsActive,
|
|
int FieldCount,
|
|
DateTimeOffset CreatedAt,
|
|
DateTimeOffset UpdatedAt);
|
|
|
|
public record TemplateDetail(
|
|
Guid Id,
|
|
string Name,
|
|
string? Description,
|
|
bool IsActive,
|
|
DateTimeOffset CreatedAt,
|
|
DateTimeOffset UpdatedAt,
|
|
IReadOnlyList<TemplateFieldDto> Fields);
|
|
|
|
/// <summary>response ของ POST /api/templates — fields ที่ detect อัตโนมัติพร้อมค่า default
|
|
/// ให้ admin ไปตั้ง label/type/required ต่อผ่าน PUT (FR-9)</summary>
|
|
public record CreateTemplateResponse(Guid Id, IReadOnlyList<TemplateFieldDto> Fields);
|
|
|
|
/// <summary>response ของ PUT /api/templates/{id}/file — เตือน tag ที่หายไป/เพิ่มมาหลัง replace ไฟล์</summary>
|
|
public record ReplaceTemplateFileResponse(
|
|
Guid Id,
|
|
IReadOnlyList<TemplateFieldDto> Fields,
|
|
IReadOnlyList<string> AddedTags,
|
|
IReadOnlyList<string> RemovedTags);
|