SuperAPI AI 工具集

tomtom-maps-sdk-js-example-authoring

通用与其它

查看项目

更新于 10-16 07:15

技能介绍

用途:在 Maps SDK 单仓库的 examples/ 目录中创建、运行和测试示例应用。示例是独立 Vite 应用,按客户方式从 @tomtom-org/maps-sdk/{core,services,map} 导入;API 本身需加载 tomtom-maps-sdk-js,常量与类型应从包中导入而非自行推导。规范文件内容见 examples/AGENTS.md。

结构:web 示例含 src/{index.html,index.ts,style.css,config.ts}、content/{page.mdx,thumbnail.png}、e2e-tests/、sandpack.ts、playwright.config.ts、tsconfig.json、package.json。Node 示例以 nodejs- 前缀、无地图,去掉 index.html、style.css、e2e-tests/ 和 playwright.config.ts,仅需 develop 与 develop:sandpack 脚本。

关键要求:每个示例必须有 src/config.ts,导出 export const API_KEY = process.env.API_KEY_EXAMPLES;;地图容器 id 为 sdk-map;首个 SDK 调用为 TomTomConfig.instance.put({ apiKey: API_KEY });sandpack.ts 必填;脚本从 examples/default-map 复制;新增构建期环境变量需加入 EXAMPLE_ENV_VARS。

创建流程:cp -r examples/default-map examples/my-new-example,再改 package.json 名称,填写 content/page.mdx frontmatter(用 examples/src/constants/tags.ts 的封闭标签表),编写 src/、正文、快照与缩略图,并在 AGENTS.md 目录中登记。

运行:pnpm develop(普通 Vite)、pnpm develop:sandpack(编辑器预览),共用默认端口需分开运行;SDK 源码改动后须 pnpm build:sdk。

正文:围绕运行中的示例起草,约 70 词、最多 100 词,去除禁用词与重复内容。测试需两次构建、两个服务、三个产物:pnpm -F map build、pnpm -F @examples/my-new-example build、build:sandpack,再 cd 后 pnpm test:e2e。快照后生成缩略图:pnpm generate-thumbnails:examples my-new-example。本地无 Orbis 授权会导致空图,勿此时更新全部基线。限制:ui-temp-upon-load.png 基线仅在 CI 可验证;缩略图裁切与 frontmatter 引用无自动校验。