Protocol example

protocol.ts

export type API = {
    'get /teams/:key': {
      request: {
        key: string
      }
      response: {
        key: string
        name: string
      }
    }
    'get /teams': {
      request: {}
      response: {
        key: string
        name: string
      }[]
    }
    // signup a new user
    'post /users': {
      request: {
        email: string
        password: string
      }
      response: {
        key: string
        avatar_url: string
        email: string
      }
    }
    'get /users/me': {
      request: {}
      response: API['post /users']['response']
    }
    'post /recordings': {
      request: {
        title: string
      }
      response: {
        key: string
      }
    }
  }

usage.ts

import { API } from './protocol'
import XHR from './xhr'

const xhr = new XHR<API>("https://example.com")

xhr.ts

/**
 * Protocol
 */

type Protocol = {
  [path: string]: {
    request: {}
    response: {}
  }
}

/**
 * HTTP Client
 */

export default class Client<P extends Protocol> {
  constructor(private readonly baseURL: string) {}

  async send<K extends keyof P>(action: K, body: P[K]['request']): Promise<P[K]['response'] | Error> {
    console.log('fetching', action, body)
    throw new Error("unimplemented")
  }
}