@pellux/goodvibes-operator-sdk
v0.33.30
Published
Contract-driven HTTP client for the GoodVibes operator and control-plane APIs.
Maintainers
Readme
@pellux/goodvibes-operator-sdk
Public GoodVibes operator package for the contract-driven operator and control-plane HTTP client.
Most applications should install @pellux/goodvibes-sdk and import @pellux/goodvibes-sdk/operator. Install this package directly when you only need the operator client subset.
import { createOperatorSdk } from '@pellux/goodvibes-sdk/operator';
const operator = createOperatorSdk({
baseUrl: 'http://127.0.0.1:3421',
authToken: process.env.GOODVIBES_TOKEN,
});
const snapshot = await operator.control.snapshot();
const login = await operator.invoke('control.auth.login', {
username: 'alice',
password: 'secret',
});Use this surface when you want only the operator/control-plane surface and do not need the main SDK composition layer.
Advanced consumers can also build directly from a preconfigured transport and contract:
import { getOperatorContract } from '@pellux/goodvibes-sdk/contracts';
import { createOperatorRemoteClient } from '@pellux/goodvibes-sdk/operator';
import { createHttpTransport } from '@pellux/goodvibes-sdk/transport-http';
const transport = createHttpTransport({
baseUrl: 'http://127.0.0.1:3421',
authToken: process.env.GOODVIBES_TOKEN,
});
const operator = createOperatorRemoteClient(transport, getOperatorContract());
const status = await operator.control.status();