Dyrected
ReferenceTypeScript

TypeScript Plugin

Understand the current status of IDE-specific TypeScript tooling in Dyrected and what to use today instead of a dedicated language-service plugin.

Use this page if you came here expecting a Dyrected equivalent to Payload's TypeScript language-service plugin. By the end, you should know the current status clearly: Dyrected does not ship a separate TypeScript IDE plugin today, what TypeScript help you do get out of the box, and which existing tools to use instead.

Current status

Dyrected does not currently ship a dedicated TypeScript language-service plugin for editor features such as config-string path validation, export-name validation inside string component references, or custom IDE autocompletion rules.

That means there is nothing to install in tsconfig.json today that plays the role of a Dyrected-specific TypeScript plugin.

If you were looking for a package like Payload's @payloadcms/typescript-plugin, this is the important answer first: there is no direct Dyrected equivalent right now.

What you do get today

Even without a separate plugin, Dyrected still gives you useful TypeScript help through its normal exported APIs.

The current tooling story is:

  • @dyrected/core infers document shapes from defineCollection, defineGlobal, defineField, and defineBlock
  • @dyrected/core exports InferDocShape when you want to derive a type from a field array
  • @dyrected/sdk exports InferSchema so SDK calls follow your exported schema constants
  • npx dyrected generate:types creates a standalone typed contract file, including DyrectedSchema, when inference alone is not the right boundary

So the real Dyrected TypeScript experience today is built from inference and generation, not from a dedicated editor plugin.

If what you really want is better TypeScript confidence while building with Dyrected, start here:

  1. write schema code with the typed helpers from @dyrected/core
  2. export the collection and global constants you want the rest of the app to know about
  3. derive the client type with InferSchema, or generate dyrected-types.ts and use DyrectedSchema when you need a standalone contract

That is the current happy path, and it covers most of the same practical needs people usually mean when they ask for "the TypeScript plugin."

What this page does and does not cover

This page is intentionally narrow.

It answers the status question:

  • is there a Dyrected-specific TypeScript plugin to install right now?
  • if not, what should you use instead?

It does not try to turn into a full guide for every TypeScript API. For the real implementation paths, use:

When this might change

This page is written against the current repo and current docs surface. If Dyrected later ships a dedicated IDE or language-service plugin, this page should become the canonical place to document:

  • what it validates
  • how to install it
  • which editors it supports
  • what it changes in the authoring workflow

For now, the safest and most accurate guidance is to keep the page explicit about the absence of that feature instead of implying it already exists.

Escape hatches

If you needed a plugin because you wanted stronger editor feedback, the current escape hatches are:

  • use inference-first schema code so mistakes surface as normal TypeScript errors
  • use InferSchema so SDK usage stays aligned with the exported schema constants
  • use generate:types when another app, repo, or package needs a plain generated contract file and then type the SDK with generated DyrectedSchema

That is less specialized than a dedicated language-service plugin, but it is the real Dyrected path available today.

On this page

Dyrected| Cloud

Get your backend ready in minutes

Use a managed database, storage, APIs, and admin dashboard without setting up the infrastructure yourself.

Set Up My Backend