Packages Overview

Overview of Colibri's published packages

1 min read

Packages ​

Colibri is built as a monorepo with several published packages that you can use independently.

Available Packages ​

Package Description npm
@colibri-hq/sdk Core SDK with database, metadata, and storage npm
@colibri-hq/mobi MOBI/Mobipocket ebook parser npm
@colibri-hq/pdf PDF.js wrapper with conditional exports npm
@colibri-hq/oauth OAuth 2.0 authorization server npm
@colibri-hq/open-library-client Open Library API client npm
@colibri-hq/languages ISO 639-3 language code utilities npm

Package Architecture ​

@colibri-hq/sdk
├── @colibri-hq/mobi
├── @colibri-hq/pdf
├── @colibri-hq/oauth
├── @colibri-hq/open-library-client
└── @colibri-hq/languages

The SDK is the main package that depends on the others. You can also use the sub-packages independently for specific functionality.

Installation ​

Install individual packages:

bash
npm install @colibri-hq/sdk
npm install @colibri-hq/mobi
npm install @colibri-hq/open-library-client

TypeScript Support ​

All packages include TypeScript type definitions and are written in TypeScript.

Requirements ​

  • Node.js 18+
  • ESM modules (all packages are ESM-only)