Skip to content

fix(eve-extension): make agentkit()'s config argument optional - #37

Merged
CahidArda merged 4 commits into
mainfrom
fix/eve-extension-optional-mount-config
Sep 8, 2026
Merged

fix(eve-extension): make agentkit()'s config argument optional#37
CahidArda merged 4 commits into
mainfrom
fix/eve-extension-optional-mount-config

Conversation

@upstash-tag

@upstash-tag upstash-tag Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

The README's minimal usage example (export default agentkit();) no longer typechecks against the published eve-extension package, because the exported agentkit(...) handle's call signature (defined upstream in eve's ExtensionHandle) requires an argument. Fixed the doc example to agentkit({}), which does typecheck, and added an AGENTS.md note explaining why so it doesn't get "corrected" back. No changeset, since this only touches documentation.


Built by upstash-tag · mission 90d57fc8-fd1c-4b50-8db5-4d3271a83c05 · fix/eve-extension-optional-mount-configmain · $8.26

upstash-tag Bot and others added 4 commits September 8, 2026 08:26
eve types ExtensionHandle's call signature with a required argument even
though the extension's config schema is fully optional, so the README's
documented 'export default agentkit();' failed tsc with TS2554 while
'agentkit({})' worked. Re-type the default export with an optional
config parameter (eve's runtime already treats the argument as
optional) so the documented zero-arg form typechecks, matching the
README's claim that every field is optional. No runtime behavior
change; adds a regression test and a changeset.
…eck"

This reverts commit 4254eb1.

Reverted on review: re-typing the default export to widen the mount factory's
config parameter (plus its regression test, changeset and guide notes) is a large
diff for a documentation-level problem. The next commit applies the smaller fix —
the README example uses agentkit({}), which is what the exported types accept.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
eve types the mount handle it returns as (values: InferInput<S>) — a required
parameter regardless of how optional the config schema is — so the README example
export default agentkit(); failed consumers' tsc with TS2554 even though it works
at runtime (defineExtension validates values ?? {}). That signature lives in the
eve peer dependency, not in this package, so the example is what changes: it now
mounts with an empty config, which typechecks against the published types.

Adds a short note in the package AGENTS.md so the example is not "corrected" back,
and a patch changeset so the fixed README reaches npm.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@CahidArda
CahidArda merged commit 91324bb into main Sep 8, 2026
1 check passed
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.

1 participant