API 型別設計：依用途拆分型別

// 改進前：為了共用，將所有欄位設成選填
interface SharedQuestion {
  id?: string;
  prompt?: string;
  answer?: string;
  createdAt?: Date;
}

// 所有欄位都有 ?，因此空物件也能通過型別檢查
const incomplete: SharedQuestion = {};

// 建立題目時提交的資料；id 與 createdAt 由伺服器產生
interface CreateQuestionInput {
  prompt: string;
  answer: string;
}

// 前面的 SharedQuestion 全部選填，允許傳入空物件
// 這裡的 prompt 與 answer 都是必填，少了任一欄位就會報錯
// const missing: CreateQuestionInput = {};

interface QuestionEntity {
  id: string; // 伺服器產生的編號
  prompt: string;
  answer: string; // 答案只留在伺服器內
  createdAt: Date; // 伺服器記錄建立時間
}

// 建立請求：必須提供題目文字與答案
const input: CreateQuestionInput = {
  prompt: "哪個關鍵字宣告變數？",
  answer: "const",
};

// 保存資料：補上系統產生的欄位，符合 QuestionEntity
const saved: QuestionEntity = {
  ...input,
  id: "q24",
  createdAt: new Date(),
};

// 若要共用欄位定義，可用這個型別取代前面的 CreateQuestionInput
// 從 QuestionEntity 取出 prompt 與 answer，保留它們的型別與必填要求
// 不包含系統產生的 id 與 createdAt
type CreateQuestionInputFromEntity = Pick<QuestionEntity, "prompt" | "answer">;

// 更新題目文字時，必須傳入新的 prompt
interface UpdateQuestionInput {
  prompt: string;
}

// 這個型別連 id 都允許傳入，超出只修改題目文字的需求
// type UpdateQuestionInput = Partial<QuestionEntity>;
// const update: UpdateQuestionInput = { id: "another-id" };

// 前面的 UpdateQuestionInput 也可以改用這種寫法，只包含必填的 prompt
// type UpdateQuestionInput = Pick<QuestionEntity, "prompt">;

const update: UpdateQuestionInput = { prompt: "新的題目文字" };
// const invalidUpdate: UpdateQuestionInput = { id: "another-id" }; // 錯誤：沒有 id 欄位

// 給作答者的回應不包含答案，日期使用字串
interface QuestionResponseDto {
  id: string;
  prompt: string;
  createdAt: string;
}

function toQuestionResponseDto(question: QuestionEntity): QuestionResponseDto {
  return {
    id: question.id,
    prompt: question.prompt,
    // 日期轉成回應使用的字串
    createdAt: question.createdAt.toISOString(),
  };
}

type PublicQuestion = Omit<QuestionEntity, "answer">;

// 型別中省略 answer，但只是將 saved 指派給另一個變數
// 兩個變數指向同一個物件，物件裡仍然有 answer
const publicQuestion: PublicQuestion = saved;
// Object.keys() 列出物件實際包含的欄位名稱
console.log(Object.keys(publicQuestion));
// ["prompt", "answer", "id", "createdAt"]

// 前面的轉換函式建立新物件，只放入要回傳的欄位
const response = toQuestionResponseDto(saved);
console.log(Object.keys(response));
// ["id", "prompt", "createdAt"]