@haxtheweb/haxcms-nodejs

中文文档
26.8.1发布于 2026/08/15Apache-2.0CommonJS近 30 天下载 5387

HAXcms 单站点和多站点节点服务器、 api 和管理

中文使用文档
文档目录5 节
  1. 运行命令
  2. API 符合性测试
  3. 当前报道概况
  4. MCP和部署概况
  5. 观看和学习更多关于HAX在这里:

Project Status: Active – The project has reached a stable, usable state and is being actively developed. OpenSSF Scorecard Community Support License: Apache 2.0 Contributor Covenant Discord Lit #HAXTheWeb Published on npm build X

有节点后端的 HAXcms

在 HAXsite 或 HAXcms 实例中启动服务器

HAXcms nodejs backend

运行命令

npm install
npm start

访问http://localhost:3:00 如果它不自动打开

API 符合性测试

运行端点匹配检查 src/openapi/site-spec.yaml数字 :

npm run test:api-conformance

跑跑者创建出一个孤立的跑跑时间工作空间,然后在结束点检查运行前通过API将一个真正的站点绑住.

  • 第一个靴子舞步呼叫 createSite 并生成运行时站点名称 :
    • haxcms-test-harness-{timestampStartOfTest}
  • 所有符合要求的呼声都与真正的站点路径相撞.
  • 可选运行时间登录覆盖值 :
    • HAXCMS_TEST_USERNAME
    • HAXCMS_TEST_PASSWORD

运行时间认证覆盖也通过全局程序得到支持 :

  • globalThis.HAXCMS_RUNTIME_CREDENTIALS = { username, password }
  • globalThis.HAXCMS_RUNTIME_USERNAME
  • globalThis.HAXCMS_RUNTIME_PASSWORD

当前报道概况

目前这个寄存器的自动测试覆盖是API兼容套件:

  • 套接字文件 : test/api-conformance/site-spec.conformance.test.cjs
  • 脚本 : npm run test:api-conformance
  • 额外的测试脚本/套件目前没有被接入 package.json

套房目前验证:

  • 发现/光谱终点:
    • getSiteApiDiscovery, (中文(简体) ), getSiteOpenApi, (中文(简体) ), getSiteOpenApiJson, (中文(简体) ), getSiteOpenApiYaml, (中文(简体) ), getApiCatalog
  • 站点/内容图终点 :
    • getSiteSummary, (中文(简体) ), listEntityDescriptors, (中文(简体) ), listSchemas, (中文(简体) ), listItems, (中文(简体) ), getItemByIdOrSlug, (中文(简体) ), listContent, (中文(简体) ), getContentByIdOrSlug, (中文(简体) ), listTags, (中文(简体) ), searchContent
  • 组件和元数据终点:
    • listCustomElements, (中文(简体) ), getCustomElementByName, (中文(简体) ), listBlocks, (中文(简体) ), getBlockByName, (中文(简体) ), getBlockUsage, (中文(简体) ), listRegions, (中文(简体) ), getRegionByName
  • 主题/报告/观点/分析终点:
    • listThemes, (中文(简体) ), getActiveTheme, (中文(简体) ), getThemeByName, (中文(简体) ), listReports, (中文(简体) ), getReportByName, (中文(简体) ), getAnalyticsCapabilities, (中文(简体) ), listViews, (中文(简体) ), getViewById, (中文(简体) ), getViewResults, (中文(简体) ), listDisplaysAlias, (中文(简体) ), getDisplayResultsAlias
  • 安全文件和修订终点 :
    • listFiles, (中文(简体) ), createFile, (中文(简体) ), getFileByUuid, (中文(简体) ), updateFileByUuid, (中文(简体) ), deleteFileByUuid, (中文(简体) ), listItemRevisions

同一套间中的行为覆盖率包括:

  • OpenAPI 响应/测试符合性检查
  • 对安全路径进行认证矩阵检查( 无认证、 仅限无记名、 无效的站点标志、 有效站点标志)
  • 边界/误差检查(缺失所需的参数、无效的ID/slugs、pagigation/query边界)
  • 代表/负责人检查json, (中文(简体) ), yaml, (中文(简体) ), xml, (中文(简体) ), md, (中文(简体) ), html 支助地点)
  • 端到端文件生命周期检查(创建 ~ 列表/查找 ~ 获取 ~ 更新 ~ 删除)

在套间中临时已知跳过 :

  • getApiCatalog returns linkset payload
    • 原因:运行时间 /.well-known/api-catalog 固定行为仍在最后确定中

MCP和部署概况

  • MCP 策略默认通过 _config/config.json。 。 。 .
  • 新的安装包括:
    • deploymentProfile数字 : single-site, (中文(简体) ), self-hosted-multi-site,或 haxiam-managed
    • mcp.enabled: 全球MCP 切换
    • mcp.readOnly: 为未来的 MCP 编写工具进行文字保护切换
  • 默认行为 :
    • haxiam-managed 除非明确启用,否则默认禁用 MCP .
    • 其他配置默认为 MCP , 启用只读模式 .

获取帮助/ 问题/ 支持

观看和学习更多关于HAX在这里:

相关链接和技术

HAX Traveler: World Changer

版本与发布记录

@haxtheweb/haxcms-nodejs 共发布 61 个版本,首次发布于 2024/06/18;过去 12 个月发布了 4 个版本。

版本发布日期距今
26.8.1latest2026/08/153 个月前
26.0.12026/05/225 个月前
26.0.02026/05/136 个月前
25.0.02026/01/1010 个月前
11.0.152025/07/251.3 年前
11.0.142025/07/241.3 年前

关于 @haxtheweb/haxcms-nodejs 的常见问题

@haxtheweb/haxcms-nodejs 是什么?

HAXcms 单站点和多站点节点服务器、 api 和管理

如何安装 @haxtheweb/haxcms-nodejs?

在项目目录运行 npm install @haxtheweb/haxcms-nodejs,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 haxcms-nodejs、haxcms-nodejs-cli,可以用 npx haxcms-nodejs 直接运行。

@haxtheweb/haxcms-nodejs 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/haxtheweb__haxcms-nodejs 是否存在。

@haxtheweb/haxcms-nodejs 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@haxtheweb/haxcms-nodejs 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.20.3。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@haxtheweb/haxcms-nodejs 可以商用吗?

@haxtheweb/haxcms-nodejs 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@haxtheweb/haxcms-nodejs 的下载量有多少?

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

@haxtheweb/haxcms-nodejs 还在维护吗?

最新版本 26.8.1 发布于 2026/08/15(3 个月前);至今共发布 61 个版本,其中过去 12 个月发布了 4 个;首次发布于 2024/06/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。