# @dazl/wix-media-client 中文文档

规范地址：https://npmcn.com/package/%40dazl/wix-media-client/

版本：1\.7\.0
npm 元数据更新时间：2026-08-07T07:10:17.482Z
中文译文更新时间：2026-11-11T16:45:27.134Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：50.6 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2025-12-10T16:18:23.258Z
- 最新版本发布：2026-05-10T11:24:29.346Z
- 近 30 天下载量：10165（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

Wix 媒体平台的浏览器客户端 - 文件上传和图像转换

## 安装

```sh
npm install @dazl/wix-media-client
```

也可以使用：`pnpm add @dazl/wix-media-client`、`yarn add @dazl/wix-media-client`、`bun add @dazl/wix-media-client`

## README

# @dazl/wix-media-客户端

通过 dazl API 服务器为 Wix 媒体平台浏览器客户端.

## 特征

-   列出带有光标的媒体文件
-   带有进度跟踪和自动媒体记录创建的文件上传
-   带有转换的图像 URL 生成( 填充、 适应、 裁剪)
-   非图像的直接文件 URL 生成
-   响应图像集生成
-   类型脚本, 零依赖, 浏览器安全

## 快速启动

所有 API 函数都使用 `endpoint` 指向媒体API. 客户端在内部附加子路由.

```typescript
const endpoint = "https://api.dazl.dev/api/media";
```

### 列表文件

```typescript
import { listFiles } from "@dazl/wix-media-client";

const result = await listFiles({ endpoint, projectId: "project-uuid" });

// Filter by type
const images = await listFiles({ endpoint, projectId: "project-uuid", mimeType: "image/" });

// Paginate
const page2 = await listFiles({ endpoint, projectId: "project-uuid", cursor: result.nextCursor! });
```

### 上传文件

```typescript
import { uploadFile } from "@dazl/wix-media-client";

const result = await uploadFile({
  endpoint,
  projectId: "project-uuid",
  file: selectedFile,
  onProgress: (progress) => console.log(`${progress.toFixed(0)}%`),
});
```

上传流量 :

1.  `POST {endpoint}/upload-configuration` ——获得一个预先签名的Wix上传URL
2.  `PUT` 直接到 Wix CDN (通过 XHR 跟踪进度)
3.  `POST {endpoint}` 在数据库中创建媒体记录

### 图像 URL

```typescript
import { getFileUrl } from "@dazl/wix-media-client";

const MEDIA_HOST = "wixmp-abc123.appspot.com";

// Image with transforms
const thumbnail = getFileUrl(MEDIA_HOST, { path: "/projects/xxx/photo.jpg", mimeType: "image/jpeg" }, {
  operation: "fill",
  width: 200,
  height: 200,
  quality: 85,
  format: "webp",
});

// Fit within bounds — both `width` and `height` are required by the wixmp
// image service. `fit` preserves aspect ratio so the actual output is bounded
// by whichever axis hits first.
const url = getFileUrl(MEDIA_HOST, { path: "/projects/xxx/photo.jpg", mimeType: "image/jpeg" }, {
  operation: "fit",
  width: 800,
  height: 800,
});

// No transform commands — defaults to fit 1000x1000 (handy for LLM URL fetchers).
const defaultUrl = getFileUrl(MEDIA_HOST, { path: "/projects/xxx/photo.jpg", mimeType: "image/jpeg" });

// Non-image (returns direct URL automatically)
const pdfUrl = getFileUrl(MEDIA_HOST, { path: "/projects/xxx/doc.pdf", mimeType: "application/pdf" });
```

## API 参考

### `listFiles(options): Promise<ListFilesResponse>`

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `endpoint` | `string` | 所需经费 | 媒体 API 端点 |
| `projectId` | `string` | 所需经费 | 项目标识符 |
| `mimeType` | `string` | \- 说吧 | 由 MIME 类型前缀过滤( 例如 ), `'image/'`(中文(简体) ) |
| `cursor` | `string` | \- 说吧 | 下一页的光标符 |
| `pageSize` | `number` | `20` | 每页项目 |

回返 `{ items: MediaItem[], nextCursor: string | null, total: number }`

### `uploadFile(options): Promise<UploadResult>`

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `endpoint` | `string` | 所需经费 | 媒体 API 端点 |
| `projectId` | `string` | 所需经费 | 项目标识符 |
| `file` | `File` | 所需经费 | 要上传的文件 |
| `acl` | `'public' | 'private'` | `'public'` | 访问控制 |
| `onProgress` | `(progress: number) => void` | \- 说吧 | 进度回调 (0- 100) |
| `createMediaRecord` | `false` | \- 说吧 | 设定为 `false` 以跳过 DB 记录创建 |

回返 `{ success, path, filename, descriptor }`

### `getFileUrl(mediaHost, file, commands?): string`

生成文件的适当 URL 。 可缩放的图像(PNG,JPEG,GIF,WebP)通过有变换功能的Wix图像服务. 非可缩放图像(SVG,ICO)和非相片获得直接URL.

何时 `commands` 中,漏出光栅图像 `fit` 1000×1000 默认(a) `console.warn` 用于鼓励来电者指定自己的。 Wixmp 图像服务需要 **两者** `width` 财务报告和审定财务报表 `height` 页:1 `fit`编号 :`fill`编号 :`crop` 操作——单凹变换回HTTP 400 `missing h`。 。 。 .

### `isImageMimeType(mimeType): boolean`

### `createResponsiveImageSet(mediaHost, path, options): Record<number, string>`

每个条目 `dimensions` 生成为 `fit dimension×dimension` (平分盖. `fit` 保存宽比,所以实际输出以先击后击的轴为界.

### `createSrcSet(mediaHost, path, options): string`

## 许可证

无效

## 常见问题

### @dazl/wix-media-client 是什么？

Wix 媒体平台的浏览器客户端 - 文件上传和图像转换

### 如何安装 @dazl/wix-media-client？

在项目目录运行 npm install @dazl/wix-media-client，或使用 pnpm add / yarn add / bun add。

### @dazl/wix-media-client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/dazl\_\_wix-media-client 是否存在。

### @dazl/wix-media-client 支持 ESM 还是 CommonJS？

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

### @dazl/wix-media-client 需要什么版本的 Node\.js？

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

### @dazl/wix-media-client 可以商用吗？

@dazl/wix-media-client 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @dazl/wix-media-client 的下载量有多少？

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

### @dazl/wix-media-client 还在维护吗？

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