# @alphabite/medusa-wishlist 中文文档

规范地址：https://npmcn.com/package/%40alphabite/medusa-wishlist/

版本：0\.7\.6
npm 元数据更新时间：2026-10-18T13:41:38.535Z
中文译文更新时间：2026-11-06T06:07:08.248Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alphabite/medusa-wishlist
原文对照：https://npmcn.com/package/%40alphabite/medusa-wishlist/?lang=original
项目主页：https://github.com/alphabite-dev/medusa-client#readme
源码仓库：https://github.com/alphabite-dev/medusa-wishlist

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

- 包体积（解压后）：227 kB，67 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：@medusajs/ui ^4\.0\.4，@medusajs/cli ^2\.13\.6，@medusajs/icons ^2\.13\.6，@medusajs/medusa ^2\.13\.6，@medusajs/admin-sdk ^2\.13\.6，@medusajs/framework ^2\.13\.6，@medusajs/test-utils ^2\.13\.6
- 首次发布：2025-06-10T06:32:13.019Z
- 最新版本发布：2026-10-18T13:41:38.309Z
- 近 30 天下载量：4596（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 18 个）

## 中文简介

Alphabite 的 Medusa 愿望列表插件

## 安装

```sh
npm install @alphabite/medusa-wishlist
```

也可以使用：`pnpm add @alphabite/medusa-wishlist`、`yarn add @alphabite/medusa-wishlist`、`bun add @alphabite/medusa-wishlist`

## README

# 美杜莎愿望列表插件

这个 **Alphabite 愿望列表插件** 最完整的愿望列表系统 [美杜莎日报社](https://medusajs.com/)。它支持认证用户和来宾用户,每个用户有多个愿望列表,以及用于前端集成的全功能SDK客户端.

此插件飞船 :

-   QQ 完全输入的 JS SDK 插件
-   邮递员收藏
-   QQ 支持客人和认证客户

* * *

## 版本兼容性

请安装匹配您的 Medusa 版本的插件版本 :

| 美杜莎版本 | 插件版本 | 安装命令 |
| --- | --- | --- |
| `2.14.*` 及以上职等 | `latest` | `npm install @alphabite/medusa-wishlist` |
| `2.13.*` | `0.5.8` | `npm install @alphabite/medusa-wishlist@0.5.8` |
| 以下 `2.13.0` | `0.5.7` | `npm install @alphabite/medusa-wishlist@0.5.7` |

`latest` 由美杜莎建造并测试 `2.21.0`。 。 。 .

### 安装最新版本(Medusa 2.14.\*及以上)

```bash
npm install @alphabite/medusa-wishlist
```

### 正在安装0.5.8版本(Medusa 2.13.\*)

```bash
npm install @alphabite/medusa-wishlist@0.5.8
```

### 安装0.5.7版本(Medusa版本低于2.13.0)

```bash
npm install @alphabite/medusa-wishlist@0.5.7
```

> iQQ使用不匹配的版本可能导致相容性问题. 确定检查您的美杜莎版本( S)`npm list @medusajs/medusa`在安装之前.

* * *

## 目录

-   [\* 特性](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--features)
-   [\* 安装](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--installation)
-   [QQ 插件选项](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--plugin-options)
-   [• 行政部门](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--admin)
-   [API 终点](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--api-endpoints)
-   [SDK 用户](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--sdk-usage)
-   [QQ 来宾愿望列表流程](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--guest-wishlist-flow)
-   [所需经费](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--requirements)
-   [邮递员收藏](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--postman-collection)
-   [捐款](https://npmcn.com/package/%40alphabite/medusa-wishlist/#readme--contributing)

* * *

## \* 特性

-   每个客户的多个愿望名单
-   将项目添加/删除到/从任何愿望列表中
-   ++ 已登记时支持的来宾愿望列表
-   完全打入了美杜莎JSDK 与我们的SDK客户端的整合
-   \* 内置加固和过滤
-   管理页面 **设置** + 键 **分析** 选项卡

* * *

## \* 安装

通过 npm 安装插件 :

```bash
npm install @alphabite/medusa-wishlist
```

在你身边 `medusa-config.js`,注册插件 :

```js
const plugins = [
  {
    resolve: "@alphabite/medusa-wishlist",
    options: {
      // all are optional, read bellow about default values
      wishlistFields: [],
      wishlistItemsFields: [],
      includeWishlistItems: true,
      includeWishlistItemsTake: 5,
      allowGuestWishlist: true,
    },
  },
];
```

* * *

## QQ 插件选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `wishlistFields` | `string[]` | `["items.*", "items.product_variant.*", "items.product_variant.prices.*", "items.product_variant.product.thumbnail", "items.product_variant.product.id"]` | 有选择地将美杜莎产品或产品变异域列入 " 愿望清单 " 清单/检索包括 " 愿望清单 " 项目的终点 |
| `wishlistItemsFields` | `string[]` | `["id", "product_id", "wishlist_id", "created_at", "wishlist.customer_id", "updated_at", "deleted_at", "product_variant.*", "product_variant.prices.*", "product_variant.calculated_price", "product_variant.product.thumbnail",]` | 选择性地将美杜莎产品或产品变异域列入愿望清单项目清单/检索终点 |
| `includeWishlistItems` | `boolean` | `false` | 自动填充愿望列表项目 `GET /store/wishlists` |
| `includeWishlistItemsTake` | `number` | `5` | 如果 `includeWishlistItems` 真实 |
| `allowGuestWishlist` | `boolean` | `false` | 启用不认证的愿望列表创建和使用( 基于 cookie) |

* * *

## • 行政部门

插件添加一个 **愿望列表** 页面到管理员边栏(`/app/wishlists`与 两个标签 : **设置** (宾客/多切入)和 **分析** 联合国 kPI的只读仪表板,一种活动趋势,以及最希望列入清单的产品 和变体).

见 [医生/医疗分析员](https://npmcn.com/package/%40alphabite/medusa-wishlist/docs/admin-analytics.md) 用于分析终点 和反应形状.

* * *

## API 终点

所有端点均可在 `/store/wishlists`。 。 。 .

| 方法 | 终点 | 认证 | 说明 |
| --- | --- | --- | --- |
| 获取 | `/store/wishlists` | ✅ | 当前客户的希望列表 |
| 邮政 | `/store/wishlists` | (可选) | 创建一个新的愿望列表 |
| 获取 | `/store/wishlists/:id` | (可选) | 使用 ID 获取愿望列表 |
| 点 | `/store/wishlists/:id` | ✅ | 更新愿望列表元数据 |
| 迪莱特 | `/store/wishlists/:id` | ✅ | 删除一个愿望列表 |
| 邮政 | `/store/wishlists/:id/transfer` | ✅ | 向登录用户传输来宾愿望列表 |
| 获取 | `/store/wishlists/:id/items` | (可选) | 在愿望列表中获取项目 |
| 邮政 | `/store/wishlists/:id/add-item` | (可选) | 在愿望列表中添加一个项目 |
| 迪莱特 | `/store/wishlists/:id/items/:item_id` | (可选) | 从愿望列表中删除项目 |

* * *

## SDK 用户

❗❗❗[更多关于我们的美杜莎相容的SDK](https://github.com/alphabite-dev/medusa-client/tree/main)

```ts
import { AlphabiteMedusaClient, wishlistPlugin } from '@alphabite/sdk'

const sdk = new AlphabiteMedusaClient({
  {
    baseUrl,
    debug: process.env.NODE_ENV === "development",
    publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
  },
  [wishlistPlugin],
  {
    getAuthHeader: () => { return { authorization: `Bearer ${customerJwt}` } },
  }
})

// Create wishlist
await sdk.alphabite.wishlist.create({ name: 'My Sneakers' })

// Add item
await sdk.alphabite.wishlist.addItem({
  id: 'wishlist_id',
  product_variant_id: 'variant_id',
})

// List items
const { data } = await sdk.alphabite.wishlist.listItems({ id: 'wishlist_id' })
```

* * *

## QQ 来宾愿望列表流程

来宾许愿者的工作就像来宾推车:

1.  创建一个愿望列表( 不需要认证)
2.  保存该 `id` 在饼干中
3.  使用该ID来列出/添加/删除物品
4.  当用户签名或登录时,请打电话 `transfer` 关联的终点:

```ts
await medusa.alphabite.wishlist.transfer({ id: wishlistId });
```

之后,饼干就不再需要了.

* * *

## 所需经费

-   美杜莎 v 2.14.0 +
-   两人合作 `@medusajs/types` 财务报告和审定财务报表 `@medusajs/framework`

`@mikro-orm/*`, (中文(简体) ), `awilix` 财务报告和审定财务报表 `pg` 由美杜莎提供,不需要在插件旁边安装.

* * *

## 邮递员收藏

您可以在下列地点找到即时进口邮递员收藏:

```
alphabite-wishlist-postman.json
```

用它来交互地探索和测试所有的终点.

* * *

## 捐款

我们欢迎问题、反馈和公关。 分叉取出,造出取出,改良取出.

让我们让商业更加个性化

## 常见问题

### @alphabite/medusa-wishlist 是什么？

Alphabite 的 Medusa 愿望列表插件

### 如何安装 @alphabite/medusa-wishlist？

在项目目录运行 npm install @alphabite/medusa-wishlist，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@medusajs/ui（^4\.0\.4）、@medusajs/cli（^2\.13\.6）、@medusajs/icons（^2\.13\.6）、@medusajs/medusa（^2\.13\.6）、@medusajs/admin-sdk（^2\.13\.6）、@medusajs/framework（^2\.13\.6）、@medusajs/test-utils（^2\.13\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @alphabite/medusa-wishlist 支持 TypeScript 吗？

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

### @alphabite/medusa-wishlist 支持 ESM 还是 CommonJS？

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

### @alphabite/medusa-wishlist 需要什么版本的 Node\.js？

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

### @alphabite/medusa-wishlist 可以商用吗？

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

### @alphabite/medusa-wishlist 的下载量有多少？

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

### @alphabite/medusa-wishlist 还在维护吗？

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

