@happyvertical/ smrt- sites (英语)
多租户s-m-r-t网络的站点生命周期管理. 管理可部署网站,提供状况、分级分类、门户配置和具有优先排序的代理约束.
安装
pnpm add @happyvertical/smrt-sites
使用量
import {
Site, SiteCollection,
SiteAgentBinding, SiteAgentBindingCollection,
SiteService
} from '@happyvertical/smrt-sites';
// Create collections
const sites = await SiteCollection.create({ db });
const bindings = await SiteAgentBindingCollection.create({ db });
// Use SiteService for lifecycle operations
const service = new SiteService({ sites, bindings });
// Create a site (starts in draft status)
const site = await service.createSite('tenant-123', {
name: 'Community Hub',
domain: 'hub.example.com',
tier: 'standard',
});
// Activate after validation (requires name + domain)
await service.activateSite(site.id);
// Mark infrastructure as provisioned
await service.markProvisioned(site.id);
// Bind agents with priority ordering (higher = first)
await service.bindAgent(site.id, 'Praeco', { schedule: '0 * * * *' });
await service.bindAgent(site.id, 'Caelus', { maxArticles: 50 });
// Get enabled agents sorted by priority descending
const agents = await service.getEnabledAgents(site.id);
// Suspend or archive a site
await service.suspendSite(site.id);
await service.archiveSite(site.id);
场地生命周期
站点通过四个状态取得进展: draft - > (中文) active - > (中文) suspended - > (中文) archived编辑 SiteService 在激活时执行验证(需要名称和域名),并分别通过轨道提供状态 provisioningStatus (待付/备付/准备/失效)。 站点由 (tenant_id, domain)。 。 。 .
代理绑定
SiteAgentBinding 是一个连接站点和代理类的交叉表。 每个约束有一个 priority (先执行高值), a enabled 旗子,每个地点可选 config 存储为 JSON 的覆盖 。 这个 bindAgent() 方法上调 - 如果绑定物已经存在,则更新配置,如果不存在,则创建配置. findEnabled() 返回绑定,按优先级下移排序.
区、域和项目链接
DnsZone 是顶端 (y)example.com(三); Domain 是一个区域下的主机名( n)work.example.comFK (韩语) zoneId(三); ProjectDomain 链接一个域到带有 role (单位:千美元)production, (中文(简体) ), staging, (中文(简体) ), preview, (中文(简体) ), mail, (中文(简体) ), redirect, (中文(简体) ), other) (中文(简体) ). 一个区主办许多项目. projectId 是一个 @crossPackageRef 改为 @happyvertical/smrt-projects:Project (不依赖软件包). 区型是 DnsZone没有 Zone,因为 @happyvertical/smrt-properties 已经注册 a Zone。 。 。 .
const service = new DomainService({ domains, links });
await links.assign(domain, projectId, 'production'); // idempotent; tenant from the domain
await service.domainsByZone(tenantId, zone.id);
await service.domainsByProject(tenantId, projectId, 'staging'); // role optional
await service.unassignedDomains(tenantId); // domains with no project link
主机名帮助者在创建记录前验证所有者的类型 。 从 @happyvertical/smrt-sites/hostname 而不是浏览器安全代码中不能加载模型的根 :
import { defaultZoneFor, hostnameBelongsToZone, parseHostname } from '@happyvertical/smrt-sites';
const host = parseHostname(' Work.Example.com. '); // 'work.example.com' (null if not a plain multi-label hostname)
if (!host) throw new Error('not a hostname');
const zone = defaultZoneFor(host); // 'example.com' (last two labels; name the zone yourself for example.co.uk)
hostnameBelongsToZone(host, zone); // true for the apex or a subdomain, never for 'evilexample.com'
Site.domain 仍然是平面字符串;尚未与 Domain。 。 。 .
门户配置
站点存储主题、品牌和导航设置 portalConfig 作为JSON。 使用 getPortalConfig()编号 :setPortalConfig() 安全进入 两种模式都要求租户的背景(@TenantScoped({ mode: 'required' })) (中文(简体) ).
API 密码
模型
| 导出 | 说明 |
|---|---|
Site | 具有域、状态、等级、提供跟踪和门户配置的站点记录 |
SiteAgentBinding | 将代理类绑定在具有优先权和配置功能的站点上 |
收款
| 导出 | 说明 |
|---|---|
SiteCollection | CRUD 和网站记录查询 |
SiteAgentBindingCollection | 按站点、代理类和启用状态进行优先排序 |
服务
| 导出 | 说明 |
|---|---|
SiteService | 高级生命周期操作:创建、激活、暂停、存档、绑定/未连接代理 |
密钥类型
SiteOptions, (中文(简体) ), SiteStatus, (中文(简体) ), SiteTier, (中文(简体) ), ProvisioningStatus, (中文(简体) ), SitePortalConfig, (中文(简体) ), SiteServiceOptions, (中文(简体) ), SiteAgentBindingOptions, (中文(简体) ), CreateSiteData
依赖关系
@happyvertical/smrt-core-- ORM 和代码生成@happyvertical/smrt-tenancy-- 需要多用户范围界定- 端点 :
@happyvertical/smrt-agents(可选)