Skip to content

feat: docs: add Lark / Feishu adapter#517

Open
mazhe-nerd wants to merge 1 commit into
vercel:mainfrom
mazhe-nerd:feat/lark-community-adapter
Open

feat: docs: add Lark / Feishu adapter#517
mazhe-nerd wants to merge 1 commit into
vercel:mainfrom
mazhe-nerd:feat/lark-community-adapter

Conversation

@mazhe-nerd
Copy link
Copy Markdown

Summary

Adds @larksuite/vercel-chat-adapter, the Lark / Feishu adapter for Chat SDK, as a vendor-official community adapter.

  • Package: @larksuite/vercel-chat-adapter — published on npm under the official larksuite scope
  • Built on: @larksuiteoapi/node-sdk's LarkChannel, the official Lark Node SDK
  • Docs source: external README referenced by adapters.json lives in larksuite/node-sdk (the official Lark vendor-owned GitHub org, pinned at commit cbc4adf1); the in-tree MDX in this PR is the rendered detail page (mdxBody: true)
  • Capabilities: native cardkit typewriter streaming, interactive cards, reactions, edit / delete, message history (via SDK normalize()), DM detection, mention handling, and scan-to-create app onboarding through registerLarkApp

Changes

File Change
apps/docs/adapters.json Add Lark / Feishu entry (community: true, vendorOfficial: true)
apps/docs/content/adapters/vendor-official/lark.mdx New hand-authored MDX detail page (frontmatter with full features matrix, install / quick start / configuration / transport / streaming / ID encoding / history / safety / limitations / FeatureSupport)
apps/docs/content/adapters/vendor-official/meta.json Append "lark" to the sidebar pages array
packages/integration-tests/src/docs-adapters.test.ts Append "lark" to the hardcoded vendor-official slug list asserted by Vendor-Official adapter MDX › contains exactly the expected adapters

No icon registered in adapters.json / iconMap / adapterLogos — matches the existing pattern for vendor-official adapters (Beeper, Resend, Liveblocks, Zernio, Photon).

Vendor Official tier

Per docs/contributing/building.mdx (Qualifications for vendor official tier):

  • Commitment for continued maintenance — owned by the Lark / Feishu team
  • GitHub hosting in official vendor-owned org — adapter README lives in larksuite/node-sdk, the official Lark org
  • Documentation in primary vendor docs — will be cross-linked from the official Lark Open Platform developer documentation
  • Announcement — will be announced through Lark developer changelog / channels

A note on source visibility

The adapter source is not currently open-sourced due to internal release-process requirements. What is public:

  • The npm package itself (consumable by any user)
  • The README, hosted in larksuite/node-sdk (official Lark org)
  • The underlying @larksuiteoapi/node-sdk on which it is built — this is fully open-source

Test plan

  • pnpm --filter docs build — docs app builds cleanly; /en/adapters/vendor-official/lark and /en/adapters/vendor-official/lark/og routes are generated
  • pnpm typecheck — passes (33 tasks)
  • pnpm check (Ultracite / Biome) — 438 files, no fixes
  • pnpm --filter @chat-adapter/integration-tests test docs-adapters — 232 tests pass (frontmatter, vendor-official roster, adapters.json ↔ MDX sync)
  • Manual: /adapters lists the Lark / Feishu card in the Vendor Official section; /adapters/vendor-official/lark renders the MDX detail page with the FeatureSupport matrix

@mazhe-nerd mazhe-nerd requested a review from a team as a code owner May 18, 2026 07:24
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 18, 2026

@mazhe-nerd is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@bensabic
Copy link
Copy Markdown
Contributor

Thanks @mazhe-nerd! Can you send us a link to the blog post about the adapter?

@mazhe-nerd
Copy link
Copy Markdown
Author

Thanks @bensabic ! The adapter is currently documented at https://github.com/larksuite/node-sdk/tree/main/docs/vercel-chat-adapter under the official Lark org. Happy to add a more formal announcement (blog post / changelog / social) if that's what you're looking for — let me know which channel works best.

@bensabic
Copy link
Copy Markdown
Contributor

https://github.com/larksuite/node-sdk/tree/main/docs/vercel-chat-adapter

Thanks for the quick response! If you can publish it on the blog, that'd be great

@mazhe-nerd
Copy link
Copy Markdown
Author

@bensabic The integration guide is now live on the Lark Open Platform docs:

It walks through how to integrate Feishu using Vercel Chat SDK — install, quickstart, app onboarding via
scan-to-create — and references @larksuite/vercel-chat-adapter throughout. It sits alongside the existing Feishu
Channel SDK guide as a sibling page in the official docs tree. Hope this satisfies the vendor-official announcement
criterion.

Thanks for taking the time to review this PR and for the clear feedback along the way!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants