mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-24 14:45:36 +00:00
2ec4fec8c2
- packages/extension-api/: @comfyorg/extension-api npm package wrapper
(src/, package.json, README.md, tsconfig{,.build,.docs}.json,
typedoc.json, scripts/build-docs.ts, .npmignore, .gitignore)
- .github/workflows/extension-api-typecheck.yml (PKG4.D3)
- .github/workflows/extension-api-publish.yml (PKG4.D4)
- scripts/generate-docs.sh (PKG5.D6)
- pnpm-lock.yaml: workspace dependency for new package
Sidecar: independent of i-foundation; stacks directly on PR #2.
@comfyorg/extension-api
Status: scaffolded. Package implementation pending PKG3 — see
../../../plans/P2-extension-api-package.mdand../../../plans/prompts/PKG3-npm-package.mdin the workspace root.
The official TypeScript declaration package for ComfyUI extensions. This
package replaces the practice of vendoring comfy.d.ts files in custom
node repos.
Install (post-publish)
pnpm add -D @comfyorg/extension-api
import { defineExtension } from '@comfyorg/extension-api'
export default defineExtension({
name: 'MyExtension',
setup(ctx) {
ctx.onNodeMounted((node) => {
// ...
})
}
})
Source
This package is built from the source-of-truth folder
../../src/extension-api/. Do not edit the package's build/ output
directly.
Versioning
0.x.y— experimental during parallel-paths transition (D6 Phase A).1.0.0— first stable release once D5/D6/D7/D8 are accepted and the surface has stabilized.- Breaking changes follow semver strictly from
1.0.0onward.
Cross-references
decisions/D6-parallel-paths-migration.md— versioning rationaleplans/P2-extension-api-package.md— package structure planplans/prompts/PKG3-npm-package.md— implementation promptplans/prompts/PKG4-ci-workflows.md— publish workflowplans/prompts/PKG5-docgen-mdx.md— docgen pipelineplans/prompts/PKG6-docs-comfy-org.md— docs.comfy.org integration