Add typings

[xavdid]

Mostly fixes https://github.com/zapier/zapier-platform-cli/issues/15. This adds a typing file to the root of the core repo. Going forward, we'll need to update the file whenever the API or options changes, but that should be pretty low key. The great news is that this doesn't get in the way of normal operations and even provides types to js users using VS Code (which picks these up for regular javascript).

This only covers the items and interfaces exported by core. Ideally we'll be able to turn the json schema into types at well, but there are some speedbumps there. Instead of holding back indefinitely, let's get these out and I can circle back for the rest at some point.

To test, run the following commands:

• mkdir ts-test
• npm i typescript zapier-platform-core
• tsc --init
• paste the below file into index.ts
• tsc
• should have no errors

The big thing is that the input and output types below match what's in the code. I went pretty carefully through the docs (and if they weren't clear, code), so it should all be there! I'm also using these for a ts zapier app (that'll be pushed soon), so know soon if there's anything I missed.

import { zObject, Bundle } from 'zapier-platform-core'

const getData = (z: zObject, bundle: Bundle) => {
  return 1
}

const perform = async (z: zObject, bundle: Bundle) => {
  // a request involving raw: true returns a different response object
  // should work if invoked with a url or with only an options object

  const rawUrlResponse = await z.request('asdf', { raw: true })
  console.log(rawUrlResponse.body) // .body only exists on the raw response

  const rawOptsResponse = await z.request({ raw: true, url: 'asdf' })
  console.log(rawOptsResponse.body)

  const urlResponse = await z.request('asdf', {
    headers: { a: '1' },
    method: 'GET'
  })
  console.log(urlResponse.content.fontsize(4)) // .fontsize assumes content is a string, which it should be

  const optsResponse = await z.request({ url: 'asdf' })
  console.log(optsResponse.content.fontsize(4))

  // fails if bundle.meta.frontend isn't a bool
  z.console.log(bundle.meta.frontend === false)
  z.console.error(bundle.meta.frontend)

  const dh = z.dehyrate(getData, { id: bundle.inputData.id })

  z.stashFile(new Buffer('asdf'))

  const obj = z.JSON.parse(optsResponse.content)
  const s = obj.id

  const hash = z.hash('sha256', 'my password')

  throw new z.errors.HaltedError('do better')
}

[BrunoBernardino]

This looks really cool! I'm not very familiar with TS, so maybe not the best person to review here, but the logic seems good and the testing instructions as well!

👍

[xavdid]

Haha fair. I'm not sure anyone else knows enough to review. Since it won't break anything, maybe I'll just merge and we'll go from there!