@financeable/brokerloop-data-plane

BrokerLoop Data Plane WebSocket SDK

A TypeScript SDK for connecting to the BrokerLoop Data Plane via WebSocket, supporting real-time workflow automation and multi-session management.

Architecture Overview

This SDK is designed to work with session details obtained from your external HTTP/REST API:

• External HTTP API - Your backend provides sessionId, jwtToken, and serverUrl
• Direct SDK Creation - Create BrokerLoopWebSocketSDK instance with serverUrl
• Session Management - Use React hooks or direct SDK methods with session details

Installation

npm install @financeable/brokerloop-data-plane

Usage

Basic WebSocket Connection

import { BrokerLoopWebSocketSDK } from "@financeable/brokerloop-data-plane";

const sdk = new BrokerLoopWebSocketSDK({
  serverURL: "wss://api.example.com",
});

async function run() {
  await sdk.connect();
  
  const session = sdk.createSession("session-123");
  
  // Send a command
  await session.sendCommand({
    type: "start_automation",
    sessionId: "session-123",
    data: { lenderName: "example-lender" }
  });
  
  // Listen for events
  session.on("workflow_started", (event) => {
    console.log("Workflow started:", event);
  });
}

run();

React Integration

The React hooks are designed to work with session details obtained from your external HTTP/REST API:

import { BrokerLoopWebSocketSDK, useSession } from "@financeable/brokerloop-data-plane";

function MyComponent() {
  // 1. Get session details from your external API
  const { sessionId, jwtToken, serverUrl } = await createSessionAPI();

  // 2. Create SDK instance with server URL
  const sdk = new BrokerLoopWebSocketSDK({ url: serverUrl });

  // 3. Use session with SDK instance
  const { state, actions } = useSession({
    sdk,
    sessionId,
    jwtToken,
    autoConnect: true
  });

  const handleStartAutomation = async () => {
    await actions.startAutomation();
  };

  return (
    <div>
      <p>Connected: {state.isConnected ? 'Yes' : 'No'}</p>
      <p>Step: {state.currentStep} / {state.totalSteps}</p>
      <p>Description: {state.currentStepDescription}</p>
      <button 
        onClick={handleStartAutomation}
        disabled={!state.isConnected || state.isAutomationRunning}
      >
        Start Automation
      </button>
      <button 
        onClick={actions.enableManualControl}
        disabled={!state.isConnected || state.isManualControlEnabled}
      >
        Enable Manual Control
      </button>
    </div>
  );
}

Available Commands

• start_automation: Start workflow automation
• resume_automation: Resume paused automation
• enable_manual_control: Enable manual step control
• skip_step: Skip current workflow step
• get_workflow_state: Get current workflow state
• close_session: Close a workflow session

Event Types

• workflow_started: Workflow has started
• workflow_completed: Workflow has completed
• workflow_step_completed: A step has completed
• workflow_step_failed: A step has failed
• workflow_manual_control_enabled: Manual control is enabled
• workflow_ready: Workflow is ready for next step

Features

• Multi-session support: Manage multiple concurrent sessions
• Automatic reconnection: Built-in reconnection logic
• Type safety: Full TypeScript support with proper typing
• React hooks: Easy integration with React applications
• Session ID validation: Automatic validation
• Event-driven architecture: Listen to workflow events in real-time

License

MIT

Summary

Table of Contents

• BrokerLoop Data Plane WebSocket SDK
  • Architecture Overview
  • Installation
  • Usage
  • Available Commands
  • Event Types
  • Features
  • License
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Custom HTTP Client
  • Debugging

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

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

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET> zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { FinanceableDataPlane } from "@financeable/brokerloop-data-plane";

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

async function run() {
  const result = await financeableDataPlane.events.create({
    type: "START_AUTOMATION",
    sessionId: "<id>",
    messageId: "<id>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

events

• create

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

• eventsCreate

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:

import { FinanceableDataPlane } from "@financeable/brokerloop-data-plane";

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

async function run() {
  const result = await financeableDataPlane.events.create({
    type: "START_AUTOMATION",
    sessionId: "<id>",
    messageId: "<id>",
  }, {
    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:

import { FinanceableDataPlane } from "@financeable/brokerloop-data-plane";

const financeableDataPlane = new FinanceableDataPlane({
  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 financeableDataPlane.events.create({
    type: "START_AUTOMATION",
    sessionId: "<id>",
    messageId: "<id>",
  });

  console.log(result);
}

run();

Error Handling

FinanceableDataPlaneError 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

Example

import { FinanceableDataPlane } from "@financeable/brokerloop-data-plane";
import * as errors from "@financeable/brokerloop-data-plane/models/errors";

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

async function run() {
  try {
    const result = await financeableDataPlane.events.create({
      type: "START_AUTOMATION",
      sessionId: "<id>",
      messageId: "<id>",
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.FinanceableDataPlaneError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• FinanceableDataPlaneError: The base class for HTTP error responses.

Less common errors (6)

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 FinanceableDataPlaneError:

• 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.

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:

import { FinanceableDataPlane } from "@financeable/brokerloop-data-plane";
import { HTTPClient } from "@financeable/brokerloop-data-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 FinanceableDataPlane({ 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.

import { FinanceableDataPlane } from "@financeable/brokerloop-data-plane";

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

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