@adobe/magento-storefront-events-sdk

中文文档
1.18.0发布于 2026/08/11MITTypeScriptESM + CJS近 30 天下载 24.8万

与 Adobe 商务商店前端事件合作的 SDK

中文使用文档
文档目录10 节
  1. 概览
  2. 安装
  3. 快开始
  4. 方案和支助的活动
  5. API 参考
  6. A. 背景情况
  7. 发布
  8. 订阅
  9. 取消订阅
  10. 支助

Adobe 商务活动 SDK

version downloads size build typescript contributing

概览

这一一揽子方案是开展以下活动的基础: Adobe 商业 存储前置。 它提供对Adobe数据层的访问,以及事件出版服务.

您可以在自定义执行中处理事件, 或者使用 Adobe 商务事件收集器 软件包,可以收听事件并发送到 Adobe Commerce 边缘进行处理.

说明: 当一个事件通过SDK发布时,该事件的所有订阅者都会得到通知. 定义一个自定义的收听者 并不排除您同时管理 Adobe 商务事件收集器.

我们的背景计划旨在简化转发到两个边缘:

  • Adobe Commerce Data Services (由Adobe Engineering维护并用于为商家的性能仪表板提供动力) 互联网档案馆的存檔,存档日期2013-12-21
  • Adobe 体验平台 (需要订阅和额外商户) 设置;数据可以被Adobe体验平台内的商人用来进行详细的分析,有针对性地进行交易,实时客户数据简介等)

安装

这个SDK可以作为主机脚本使用,或者被捆绑在一个JavaScript应用程序中. 脚本版本托管于 兹德利夫尔,则捆绑的版本在 无。 。 。 .

要将SDK作为脚本加载,请使用以下片段.

<script src="https://cdn.jsdelivr.net/npm/@adobe/commerce-events-sdk/dist/index.js"></script>

要将脚本安装为依赖, 请运行此命令 .

npm install @adobe/commerce-events-sdk

快开始

一旦导入,您可以访问 Evention SDK 的四大功能.

  • Context - 设置上下文数据
  • Publish - 出版活动
  • Subscribe - 订阅活动
  • Unsubscribe - 不订阅事件

下面是一个如何开始的代码示例.

重要性 相关背景数据在发布需要的数据的事件之前必须包含在内.

import mse from "@adobe/commerce-events-sdk";
// handler - can go in a different module
function addToCartHandler(event) {
    // do something with the event
}
// subscribe to events
mse.subscribe.addToCart(addToCartHandler);

// set context data
const shoppingCartContext = {
    id: "1",
    items: [
        {
            id: "shoppingCart",
            product: {
                productId: 111111,
                sku: "ts001",
                pricing: {
                    regularPrice: 20.0,
                    currencyCode: "USD",
                },
            },
            quantity: 1,
        },
    ],
};
mse.context.setShoppingCart(shoppingCartContext);

// publish events
mse.publish.addToCart();

// unsubscribe from events
mse.unsubscribe.addToCart(addToCartHandler);

方案和支助的活动

以下方法允许您根据SDK schema设置特定上下文,并发布一套由此API支持的事件.

另外,还可以发布自定义事件,或者在支持的事件上添加自定义上下文.

API 参考

SDK分为四个主要部分: Context, (中文(简体) ), Publish, (中文(简体) ), Subscribe, (中文(简体) ), Unsubscribe。 。 。 .

A. 背景情况

预定义上下文列于 背景管理器。 。 。 .

二、根据《公约》第16条建立环境的实例 实例/事件/实例。 。 。 .

每个事件所需的背景 实例/活动/。 。 。 .

发布

预定义的可公布事件列于 出版管理器。任何不属于 PublishManager 应作为自定义事件处理.

关于出版活动的实例清单,请参见: 实例。 。 。 .

订阅

支助 subscibe 事件定义于 订阅管理器。任何不属于 SubscribeManager 应作为自定义事件处理.

请注意,许多自定义事件与不同的计划是反模式的(您需要的多数事件应该由 SubscribeManager) (中文(简体) ). 如果有标准事件,您认为应当支持 SubscribeManager请提交 问题。 。 。 .

请注意,使用SDK的应用程序很少需要订阅事件。 在多数情况下,订阅和未订阅由 存储前置事件收集器。 。 。 .

取消订阅

支助 unsubscibe 事件定义于 注销管理器。 。 。 .

如上所述,SDK和收集器用户很少需要直接调用这些函数.

支助

如果有任何问题或遇到任何问题,请联系 GitHub 图像。 。 。 .

版本与发布记录

@adobe/magento-storefront-events-sdk 共发布 263 个版本,首次发布于 2021/03/18;过去 12 个月发布了 9 个版本。

版本发布日期距今
1.18.0latest2026/08/112 个月前
0.0.0-84da724408a456d7ef1cd15b1cb6c1c6da4f83e3qa2026/08/112 个月前
0.0.0-7387e97ff463b8c6f589cb378485c553591016bc2026/07/303 个月前
1.17.02026/05/046 个月前
0.0.0-073607462513e30948d67e0f5de3f6770bc194e02026/05/046 个月前
0.0.0-278062401f574c64949b443e2e19a7d80b93b7d32026/05/016 个月前

关于 @adobe/magento-storefront-events-sdk 的常见问题

@adobe/magento-storefront-events-sdk 是什么?

与 Adobe 商务商店前端事件合作的 SDK

如何安装 @adobe/magento-storefront-events-sdk?

在项目目录运行 npm install @adobe/magento-storefront-events-sdk,或使用 pnpm add / yarn add / bun add。

@adobe/magento-storefront-events-sdk 支持 TypeScript 吗?

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

@adobe/magento-storefront-events-sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@adobe/magento-storefront-events-sdk 可以商用吗?

@adobe/magento-storefront-events-sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@adobe/magento-storefront-events-sdk 的下载量有多少?

根据 npm 官方下载统计,@adobe/magento-storefront-events-sdk 在 2026/10/05 – 2026/11/03 这 30 天内被下载 247,650 次,日均约 8,255 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@adobe/magento-storefront-events-sdk 还在维护吗?

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