@happyvertical/smrt-properties

中文文档
0.62.1发布于 2026/11/17MITTypeScriptES Module近 30 天下载 1.4万

Digital property and zone management models for SMRT framework

原始使用文档
文档目录8 节
  1. Installation
  2. Usage
  3. Zone hierarchy
  4. API
  5. Models
  6. Collections
  7. Key Types
  8. Dependencies

@happyvertical/smrt-properties

Digital property and hierarchical zone management for the s-m-r-t framework. Properties represent websites, apps, or publications. Zones form an arbitrarily nested tree within each property for content and ad placement.

Installation

pnpm add @happyvertical/smrt-properties

Usage

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);

Zone hierarchy

Zones use parentId self-referencing to form a tree. Common zone types include page, section, slot, container, and widget. Each zone can specify a URL path pattern, CSS selector, position hint, pixel width/height, and an allowedFormats array for filtering content or ad types. An empty allowedFormats array means all formats are allowed (no restrictions).

The ZoneCollection provides tree operations: getTree() builds a nested structure in memory, getAncestors()/getDescendants() walk the hierarchy, and moveZone() prevents cycles by checking descendants before reparenting. deleteZone(cascade) either removes descendants or orphans children to the deleted zone's parent.

API

Models

ExportDescription
PropertyDigital property (STI) with domain, URL, status, and owner/repository links
ZoneHierarchical zone within a property for content/ad placement

Collections

ExportDescription
PropertyCollectionCRUD and queries for Property records
ZoneCollectionZone CRUD plus tree ops: getTree(), moveZone(), deleteZone(), getAncestors(), getDescendants()

Key Types

PropertyOptions, PropertyStatus, ZoneOptions, ZoneTree, ZoneTreeNode

Dependencies

  • @happyvertical/smrt-core -- ORM and code generation
  • @happyvertical/smrt-tenancy -- optional multi-tenant scoping
  • Peer: @happyvertical/smrt-profiles, @happyvertical/smrt-projects (optional)

版本与发布记录

@happyvertical/smrt-properties 共发布 365 个版本,首次发布于 2026/06/23;过去 12 个月发布了 365 个版本。

版本发布日期距今
0.62.1latest2026/11/17今天
0.62.02026/11/17今天
0.61.62026/11/161 天前
0.61.52026/11/161 天前
0.61.42026/11/161 天前
0.61.32026/11/152 天前

关于 @happyvertical/smrt-properties 的常见问题

@happyvertical/smrt-properties 是什么?

Digital property and zone management models for SMRT framework

如何安装 @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 和提交记录判断。