npm package: @financeable/brokerloop-data-plane
Description: A TypeScript SDK for connecting to the BrokerLoop Data Plane via WebSocket, supporting real-time workflow automation and multi-session management.
Author: Speakeasy
Latest version: 0.14.0

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

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

## Installation

```bash
npm install @financeable/brokerloop-data-plane
```

## Usage

### Basic WebSocket Connection

```typescript
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:

```typescript
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

<!-- Start Summary [summary] -->
## Summary


<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [BrokerLoop Data Plane WebSocket SDK](#brokerloop-data-plane-websocket-sdk)
  * [Architecture Overview](#architecture-overview)
  * [Installation](#installation)
  * [Usage](#usage)
  * [Available Commands](#available-commands)
  * [Event Types](#event-types)
  * [Features](#features)
  * [License](#license)
  * [SDK Installation](#sdk-installation)
  * [Requirements](#requirements)
  * [SDK Example Usage](#sdk-example-usage)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Standalone functions](#standalone-functions)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Custom HTTP Client](#custom-http-client)
  * [Debugging](#debugging)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!TIP]
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).


The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.

### NPM

```bash
npm add <UNSET>
```

### PNPM

```bash
pnpm add <UNSET>
```

### Bun

```bash
bun add <UNSET>
```

### Yarn

```bash
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.
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
<!-- End Requirements [requirements] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```typescript
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();

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [events](docs/sdks/events/README.md)

* [create](docs/sdks/events/README.md#create)


</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Standalone functions [standalone-funcs] -->
## 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](./FUNCTIONS.md).

<details>

<summary>Available standalone functions</summary>

- [`eventsCreate`](docs/sdks/events/README.md#create)

</details>
<!-- End Standalone functions [standalone-funcs] -->

<!-- Start Retries [retries] -->
## 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 { 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:
```typescript
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();

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`FinanceableDataPlaneError`](./src/models/errors/financeabledataplaneerror.ts) 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
```typescript
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`](./src/models/errors/financeabledataplaneerror.ts): The base class for HTTP error responses.

<details><summary>Less common errors (6)</summary>

<br />

**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.


**Inherit from [`FinanceableDataPlaneError`](./src/models/errors/financeabledataplaneerror.ts)**:
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): 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.

</details>
<!-- End Error Handling [errors] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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 { 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 });
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Debugging [debug] -->
## 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 { 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.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->