npmpackage.info

Gathering detailed insights and metrics for @directus/sdk

Other packages similar to @directus/sdk

@directus/extensions-sdk

14.0.0

A toolkit to develop extensions to extend Directus

@directus/sdk-js

9.0.0-rc.53

Directus SDK for JavaScript (Node and Browser)

pc-directus-interface

2.2.1

Internal implementation of generic Directus methods to interact with Directus

directus-sdk-typegen

0.2.0

CLI and library to generate TypeScript types from Directus collections for use with Directus SDK.

Gathering detailed insights and metrics for @directus/sdk

@directus/sdk - 20.0.0 | npmpackage.info

@directus/sdk

The flexible backend for all your projects 🐰 Turn your DB into a headless CMS, admin panels, or apps with a custom UI, instant APIs, auth & more.

20.0.0

31,662

NOASSERTION

TypeScript

538.02 kB

5.7

Installations

npm install @directus/sdk

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=22

Node Version

22.16.0

NPM Version

10.9.2 Pull Requests

Open

36

Total

9,203

Closed

1,182

Merged

7,985

Issues

Open

270

Total

9,235

Closed

8,965

Releases

339

v11.9.3

Updated on Jul 09, 2025

v11.9.2

Updated on Jul 01, 2025

v11.9.1

Updated on Jun 30, 2025

v11.9.0

Updated on Jun 25, 2025

v11.8.0

Updated on May 28, 2025

v11.7.2

Updated on Apr 29, 2025

View All 339 releases

Languages

TypeScript

Vue

SCSS

Liquid

JavaScript

CSS

Dockerfile

HTML

TypeScript (71.84%)

Vue (26.21%)

SCSS (0.8%)

Liquid (0.38%)

JavaScript (0.36%)

CSS (0.36%)

Dockerfile (0.03%)

HTML (0.02%)

Developer

directus

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

31,662 Stars

13,018 Commits

4,300 Forks

324 Watchers

213 Branches

463 Contributors

Updated on Jul 15, 2025

Sponsor this package

https://github.com/directus/directus?sponsor=1

Maintainers

View All 463 Contributors

Package Meta Information

Latest Version

20.0.0

Package Id

@directus/sdk@20.0.0

Unpacked Size

538.02 kB

Size

94.17 kB

File Count

NPM Version

10.9.2

Node Version

22.16.0

Published on

Jun 25, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@directus/tsconfig esbuild-plugin-replace tsup typescript vitest @directus/system-data

Directus JavaScript SDK

Features

TypeScript first: The SDK provides a robust and type-safe development experience.
Modular architecture: The SDK is split into separate modules, giving you granular control over which features to include and which can be pruned at build-time.
Lightweight and dependency-free: It does not require external libraries, ensuring a lighter bundle and streamlined experience.

Composable Client

The client is split up in separate features you can mix and match to compose a client with only the features you need or want.

1const client = createDirectus<Schema>('https://api.directus.io');

This client is currently an empty wrapper without any functionality. Before you can do anything with it you'll need to add some features. The following composables are available/in progress:

rest() REST request functions
- adds .request(...) on the client
graphql() GraphQL request functions
- adds .query(...) on the client
staticToken() authentication functions
- adds .getToken() and .setToken() on the client
authenticate() authentication functions
- adds .login({ email, password }), .logout(), .refresh() on the client
- adds .getToken() and .setToken() on the client
realtime() websocket connectivity
- adds .subscribe(...), .sendMessage(...), .onWebsocket('message', (message) => {}) on the client

For this example we'll build a client including rest and graphql:

1const client = createDirectus<Schema>('https://api.directus.io').with(rest()).with(graphql());
2
3// do a REST request
4const restResult = await client.request(readItems('articles'));
5
6// do a GraphQL request
7const gqlResult = await client.query<OutputType>(`
8    query {
9        articles {
10            id
11            title
12            author {
13                first_name
14            }
15        }
16    }
17`);

Authentication

1const client = createDirectus<Schema>('https://api.directus.io').with(rest()).with(authentication('json'));
2
3await client.login('admin@example.com', 'd1r3ctu5');
4
5// do authenticated requests

1const client = createDirectus<Schema>('https://api.directus.io').with(rest()).with(staticToken('super-secure-token'));
2
3// do authenticated requests

Real-Time

The realtime() extension allows you to work with a Directus REST WebSocket.

Subscribing to updates:

1const client = createDirectus<Schema>('https://api.directus.io').with(
2	realtime({
3		authMode: 'public',
4	}),
5);
6
7const { subscription, unsubscribe } = await client.subscribe('test', {
8	query: { fields: ['*'] },
9});
10
11for await (const item of subscription) {
12	console.log('subscription', { item });
13}
14
15// unsubscribe()

Receive/Send messages:

1const client = createDirectus<Schema>('https://api.directus.io').with(
2	realtime({
3		authMode: 'public',
4	}),
5);
6
7const stop = client.onWebSocket('message', (message) => {
8	if ('type' in message && message['type'] === 'pong') {
9		console.log('PONG received');
10		stop();
11	}
12});
13
14client.sendMessage({ type: 'ping' });

Build Your Schema

1// The main schema type containing all collections available
2interface MySchema {
3	collection_a: CollectionA[]; // regular collections are array types
4	collection_b: CollectionB[];
5	collection_c: CollectionC; // this is a singleton
6	// junction collections are collections too
7	collection_a_b_m2m: CollectionAB_Many[];
8	collection_a_b_m2a: CollectionAB_Any[];
9}
10
11// collection A
12interface CollectionA {
13	id: number;
14	status: string;
15	// relations
16	m2o: number | CollectionB;
17	o2m: number[] | CollectionB[];
18	m2m: number[] | CollectionAB_Many[];
19	m2a: number[] | CollectionAB_Any[];
20}
21
22// Many-to-Many junction table
23interface CollectionAB_Many {
24	id: number;
25	collection_a_id: CollectionA;
26	collection_b_id: CollectionB;
27}
28
29// Many-to-Any junction table
30interface CollectionAB_Any {
31	id: number;
32	collection_a_id: CollectionA;
33	collection: 'collection_b' | 'collection_c';
34	item: string | CollectionB | CollectionC;
35}
36
37// collection B
38interface CollectionB {
39	id: number;
40	value: string;
41}
42
43// singleton collection
44interface CollectionC {
45	id: number;
46	app_settings: string;
47	something: string;
48}

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

3

Security-Policy

Determines if the project has published a security policy.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/blackbox.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/blackbox.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/blackbox.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/blackbox.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/check.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/check.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/check.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/check.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/check.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/check.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/check.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/cla.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/cla.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/cla.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/cla.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/cla.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/cla.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/docs.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock-threads.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/lock-threads.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:109: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:145: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:153: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/stale-issues.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/stale-issues.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-dockerhub-readme.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/sync-dockerhub-readme.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-dockerhub-readme.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/directus/directus/sync-dockerhub-readme.yml/main?enable=pin
Warn: containerImage not pinned by hash: Dockerfile:8
Warn: containerImage not pinned by hash: Dockerfile:50
Warn: npmCommand not pinned by hash: Dockerfile:12
Warn: npmCommand not pinned by hash: Dockerfile:52-54
Info: 0 out of 16 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 16 third-party GitHubAction dependencies pinned
Info: 0 out of 2 containerImage dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More