fix(1.0.0): export missing config types, correct stale docs, add API smoke tests#93
Merged
Conversation
…smoke tests - Export FlexSearchConfig and BuiltinIndexerOptions from the main entry. Both are referenced by already-exported types and the loadIndexer/loadSearchProvider signatures but weren't exported, so consumers couldn't name them. - README Features: replace the stale "pre-built adapters for Vercel, Netlify, Cloudflare" bullet with the real surface (one web-standard handler + a Node dev server); reword the CORS bullet to match. - README props table: serverUrl/serverName are optional (fall back to plugin global data), not required. - CONTRIBUTING: update the src/adapters/ description to the current handlers. - Harden prepublishOnly to run lint + typecheck + test before build. - SKILL: note dist/ is a build artifact (run npm run build, or read src). - Add tests/public-exports-test.ts covering mcpServerPlugin, DEFAULT_PLUGIN_OPTIONS, the tool definitions, and createNodeHandler — previously exported but untested. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Release-readiness polish surfaced by a full audit of the 1.0.0 public surface.
API completeness
FlexSearchConfigandBuiltinIndexerOptionsfrom the main entry. Both are referenced by already-exported types (McpServerPluginOptions.flexsearch, the config union) and by theloadIndexer/loadSearchProvidersignatures, but weren't exported — so a consumer couldn't name them when constructing a config.Docs accuracy
createWebRequestHandlerplus a Node dev server. CORS bullet reworded to match.serverUrl/serverNameare optional (they fall back to the plugin's global data), not required.src/adapters/description updated to the current handlers.dist/is a build artifact (runnpm run build, or readsrc).Release hardening
prepublishOnlynow runslint && typecheck && test && buildso a publish can't ship type/test regressions.Tests
tests/public-exports-test.tscoveringmcpServerPlugin,DEFAULT_PLUGIN_OPTIONS, the tool definitions, andcreateNodeHandler— exported but previously untested (+5 tests, 109 total).Verification
build, lint, typecheck, 109 unit tests, snippet sync, and
npm audit --omit=dev(0 prod vulnerabilities) all pass locally.🤖 Generated with Claude Code