@brendanbank/atrium-host-types

中文文档
0.32.5发布于 2026/11/09BSD-2-ClauseTypeScriptES Module零依赖构建来源已验证近 30 天下载 1691

TypeScript declarations for the atrium host-extension contract: AtriumRegistry, UserContext, AdminUserRow, AtriumNotification, AtriumEvent. Source-of-truth shapes a host bundle types against, kept in sync with atrium's published image major.minor.

原始使用文档
文档目录4 节
  1. Installation
  2. Versioning
  3. What ships
  4. See also

@brendanbank/atrium-host-types

TypeScript declarations for the atrium host-extension contract.

import type {
  AtriumRegistry,
  AtriumNotification,
  AtriumEvent,
  UserContext,
  AdminUserRow,
} from '@brendanbank/atrium-host-types';

const reg = window.__ATRIUM_REGISTRY__ as AtriumRegistry;
reg.registerHomeWidget({ key: 'my-card', render: () => /* ... */ });

The package is types-only — no runtime, no JS payload at runtime. Bundlers strip it from the production output.

Installation

pnpm add -D @brendanbank/atrium-host-types

The package is published on the public npm registry. No .npmrc, no auth token, no PAT. If you adopted atrium before v0.15.1 and have an @brendanbank:registry=https://npm.pkg.github.com line in your .npmrc, delete it — npmjs.org is the default registry.

Versioning

The package version tracks atrium's image version. Pin ^0.32 for "compatible with atrium 0.32.x"; bump together with the atrium image to pick up new registry slots. New slots land as optional members on AtriumRegistry first so a host that hasn't bumped yet still type-checks.

What ships

  • AtriumRegistry — every register* slot atrium exposes plus subscribeEvent.
  • UserContext — /users/me/context shape.
  • AdminUserRow — /admin/users row shape.
  • AtriumNotification — notification row body.
  • AtriumEvent / AtriumEventHandler — SSE typed event shape.
  • Per-slot option-bag types: HomeWidget, RouteEntry, NavItem, AdminTab, ProfileItem, NotificationKindRenderer, LocaleOverlay.
  • ProfileSlot, HomeWidgetWidth — string unions.
  • A declare global block that types window.React, window.__ATRIUM_VERSION__, and window.__ATRIUM_REGISTRY__.

See also

版本与发布记录

@brendanbank/atrium-host-types 共发布 52 个版本,首次发布于 2026/04/29;过去 12 个月发布了 52 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.32.5latest2026/11/091 天前
0.32.42026/11/028 天前
0.32.32026/11/028 天前
0.32.22026/10/3110 天前
0.32.12026/10/2912 天前
0.32.02026/10/2614 天前

关于 @brendanbank/atrium-host-types 的常见问题

@brendanbank/atrium-host-types 是什么?

TypeScript declarations for the atrium host-extension contract: AtriumRegistry, UserContext, AdminUserRow, AtriumNotification, AtriumEvent. Source-of-truth shapes a host bundle types against, kept in sync with atrium's published image major.minor.

如何安装 @brendanbank/atrium-host-types?

在项目目录运行 npm install @brendanbank/atrium-host-types,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@brendanbank/atrium-host-types 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@brendanbank/atrium-host-types 支持 ESM 还是 CommonJS?

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

@brendanbank/atrium-host-types 可以商用吗?

@brendanbank/atrium-host-types 使用 BSD-2-Clause 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@brendanbank/atrium-host-types 的下载量有多少?

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

@brendanbank/atrium-host-types 还在维护吗?

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