Directus SDK Typegen

Generate TypeScript types for your Directus SDK dynamically. Split between the package that generates the types based on you (using typescript compiler API) and a cli

Usage as a cli

Using the snapshot.yaml generated by cli to get the snapshot

1npx @ikerin/directus-typegen-cli snapshot --input snapshot.yaml --output src/directus-schema.ts

You can also install the script with its dependencies locally to run it with your package manager of choice:

1# With yarn
2yarn add --dev @ikerin/directus-typegen-cli
3yarn directus-typegen-cli snapshot --input snapshot.yaml --output src/directus-schema.ts
4
5# With bun
6bun add --dev @ikerin/directus-typegen-cli
7bun run directus-typegen-cli snapshot --input snapshot.yaml --output src/directus-schema.ts

You can utilize both stdin and stdout if this needs to be a part of a pipeline

1cat snapshot.yaml | bun run directus-typegen-cli snapshot | bun run prettier --stdin-filepath directus-schema.ts > src/directus-schema.ts

You can also query a live server to get your types, which will take into account the user's permissions.

1yarn directus-typegen-cli server --url http://localhost:8055 --user 'admin@example.com:admin-password' --output src/directus-schema.ts

More detailed docs can be found in the @ikerin/directus-typegen-cli package folder

Using the library

You can integrate the library (without the CLI dependencies) in you extensions.

1bun add @ikerin/directus-typegen

simple.ts

1import { generateTypesFromSnapshot } from '@ikerin/directus-typegen';
2import { readFileSync } from 'fs';
3import { join } from 'path';
4
5// Get the contents of the snapshot
6// We are using JSON for simplicity, usually you will use YAML
7const snapshotPath = join(import.meta.dirname, 'snapshot.json');
8const snapshot = JSON.parse(readFileSync(snapshotPath, 'utf-8'));
9
10// This is the core of the operation
11const types = generateTypesFromSnapshot(snapshot);
12
13console.log(types);

More explanations in the package itself @ikerin/directus-typegen