@happy-technology/连接器-核心
快乐科技产品共享接通基底. 它提供 连接器平台中产品完全相同的部分,没有 具体如下:
- 说明/说明计划
ConnectorDescriptor: 单一来源 连接器元数据的真实性,驱动配置验证,目录,以及 登记表. - 通用软件
ConnectorRegistry<T>: 注册连接器, 查找它们, 列出 目录, 验证配置 。 替换已关闭的enum和DB CHECK限制. - 描述器驱动的配置验证,包括拒绝的守护 非秘密配置路径上的证书形状密钥 .
- OAuth 和 证书底盘(
OAuthSubstrate: 授权码 流,令牌刷新,并加密令牌存储,被注入接口后. - 可选的单证连接合同(
SourceConnector用于产品 摄入文件.
设计边界
此软件包拥有元数据、 登记力学、 验证和认证 管弦乐 它不拥有:
- 出品域逻辑(编译为文物,与CIS相协调).
- 密码 你注射一个
SecretCipher。 。 。 . - 存储。 你注射一个
CredentialStore可选OAuthStateStore。 。 。 . - 一个特定的 OAuth 库. 您给每个提供者注射
OAuthClient实例.
这是让认证后端稍后被互换的接合器( 例如到一个 自我托管的"南戈"),没有触摸连接器代码.
将OAuth基底与北极连接
北极地区(arcticjs.dev, MIT)为微软提供打入了 OAuth 2.0 客户端
Entra ID, Google, Atlassian, GitHub, Slack, 等. 星洲网. 北极的标志对象
暴露方法accessToken()),将每个客户端包装到 OAuthClient
形状
import * as arctic from "arctic";
import { OAuthSubstrate, type OAuthClient } from "@happy-technologies/connector-core";
function wrap(provider: {
createAuthorizationURL: (state: string, codeVerifier: string, scopes: string[]) => URL;
validateAuthorizationCode: (code: string, codeVerifier: string) => Promise<arctic.OAuth2Tokens>;
refreshAccessToken: (refreshToken: string, scopes?: string[]) => Promise<arctic.OAuth2Tokens>;
}): OAuthClient {
const toTokens = (t: arctic.OAuth2Tokens) => ({
accessToken: t.accessToken(),
refreshToken: t.hasRefreshToken() ? t.refreshToken() : undefined,
accessTokenExpiresAt: t.accessTokenExpiresAt(),
});
return {
createAuthorizationURL: (state, verifier, scopes) =>
provider.createAuthorizationURL(state, verifier, scopes),
validateAuthorizationCode: async (code, verifier) =>
toTokens(await provider.validateAuthorizationCode(code, verifier)),
refreshAccessToken: async (refreshToken, scopes) =>
toTokens(await provider.refreshAccessToken(refreshToken, scopes)),
};
}
const google = new arctic.Google(clientId, clientSecret, redirectUri);
const oauth = new OAuthSubstrate({
clients: new Map([["google", wrap(google)]]),
credentials: myCredentialStore, // backed by your DB + envelope crypto
cipher: myEnvelopeCipher, // encryptSecret / decryptSecret
});
// In a fetch path:
const cred = await oauth.resolve(sourceId);
const res = await fetch(url, { headers: cred.headers });
对于客户端证书/只应用的赠款(微软图形只应用,ServiceNow)
服务账户),执行 OAuthClient 直接在一个符号端点上,或
使用情况 openid-client。 。 。 .
脚本
bun test运行单元套房.bun run type-check运行tsc --noEmit。 。 。 .bun run build发射dist/与声明.bun run check:no-em-dash执行 org 内容规则.
状态
v0.1: 底部核心(描述、登记、验证、认证、文档) 合同),并附有测试. 首先由"快乐知识"(Happy Knowledge;HappyCMDB)所拥有 框架随时间推移而迁移到同样的明确计划.