Asterisms JS SDK#

The Asterisms Browser SDK (@asterisms/sdk) provides a comprehensive TypeScript library for integrating your applications with the Asterisms ecosystem. This SDK enables authentication, resource management, and seamless communication with Asterisms platform services.

Overview#

The Asterisms JS SDK is designed to be:

• TypeScript First - Built with TypeScript for excellent developer experience
• Framework Agnostic - Works with any JavaScript framework (React, Vue, Svelte, etc.)
• Modular - Use only the features you need
• Extensible - Built-in extension system for custom functionality

Quick Start#

npm install @asterisms/sdk

import { asterismsFactory } from '@asterisms/sdk';

const sdk = asterismsFactory({
  bundleId: 'com.example.your-app',
  domain: 'your-asterisms-domain.com',
  navigator: createNavigationAdapter()
});

await sdk.boot();

Core Resources#

The SDK provides access to these core platform resources:

• Authentication - User authentication and token management
• Account - User account information and management
• Profile - User profile data and preferences
• Storage - File storage and management
• Drive - Document collaboration and sharing
• Dashboard - Dashboard and workspace management
• Notifications - Real-time notifications
• Platform - Platform-level services

Documentation Sections#

Getting Started#

• Getting Started - Complete setup guide
• Core Concepts - Understanding the SDK architecture
• Configuration - SDK configuration options

Development#

• Resources - Working with platform resources
• Events - Event system and real-time updates
• Extensions - Extending SDK functionality
• Testing - Testing strategies and utilities

Reference#

• API Reference - Complete TypeScript API documentation
• Examples - Code examples and patterns
• Migration - Migration guides between versions

Support#

• FAQ - Frequently asked questions
• Troubleshooting - Common issues and solutions

Features#

Authentication & Security#

• Single sign-on (SSO) across ecosystem applications
• Secure token management with automatic refresh
• Multi-factor authentication support
• Session management and security

Resource Management#

• Standardized APIs for all platform services
• Built-in caching and offline support
• Real-time synchronization
• Conflict resolution

Developer Experience#

• Full TypeScript support with comprehensive type definitions
• Excellent IDE integration with IntelliSense
• Comprehensive error handling and logging
• Extensive documentation and examples

Framework Integration#

• Navigation adapters for popular frameworks
• Server-side rendering (SSR) support
• State management integration
• Component libraries available

Browser Support#

The SDK supports all modern browsers:

• Chrome 90+
• Firefox 88+
• Safari 14+
• Edge 90+

Next Steps#

1. Get Started - Set up your first SDK integration
2. Explore Examples - See the SDK in action
3. Browse API Reference - Dive into the complete API documentation
4. Join the Community - Get help and connect with other developers