@ godspideai/ cognate- 内核- api
Cognate的框架自有内核合同:组件,范围,能力,纤维,效果,和政策——作为TypeScript类型外加几个决定性的帮助者. 这里没有引擎密码船.
何时使用此软件包 : 您正在创建必须针对内核输入的能力组件或写入代码,或者您正在实施内核引擎。 申请通常通过
@godspeedai/cognate-runtime-bun 或 @godspeedai/cognate 伞.
安装
bun add @godspeedai/cognate-kernel-api
要求数 阿宝 >= 1.4.0.
盒子里的东西
- 类型 —— 说
Kernel, (中文(简体) ),Scope, (中文(简体) ),Component, (中文(简体) ),FiberContext, (中文(简体) ),CapabilityLease, (中文(简体) ),Effects, (中文(简体) ),Policy, (中文(简体) ),InvocationResult,其他内核词汇. isCompatible(requirement, contract)——决定能力资格:相同能力id,相同主要版本需要小/patch QQ,每个需要的属性相等. 不需要发动机.- 政策 —— 说
denyAll(没有授权,除非你这么说),rulePolicy(policyId, rules)(第一匹配规则决定,不否认匹配),和allowCapabilities(policyId, ids)明确允许列表. isUnavailable(value)——类型后卫区分失败解析与租赁.- 输入错误 —— 说
CleanupError, (中文(简体) ),PermanentActivationError, (中文(简体) ),ActivationTimeoutError, (中文(简体) ),UndeclaredCapabilityError, (中文(简体) ),ScopeClosedError。 。 。 .
快开始
宣布一个提供能力的组成部分,并选择政策加以援引:
import { allowCapabilities, isCompatible } from "@godspeedai/cognate-kernel-api";
import type { Component } from "@godspeedai/cognate-kernel-api";
const greeter: Component = {
id: "greeter",
provides: [{ id: "greet", version: "1.0.0" }],
activate(fiber) {
// Reversible effects, torn down in reverse order on disposal.
fiber.effects.register(() => console.log("greeter cleaned up"));
// Publish the capability; visible only after activation succeeds.
fiber.provide({ id: "greet", version: "1.0.0" }, async (name: string) => ({
hello: name,
}));
},
};
// Deterministic eligibility — computed locally, no engine involved:
isCompatible({ capability: "greet", version: "1.0.0" }, greeter.provides![0]!); // true
// Every invocation passes through a policy; anything not allowed is denied.
const policy = allowCapabilities("allow-greetings", ["greet"]);
上载组件、解决租赁问题和援引能力需要引擎:使用
@godspeedai/cognate-kernel-cordis
或运行时间, 嵌入一个.
语义上说合同定下来
- 决议从不考虑政策;每次援引都是如此,默认就是否认。 每项决定均作为
invocation审计活动通过kernel.observe。 。 。 . - 召见从不扔出: 它返回一个
InvocationResult输入失败的..unavailable, (中文(简体) ),denied, (中文(简体) ),deadline_exceeded, (中文(简体) ),cancelled,或failed。 。 。 . - 活化是全-或-无:失败活化会按倒序处理尝试的效果并发布什么.
- 处置为一等能,按倒序运行每个处置者,并拒绝一次
CleanupError如果任何处置者失败. - 提供的能力在范围上是显而易见的,只有后代才有;儿童的范围可能会缩小其本能,但绝不会通过继承而获得权威.
供引擎执行者使用的合规包
如果您执行 KernelFactory,在自己的测试套房中执行可执行合同时不变:
import { contractSuite } from "@godspeedai/cognate-kernel-api/conformance";
import { createCordisKernel } from "@godspeedai/cognate-kernel-cordis";
contractSuite("my-kernel", createCordisKernel);
副路径输出出六套套套房(contractSuite, (中文(简体) ), lifecycleSuite, (中文(简体) ), effectsSuite, (中文(简体) ), dependenciesSuite, (中文(简体) ), scopesSuite, (中文(简体) ), authoritySuite加上一个 fixtures 与现成主机、供应商和消费者进行内核测试的命名空间.
限制
- 这个软件包在运行时除了它输出的小助手之外,不会执行任何东西:它不会挂载组件,匹配提供者,或者授权调用. 与引擎执行对等.
- 类型仅是编译时间;在TypeScript检查之前,任何部件都无法对照合同验证.
相关软件包
@godspeedai/cognate-kernel-cordis——本合同的内核引擎实施.@godspeedai/cognate-runtime-bun——嵌入内核的参考运行时间.@godspeedai/cognate——SDK伞;最容易得到工作内核后置运行时间的方法.
许可证
阿帕奇 - 2.0