Zodで型安全性を強化するブランド型（Branded Type）を活用する

type User = {
  id: number;
  name: string;
  age: number;
};

type Product = {
  id: number;
  name: string;
};

const user: User = {
  id: 1,
  name: "Alice",
  age: 30,
};

const product: Product = {
  id: 1,
  name: "Product",
};

function printProductName(product: Product) {
  console.log(product);
}

printProductName(user);
// Output: { id: 1, name: 'Alice', age: 30 }
// Product型に存在しない、ageまでもが渡ってしまう...

type UserId = {
  // UserIdというブランドを付与
  __userId: never;
  id: number;
};

type ProductId = {
  // ProductIdというブランドを付与
  __productId: never;
  id: number;
};

const printProductId = (userId: ProductId) => {
  console.log(userId);
};

// 型アサーションを使用して、UserIdとして定義する！
const userId = { id: 1 } as UserId;

// エラーが発生する
printProductId(userId);
// 型'UserId'の引数を型'ProductId'のパラメーターに割り当てることはできません。
// プロパティ'__productId'は型'UserId'にありませんが、型'ProductId'では必須です。

import { z } from "zod";

// 1. Zodのスキーマ定義 + brand()メソッドでブランド型を定義
const UserIdSchema = z.number().brand<"UserId">();
const ProductIdSchema = z.number().brand<"ProductId">();

// 2. スキーマから型を生成
type UserId = z.infer<typeof UserIdSchema>;
type ProductId = z.infer<typeof ProductIdSchema>;
// => type UserId = number & z.core.$brand<"UserId">
// => type ProductId = number & z.core.$brand<"ProductId">

// 3. スキーマの構造に一致するデータをパースすることで自動的にブランドを付与できる
const userId = UserIdSchema.parse(1);
const productId = ProductIdSchema.parse(2);
// => const userId: number & z.core.$brand<"UserId">
// => const productId: number & z.core.$brand<"ProductId">

function getUserById(userId: UserId) {
  console.log(userId);
}

function getProductById(productId: ProductId) {
  console.log(productId);
}

// OKパターン
getUserById(userId);
getProductById(productId);

// NGパターン
getUserById(productId);
// => プロパティ'[$brand]'の型に互換性がありません。

import { z } from "zod";

const articleSchema = z
  .object({
    id: z.string().min(1),
    title: z.string().min(1),
    description: z.string().min(1),
    content: z.string().min(1),
    createdAt: z.date(),
    updatedAt: z.date(),
  })
  .brand("Article");

type Article = z.infer<typeof articleSchema>;

export const findAll = async (): Promise<Article[]> => {
  // 記事データを取得する処理
  const articles = await fetch();

  return articles.map((article) =>
    articleSchema.parse({
      id: article.id,
      title: article.title,
      description: article.description,
      content: article.content,
      createdAt: new Date(article.createdAt),
      updatedAt: new Date(article.updatedAt),
    }),
  );
};