@withstudiocms/sdk

A comprehensive Software Development Kit for StudioCMS, providing a unified API for interacting with the CMS core functionality. Built with TypeScript and Effect-ts for type-safety and functional programming patterns, with Kysely DB (@withstudiocms/kysely) for dynamic database storage.

Warning

This package is primarily intended for internal use by StudioCMS. While you can use it directly in your projects, be aware that it may change without notice as StudioCMS evolves.

Want to learn more about how to use the SDK with StudioCMS? Check out The SDK documentation to learn how to use it in your StudioCMS project!

Features

• Authentication Module - User authentication and session management
• Configuration Management - Type-safe configuration handling with validation
• Database Operations - CRUD operations with Effect-ts error handling
• Plugin System - Utilities for plugin development and integration
• Caching Layer - Built-in caching with query memoization and invalidation
• Middleware Utilities - Request handling and middleware composition
• Diff Tracking - Track changes and modifications
• REST API Helpers - Utilities for building REST endpoints
• Notification Settings - User notification preference management
• Token Bucket - Rate limiting and token management

Further Reading

For a code example of how to use the StudioCMS SDK manually in your project, check how it’s implemented in StudioCMS on GitHub^

Interested in the live SDK already available in StudioCMS? Check out The SDK documentation to learn how to use it in your StudioCMS project!

Learn more about the Kysely Database Client in the Kysely Documentation.