@vimconnect/app-sdk
v0.4.58
Published
Vim Connect Application SDK — typed wrapper over coreSdk with collection-generated entity types
Readme
@vimconnect/app-sdk
Typed SDK for building applications on the Vim Connect platform. Provides full IDE autocomplete, compile-time safety, and Zod schemas for runtime validation.
Installation
npm install @vimconnect/app-sdkRequires Zod v4+ as a peer dependency.
Documentation
For the full SDK documentation — authentication, EHR reading/writing, Hub controls, React integration, error handling, and the complete API reference — see the Vim Connect Docs. AI-readable versions are also available at /llms.txt (index), /llms-full.txt (every page as markdown) and /collection/api-reference.json (generated entity types, events, context keys and method signatures — the reference tables are not in llms-full.txt).
Using with Claude Code
This package ships a skill — packaged as a plugin so it's ready for marketplace distribution later — that teaches Claude Code to look up the real SDK reference (llms.txt/llms-full.txt/collection/api-reference.json) instead of guessing entity fields, event ids, or method signatures. For now, add it to your project manually:
mkdir -p .claude/skills
cp -r node_modules/@vimconnect/app-sdk/skills/vim-app-sdk-docs .claude/skills/vim-app-sdk-docsWhere the types come from (maintainers)
These types are generated from the platform's official collection, not hand-written.
The build pulls a specific published PROD collection version — pinned in
collection-values.yaml — and generates generated/vim-types.ts from it. Types are
always generated from the prod collection (no per-env split). That pin is
types-only: bump it only when the type surface (entities / events /
typeDefinitions / apiCatalog) changes. It is not the deployed collection that drives
EHR behavior — that (the source of truth) lives in the backend and is inspected via
connect-cli. See the repo CLAUDE.md "Collections, Types & the Source of Truth".
License
MIT
