@voyant-travel/connect-provider-sdk
v0.5.1
Published
Public SDK primitives for building Voyant Connect provider integrations.
Downloads
434
Readme
@voyant-travel/connect-provider-sdk
Public SDK primitives for building Voyant Connect provider integrations.
Use this package when implementing an integration that runs on the provider side of Connect. It intentionally does not contain provider-specific API clients.
Install
pnpm add @voyant-travel/connect-provider-sdkUsage
import {
defineConnectProvider,
parseJsonCredentials,
} from "@voyant-travel/connect-provider-sdk";
const provider = defineConnectProvider({
key: "example-cruises",
displayName: "Example Cruises",
authModel: "bring_your_own_credentials",
accessModel: "credential_scoped",
supportedDirections: ["inbound"],
categoryCoverage: ["cruise"],
parseCredentials(raw) {
return parseJsonCredentials(String(raw));
},
});
void provider;Notes
- The package is for provider integration authors, not Connect API consumers.
- API consumers should use
@voyant-travel/connect-sdk. - The default Connect API base URL used by consumer clients is
https://api.voyant.travel; provider integrations should receive runtime endpoints from their host environment.
For repo-level context, see ../../docs/provider-sdk.md.
