Directus SDK Types Generator

Opinionated CLI tool and library to generate TypeScript types from Directus collections to use with the Directus SDK.

Generates the individual interfaces for the Directus collections and a Schema type that collects all the interfaces together for use with the Directus SDK.

Example

Generate the types from the CLI.

1npx directus-sdk-typegen -u http://localhost:8055 -t your-token-here -o ./my-schema.ts

1// my-schema.ts
2export interface Event {
3	/** @required */
4	id: string;
5	status?: 'draft' | 'active' | 'past';
6	sort?: number | null;
7	user_created?: DirectusUser | string | null;
8	date_created?: string | null;
9	user_updated?: DirectusUser | string | null;
10	date_updated?: string | null;
11	/** @description Name of the event. @required */
12	title: string;
13	/** @required */
14	slug: string;
15	/** @description When does this event start? @required */
16	start_at: string;
17	/** @description When does this event end? */
18	end_at?: string | null;
19	/** @description Short description of the event. Used in SEO meta description. */
20	description?: string | null;
21	featured_image?: DirectusFile | string | null;
22	timezone?: string | null;
23	location?: 'whereby' | 'youtube' | 'other' | null;
24	location_url?: string | null;
25	location_youtube?: string | null;
26	recording_url?: string | null;
27	content?: string | null;
28	location_whereby?: any | null;
29	custom_registration_questions?: EventCustomRegistrationQuestion[] | string[];
30	emails?: EventEmail[] | string[];
31	feedback?: EventFeedback[] | string[];
32	registrants?: EventRegistration[] | string[];
33	hosts?: EventHost[] | string[];
34}
35
36export interface Schema {
37	events: Event[]
38}

Then use the generated types with the Directus SDK.

1import type { Schema } from './my-schema';
2
3import {
4	createDirectus,
5    rest
6} from '@directus/sdk';
7
8const directus = createDirectus<Schema>('http://localhost:8055').with(rest())

Installation

You can run the CLI tool using npx or install it globally.

1npx directus-sdk-typegen -u http://localhost:8055 -t your-token-here -o ./my-schema.ts

or

1npm install -g directus-sdk-typegen

1directus-sdk-typegen -u http://localhost:8055 -t your-token-here -o ./my-schema.ts

Usage

You can use the Directus Type Generator as a CLI tool or as a library in your Node.js application.

CLI Usage

To generate TypeScript types from Directus collections, use the following command:

1npx directus-sdk-typegen --url <DIRECTUS_API_URL> --token <DIRECTUS_API_TOKEN> --output <OUTPUT_FILE_PATH>

Options

• -o, --output <path>: Specify the output file path including filename (default: ./directus-schema.ts).
• -u, --url <url>: Directus API URL (default: http://localhost:8055).
• -t, --token <token>: Directus API token. Needs Adminstrator permissions (default: your-token-here).

Library Usage

You can also use the generator programmatically in your Node.js application:

1// Output to a file
2import { generateDirectusTypes } from 'directus-sdk-typegen';
3
4async function generateTypes() {
5    try {
6        await generateDirectusTypes({
7            outputPath: './my-schema.ts',
8            directusUrl: 'http://localhost:8055',
9            directusToken: 'your-token-here',
10        });
11    } catch (error) {
12        console.error('Failed to generate types:', error);
13    }
14}
15
16generateTypes();

1// Return types as a variable
2import { generateDirectusTypes } from 'directus-sdk-typegen';
3
4async function generateTypes() {
5    try {
6        const types = await generateDirectusTypes({
7            directusUrl: 'http://localhost:8055',
8            directusToken: 'your-token-here',
9        });
10        // Do something else with the types
11        console.log(types);
12    } catch (error) {
13        console.error('Failed to generate types:', error);
14    }
15}

Contributing

Happy to accept contributions that improve the types generated! But please open an issue first to discuss changes.

License

This project is licensed under the MIT License.