@shipbook/core

The platform-agnostic core of the Shipbook SDK. This package provides the foundational logging infrastructure used by all Shipbook platform-specific packages.

⚠️ Important

This package is not meant to be used directly. Instead, use one of the platform-specific packages:

• @shipbook/react-native - For React Native apps
• @shipbook/browser - For web/SPA applications
• @shipbook/node - For Node.js servers and serverless functions

What's Included

This core package contains:

• Log Management - Centralized logging with severity levels (verbose, debug, info, warning, error)
• Session Management - User session tracking and configuration
• Appenders - Console and cloud appender implementations
• Models - Data structures for logs, exceptions, and events
• Networking - API client for Shipbook cloud services

Logging API

All log methods accept multiple arguments (like console.log):

log.d('Message');                                    // Simple message
log.d('User data:', { id: 123, name: 'John' });     // With object
log.d('Items:', ['a', 'b', 'c']);                    // With array
log.d('Count:', 42, 'Status:', { active: true });   // Multiple args
log.e('Failed', new Error('Something went wrong')); // With error (last arg)
log.e('Context:', { id: 123 }, new Error('Fail'));  // Context + error

Error objects should be passed as the last argument to be properly captured with stack traces.

For Package Developers

If you're building a new platform adapter for Shipbook, you'll need to implement the following interfaces:

import {
  IStorage,
  IPlatform,
  IEventManager,
  IExceptionHandler,
} from '@shipbook/core';

Required Interfaces

• IStorage - Persistent key-value storage
• IPlatform - Platform information (OS, version, device info)
• IEventManager - Lifecycle event handling (foreground/background)
• IExceptionHandler - Uncaught exception capture

See the existing adapters in @shipbook/react-native, @shipbook/browser, or @shipbook/node for reference implementations.

Links

• Shipbook Website
• GitHub Repository
• Documentation

License

MIT