@marvalt/sadapter
v0.1.6
Published
SuiteCRM client and static metadata generator for DigiValt applications
Downloads
541
Readme
@marvalt/sadapter
SuiteCRM integration for DigiValt: OAuth client, REST helpers, and build-time static metadata generation.
When you need it
Use this package when your app integrates with SuiteCRM (lead forms, module metadata). In most DigiValt apps you install @marvalt/digivalt-core, which calls sadapter generators during npm run build — you rarely import sadapter directly unless building custom tooling.
Installation
npm install @marvalt/sadapterPeer: React 18+ (for any React-facing exports).
Typically also install @marvalt/digivalt-core for orchestrated static generation.
Entry points
import { SuiteCRMClient } from '@marvalt/sadapter';
import { generateSuiteCRMData } from '@marvalt/sadapter'; // or via digivalt-core generatorsEnvironment (summary)
| Variable | Required | Notes |
|----------|----------|-------|
| VITE_SUITECRM_URL | For generation | Base URL; when unset, digivalt-core skips SuiteCRM generation |
| VITE_SUITECRM_PROXY_URL | Proxy mode | Cloudflare proxy |
| VITE_SUITECRM_CLIENT_ID / SECRET | OAuth | API credentials |
| VITE_SUITECRM_USERNAME / PASSWORD | OAuth password grant | As configured on your SuiteCRM |
Full list: docs/ENVIRONMENT.md.
Documentation
- After install:
node_modules/@marvalt/sadapter/docs/README.md - Orchestration:
node_modules/@marvalt/digivalt-core/docs/README.md
