@financeable/brokerloop-control-plane

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @financeable/brokerloop-control-plane API.

> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Table of Contents

* @financeable/brokerloop-control-plane
* SDK Installation
* Requirements
* SDK Example Usage
* Available Resources and Operations
* Standalone functions
* Retries
* Error Handling
* Custom HTTP Client
* Debugging
* Development
* Maturity
* Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

$3

``bash
npm add @financeable/brokerloop-control-plane
`

$3

`bash
pnpm add @financeable/brokerloop-control-plane
`

$3

`bash
bun add @financeable/brokerloop-control-plane
`

$3

`bash
yarn add @financeable/brokerloop-control-plane
`

> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.




$3

This SDK is also an installable MCP server where the various SDK methods are
exposed as tools that can be invoked by AI applications.

> Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

`json
{
"mcpServers": {
"BrokerLoopControlPlane": {
"command": "npx",
"args": [
"-y", "--package", "@financeable/brokerloop-control-plane",
"--",
"mcp", "start",
"--server-url", "..."
]
}
}
}
`

Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

`json
{
"mcpServers": {
"BrokerLoopControlPlane": {
"command": "npx",
"args": [
"-y", "--package", "@financeable/brokerloop-control-plane",
"--",
"mcp", "start",
"--server-url", "..."
]
}
}
}
`

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

`bash
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
`

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".


`json
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}
`

For a full list of server arguments, run:

`sh
npx -y --package @financeable/brokerloop-control-plane -- mcp start --help
`





Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.





SDK Example Usage

$3

`typescript
import { BrokerLoopControlPlane } from "@financeable/brokerloop-control-plane";

const brokerLoopControlPlane = new BrokerLoopControlPlane({
serverURL: "https://api.example.com",
});

async function run() {
const result = await brokerLoopControlPlane.events.list();

console.log(result);
}

run();

`





Available Resources and Operations

Available methods

$3

* list

$3

* create - Create a new session

Creates a new session for a tenant with the specified application and lender.
The session will be queued and can be activated when resources are available.
* list - Returns an empty array if no sessions exist matching the queried criteria
* get - Get session details
Retrieves the details of an existing session by its ID.

Standalone functions

All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

- eventsList
- sessionsCreate - Create a new session

Creates a new session for a tenant with the specified application and lender.
The session will be queued and can be activated when resources are available.
- sessionsGet - Get session details
Retrieves the details of an existing session by its ID.
- sessionsList - Returns an empty array if no sessions exist matching the queried criteria

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
`typescript
import { BrokerLoopControlPlane } from "@financeable/brokerloop-control-plane";

const brokerLoopControlPlane = new BrokerLoopControlPlane({
serverURL: "https://api.example.com",
});

async function run() {
const result = await brokerLoopControlPlane.events.list({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});

console.log(result);
}

run();

`

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
`typescript
import { BrokerLoopControlPlane } from "@financeable/brokerloop-control-plane";

const brokerLoopControlPlane = new BrokerLoopControlPlane({
serverURL: "https://api.example.com",
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});

async function run() {
const result = await brokerLoopControlPlane.events.list();

console.log(result);
}

run();

`





Error Handling

BrokerLoopControlPlaneError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

$3


`typescript
import { BrokerLoopControlPlane } from "@financeable/brokerloop-control-plane";
import * as errors from "@financeable/brokerloop-control-plane/models/errors";

const brokerLoopControlPlane = new BrokerLoopControlPlane({
serverURL: "https://api.example.com",
});

async function run() {
try {
const result = await brokerLoopControlPlane.sessions.create({
tenancyId: "",
applicationId: "",
lender: "SCOTPAC",
applicationObjectKey: "https://monstrous-sundae.info",
});

console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.BrokerLoopControlPlaneError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);

// Depending on the method different errors may be thrown
if (error instanceof errors.ErrorResponse) {
console.log(error.data$.success); // boolean
console.log(error.data$.error); // string
console.log(error.data$.details); // string
console.log(error.data$.message); // string
}
}
}
}

run();

`

$3


Primary error:
* BrokerLoopControlPlaneError: The base class for HTTP error responses.

Less common errors (7)

Network errors:
* ConnectionError: HTTP client was unable to make a request to a server.
* RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
* RequestAbortedError: HTTP request was aborted by the client.
* InvalidRequestError: Any input used to create a request is invalid.
* UnexpectedClientError: Unrecognised or unexpected error.


Inherit from BrokerLoopControlPlaneError:
ErrorResponse: The server could not understand the request due to invalid syntax. Applicable to 3 of 4 methods.
* ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

\* Check the method documentation to see if the error is applicable.





Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:

`typescript
import { BrokerLoopControlPlane } from "@financeable/brokerloop-control-plane";
import { HTTPClient } from "@financeable/brokerloop-control-plane/lib/http";

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native fetch.
fetcher: (request) => {
return fetch(request);
}
});

httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});

nextRequest.headers.set("x-custom-header", "custom value");

return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", ${error});
console.log("Endpoint:", ${request.method} ${request.url});
console.groupEnd();
});

const sdk = new BrokerLoopControlPlane({ httpClient: httpClient });
`





Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

`typescript
import { BrokerLoopControlPlane } from "@financeable/brokerloop-control-plane";

const sdk = new BrokerLoopControlPlane({ debugLogger: console });
`

You can also enable a default debug logger by setting an environment variable BROKERLOOPCONTROLPLANE_DEBUG` to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

$3