SuperAPI AI 工具集

contentstack-utils

编程与开发

查看项目

更新于 10-15 20:28

技能介绍

用途:用于实现或修改 RTE/HTML 渲染、JSON RTE 解析以及 variant 相关辅助逻辑,也用于维护 README、CHANGELOG、podspec 等对用户可见行为的文档,并评估公开或开放变更的语义化版本影响。

主要能力:消费者导入 ContentstackUtils 后使用其公开接口,例如 render(content::)、render(contents::)、jsonToHtml(node::)、getVariantAliases,以及嵌套的 GQL.jsonToHtml(rte::)。数据模型包括 Node、JSONNode/JSONNodes、MarkType、StyleType、Metadata,以及嵌入式条目与资源类型(EmbeddedObject、EmbeddedEntry 等)。错误以嵌套类型暴露领域失败,如 ContentstackUtils.VariantUtilityError.invalidArgument。

使用方式:通过继承 Option(open class)并遵循 Renderable 实现自定义,可重写 renderItem(embeddedObject:metadata:)、renderMark(markType:text:)、renderNode(nodeType:node:next:)。渲染内部使用 Kanna/HTML库。

限制与注意事项:该包不提供 HTTP 客户端或 token,README 中的 Stack、fetch、Apollo 示例仅为集成草图,不应在 Package.swift 中硬依赖主 Contentstack iOS SDK 或 Apollo,除非产品明确要求。保持静态接口精简且有文档,破坏性变更需遵循 semver 并记录 changelog。未获主版本不得移除或重命名开放钩子。需保持与 Contentstack Delivery 及 GraphQL 负载的 Codable/解码兼容性;公共路径避免强制解包。部分遗留命名(如 embdeddedItems)改动属破坏性 API 变更,需与维护者协调。podspec 与 git tag 需与发布对齐。