@breign/client

TypeScript client library for interacting with the Brain API. This package provides a strongly-typed interface generated from OpenAPI specifications.

Installation

npm install @breign/client

Usage

import { ... } from '@breign/client';

// Configure API key authentication
// Implementation details depend on your use case

Development

Prerequisites

• Node.js (version specified in .nvmrc)
• npm

Setup

1. Clone the repository
2. Install dependencies:

   npm install
   

Available Scripts

• npm run generate - Generates API client from OpenAPI specs
• npm run build - Builds the TypeScript project
• npm run clean - Cleans generated and build directories
• npm run format - Formats code using Prettier
• npm run format:check - Checks code formatting

Project Structure

• src/resources/openapi/ - OpenAPI specifications
• dist/ - Compiled output
• target/ - Generated source files

TODO

• Generate API for mobile development (Swift, Kotlin)?
• Decide if we should use date-time format for dates or strings?