Tianyi Cui
7f024a1a9d
Docs: per-folder README.md for packages/ (family overview + one per package: service, events, API, extension points, TODOs), examples/, and examples/echo-agent/; folder-level AGENTS.md (+ CLAUDE.md symlinks) for packages/ and vendor/; module-level doc comments in every packages/*/src file; richer JSDoc on all exported API (event side effects, disposal contracts, error behavior). Root AGENTS.md gains a "Type Safety and Documentation" policy section: the codebase aims to be very type-safe and well documented; type gymnastics are acceptable in core packages when they improve plugin-author DX; verbose docs are fine as long as they stay strictly in sync with the code. Type safety: removed the upstream-inherited "noImplicitAny": false from tsconfig.base.json — packages/* now compile under full strict mode; vendor/loader and vendor/include set it locally (vendor/cordis already did). Eliminated every `: any` / `as any` from packages and examples (catch clauses use unknown + a CodedError narrowing type; event data access uses discriminated-union narrowing). Typed tool schemas: new @deepseek-ai/dsh-tools schema DSL — SchemaSpec with per-property `required: true` booleans, type-level InferArgs<S>, a runtime SchemaSpec → JSON Schema converter, and defineTool() so first-party tools get typed execute(args) with zero casts (raw JSON Schema still accepted for MCP interop; chosen over schemastery because it targets JSON Schema generation directly). echo-tool and all test tools migrated; +7 tests.
@cordisjs/plugin-loader
Runtime plugin loader for Cordis. The loader owns an EntryTree, imports plugin
modules by name, applies their config, and keeps the running plugin graph in
sync with entry updates.
Usage
import { Context } from 'cordis'
import Loader from '@cordisjs/plugin-loader'
const root = new Context()
await root.plugin(Loader, { baseUrl: import.meta.url })
const id = await root.loader.create({
name: './plugins/example',
config: { enabled: true },
})
await root.loader.await()
root.loader.update(id, { config: { enabled: false } })
Entry Options
| Field | Description |
|---|---|
id |
Stable id for resolving, updating, and removing the entry. |
name |
Module specifier imported by the loader. |
config |
Config passed to the plugin. |
group |
Marks the entry as a group whose config is a child entry list. |
disabled |
Stops the entry and prevents it from starting. |
inject |
Adds required services or intercept config for this entry. |
API
| API | Description |
|---|---|
loader.create(options, parent?, position?) |
Add and start an entry. |
loader.update(id, options, parent?, position?) |
Update, move, and restart an entry. |
loader.remove(id) |
Stop and delete an entry. |
loader.resolve(id) |
Resolve an entry by id, including nested a:b ids. |
loader.resolveGroup(id) |
Resolve the root group or a nested group. |
loader.await() |
Wait for pending entry imports and fiber reloads. |
loader.locate(fiber?) |
Return the loader entry id that owns a fiber. |
For file-backed trees, use @cordisjs/plugin-include.