SuperAPI AI 工具集

fcode-examples

编程与开发

查看项目

更新于 10-15 21:40

技能介绍

用途:这是 Factorial Code 的参考实现(reference implementations)集合,展示完整、接近生产形态的示例应用。它补充以规则为主的技能(fcode-core-concepts、fcode-javascript/fcode-python、fcode-json-schema、fcode-forms、fcode-cli),后者讲如何写 fcode 代码,本技能展示成品应用长什么样。

主要能力与示例:references/ 中每个参考对应一个真实样例,说明其架构、关键代码与适配方式。按构建目标选择:市场集成(向外部系统交付 Factorial 数据,如薪资、休假)读 references/integration-acme.md;带安装/卸载生命周期的自定义应用(设置表单、webhook、计划任务)读 references/custom-app-linear.md;一次性自动化(导出/报表生成、文件处理)读 references/utility-processes.md;通过表单用 OAuth 连接第三方账号(无需粘贴 API token)读 references/oauth-connect.md。

模式索引:可查找具体模式,如扩展 OutboundSync 基类、逐项 API 推送与聚合文件交付、逐项同步状态上报、由平台鉴权的 webhook 入口、在 metadata.json 中激活 webhook/表单触发器并保护 webhook(webhook.authMode + workspace webhookAuth、marketplace appRole)、多步设置表单(nextProcessId 链式)、通过 preRenderProcess + #/variables 实现动态下拉、表单中的 OAuth 连接按钮(ui:widget: "oauth")、安装时创建 webhook 与计划任务并记录以便卸载、使用 datastore 游标与幂等性轮询、尽力而为的卸载/清理、Storage 上传 + 签名下载 URL + 用 fcode.sendMail 发邮件、读取表单上传到 Storage 的文件、调用 Factorial API SDK(factorial-sdk 模块)。

基础工作区:每个 fcode App 工作区都继承基础应用的共享模块,用 fcode.import(...) / fcode.import_module(...) 导入,不要重新实现:factorial-sdk(来自 base-app,提供 createFactorialClient())、factorial-utils(getCompanyId()、setupWebhook()、listWebhookSubscriptions()、deleteWebhookSubscription())、fcode-forms(表单 schema 构建器 selectField()、toOptions() 等)、mail-helper(brandedHtml())、error-handler、outbound-sync(来自 base-integration-app 的 OutboundSync 基类)。集成应用继承 base-integration-app(其继承 base-app),自定义应用直接继承 base-app。注意 fcode-forms 模块与 fcode-forms 技能无关。

使用方式与限制:应适配而非粘贴,按用户实际供应商/需求重建模式,重命名 slug、变量与映射,删除用例不需要的部分。参考代码保持紧凑并省略常规日志,真实实现应通过共享 fcode-logs 模块详细记录日志。每个样例都有 JavaScript(Node.js v22)与 Python(3.13)版本,结构与行为一致;参考展示 JavaScript,Python 变体仅在惯用法上不同(main.py、fcode.import_module、fcode.send_mail、snake_case)。