mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-05-24 06:35:10 +00:00

Files

Connor Byrne a86dc1cc2b feat(extension-api): npm package + TypeDoc docgen + CI workflows

Restratified i-pkg. Adds the @comfyorg/extension-api npm package
(packages/extension-api/) — package.json, tsconfig.{json,build,docs},
typedoc.json, scripts/build-docs.ts, README, .npmignore — plus three
CI workflows (extension-api-typecheck.yml, extension-api-publish.yml,
ci-tests-extension-api.yaml) and the docgen helper script.

Modifies foundation's src/extension-api/index.ts and
src/services/extension-api-service.ts with the package-aware tweaks
required for npm consumption.

Lockfile regenerated to include packages/extension-api workspace deps.

Original (pre-restratify) branch tip backed up at
refs/backup/restratify-20260511/ext-api-i-pkg.

2026-05-21 14:01:37 -07:00

1.4 KiB

Raw Blame History

@comfyorg/extension-api

Status: scaffolded. Package implementation pending PKG3 — see ../../../plans/P2-extension-api-package.md and ../../../plans/prompts/PKG3-npm-package.md in 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.0 onward.

Cross-references

decisions/D6-parallel-paths-migration.md — versioning rationale
plans/P2-extension-api-package.md — package structure plan
plans/prompts/PKG3-npm-package.md — implementation prompt
plans/prompts/PKG4-ci-workflows.md — publish workflow
plans/prompts/PKG5-docgen-mdx.md — docgen pipeline
plans/prompts/PKG6-docs-comfy-org.md — docs.comfy.org integration

1.4 KiB Raw Blame History