Asterisms JS Documentation#

Welcome to the comprehensive documentation for Asterisms JavaScript libraries. This documentation provides everything you need to integrate your applications with the Asterisms ecosystem using our complete suite of JavaScript tools.

Platform Overview#

The Asterisms Platform is a comprehensive ecosystem that enables organizations to build, deploy, and manage interconnected applications and services. Our JavaScript SDKs provide everything you need to create seamless, integrated experiences.

JavaScript Libraries#

Browser SDK#

• Asterisms JS SDK - TypeScript browser SDK for client-side applications
  • Complete authentication flows
  • Resource management (Storage, Drive, Profile, etc.)
  • Real-time events and notifications
  • Framework-agnostic design

Server SDK#

• Asterisms Backend SDK - Node.js SDK for server-side applications
  • SvelteKit integration
  • Authentication and authorization
  • Storage and notification services
  • Middleware and controllers

Quick Start#

Browser Applications#

Get started with the Asterisms Browser SDK:

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();
const isAuthenticated = sdk.auth().currentTokenIsValid();

Server Applications#

Get started with the Asterisms Backend SDK:

npm install @asterisms/sdk-backend

import { getAsterismsBackendSDK } from '@asterisms/sdk-backend';

const sdk = getAsterismsBackendSDK(props);
await sdk.boot();

const storage = sdk.storage();
const notifications = sdk.notifications();

Key Features#

🔐 Unified Authentication#

Single sign-on across all ecosystem applications with robust security including OAuth 2.0 and SRP6 authentication

🚀 Resource Management#

Standardized access to platform services with consistent APIs for Storage, Drive, Profile, and other resources

🔧 Extensible Framework#

Custom extensions and integrations for specific use cases with plugin architecture

Getting Started#

For Client-Side Applications#

Start with the Asterisms JS SDK for browser-based applications

For Server-Side Applications#

Use the Asterisms Backend SDK for Node.js applications

Browser Support#

The Asterisms JavaScript libraries support all modern browsers:

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

TypeScript Support#

All Asterisms JavaScript libraries are built with TypeScript and provide comprehensive type definitions for all APIs, ensuring excellent developer experience with full IntelliSense support.

Documentation Structure#

Browser SDK Documentation#

• Getting Started - Quick start guide
• API Reference - Complete TypeScript API documentation
• Examples - Practical code examples
• Authentication - Authentication flows and patterns
• Resources - Working with platform resources
• Events - Event handling and real-time updates
• Testing - Testing strategies and patterns

Backend SDK Documentation#

• Getting Started - Quick start guide
• API Reference - Complete API documentation
• Examples - Practical implementation examples
• Authentication & Authorization - User authentication
• Storage Services - Data persistence
• Notification Services - Sending notifications
• Middleware - Request/response handling
• Controllers - Pre-built and custom controllers
• Testing Strategies - Testing approaches

Support & Community#

• FAQ - Frequently asked questions
• Troubleshooting - Common issues and solutions
• GitHub Repository: asterisms-js-ui
• Issues: Report bugs and request features
• Discussions: Ask questions and share ideas

License#

The Asterisms JavaScript libraries are licensed under the AGPL-3.0-or-later license.

Ready to get started? Choose your platform:

• Browser SDK - For client-side applications
• Backend SDK - For server-side applications