Row Polymorphism di Typescript

Intro

Pada suatu hari ada sebuah object koordinat 3 dimensi yang memiliki attribute X, Y, dan Z

interface Coordinate3d {
  x: number;
  y: number;
  z: number;
}

const coord3d: Coordinate3d = {
  x: 17,
  y: 8,
  z: 45
}

dan object kooridinat tersebut dapat di-flip secara horizontal seolah-olah memberikan efek bercermin. Dandan sekalian kalo bisa bro.

const flipX = (coordinate: Coordinate3d) => ({
  ...coordinate,
  x: coordinate.x * -1
})

const flippedCoord = flipX(coord3d)
// { x: -17, y: 8, z: 45 }

Function flipX tersebut menerima object bertipe Coordinate3d yang memiliki attribute x, y, dan z. Artinya compiler akan complain ketika data seperti Coordinate2d dimasukkan ke dalam function tersebut.

interface Coordinate2d {
  x: number;
  y: number;
}

const coord2d: Coordinate2d = {
  x: 178,
  y: 45,
}

const flippedCoord = flipX(coord2d)
                           ^^^^^^^
// Argument of type 'Coordinate2d' is not assignable to parameter of type 'Coordinate3d'.
//  Property 'z' is missing in type 'Coordinate2d' but required in type 'Coordinate3d'.

Sedangkan kalau dipikir baik-baik, fungsi tersebut hanya melakukan perubahan pada row x saja. Kalau yang dibutuhkan hanyalah x, function flipX harusnya bisa dibuat lebih “minimal” dengan mengubahnya menjadi

const flipX = <A extends { x: number }>(hasX: A): A => ({
  ...hasX,
  x: hasX.x * -1
})

Dengan begini, flipX sekarang hanya memiliki satu attribute sebagai constraint, yaitu x yang bertipe number. Seolah-olah ia menyeru, “Barangsiapa memiliki row x bertipe number, niscaya aku akan dapat melakukan manipulasi data terhadapnya. Sesungguhnya, aku adalah row polymorphism”.

flipX({ x: 17, y: 8, z: 45 }) // { x: -17, y: 8, z: 45 } ✅
flipX({ x: 178, y: 45 }) // { x: -178, y: 45 } ✅
flipX({ x: 99 }) // { x: -99 } ✅

🎉🎉🎉

NOTE: Perlu diperhatikan bahwa penggunaan keyword extends di sini sangat penting untuk mengindikasikan bahwa type parameter A bisa jadi memiliki row lain selain x. Jika kita tuliskan code di atas seperti ini

type X = { x: number }

const flipX = (hasX: X): X => ({
  ...hasX,
  x: hasX.x * -1
})

Maka flipX tidak lagi sepenuhnya row-polymorphic. Akan terlihat ketika sebuah subset dari X dimasukkan

const coord3d = { x: 17, y: 8, z: 45 }
const res = flipX(coord3d)
res.y
    ^
// Property 'y' does not exist on type 'X'.

Compiler sekarang kehilangan informasi row y (dan row z!) karena notasi dari fungsi flipX yang hanya menyatakan X sebagai return type-nya.

Inilah dasar dari definisi Row Polymorphism, yang memungkinkan kita untuk membuat program yang polymorphic terhadap rows tanpa kehilangan informasi row sama sekali.

Tapi jangan salah, kalau mau dibuat lebih constrained juga boleh kok. Misal kita ingin menulis sebuah function yang hanya menerima row x saja, tidak lebih tidak kurang.

type Exact<O, E> = E & Record<Exclude<keyof O, keyof E>, never>

const exact = <O extends Exact<O, { x: number }>>(obj: O) => {}

exact({ x: 1 }) // typecheck ✅

exact({ x: 1, y: 2 }) // complain ✅
              ^
exact({ y: 2, z: 3 }) // complain ✅
        ^     ^
// Type 'number' is not assignable to type 'never'.

Plis jangan muntah liat syntax-nya ya!

Adding

Row Polymorphism nggak sebatas bisa baca row aja, tapi harusnya juga bisa melakukan manipulasi terhadap rows: seperti penambahan, pengurangan, dan penamaan ulang.

Anggap kita punya function yang polymorphic dengan row firstName bertipe string, yang menambahkan row lastName (jika belum ada) sebagai return value-nya.

const addLastName = obj => ({
  lastName: obj.firstName,
  ...obj
})

addLastName({ firstName: 'jihad' })
// { firstName: 'jihad', lastName: 'jihad' }

addLastName({ firstName: 'jihad', lastName: 'waspada' })
// { firstName: 'jihad', lastName: 'waspada' }

Bagaimana informasi penambahan row ini dapat ditangkap oleh compiler?

Kebetulan Typescript memiliki operasi intersection yang dinotasikan menggunakan symbol & sehingga operasi penambahan row ini relatif terlihat mudah.

type FName = { firstName: string }

const addLastName = <T extends FName>(
  obj: T
): T & { lastName: string } => ({
  lastName: obj.firstName,
  ...obj
})

const person = { firstName: 'jihad', email: 'email@email.email' }
const res = addLastName(person)
// { firstName: 'jihad', lastName: 'jihad', email: 'email@email.email' }

Deleting

Sekarang kita balik: kita ingin membuat sebuah function yang polymorphic terhadap row firstName dan lastName (keduanya bertipe string), dan ingin menghilangkan lastName dari object tersebut.

Typescript sudah menyediakan utility type untuk operasi ini dengan menggunakan Omit.

type Names = { firstName: string; lastName: string }
type NoLastName<T> = Omit<T, 'lastName'>

function removeLastName<T extends Names>(
  obj: T
): NoLastName<T> {
  const { lastName, ...withoutLastName } = obj
  return withoutLastName
}

Renaming

Menurut saya renaming ini adalah operasi gabungan dari adding dan deleting. Anggap kita ingin mengubah label (key) row y menjadi z. Operasi ini dapat dilakukan dengan dua cara yang identik:

1. Tambah row z kemudian hapus row y, atau
2. Hapus row y dulu baru tambah row z

declare function rename<
  T,
  KeyToRemove extends keyof T,
  ReplaceWith extends string
>(
  obj: T,
  k1: KeyToRemove,
  k2: ReplaceWith
): Omit<T, KeyToRemove> & Record<ReplaceWith, T[KeyToRemove]>
// ^^^^^^^^^^^^^^^^^^^^   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
//       remove                       then add

const x2 = rename({ x: 17, y: 8 }, 'y', 'z')
// { x: 17, z: 8 }

Kesimpulan

Sebuah fungsi yang row-polymorphic adalah fungsi yang reusable, dapat digunakan oleh berbagai macam record selama memenuhi constraint-nya. Row Polymorphism di Typescript lumrahnya ditandai dengan keyword extends agar compiler tidak kehilangan informasi tipe rows yang sedang dimanipulasi. Terjaganya informasi ini sangat dibutuhkan ketika kita ingin mengembalikan object tersebut kembali (the row type parameter appears in the return type).

Typescript sendiri sudah menyediakan sekumpulan utlity types (seperti Record, Omit, dsb) yang bisa digunakan untuk mendukung Row Polymorphism dengan cukup mudah. Yah, menurut saya sih lebih mudah dibanding RP nya Purescript yang… sudahlah 😄