Interfaces Generator​

Installation​

To get started, install the following packages. (If you’re using Deno, you can skip this step.)

Install the edgedb package.

$ 

npm install edgedb       # npm users

$ 

yarn add edgedb          # yarn users

$ 

bun add edgedb           # bun users

Then install @edgedb/generate as a dev dependency.

$ 

npm install @edgedb/generate --save-dev      # npm users

$ 

yarn add @edgedb/generate --dev              # yarn users

$ 

bun add --dev @edgedb/generate               # bun users

Generation​

Assume your database contains the following EdgeDB schema.

module default {
  type Person {
    required name: str;
  }

  scalar type Genre extending enum<Horror, Comedy, Drama>;

  type Movie {
    required title: str;
    genre: Genre;
    multi actors: Person;
  }
}

The following command will run the interfaces generator.

$ 

npx @edgedb/generate interfaces

$ 

deno run --allow-all --unstable https://deno.land/x/edgedb/generate.ts interfaces

$ 

bunx @edgedb/generate interfaces

{
  "imports": {
    "edgedb": "https://deno.land/x/edgedb/mod.ts",
    "edgedb/": "https://deno.land/x/edgedb/"
  }
}

{
  "importMap": "./importMap.json"
}

This will introspect your schema and generate TypeScript interfaces that correspond to each object type. By default, these interfaces will be written to a single file called interfaces.ts into the dbschema directory in your project root. The file will contain the following contents (roughly):

export interface Person {
  id: string;
  name: string;
}

export type Genre = "Horror" | "Comedy" | "Drama";

export interface Movie {
  id: string;
  title: string;
  genre?: Genre | null;
  actors: Person[];
}

Any types declared in a non-default module will be generated into an accordingly named namespace.

$ 

npx @edgedb/generate interfaces --file schema.ts

dbschema/interfaces.ts

Usage​

The generated interfaces can be imported like so.

import {Genre, Movie} from "./dbschema/interfaces";

You will need to manipulate the generated interfaces to match your application’s needs. For example, you may wish to strip the id property for a createMovie mutation.

function createMovie(data: Omit<Movie, "id">) {
  // ...
}

For convenience, the file also exports a namespace called helper containing a couple useful utilities for extracting the properties or links from an object type interface.

import {Movie, helper} from "./dbschema/interfaces";

type MovieProperties = helper.Props<Movie>;
// { id: string; title: string; ... }

type MovieLinks = helper.Links<Movie>;
// { actors: Person[]; }

export type Genre = "Horror" | "Comedy" | "Drama";