# @deliverart/sdk-js-global-types 中文文档

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

版本：3\.0\.1
npm 元数据更新时间：2026-11-10T20:25:50.034Z
中文译文更新时间：2026-11-11T21:43:18.153Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：93.1 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-06-16T12:39:52.529Z
- 最新版本发布：2026-11-10T20:25:49.862Z
- 近 30 天下载量：6563（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：334（近 12 个月 230 个）

## 中文简介

在 JavaScript 中交付的 SDK 全球类型

## 安装

```sh
npm install @deliverart/sdk-js-global-types
```

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

## README

# @ deliverart/ sdk- js- 全球类型

交付艺术JavaScript SDK的共享类型和公用软件包.

## 安装

```bash
npm install @deliverart/sdk-js-global-types
```

## 导出类型

### 常见图

#### 地址

```typescript
interface Address {
  street: string
  city: string
  postalCode: string
  country: string
  state?: string
  province?: string
  line1?: string
  line2?: string
}
```

#### 地点

```typescript
interface Location {
  latitude: number
  longitude: number
}
```

#### 比林数据

```typescript
interface BillingData {
  email: string
  pec?: string
  sdi?: string
  phone?: string
}
```

#### 倾斜

```typescript
interface Pagination {
  currentPage: number
  itemsPerPage: number
  totalItems: number
  totalPages: number
}
```

#### 标注

```typescript
interface Paginated<T> {
  data: T[]
  pagination: Pagination
}
```

### 工具类型

#### 排序目录

```typescript
type SortDir = 'asc' | 'desc'
```

#### 日期时间

```typescript
interface DatetimeFilter {
  before?: string
  after?: string
  strictly_before?: string
  strictly_after?: string
}
```

### IRI 帮助者

#### iriSchema 系统

为 API 资源 IRIS 创建一个计划.

```typescript
import { iriSchema } from '@deliverart/sdk-js-global-types';

const userIriSchema = iriSchema('/users/:id');
// Validates strings like: /users/123
```

#### iriNullableSchema (英语:

为无效的 API 资源 IRI 创建计划 .

```typescript
import { iriNullableSchema } from '@deliverart/sdk-js-global-types';

const userNullableIriSchema = iriNullableSchema('/users/:id');
// Validates strings like: /users/123 or null
```

### 工具函数

#### 创建 PagizedSchema

创建 Zod 响应的系统 .

```typescript
import { createPaginatedSchema } from '@deliverart/sdk-js-global-types';
import { z } from 'zod';

const userSchema = z.object({
  id: z.string(),
  name: z.string()
});

const paginatedUsersSchema = createPaginatedSchema(userSchema);
// Type: Paginated<User>
```

#### 配置响应

从 API 响应头提取 pagination 信息 .

```typescript
import { responseToPagination } from '@deliverart/sdk-js-global-types';

parseResponse(data: unknown, rawResponse: Response): Paginated<User> {
  const users = z.array(userSchema).parse(data);
  
  return {
    data: users,
    pagination: responseToPagination(rawResponse)
  };
}
```

## 用法实例

### 使用地址Schema

```typescript
import { addressSchema } from '@deliverart/sdk-js-global-types';
import { z } from 'zod';

const createOrderSchema = z.object({
  customerAddress: addressSchema.required(),
  billingAddress: addressSchema.optional()
});
```

### 使用 PGination (P)

```typescript
import { Paginated } from '@deliverart/sdk-js-global-types';

function displayUsers(result: Paginated<User>) {
  console.log(`Page ${result.pagination.currentPage} of ${result.pagination.totalPages}`);
  console.log(`Total items: ${result.pagination.totalItems}`);
  
  result.data.forEach(user => {
    console.log(user.name);
  });
}
```

### 使用IRI验证器

```typescript
import { iriSchema } from '@deliverart/sdk-js-global-types';

const productIriSchema = iriSchema('/products/:id');

// Valid
productIriSchema.parse('/products/123'); // ✓

// Invalid
productIriSchema.parse('/users/123'); // ✗ Throws validation error
productIriSchema.parse('invalid'); // ✗ Throws validation error
```

## 常数

### 国家

```typescript
export const COUNTRIES = ['IT', 'US', 'UK', /* ... */] as const;
```

### 语言

```typescript
export const LOCALES = ['it_IT', 'en_US', 'en_GB', /* ... */] as const;
```

## 许可证

麻省理工学院

## 排序子伙伴

`orderSubPartnerSchema` 揭露了被支持的五大象市场身份. `getOrderSubPartners(partner)` 返回允许的值,而独立于连接 启动. `isOrderSubPartnerAllowed(partner, subPartner)` 验证一对. `getOrderSubPartnerPresentation(order)` 返回市场/主显示数据 或对未知出处无效;客户端翻译连接词"vi". `matchesOrderProvenance(order, filter)` 匹配 API 等同的父, 市场, 财务报告和审定财务报表 `hasSubPartner` 用于客户端实时视图的过滤器。 数值和省略值 两者均未具体说明。 此元数据不会取代服务器的授权或 餐厅写字资格检查.

## 常见问题

### @deliverart/sdk-js-global-types 是什么？

在 JavaScript 中交付的 SDK 全球类型

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

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

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

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

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

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

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

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

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

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

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

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