@based/sdk

Welcome to the official SDK for the Based platform. This package is the single, unified entry point for all official @based libraries and tools.

Why use @based/sdk?

Previously, to use different parts of the Based ecosystem, you had to install and manage multiple packages individually (e.g., @based/schema).

The @based/sdk package simplifies this by providing a single, consistent, and optimized way to access the entire Based toolset.

• Simplified Dependency Management: Install one package, not many.

• Improved Developer Experience: A single, predictable import source for all Based functionalities.

• Optimized for Modern Tooling: Designed with a modern exports map for better tree-shaking, ensuring your application bundles only the code they actually use.

• Controlled API Surface: Provides a stable and clear public API, preventing accidental reliance on internal functionalities.

Installation

Install the SDK using your package manager:

npm install @based/sdk

Usage

The SDK is designed to be flexible, allowing you to import exactly what you need.

Importing an Entire Module

You can import an entire module (like schema) directly from its subpath. This is the recommended approach for clarity and organization.

import * as schema from '@based/sdk/schema'

// Now you can use functions from each module
const mySchema = schema.parse({
  /* ... */
})

Importing Specific Functions

For better tree-shaking and cleaner code, you can import specific functions or components directly from the module's subpath.

import { SchemaProp, SchemaType } from '@based/sdk/schema';
import { wait } from '@based/sdk/utils';

// Use the imported functions directly
  const voteCountrySchema: SchemaProp = countrySchema

  await wait(500)

Packages Included

This SDK provides exports from the following core Based packages:

• @based/schema - Tools for schema definition and validation.
• @based/utils - Shared utility functions.
• @based/hash - Fast, low collision hashing based on djb2
• @based/protocol - Protocols for network operations and storage
• @based/functions - To be used with based cloud functions, adds types and utilities.
• @based/errors - Error codes and handlers
• @based/type-gen - Generates based client types and validators from functions & schema
• @based/client - Based client
• @based/react - Wraps the @based/client into react hooks

For detailed documentation on the specific functions available within each module, please refer to the documentation for that individual package.

Contributing

This SDK is part of the main Based monorepo. Please see the repository for contribution guidelines.

License

Copyright (c) 2025 Saulx B.V.

This monorepo contains multiple packages, each governed by its own license. Individual packages within this monorepo are licensed under either the MIT License or the Apache License 2.0.