# @happyvertical/smrt-properties 中文文档

规范地址：https://npmcn.com/package/%40happyvertical/smrt-properties/

版本：0\.62\.1
npm 元数据更新时间：2026-11-17T07:55:20.157Z
中文译文更新时间：2026-11-17T10:28:12.780Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：255 kB，31 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-06-23T01:18:42.114Z
- 最新版本发布：2026-11-17T07:55:19.922Z
- 近 30 天下载量：14257（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：365（近 12 个月 365 个）

## 中文简介

SMRT框架的数字财产和区管理模式

## 安装

```sh
npm install @happyvertical/smrt-properties
```

也可以使用：`pnpm add @happyvertical/smrt-properties`、`yarn add @happyvertical/smrt-properties`、`bun add @happyvertical/smrt-properties`

## README

# @happyvertical/smrt-财产

S-m-r-t框架的数字属性和分级区管理. 属性代表网站,应用程序,或出版物. 区块在每个地产内任意地形成一棵筑巢树,用于内容和广告放置.

## 安装

```bash
pnpm add @happyvertical/smrt-properties
```

## 使用量

```typescript
import {
  Property, PropertyCollection,
  Zone, ZoneCollection
} from '@happyvertical/smrt-properties';

// Create a property
const properties = await PropertyCollection.create({ db });
const site = await properties.create({
  name: 'Oak Creek News',
  domain: 'oakcreeknews.com',
  url: 'https://oakcreeknews.com',
  status: 'active',
});
await site.save();

// Build a zone hierarchy: page -> section -> ad slot
const zones = await ZoneCollection.create({ db });
const homePage = await zones.create({
  propertyId: site.id,
  name: 'Home Page',
  type: 'page',
  path: '/',
});
await homePage.save();

const sidebar = await zones.create({
  propertyId: site.id,
  parentId: homePage.id,
  name: 'Sidebar',
  type: 'section',
  selector: '.sidebar',
});
await sidebar.save();

const adSlot = await zones.create({
  propertyId: site.id,
  parentId: sidebar.id,
  name: 'Sidebar Ad',
  type: 'slot',
  width: 300,
  height: 250,
  allowedFormats: ['image', 'html'],
});
await adSlot.save();

// Retrieve the full zone tree for a property
const tree = await zones.getTree(site.id);

// Move a zone (validates against descendant cycles)
await zones.moveZone(adSlot.id, homePage.id);

// Delete a zone — cascade=false moves children to parent
await zones.deleteZone(sidebar.id, false);
```

### 区级

区数 `parentId` 自我引用来形成一棵树。 共同区类型包括: `page`, (中文(简体) ), `section`, (中文(简体) ), `slot`, (中文(简体) ), `container`,以及 `widget`。每个区域可以指定一个 URL `path` 图案, CSS `selector`, (中文(简体) ), `position` 提示, 像素 `width`编号 :`height`,则 `allowedFormats` 用于过滤内容或广告类型的数组。 一个空的 `allowedFormats` 数组表示允许所有格式(没有限制).

这个 `ZoneCollection` 提供树运算 : `getTree()` 在记忆中构建一个嵌入式结构, `getAncestors()`编号 :`getDescendants()` 步入等级 `moveZone()` 防止循环,在再生育前检查后代. `deleteZone(cascade)` 或将后代或孤儿转移到被删除区域的父母身边.

## API 密码

### 模型

| 导出 | 说明 |
| --- | --- |
| `Property` | 有域名、 URL、 状态和所有者/ 存储器链接的数字属性( STI) |
| `Zone` | 财产内的等级区,用于内容/ad放置 |

### 收款

| 导出 | 说明 |
| --- | --- |
| `PropertyCollection` | CRUD 和查询财产记录 |
| `ZoneCollection` | 区域 CRUD+树行动 : `getTree()`, (中文(简体) ), `moveZone()`, (中文(简体) ), `deleteZone()`, (中文(简体) ), `getAncestors()`, (中文(简体) ), `getDescendants()` |

### 密钥类型

`PropertyOptions`, (中文(简体) ), `PropertyStatus`, (中文(简体) ), `ZoneOptions`, (中文(简体) ), `ZoneTree`, (中文(简体) ), `ZoneTreeNode`

## 依赖关系

-   `@happyvertical/smrt-core` -- ORM 和代码生成
-   `@happyvertical/smrt-tenancy` -- 可选多租户范围界定
-   端点 : `@happyvertical/smrt-profiles`, (中文(简体) ), `@happyvertical/smrt-projects` (可选)

## 常见问题

### @happyvertical/smrt-properties 是什么？

SMRT框架的数字财产和区管理模式

### 如何安装 @happyvertical/smrt-properties？

在项目目录运行 npm install @happyvertical/smrt-properties，或使用 pnpm add / yarn add / bun add。

### @happyvertical/smrt-properties 支持 TypeScript 吗？

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

### @happyvertical/smrt-properties 支持 ESM 还是 CommonJS？

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

### @happyvertical/smrt-properties 可以商用吗？

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

### @happyvertical/smrt-properties 的下载量有多少？

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

### @happyvertical/smrt-properties 还在维护吗？

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

