{"_id":"@aipmorg/chat-plugins-gateway","_rev":"1-dd393e16b7b42abd604016a0c827b7ee","name":"@aipmorg/chat-plugins-gateway","description":"Lobe Chat Plugin Market","dist-tags":{"latest":"1.9.1"},"versions":{"1.9.0":{"name":"@aipmorg/chat-plugins-gateway","version":"1.9.0","author":{"name":"AiPMHub","email":"nextprofessionalpower@gmail.com"},"_id":"@aipmorg/chat-plugins-gateway@1.9.0","homepage":"https://github.com/aipmhub/chat-plugins-gateway#readme","bugs":{"url":"https://github.com/aipmhub/chat-plugins-gateway/issues"},"dist":{"shasum":"958929c5e3910573e0c8ef499d8a10d33308681d","tarball":"https://registry.npmjs.org/@aipmorg/chat-plugins-gateway/-/chat-plugins-gateway-1.9.0.tgz","fileCount":14,"integrity":"sha512-KVjQoNoz7YjRH8t4+zxyNDG1grhrGrGkECk5Ln40u6AubAEahRzOwXs8reW+tpWe9ZS8BPAaCfODFEPKQHB1Pw==","signatures":[{"sig":"MEUCIQC6NmDx+JocPFYy8fEur4FVt05gKi8WqP/kgi3+peo4UQIgTymPaa7TKFNckxZ1Goznj7Rn/FtbTS9C7vLoPaJJFng=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28081},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"f91457ea062896392b65b0710629bfecef6f9fda","scripts":{"ci":"npm run lint && npm run type-check && npm run doctor","lint":"eslint \"{src,api,docs}/**/*.{js,jsx,ts,tsx}\" --fix","test":"vitest","build":"father build","start":"vercel dev","doctor":"father doctor","lint:md":"remark . --quiet --frail --output","prepare":"husky install","release":"semantic-release","prettier":"prettier -c --write \"**/**\"","type-check":"tsc --noEmit","build:watch":"father dev","test:update":"vitest -u","test:coverage":"vitest --coverage","prepublishOnly":"npm run build"},"_npmUser":{"name":"aipmnpm","email":"nextprofessionalpower@gmail.com"},"repository":{"url":"git+https://github.com/aipmhub/chat-plugins-gateway.git","type":"git"},"_npmVersion":"10.2.4","description":"AiPM Chat Plugin Market","directories":{},"lint-staged":{"*.md":["remark --quiet --output --","prettier --write --no-error-on-unmatched-pattern"],"*.json":["prettier --write --no-error-on-unmatched-pattern"],"*.{js,jsx}":["prettier --write","eslint --fix"],"*.{ts,tsx}":["prettier --parser=typescript --write","eslint --fix"]},"sideEffects":false,"_nodeVersion":"20.11.0","browserslist":["> 1%","last 2 versions","not ie <= 10"],"dependencies":{"ajv":"^8","zod":"^3","@babel/runtime":"^7","swagger-client":"^3","@cfworker/json-schema":"^1","@aipmorg/chat-plugin-sdk":"^1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"_hasShrinkwrap":false,"devDependencies":{"husky":"^8","eslint":"^8","father":"4.3.1","remark":"^14","vercel":"^32.7.1","vitest":"0.34.6","prettier":"^3","cross-env":"^7","commitlint":"^17","remark-cli":"^11","typescript":"^5","lint-staged":"^13","@vercel/node":"^2","@aipmorg/lint":"latest","@commitlint/cli":"^17","semantic-release":"^21","@vitest/coverage-v8":"0.34.6"},"_npmOperationalInternal":{"tmp":"tmp/chat-plugins-gateway_1.9.0_1719492910713_0.32259910025640726","host":"s3://npm-registry-packages"}},"1.9.1":{"name":"@aipmorg/chat-plugins-gateway","version":"1.9.1","description":"Lobe Chat Plugin Market","repository":{"type":"git","url":"git+https://github.com/aipmhub/chat-plugins-gateway.git"},"author":{"name":"AiPMHub","email":"nextprofessionalpower@gmail.com"},"sideEffects":false,"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"father build","build:watch":"father dev","ci":"npm run lint && npm run type-check && npm run doctor","doctor":"father doctor","lint":"eslint \"{src,api,docs}/**/*.{js,jsx,ts,tsx}\" --fix","lint:md":"remark . --quiet --frail --output","prepare":"husky install","prepublishOnly":"npm run build","prettier":"prettier -c --write \"**/**\"","release":"semantic-release","start":"vercel dev","test":"vitest","test:coverage":"vitest --coverage","test:update":"vitest -u","type-check":"tsc --noEmit"},"lint-staged":{"*.md":["remark --quiet --output --","prettier --write --no-error-on-unmatched-pattern"],"*.json":["prettier --write --no-error-on-unmatched-pattern"],"*.{js,jsx}":["prettier --write","eslint --fix"],"*.{ts,tsx}":["prettier --parser=typescript --write","eslint --fix"]},"browserslist":["> 1%","last 2 versions","not ie <= 10"],"dependencies":{"@babel/runtime":"^7","@cfworker/json-schema":"^1","@aipmorg/chat-plugin-sdk":"^1","ajv":"^8","swagger-client":"^3","zod":"^3"},"devDependencies":{"@commitlint/cli":"^17","@aipmorg/lint":"latest","@vercel/node":"^2","@vitest/coverage-v8":"0.34.6","commitlint":"^17","cross-env":"^7","eslint":"^8","father":"4.3.1","husky":"^8","lint-staged":"^13","prettier":"^3","remark":"^14","remark-cli":"^11","semantic-release":"^21","typescript":"^5","vercel":"^32.7.1","vitest":"0.34.6"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"_id":"@aipmorg/chat-plugins-gateway@1.9.1","gitHead":"322c90c985fb3364fac0d2c957b94d4594a0fd07","bugs":{"url":"https://github.com/aipmhub/chat-plugins-gateway/issues"},"homepage":"https://github.com/aipmhub/chat-plugins-gateway#readme","_nodeVersion":"20.15.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-//YXS+yYAAI/uBqrgFrBzvCf5DNQIlbyFRzXqDnqyoDJkZO5/wvetvJty/F6Qsh3cjZ/jbTGAu4iAWqw0Rt8cg==","shasum":"647738611e9a60c585f4be0f59c43a51b2b43344","tarball":"https://registry.npmjs.org/@aipmorg/chat-plugins-gateway/-/chat-plugins-gateway-1.9.1.tgz","fileCount":14,"unpackedSize":50415,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGcj0aK1RyWpdYkBEKMXVg6MgZrqEw3+FiBw/lXRjYxAIhAINTM/blNiCoSa7W0Ao7uudE4yIyo/vpvAWV/KiKjBvi"}]},"_npmUser":{"name":"aipmnpm","email":"nextprofessionalpower@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/chat-plugins-gateway_1.9.1_1719851194106_0.39970888937301474"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-27T12:55:10.564Z","modified":"2024-07-01T16:26:34.504Z","1.9.0":"2024-06-27T12:55:10.852Z","1.9.1":"2024-07-01T16:26:34.327Z"},"maintainers":[{"name":"aipmnpm","email":"nextprofessionalpower@gmail.com"}],"author":{"name":"AiPMHub","email":"nextprofessionalpower@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/aipmhub/chat-plugins-gateway.git"},"homepage":"https://github.com/aipmhub/chat-plugins-gateway#readme","bugs":{"url":"https://github.com/aipmhub/chat-plugins-gateway/issues"},"readme":"\n\n
\n\n\n\n\n\n

AiPMChat 插件网关

\n\nAiPMChat Plugin Gateway 是一个为 AiPMChat 和 AiPMHub 提供 Chat 插件网关的后端服务。\n\n[![][🤯-🧩-aipmhub-shield]][🤯-🧩-aipmhub-link]\n[![][npm-release-shield]][npm-release-link]\n[![][github-releasedate-shield]][github-releasedate-link]\n[![][github-action-test-shield]][github-action-test-link]\n[![][github-action-release-shield]][github-action-release-link]
\n[![][github-contributors-shield]][github-contributors-link]\n[![][github-forks-shield]][github-forks-link]\n[![][github-stars-shield]][github-stars-link]\n[![][github-issues-shield]][github-issues-link]\n[![][github-license-shield]][github-license-link]\n\n[English](./README.md) · **简体中文** · [更新日志](./CHANGELOG.md) · [报告 Bug][github-issues-link] · [请求功能][github-issues-link]\n\n
\n\n
\n目录\n\n#### TOC\n\n- [👋 简介](#-简介)\n- [🤯 使用方法](#-使用方法)\n - [基本 URL](#基本-url)\n - [POST 插件网关](#post-插件网关)\n- [🛳 自托管](#-自托管)\n - [部署到 Vercel](#部署到-vercel)\n- [📦 插件生态](#-插件生态)\n- [⌨️ Local Development](#️-local-development)\n- [🤝 Contributing](#-contributing)\n- [🔗 Links](#-links)\n\n####\n\n
\n\n## 👋 简介\n\nAiPMChat 插件网关是一个后端服务，为 AiPMChat 插件提供网关。我们使用 [vercel](https://vercel.com/) 来部署此服务。主要 API `POST /api/v1/runner` 部署为[Edge Function](https://vercel.com/docs/functions/edge-functions)。\n\n网关服务从 [AiPMChat 插件](https://github.com/aipmhub/aipm-chat-plugins) 获取 Lobe 插件索引，如果您想将您的插件添加到索引中，请在 AiPMChat 插件仓库中[提交 PR](https://github.com/aipmhub/aipm-chat-plugins/pulls)。\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 🤯 使用方法\n\n### 基本 URL\n\n| 环境 | URL |\n| ------ | ---------------------------------------------- |\n| `PROD` | |\n| `DEV` | |\n\n### POST 插件网关\n\n> **Note**\\\n> **POST** `/api/v1/runner`\\\n> 与 AiPMChat 插件进行通信的接口。此接口描述了如何使用 AiPMChat 插件网关 API 发送请求和获取响应。\n\n#### Body Request Parameters 请求体参数\n\n```json\n{\n \"arguments\": \"{\\n \\\"city\\\": \\\"杭州\\\"\\n}\",\n \"name\": \"realtimeWeather\"\n}\n```\n\n#### Response 响应\n\n```json\n[\n {\n \"city\": \"杭州市\",\n \"adcode\": \"330100\",\n \"province\": \"浙江\",\n \"reporttime\": \"2023-08-17 23:32:22\",\n \"casts\": [\n {\n \"date\": \"2023-08-17\",\n \"week\": \"4\",\n \"dayweather\": \"小雨\",\n \"nightweather\": \"小雨\",\n \"daytemp\": \"33\",\n \"nighttemp\": \"24\",\n \"daywind\": \"东\",\n \"nightwind\": \"东\",\n \"daypower\": \"≤3\",\n \"nightpower\": \"≤3\",\n \"daytemp_float\": \"33.0\",\n \"nighttemp_float\": \"24.0\"\n },\n {\n \"date\": \"2023-08-18\",\n \"week\": \"5\",\n \"dayweather\": \"小雨\",\n \"nightweather\": \"小雨\",\n \"daytemp\": \"32\",\n \"nighttemp\": \"23\",\n \"daywind\": \"东北\",\n \"nightwind\": \"东北\",\n \"daypower\": \"4\",\n \"nightpower\": \"4\",\n \"daytemp_float\": \"32.0\",\n \"nighttemp_float\": \"23.0\"\n },\n {\n \"date\": \"2023-08-19\",\n \"week\": \"6\",\n \"dayweather\": \"小雨\",\n \"nightweather\": \"雷阵雨\",\n \"daytemp\": \"32\",\n \"nighttemp\": \"24\",\n \"daywind\": \"东\",\n \"nightwind\": \"东\",\n \"daypower\": \"4\",\n \"nightpower\": \"4\",\n \"daytemp_float\": \"32.0\",\n \"nighttemp_float\": \"24.0\"\n },\n {\n \"date\": \"2023-08-20\",\n \"week\": \"7\",\n \"dayweather\": \"雷阵雨\",\n \"nightweather\": \"多云\",\n \"daytemp\": \"33\",\n \"nighttemp\": \"25\",\n \"daywind\": \"东\",\n \"nightwind\": \"东\",\n \"daypower\": \"≤3\",\n \"nightpower\": \"≤3\",\n \"daytemp_float\": \"33.0\",\n \"nighttemp_float\": \"25.0\"\n }\n ]\n }\n]\n```\n\n更多信息请参见[API 文档](https://apifox.com/apidoc/shared-c574e77f-4230-4727-9c05-c5c9988eed06)。\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 🛳 自托管\n\n如果您想自己部署此服务，可以按照以下步骤进行操作。\n\n### 部署到 Vercel\n\n点击下方按钮来部署您的私有插件网关。\n\n[![使用 Vercel 部署](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Faipmhub%2Fchat-plugins-gateway&project-name=chat-plugins-gateway&repository-name=chat-plugins-gateway)\n\n如果您想进行一些自定义设置，可以在部署时添加环境变量（Environment Variable）：\n\n- `PLUGINS_INDEX_URL`：你可以通过该变量指定插件市场的索引地址\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 📦 插件生态\n\n插件提供了扩展 AiPMChat Function Calling 能力的方法。可以用于引入新的 Function Calling，甚至是新的消息结果渲染方式。如果你对插件开发感兴趣，请在 Wiki 中查阅我们的 [📘 插件开发指引](https://github.com/aipmhub/aipm-chat/wiki/Plugin-Development.zh-CN) 。\n\n- [aipm-chat-plugins][aipm-chat-plugins]：这是 AiPMChat 的插件索引。它从该仓库的 index.json 中获取插件列表并显示给用户。\n- [chat-plugin-template][chat-plugin-template]: Chat Plugin 插件开发模版，你可以通过项目模版快速新建插件项目。\n- [@aipmorg/chat-plugin-sdk][chat-plugin-sdk]：AiPMChat 插件 SDK 可帮助您创建出色的 Lobe Chat 插件。\n- [@aipmorg/chat-plugins-gateway][chat-plugins-gateway]：AiPMChat 插件网关是一个后端服务，作为 AiPMChat 插件的网关。我们使用 Vercel 部署此服务。主要的 API POST /api/v1/runner 被部署为 Edge Function。\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## ⌨️ Local Development\n\n可以使用 GitHub Codespaces 进行在线开发：\n\n[![][github-codespace-shield]][github-codespace-link]\n\n或者使用以下命令进行本地开发：\n\n[![][bun-shield]][bun-link]\n\n```bash\n$ git clone https://github.com/aipmhub/chat-plugins-gateway.git\n$ cd chat-plugins-gateway\n$ bun install\n$ bun dev\n```\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 🤝 Contributing\n\n我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues][github-issues-link]，大展身手，向我们展示你的奇思妙想。\n\n[![][pr-welcome-shield]][pr-welcome-link]\n\n[![][github-contrib-shield]][github-contrib-link]\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 🔗 Links\n\n- **[🤖 Lobe Chat](https://github.com/aipmhub/aipm-chat)** - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.\n- **[🧩 / 🏪 Plugin Index](https://github.com/aipmhub/aipm-chat-plugins)** - This is the plugin index for AiPMChat. It accesses index.json from this repository to display a list of available plugins for Function Calling to the user.\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n---\n\n#### 📝 License\n\nCopyright © 2023 [AiPMHub][profile-link].
\nThis project is [MIT](./LICENSE) licensed.\n\n\n\n[🤯-🧩-aipmhub-link]: https://github.com/aipmhub/aipm-chat-plugins\n[🤯-🧩-aipmhub-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20%26%20%F0%9F%A7%A9%20AiPMHub-Plugin-95f3d9?labelColor=black&style=flat-square\n[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square\n[bun-link]: https://bun.sh\n[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge\n[chat-plugin-sdk]: https://github.com/aipmhub/chat-plugin-sdk\n[chat-plugin-template]: https://github.com/aipmhub/chat-plugin-\n[chat-plugins-gateway]: https://github.com/aipmhub/chat-plugins-gateway\n[github-action-release-link]: https://github.com/aipmhub/chat-plugins-gateway/actions/workflows/release.yml\n[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/aipmhub/chat-plugins-gateway/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square\n[github-action-test-link]: https://github.com/aipmhub/chat-plugins-gateway/actions/workflows/test.yml\n[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/aipmhub/chat-plugins-gateway/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square\n[github-codespace-link]: https://codespaces.new/aipmhub/chat-plugins-gateway\n[github-codespace-shield]: https://github.com/codespaces/badge.svg\n[github-contrib-link]: https://github.com/aipmhub/chat-plugins-gateway/graphs/contributors\n[github-contrib-shield]: https://contrib.rocks/image?repo=aipmhub%2Fchat-plugins-gateway\n[github-contributors-link]: https://github.com/aipmhub/chat-plugins-gateway/graphs/contributors\n[github-contributors-shield]: https://img.shields.io/github/contributors/aipmhub/chat-plugins-gateway?color=c4f042&labelColor=black&style=flat-square\n[github-forks-link]: https://github.com/aipmhub/chat-plugins-gateway/network/members\n[github-forks-shield]: https://img.shields.io/github/forks/aipmhub/chat-plugins-gateway?color=8ae8ff&labelColor=black&style=flat-square\n[github-issues-link]: https://github.com/aipmhub/chat-plugins-gateway/issues\n[github-issues-shield]: https://img.shields.io/github/issues/aipmhub/chat-plugins-gateway?color=ff80eb&labelColor=black&style=flat-square\n[github-license-link]: https://github.com/aipmhub/chat-plugins-gateway/blob/main/LICENSE\n[github-license-shield]: https://img.shields.io/github/license/aipmhub/chat-plugins-gateway?color=white&labelColor=black&style=flat-square\n[github-releasedate-link]: https://github.com/aipmhub/chat-plugins-gateway/releases\n[github-releasedate-shield]: https://img.shields.io/github/release-date/aipmhub/chat-plugins-gateway?labelColor=black&style=flat-square\n[github-stars-link]: https://github.com/aipmhub/chat-plugins-gateway/network/stargazers\n[github-stars-shield]: https://img.shields.io/github/stars/aipmhub/chat-plugins-gateway?color=ffcb47&labelColor=black&style=flat-square\n[aipm-chat-plugins]: https://github.com/aipmhub/aipm-chat-plugins\n[npm-release-link]: https://www.npmjs.com/package/@aipmorg/chat-plugins-gateway\n[npm-release-shield]: https://img.shields.io/npm/v/@aipmorg/chat-plugins-gateway?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square\n[pr-welcome-link]: https://github.com/aipmhub/chat-plugins-gateway/pulls\n[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge\n[profile-link]: https://github.com/aipmhub\n","readmeFilename":"README.zh-CN.md"}