@framers/agentos-ext-notifications

中文文档
0.1.7发布于 2026/11/11Apache-2.0TypeScriptCommonJS零依赖构建来源已验证近 30 天下载 2万

Unified multi-channel notification router for AgentOS — send, broadcast, and schedule notifications across all configured channels.

原始使用文档
文档目录8 节
  1. Installation
  2. Usage
  3. Tools
  4. notifySend
  5. notifyBroadcast
  6. notifySchedule
  7. Notes
  8. License

Notifications

This pack gives an agent tools to send, broadcast, and schedule notifications through the pack's NotificationService. Delivery uses registered channel callbacks.

Installation

npm install @framers/agentos-ext-notifications

Peer dependency: @framers/agentos with range >=0.10.40.

Usage

import { AgentOS } from '@framers/agentos';

const agentos = await AgentOS.create({
  extensionManifest: {
    packs: [{ package: '@framers/agentos-ext-notifications' }],
  },
});

Tools

ToolWhat it does
notifySendSends a notification through a specified channel or the highest-priority available channel.
notifyBroadcastBroadcasts a notification to all registered channels or a specified subset.
notifyScheduleSchedules, cancels, or lists pending notifications.

notifySend

ParameterTypeRequiredDescription
channelstringNoTarget channel id. If omitted, the highest-priority channel is used.
messagestringYesNotification body text.
subjectstringNoOptional subject or title for the notification.
metadataobjectNoArbitrary metadata forwarded to the channel.

notifyBroadcast

ParameterTypeRequiredDescription
messagestringYesNotification body text.
subjectstringNoOptional subject or title for the notification.
channelsarray of stringNoSubset of channel ids to target. If omitted, all registered channels are used.
metadataobjectNoArbitrary metadata forwarded to every channel.

notifySchedule

ParameterTypeRequiredDescription
actionstring, enum: schedule, cancel, listYesAction to perform: "schedule" to create, "cancel" to remove, or "list" to view pending notifications.
channelstringNoTarget channel id (used with "schedule" action).
messagestringNoNotification body text (required for "schedule" action).
subjectstringNoOptional subject or title (used with "schedule" action).
sendAtstringNoISO 8601 timestamp for when to send (required for "schedule" action).
scheduleIdstringNoSchedule id to cancel (required for "cancel" action).

Notes

  • The factory reads no options, secrets, or environment variables. It creates a service with an empty channel registry and does not expose that service in the returned pack.
  • The exported NotificationService supports registerChannel, unregisterChannel, and listChannels. A channel supplies id, name, priority, and a sendFn callback. The exported tool classes accept a service instance in their constructors.
  • Sending invokes the channel's sendFn with the message, subject, and metadata. A missing channel makes notifySend return success: false. With no registered channels, sending fails with "No notification channels registered".
  • Broadcast sends to channels sequentially, skips unknown ids in a requested subset, and fails if no target channels remain.
  • Channel callback failures appear as delivered: false with an error in the returned data. The send and broadcast tools still return success: true when the service returns those delivery results.
  • Scheduling stores notifications in memory and uses setTimeout. A past sendAt triggers delivery without waiting. Deactivation cancels and clears pending notifications.
  • The schedule action checks for message and sendAt; the cancel action checks for scheduleId. These fields remain optional in the input schema.
  • Scheduled delivery failures are swallowed, and the pending entry is removed after the delivery attempt.

License

Apache-2.0

版本与发布记录

@framers/agentos-ext-notifications 共发布 8 个版本,首次发布于 2026/05/02;过去 12 个月发布了 8 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.7latest2026/11/114 天前
0.1.62026/11/0115 天前
0.1.52026/10/2125 天前
0.1.42026/10/121 个月前
0.1.32026/10/111 个月前
0.1.22026/10/081 个月前

关于 @framers/agentos-ext-notifications 的常见问题

@framers/agentos-ext-notifications 是什么?

Unified multi-channel notification router for AgentOS — send, broadcast, and schedule notifications across all configured channels.

如何安装 @framers/agentos-ext-notifications?

在项目目录运行 npm install @framers/agentos-ext-notifications,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@framers/agentos(>=0.10.40)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@framers/agentos-ext-notifications 支持 TypeScript 吗?

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

@framers/agentos-ext-notifications 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@framers/agentos-ext-notifications 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@framers/agentos-ext-notifications 可以商用吗?

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

@framers/agentos-ext-notifications 的下载量有多少?

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

@framers/agentos-ext-notifications 还在维护吗?

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