Mudbase TypeScript SDK

Official JavaScript and TypeScript SDK for Mudbase - the backend platform for modern apps.

Mudbase is a Backend-as-a-Service (BaaS) platform: authentication, a schema-driven database, file storage, serverless functions, webhooks, and real-time and transactional messaging behind one API. The TypeScript SDK is a native TypeScript/JavaScript client for that API, so you can manage users and organizations, define collections and query data, store and serve files, invoke functions, and configure webhooks without hand-rolling HTTP requests.

Installation

npm install mudbase-sdk

Quickstart

import { Configuration, CollectionsApi } from "mudbase-sdk";

const config = new Configuration({
  basePath: "https://cloud.mudbase.dev",
  apiKey: "YOUR_API_KEY",
});

const collections = new CollectionsApi(config);
const result = await collections.listCollections({ projectId: "YOUR_PROJECT_ID" });
console.log(result.data.collections);

What you can do

• Authentication - sign-up, sign-in, sessions, and API key management
• Database - schema-defined collections with typed CRUD and filtered queries
• Storage - buckets and file uploads and downloads
• Realtime - WebSocket events and live data subscriptions
• Functions - deploy and invoke serverless functions
• Messaging - transactional email, SMS, and push notifications
• Webhooks - configurable delivery with retry and logs
• Roles and permissions - project-level access control

Links

• Documentation: https://docs.mudbase.dev
• API reference: https://docs.mudbase.dev/api
• Dashboard: https://console.mudbase.dev
• Status: https://status.mudbase.dev
• Product: https://mudbase.dev

Support

Questions or issues: [email protected] or see https://docs.mudbase.dev