# @deliverart/sdk-js-stats 中文文档

规范地址：https://npmcn.com/package/%40deliverart/sdk-js-stats/

版本：3\.0\.1
npm 元数据更新时间：2026-11-10T20:26:32.575Z
中文译文更新时间：2026-11-12T03:44:44.191Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40deliverart/sdk-js-stats
原文对照：https://npmcn.com/package/%40deliverart/sdk-js-stats/?lang=original

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

- 包体积（解压后）：1.7 MB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2026-01-20T20:42:37.934Z
- 最新版本发布：2026-11-10T20:26:32.362Z
- 近 30 天下载量：3033（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：142（近 12 个月 142 个）

## 中文简介

为 Stats 交付 JavaScript SDK

## 安装

```sh
npm install @deliverart/sdk-js-stats
```

也可以使用：`pnpm add @deliverart/sdk-js-stats`、`yarn add @deliverart/sdk-js-stats`、`bun add @deliverart/sdk-js-stats`

## README

# @ deliverart/ sdk- js- stats

交付艺术JavaScript SDK的统计和分析包.

## 安装

```bash
npm install @deliverart/sdk-js-stats @deliverart/sdk-js-core
# or
pnpm add @deliverart/sdk-js-stats @deliverart/sdk-js-core
# or
yarn add @deliverart/sdk-js-stats @deliverart/sdk-js-core
```

## 此套件导出什么

该套件目前每天揭露五个统计家庭:

-   `CustomerDailyStats`
-   `CourierDailyStats`
-   `DeliveryDailyStats`
-   `MenuItemDailyStats`
-   `OrderDailyStats`

也暴露出前端准备的分析端点:

-   `CustomerStatsOverviewResponse`
-   `DeliveryStatsOverviewResponse`
-   `DeliveryZoneStatsResponse`

每个家庭包括:

-   a Zod 模型计划并推断出类型Script
-   a 详细资源的IRI 计划/类型
-   请求收集分类和细节终点
-   现有销售点范围收集请求

所有日常桶都使用本地日销售点,暴露为 `YYYY-MM-DD`。 。 。 .

## 现有请求

### 日统计

-   `GetCourierDailyStats`
-   `GetCourierDailyStatsDetails`
-   `GetCourierDailyStatsFromPointOfSale`
-   `GetCourierDailyStatsFromUser`

### 客户日统计

-   `GetCustomerDailyStats`
-   `GetCustomerDailyStatsDetails`
-   `GetCustomerDailyStatsFromPointOfSale`
-   `GetCustomerDailyStatsFromCustomer`
-   `GetCustomerStatsOverview`

### 每日发送数据

-   `GetDeliveryDailyStats`
-   `GetDeliveryDailyStatsDetails`
-   `GetDeliveryDailyStatsFromPointOfSale`

### 交付统计概览

-   `GetDeliveryStatsOverviewFromPointOfSale`

### 交付区分析

-   `GetDeliveryZoneStatsFromPointOfSale`

### 每日统计顺序

-   `GetOrderDailyStats`
-   `GetOrderDailyStatsDetails`
-   `GetOrderDailyStatsFromPointOfSale`

### 菜单项每日统计

-   `GetMenuItemDailyStats`
-   `GetMenuItemDailyStatsDetails`
-   `GetMenuItemDailyStatsFromPointOfSale`
-   `GetMenuItemDailyStatsFromMenuItem`

## 查询支持

软件包将当前API支持的过滤器的输入查询方案曝光:

-   维度的精确过滤器,例如 `pointOfSale`, (中文(简体) ), `courierUser`, (中文(简体) ), `menuItem`, (中文(简体) ), `salesMode`, (中文(简体) ), `type`, (中文(简体) ), `orderType`, (中文(简体) ), `source`, (中文(简体) ), `partner`, (中文(简体) ), `paymentMethod`,以及 `planningMode`
-   维度的精确过滤器,例如 `customer`, (中文(简体) ), `pointOfSale`, (中文(简体) ), `courierUser`, (中文(简体) ), `menuItem`, (中文(简体) ), `salesMode`, (中文(简体) ), `type`, (中文(简体) ), `orderType`, (中文(简体) ), `source`, (中文(简体) ), `partner`, (中文(简体) ), `paymentMethod`,以及 `planningMode`
-   日期过滤器, 如 `day[before]`, (中文(简体) ), `day[strictly_after]`, (中文(简体) ), `calculatedAt[after]`
-   数字 KPI 的筛选范围, 如 `ordersCount[gte]`, (中文(简体) ), `deliveryOrdersCount[lte]`, (中文(简体) ), `totalAmount[gt]`
-   排序通过 `order[...]`
-   通过 `page`, (中文(简体) ), `itemsPerPage`,以及 `pagination`

## 用法实例

### 每日发送者名单

```typescript
import { GetCourierDailyStats } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetCourierDailyStats({
    query: {
      source: 'application',
      'day[after]': '2026-04-01',
      'order[day]': 'desc',
    },
  }),
)
```

### 一个客户的每日统计表

```typescript
import { GetCustomerDailyStatsFromCustomer } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetCustomerDailyStatsFromCustomer('customer-123', {
    query: {
      source: 'application',
      'day[after]': '2026-04-01',
      'order[totalAmount]': 'desc',
    },
  }),
)
```

### 列出单点销售的每日数据

```typescript
import { GetDeliveryDailyStatsFromPointOfSale } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetDeliveryDailyStatsFromPointOfSale('pos-123', {
    query: {
      planningMode: 'PLANNED',
      'totalDelaySeconds[gt]': 0,
      'day[after]': '2026-04-01',
    },
  }),
)
```

### 每日数据列表顺序

```typescript
import { GetOrderDailyStats } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetOrderDailyStats({
    query: {
      type: 'delivery',
      paymentMethod: 'credit_card',
      'totalAmount[gte]': 100,
      'order[totalAmount]': 'desc',
    },
  }),
)
```

### 列出一个销售点的菜单项

```typescript
import { GetMenuItemDailyStatsFromPointOfSale } from '@deliverart/sdk-js-stats'

const response = await sdk.call(
  new GetMenuItemDailyStatsFromPointOfSale('pos-123', {
    query: {
      orderType: 'delivery',
      'quantitySold[gte]': 10,
      'order[totalAmount]': 'desc',
    },
  }),
)
```

### 每天拿一个统计桶

```typescript
import {
  GetCustomerDailyStatsDetails,
  GetCourierDailyStatsDetails,
  GetDeliveryDailyStatsDetails,
  GetMenuItemDailyStatsDetails,
  GetOrderDailyStatsDetails,
} from '@deliverart/sdk-js-stats'

await sdk.call(new GetCustomerDailyStatsDetails('customer-stats-uuid'))
await sdk.call(new GetCourierDailyStatsDetails('courier-stats-uuid'))
await sdk.call(new GetDeliveryDailyStatsDetails('delivery-stats-uuid'))
await sdk.call(new GetMenuItemDailyStatsDetails('menu-item-stats-uuid'))
await sdk.call(new GetOrderDailyStatsDetails('order-stats-uuid'))
```

### 获取客户数据概览

```typescript
import { GetCustomerStatsOverview } from '@deliverart/sdk-js-stats'

const overview = await sdk.call(
  new GetCustomerStatsOverview('customer-123', {
    query: {
      'day[after]': '2026-04-01',
      source: 'application',
    },
  }),
)
```

### 获取一个销售点的交货区分析

```typescript
import { GetDeliveryZoneStatsFromPointOfSale } from '@deliverart/sdk-js-stats'

const analytics = await sdk.call(
  new GetDeliveryZoneStatsFromPointOfSale('pos-123', {
    query: {
      'day[after]': '2026-04-01',
      distanceBand: 'between_2km_4km',
      'order[lateRate]': 'desc',
    },
  }),
)
```

### 获取一个销售点的快递数据概览

```typescript
import { GetDeliveryStatsOverviewFromPointOfSale } from '@deliverart/sdk-js-stats'

const overview = await sdk.call(
  new GetDeliveryStatsOverviewFromPointOfSale('pos-123', {
    query: {
      'day[after]': '2026-04-01',
      planningMode: 'PLANNED',
    },
  }),
)
```

## 许可证

许可证信息参见SDK主仓库.

## 常见问题

### @deliverart/sdk-js-stats 是什么？

为 Stats 交付 JavaScript SDK

### 如何安装 @deliverart/sdk-js-stats？

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

### @deliverart/sdk-js-stats 支持 TypeScript 吗？

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

### @deliverart/sdk-js-stats 支持 ESM 还是 CommonJS？

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

### @deliverart/sdk-js-stats 可以商用吗？

@deliverart/sdk-js-stats 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @deliverart/sdk-js-stats 的下载量有多少？

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

### @deliverart/sdk-js-stats 还在维护吗？

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