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/coreinfers document shapes fromdefineCollection,defineGlobal,defineField, anddefineBlock@dyrected/coreexportsInferDocShapewhen you want to derive a type from a field array@dyrected/sdkexportsInferSchemaso SDK calls follow your exported schema constantsnpx dyrected generate:typescreates a standalone typed contract file, includingDyrectedSchema, 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.
The recommended path instead
If what you really want is better TypeScript confidence while building with Dyrected, start here:
- write schema code with the typed helpers from
@dyrected/core - export the collection and global constants you want the rest of the app to know about
- derive the client type with
InferSchema, or generatedyrected-types.tsand useDyrectedSchemawhen 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
InferSchemaso SDK usage stays aligned with the exported schema constants - use
generate:typeswhen another app, repo, or package needs a plain generated contract file and then type the SDK with generatedDyrectedSchema
That is less specialized than a dedicated language-service plugin, but it is the real Dyrected path available today.
InferSchema
Derive a typed SDK schema from your exported collection and global constants, and know when this path is better than generating a file.
Troubleshooting
Narrow a Dyrected problem down quickly by checking the right layer first: admin mounting, backend config, schema sync, auth, preview, uploads, or email.