# @aglyn/plugins-commerce 中文文档

规范地址：https://npmcn.com/package/%40aglyn/plugins-commerce/

版本：1\.18\.0
npm 元数据更新时间：2026-11-07T06:41:55.970Z
中文译文更新时间：2026-11-07T01:24:30.997Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aglyn/plugins-commerce
原文对照：https://npmcn.com/package/%40aglyn/plugins-commerce/?lang=original
项目主页：https://aglyn.com/
源码仓库：https://github.com/aglyn/aglyn

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：21.5 MB，1662 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：18 个
- peer 依赖：next ^16\.3\.3，react ^19\.2\.8，firebase ^13\.0\.0，@mui/material ^9\.3\.1，firebase-admin ^14\.3\.0，@mui/x-data-grid ^9\.12\.0，@mui/x-date-pickers ^9\.15\.0
- 首次发布：2026-09-20T23:53:12.425Z
- 最新版本发布：2026-11-07T06:41:55.650Z
- 近 30 天下载量：9582（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：161（近 12 个月 161 个）

## 中文简介

Aglyn的商务插件:产品,手推车,退货,订单和发售点,加上游客账户和成员挡住同一捆的船. 如果您正在运行或建在 Aglyn 平台上, 想要一个商店前端, 请安装它 .

## 安装

```sh
npm install @aglyn/plugins-commerce
```

也可以使用：`pnpm add @aglyn/plugins-commerce`、`yarn add @aglyn/plugins-commerce`、`bun add @aglyn/plugins-commerce`

## README

# @aglyn/plugins-商业

Aglyn的商务插件:产品,手推车,退货,订单和发售点,加上游客账户和成员挡住同一捆的船. 如果您正在运行或建在 Aglyn 平台上, 想要一个商店前端, 请安装它 .

> 从Aglyn monorepo出版到npm. 随后的版本 [语义版本](https://semver.org/)。 。 。 .

## 安装

```
npm install @aglyn/plugins-commerce
```

同伴依赖性 :

-   `@mui/material`
-   `firebase`
-   `next`
-   `react`

无是可选的。 服务器的另一半依赖 `firebase-admin` 结束 `@aglyn/tenant-data-admin`。 。 。 .

## 里面有什么东西

这个软件包是一个第一党的Aglyn插件. 它通过 Aglyn 的插件管理器被装入: 应用程序读取了单列波的条目 `plugins.config.json`,输入每个表层名称,并呼叫登记员宣布该表层。 它不是一个独立的库;安装在它自己的负载上没有什么.

### 在一个公开的网站上

`registerCommercePlugin()` 记录这些画布组件,并与其他元素一样放置在标本中:

-   存储前置 : `product-grid`, (中文(简体) ), `product-detail`, (中文(简体) ), `related-products`, (中文(简体) ), `product-reviews`, (中文(简体) ), `cart`, (中文(简体) ), `wishlist`, (中文(简体) ), `reservation-widget`, (中文(简体) ), `newsletter-signup`
-   账户和成员: `customer-account`, (中文(简体) ), `member-signin`, (中文(简体) ), `member-signup`, (中文(简体) ), `member-recovery`, (中文(简体) ), `member-feed`, (中文(简体) ), `gate`, (中文(简体) ), `gated-video`

元件代号在屏幕文档中被坚持,从未被更名.

输入 `plugins.config.json` 还宣布 `accounts` 容量("用户账户"):访问者在站点的账户,有登录,注册和恢复页以及成员块. 它需要商业,在打开前关闭一个站点,没有单独的包;这包记录它的块和它的块 `membership/*` 管理者.

### 在操纵台上

`registerCommerceConsole()` 登记册 :

-   A 类 **产品** 导航项目和页面 : `/products`,以目录、命令、晋升、保留、设置和分析等部分作为路线.
-   A 类 **业务干事** 导航项目和页面 : `/pos`,这需要插件自己的 `managePos` 允许.
-   一个“ 商业” 部件 `commerceGlance` 和“最新网站用户”部件 `hostDashboard` 账户能力下的插槽.
-   一个“ 购买” 部件 `siteMember` 插槽:一个网站用户一生的购买总额,订单和订阅,放在网站用户页面的抽屉中.
-   插件的权限( E)`COMMERCE_PERMISSIONS`)及其配置方案(`COMMERCE_CONFIG_SCHEMA`,持有POS折扣上限).
-   其他插件区域中的部件(AGL-4098):Inbox中一个引用请求上的"开始引用"(AGL-4098):`inboxSubmissionActions`)和客户关系管理中的联系人(`crmRecordActions`),每个打开填入的引用编辑器.
-   这个 `product-options-field` 元素(AGL-4098):一种产品及其选项的窗体字段,该字段将其可读行以名称和确切选择置于 `{name}__data`。 。 。 .
-   三个区域,它自己的表面宿主,宣布 `registerPluginZone`数字 : `productEditor` (在产品编辑器的栏目中), `productsHub` (目录表上)和 `productImport` (产品导入向导后导入步骤). 他们的道具被宣布 在区域标志 `components/console/product-zones`。 。 。 .
-   客户端将6个进出口资源减半,产品向导的"后进口步骤"和礼品卡进口的"确认步骤"(C`transfer/register-transfer-ui`) (中文(简体) ). 产品、订单、折扣、优惠券、礼品卡和类别卡通过核心发射器打开控制台的进口向导和导对话框(`useTransferLauncher`) (中文(简体) ).

所有控制台页面和卡片都是密码分解.

### 启动站点

`commerceStarterTemplates()` (单位:千美元)`starter-templates`)返回两个商店起步器"Shop (物理产品)"和"Shop (数字产品)":家用,商店,产品页面,推车和账户页面围绕这个插件的元素所构建. `plugins.config.json` 名字下边 `starterTemplates`,显示的生成器将启动器编译为核心的 `STARTER_TEMPLATES`,模板库、种子路由和AI插件的示例将读取。 启动的ID,页面密钥和节点ID在每一个使用一个的站点中都被坚持.

### 在服务器上

`@aglyn/plugins-commerce/server` 停车 `firebase-admin` 和条纹,并远离客户的切入点.

-   `registerCommerceApi()` (单位:千美元) `tenantApi` (表层)登记以下储存的前沿路线: `commerce/` (目录、产品、相关评论、推车、推车检查、离职、下载、饲料、通讯、备用通知、命令分析、订单状况、客户报价页、其付款按钮和PDF)`quote-view`, (中文(简体) ), `quote-pay`, (中文(简体) ), `quote-pdf`),其证明,客户的艺术品上传及其答案("`quote-proof`, (中文(简体) ), `quote-upload`, (中文(简体) ), `quote-respond`),以及他们给企业的信息(`quote-message`;同一页,付款按钮和PDF服务于开具发票的订单草案的持久薪酬链接、预订、闸口、成员馈赠、溪流、订阅门户)和以下账户路线: `membership/` (登记,登录,登录,恢复,重置,账号,内容,愿望列表). 它还登记一个网页解析器和扩充器、商业税概况和一个核心接合器的产品卡读取器.
    
-   `registerCommerceConsoleApi()` (单位:千美元) `consoleApi` (d) 注销、履行和退还订单、订单草稿、带有工资链接的引文、PDF、证明、修订和发送订单的电子邮件(`quote` `send`),命令或引文的发票电子邮件(`order-invoice-send`),并引出从表单的引出请求(`quote` `start-from-request`,以及 `create` 与 `from`,通过表单插件读取 `forms.submission` 网站用户的密码帮助和删除(`membership/admin-password`, (中文(简体) ), `membership/admin-remove`),花纹连接,供应商更新,以及被废弃的检查出站和备用处理器. 它还在平台上增加了一个处理器,对webhook和订购人物阅读器进行计费.
    
-   `registerCommerceConsoleApi()` 此外,还登记了人工智能建筑在存储、核心资源草案和人工智能能力接合方面可能起到的作用: `product` 起草作者和构建行动 `store-settings` 作者与 `store-shipping`, (中文(简体) ), `store-pickup`, (中文(简体) ), `store-delivery` 财务报告和审定财务报表 `store-tax` 建立行动`server/store-setup-ai-*.ts`) (中文(简体) ). 这四个人把船运区和费率、皮卡、当地交货和销售税设定在控制台的卡片所保存的状态下,只使用请求所述的数量和费率,而从未设置过承运人或税务服务账户. `model/store-setup-content.ts` 保持纯粹的读取和应用步骤.
    
-   正在装入模块注册计划插件任务 : `abandoned-checkout-recovery`, (中文(简体) ), `back-in-stock-alerts`, (中文(简体) ), `review-request-emails`, (中文(简体) ), `stock-decrement-reconciliation`, (中文(简体) ), `supplier-webhook-delivery`, (中文(简体) ), `payment-method-domains` 财务报告和审定财务报表 `pos-reader-splash-refresh` (读卡器在更改了标志后启动屏幕). 这就是为什么 `package.json` 列表 `./src/lib/server.*` 下级 `sideEffects`。 。 。 .
    
-   `registerCommerceConsoleServerDeclarations()` (单位:千美元) `consoleServerDeclarations` (表层)声明 `commerce-quote-upload-sweep`,在表单插件的扫描中,一个15分钟的控制台工作,删除一个客户附在引文的答案后从未发送的艺术品,这是其最后一次上传的第二天(AGL-4096)。 每个文件记录为待决文件 `orders/{quoteId}/quoteUploadKeys/{quoteId}` 从罚单到 `quote-respond` 发去`server/quote-upload-keys.ts`, (中文(简体) ), `server/quote-upload-sweep.ts`) (中文(简体) ).
    
-   产品审查是默认的经核实的买方. `commerce/reviews` (POST) 标记一个只被验证的登录网站成员,其经过验证的电子邮件的订单仍有权使用该产品,或者从审查-请求电子邮件获得一个单一用途链接(`server/review-tokens.ts`:散货,60天,订货,产品和电子邮件). 输入的邮件从未验证 。 已核实的评论立即出版;在商店下面 `anyone` 政策`settings/store.reviews.policy`剩下的作为等待 `pending`下页 `verified` 他们得到403. `GET commerce/reviews?mode=eligibility` 告诉商店前方块要绘制什么形式 。 POST是每个地址和每个成员受限的费率. 这个 `order.fulfilled`, (中文(简体) ), `order.delivered` 财务报告和审定财务报表 `order.paid` 订阅者印有其审查请求的订单和小时 `review-request-emails` 任务发送( o)`server/review-requests.ts`,目录密钥 `review-request`) (中文(简体) ). 商人只出于内容原因隐藏评论(`REVIEW_MODERATION_REASONS`),由Firestore规则执行.
    

线路由主机API调度器提供 `/api/`,例如 `/api/commerce/catalog`。 。 。 .

### 入境点

| 导入 | 目录 |
| --- | --- |
| `@aglyn/plugins-commerce` | `BUNDLE_ID`, (中文(简体) ), `registerCommerceConsole`,站点的一半,以及纯型号:推车(`upsertCartLine`, (中文(简体) ), `removeCartLine`, (中文(简体) ), `cartCount`, (中文(简体) ), `mergeCarts`),以及订单、折扣、晋升、礼品卡、预订、发货、库存和税务模块 |
| `@aglyn/plugins-commerce/site` | `registerCommercePlugin` 财务报告和审定财务报表 `COMMERCE_BUNDLE` 只有这个 这是已出版的页面加载, 所以它没有控制台代码 |
| `@aglyn/plugins-commerce/server` | `registerCommerceApi`, (中文(简体) ), `registerCommerceConsoleApi` |
| `@aglyn/plugins-commerce/transfer/*` | 进出口资源`commerce.products`, (中文(简体) ), `commerce.categories`, (中文(简体) ), `commerce.orders`, (中文(简体) ), `commerce.discounts`, (中文(简体) ), `commerce.coupons`, (中文(简体) ), `commerce.gift-cards`:他们的字段,"shopify"产品词典和预设(`product-transfer`),而服务器将二分之一(`products.server`, (中文(简体) ), `records.server`, (中文(简体) ), `gift-cards.server`,通过每张礼品卡的发行来进口礼品卡 `server/gift-card-issue`),控制台的服务器声明注册 |
| `@aglyn/plugins-commerce/*` | 下的任何模块 `src/lib/`。控制台组件是从 `@aglyn/plugins-commerce/components/console/...` 并且故意不从根上再出口 |

## 使用量

登记员通常由Aglyn生成的插件加载器调用. 直接调用 :

```ts
// Published site (canvas half only)
import { registerCommercePlugin } from '@aglyn/plugins-commerce/site'
registerCommercePlugin()

// Console app
import { registerCommerceConsole } from '@aglyn/plugins-commerce'
registerCommerceConsole()

// Server-only API dispatcher
import {
  registerCommerceApi,
  registerCommerceConsoleApi,
} from '@aglyn/plugins-commerce/server'
registerCommerceApi()
```

## 怎样才合适

插件可以导入租户运行时间,渲染器,Besigner逻辑,核心和共享包. 它从不导入另一个插件,核心也从不导入一个插件. 商业取决于 `@aglyn/aglyn`, (中文(简体) ), `@aglyn/tenant-runtime`, (中文(简体) ), `@aglyn/tenant-data-admin`, (中文(简体) ), `@aglyn/tenant-feature-instance`数 `@aglyn/shared-*` 软件包,以及 Stale 客户端库。 其它的插件需要通过核心接合:它注册了付费预订价格的插件税概况,以及产品卡和订单读者通过合同阅读的其他插件.

## 许可证

阿帕奇2.0 (英语). 资料来源: [https://github.com/aglyn/aglyn/tree/main/libs/plugins/commerce 互联网档案馆的存檔,存档日期2014-12-11](https://github.com/aglyn/aglyn/tree/main/libs/plugins/commerce)

## 常见问题

### @aglyn/plugins-commerce 是什么？

Aglyn的商务插件:产品,手推车,退货,订单和发售点,加上游客账户和成员挡住同一捆的船\. 如果您正在运行或建在 Aglyn 平台上, 想要一个商店前端, 请安装它 \.

### 如何安装 @aglyn/plugins-commerce？

在项目目录运行 npm install @aglyn/plugins-commerce，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：next（^16\.3\.3）、react（^19\.2\.8）、firebase（^13\.0\.0）、@mui/material（^9\.3\.1）、firebase-admin（^14\.3\.0）、@mui/x-data-grid（^9\.12\.0）、@mui/x-date-pickers（^9\.15\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aglyn/plugins-commerce 支持 TypeScript 吗？

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

### @aglyn/plugins-commerce 支持 ESM 还是 CommonJS？

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

### @aglyn/plugins-commerce 可以商用吗？

@aglyn/plugins-commerce 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aglyn/plugins-commerce 的下载量有多少？

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

### @aglyn/plugins-commerce 还在维护吗？

最新版本 1\.18\.0 发布于 2026/11/07（今天）；至今共发布 161 个版本，其中过去 12 个月发布了 161 个；首次发布于 2026/09/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。