# @fourierhq/sdk 中文文档

规范地址：https://npmcn.com/package/%40fourierhq/sdk/

版本：0\.2\.1
npm 元数据更新时间：2026-09-25T09:06:41.169Z
中文译文更新时间：2026-11-15T10:24:17.620Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：247 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：next \>=13，react \>=18
- 首次发布：2026-09-15T09:11:35.112Z
- 最新版本发布：2026-09-25T09:06:40.408Z
- 近 30 天下载量：3034（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

开源产品分析 SDK. 识别/跟踪/页面,分析.js-形状,并有一等的Next.js支持.

## 安装

```sh
npm install @fourierhq/sdk
```

也可以使用：`pnpm add @fourierhq/sdk`、`yarn add @fourierhq/sdk`、`bun add @fourierhq/sdk`

## README

# @fourierhq/sdk (英语)

开源产品分析 SDK. Drop- in符合 Side 分析器.js API: `identify`, (中文(简体) ), `track`, (中文(简体) ), `page`, (中文(简体) ), `group`, (中文(简体) ), `alias`, (中文(简体) ), `reset`, (中文(简体) ), `user()`, (中文(简体) ), `ready()`, (中文(简体) ), `on()`, (中文(简体) ), `trackLink`, (中文(简体) ), `trackForm`,源的中间件和相同 `ajs_*` cookie,所以一个已有的Side安装会保留其匿名的ID.

它跟一个 [傅里叶](https://github.com/FourierHQ/fourier) 在 Vercel 上,您可以自行运行服务器,在下方使用 ClickHouse 。 SDK为MIT;服务器为AGPL-3.0.

```bash
pnpm add @fourierhq/sdk
```

## Next.js (App路由器) (英语)

```tsx
// app/layout.tsx
import { FourierProvider } from "@fourierhq/sdk/next";

export default function RootLayout({ children }) {
  return (
    <html>
      <body>
        <FourierProvider writeKey={process.env.NEXT_PUBLIC_FOURIER_WRITE_KEY!} host={process.env.NEXT_PUBLIC_FOURIER_HOST!}>
          {children}
        </FourierProvider>
      </body>
    </html>
  );
}
```

```tsx
"use client";
import { useFourier } from "@fourierhq/sdk/next";

export function UpgradeButton() {
  const fourier = useFourier();
  return <button onClick={() => fourier.track("Upgrade Clicked", { plan: "pro" })}>Upgrade</button>;
}
```

在路由更改时自动跟踪页面视图.

## 浏览器中的任何地方

```ts
import fourier from "@fourierhq/sdk";
fourier.init({ writeKey: "...", host: "https://analytics.example.com" });
fourier.identify("user_123", { email: "jane@acme.com", plan: "pro" });
fourier.group("acme", { name: "Acme Inc", plan: "enterprise" });
fourier.track("Report Exported", { format: "csv" });
```

## 服务器( API 路由、 服务器动作、 cron)

```ts
import { FourierServer } from "@fourierhq/sdk/server";
const fourier = new FourierServer({ writeKey: process.env.FOURIER_WRITE_KEY!, host: process.env.FOURIER_HOST! });
fourier.track({ userId: "user_123", event: "Invoice Paid", properties: { amount: 4900 } });
await fourier.closeAndFlush();
```

## 几个地点,一个身份

```ts
fourier.init({
  writeKey,                       // this site's own source key from the dashboard
  host,
  cookieDomain: ".example.com",   // subdomains share the anonymous id via the cookie
  crossDomain: ["example.io"],    // links to other domains carry it as ?ajs_aid=… (and ?ajs_uid=… when identified)
});
fourier.decorateUrl("https://app.example.io/signup"); // for URLs you build yourself
fourier.newSession();                                  // force a new session (attribution touch)
```

## 公司/工作场所

`group(groupId, traits)` 注册一个公司,并链接当前用户。 之后的每一个事件都带有 `context.groupId`,因此仪表板和查询API可以按公司滚动用户和事件.

## 常见问题

### @fourierhq/sdk 是什么？

开源产品分析 SDK\. 识别/跟踪/页面,分析\.js-形状,并有一等的Next\.js支持\.

### 如何安装 @fourierhq/sdk？

在项目目录运行 npm install @fourierhq/sdk，或使用 pnpm add / yarn add / bun add。

### @fourierhq/sdk 支持 TypeScript 吗？

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

### @fourierhq/sdk 支持 ESM 还是 CommonJS？

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

### @fourierhq/sdk 可以商用吗？

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

### @fourierhq/sdk 的下载量有多少？

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

### @fourierhq/sdk 还在维护吗？

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