ctien / dato-types

Typescript types for all items from our Dato graphql API

HashiCorp DatoCMS Typings

This repo serves one purpose: to always contain, at index.d.ts, an up to date file with typings for all of our DatoCMS models in our primary Dato instance.

Usage

Install this package with npm i hashicorp/dato-types, then add its location to the typeRoots config in your tsconfig.json file, as such:

{
  "compilerOptions": {
    "otherOptions": "xxx",
    "typeRoots": ["node_modules/@types", "node_modules/@hashicorp/dato-types"]
  }
}

Now you should be able to require typings directly from this package, as such:

import { ButtonRecord } from '@hashicorp/dato-types'

NOTE: The installation command is hashicorp/dato-types without an @ on purpose, as this package is intended to be installed directly from github. When requiring it internally however, use @hashicorp/dato-types as this is the npm package name.

Updating

Each time DatoCMS changes are made, a script will trigger to cause this repo to update its types. If you made a change in DatoCMS and would like for it to be reflected in your local project, just run npm i again and it will update to the latest version. The key here is that the installation references the github repo, so its not an npm module nor does it use semver.

The update script is a probot GitHub app, found inside the /webhook folder. To start the app, run npm start from the root. Grab a copy of the .env file from a teammate, and make sure you have access to the app in Heroku. It's set up such that dato pings the app when there is a new publish event, the app generates types from dato, compares to existing types, and if they are different, commits them to the index.d.ts file.

The initial author was Jeff Escalante, if changes need to be made here please reach out with any questions!