@godspeedai/cognate-profile

中文文档
0.10.0发布于 2026/11/16Apache-2.0ES Module构建来源已验证近 30 天下载 3422

defineProfile: reusable application compositions that select and configure components without new kernel concepts (spec §29).

原始使用文档
文档目录6 节
  1. Installation
  2. Quick start
  3. What the types guarantee
  4. Limitations
  5. Related packages
  6. License

@godspeedai/cognate-profile

Declarative composition for Cognate applications: defineProfile names an ordered selection of registered components plus their configuration, and resolveProfile turns that selection into contributions. Profiles add no kernel concepts — they only select and configure what packages already register.

When to use this package: you are defining a reusable application composition (a "profile") or building the registry a profile resolves against. Ready-made profiles include @godspeedai/cognate-profile-harness and @godspeedai/cognate-profile-copilot.

Installation

bun add @godspeedai/cognate-profile

Requires Bun >= 1.4.0.

Quick start

import { defineProfile, resolveProfile } from "@godspeedai/cognate-profile";
import type { ComponentEntry } from "@godspeedai/cognate-profile";

// A registry: entries a package provides, each producing one contribution.
const registry: ComponentEntry<string[]>[] = [
  {
    name: "sessions",
    package: "@godspeedai/cognate-runtime-bun",
    supported: true,
    contribute: () => ["sessions"],
  },
  {
    name: "agents",
    package: "@godspeedai/cognate-runtime-bun",
    supported: true,
    contribute: (options) => [`agents:${JSON.stringify(options ?? null)}`],
  },
];

// Validate and freeze the profile. Names must be unique and non-empty.
const profile = defineProfile({
  name: "research-workbench",
  description: "Sessions plus a bounded agent pool",
  components: ["sessions", "agents"],
  options: { agents: { max: 2 } },
});

const resolved = resolveProfile(profile, registry);
resolved.contributions; // [{ name: "sessions", ... }, { name: "agents", contribution: 'agents:{"max":2}' }]
resolved.unresolved; // every requested name that could not be included, with a reason

resolveProfile walks the profile's components in order, calling contribute(profile.options[name]) only for supported entries. An unknown name is reported with reason "unknown component"; an entry marked supported: false is reported with its own reason. Nothing is ever silently dropped.

What the types guarantee

  • defineProfile returns a deep-frozen ProfileDefinition: the component list and options cannot be mutated after definition, and validation errors throw ProfileError at definition time, not resolution time.
  • ResolvedProfile separates contributions (in profile order, each tagged with its source package) from unresolved (requested but absent, each with a reason), so a composition can show exactly what it is running and why anything is missing.
  • ComponentEntry.supported: false records an unavailable component explicitly, with a human-readable reason.

Limitations

  • Pure data: this package validates and resolves — it mounts nothing, starts nothing, and knows no registry by itself. The caller owns what contribute returns and what happens with the resolved contributions.
  • Options are opaque to this package; they are passed through to each entry's contribute untouched.

License

Apache-2.0

版本与发布记录

@godspeedai/cognate-profile 共发布 20 个版本,首次发布于 2026/10/09;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.10.0latest2026/11/16今天
0.9.22026/11/152 天前
0.9.12026/11/143 天前
0.9.02026/11/0610 天前
0.8.02026/10/2720 天前
0.7.12026/10/2523 天前

关于 @godspeedai/cognate-profile 的常见问题

@godspeedai/cognate-profile 是什么?

defineProfile: reusable application compositions that select and configure components without new kernel concepts (spec §29).

如何安装 @godspeedai/cognate-profile?

在项目目录运行 npm install @godspeedai/cognate-profile,或使用 pnpm add / yarn add / bun add。

@godspeedai/cognate-profile 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/godspeedai__cognate-profile 是否存在。

@godspeedai/cognate-profile 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@godspeedai/cognate-profile 可以商用吗?

@godspeedai/cognate-profile 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@godspeedai/cognate-profile 的下载量有多少?

根据 npm 官方下载统计,@godspeedai/cognate-profile 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,422 次,日均约 114 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@godspeedai/cognate-profile 还在维护吗?

最新版本 0.10.0 发布于 2026/11/16(今天);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/10/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。