@massalabs/gossip-sdk 0.0.2-dev.20260128094509

package/src/index.ts

@@ -0,0 +1,211 @@
+/**
+ * Gossip SDK
+ *
+ * Main entry point for the Gossip SDK.
+ * Provides a platform-agnostic interface for automation, chatbot,
+ * and integration use cases with the Gossip messenger.
+ *
+ * @example
+ * ```typescript
+ * import { gossipSdk } from 'gossip-sdk';
+ *
+ * // Initialize once at app startup
+ * await gossipSdk.init({
+ *   db,
+ *   protocolBaseUrl: 'https://api.example.com',
+ * });
+ *
+ * // Open session (login)
+ * await gossipSdk.openSession({ mnemonic: '...' });
+ *
+ * // Use clean API
+ * await gossipSdk.messages.send(contactId, 'Hello!');
+ * await gossipSdk.discussions.start(contact);
+ *
+ * // Events
+ * gossipSdk.on('message', (msg) => { ... });
+ *
+ * // Logout
+ * await gossipSdk.closeSession();
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+// SDK version - matches package.json
+export const SDK_VERSION = '0.0.1';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// SDK Singleton - Primary API
+// ─────────────────────────────────────────────────────────────────────────────
+export { gossipSdk, GossipSdkImpl } from './gossipSdk';
+export type {
+  GossipSdkInitOptions,
+  OpenSessionOptions,
+  SdkEventType,
+  SdkEventHandlers,
+} from './gossipSdk';
+
+// SDK Events
+export type { GossipSdkEvents } from './types/events';
+
+// Services - class-based with dependency injection
+export { AuthService } from './services/auth';
+export type { PublicKeyResult } from './services/auth';
+export {
+  getPublicKeyErrorMessage,
+  PUBLIC_KEY_NOT_FOUND_ERROR,
+  PUBLIC_KEY_NOT_FOUND_MESSAGE,
+  FAILED_TO_FETCH_ERROR,
+  FAILED_TO_FETCH_MESSAGE,
+  FAILED_TO_RETRIEVE_CONTACT_PUBLIC_KEY_ERROR,
+} from './services/auth';
+
+export {
+  AnnouncementService,
+  EstablishSessionError,
+} from './services/announcement';
+export type { AnnouncementReceptionResult } from './services/announcement';
+
+export { MessageService } from './services/message';
+export type { MessageResult, SendMessageResult } from './services/message';
+
+export { DiscussionService } from './services/discussion';
+
+export { RefreshService } from './services/refresh';
+
+// Contact Management (utility functions)
+export {
+  getContacts,
+  getContact,
+  addContact,
+  updateContactName,
+  deleteContact,
+} from './contacts';
+export type {
+  UpdateContactNameResult,
+  DeleteContactResult,
+} from './utils/contacts';
+
+// Discussion utilities
+export { updateDiscussionName } from './utils/discussions';
+export type { UpdateDiscussionNameResult } from './utils/discussions';
+
+// Types - re-export all types from the types module
+export * from './types';
+
+// Message Protocol - for direct use by host apps
+export {
+  createMessageProtocol,
+  restMessageProtocol,
+  RestMessageProtocol,
+  MessageProtocol,
+} from './api/messageProtocol';
+export type {
+  IMessageProtocol,
+  EncryptedMessage,
+  MessageProtocolResponse,
+  BulletinItem,
+} from './api/messageProtocol';
+
+// Config - for runtime configuration
+export {
+  setProtocolBaseUrl,
+  resetProtocolBaseUrl,
+  MessageProtocolType,
+  protocolConfig,
+} from './config/protocol';
+export type { ProtocolConfig } from './config/protocol';
+
+// SDK Config - for SDK initialization options
+export { defaultSdkConfig, mergeConfig } from './config/sdk';
+export type {
+  SdkConfig,
+  PollingConfig,
+  MessagesConfig,
+  AnnouncementsConfig,
+  DeepPartial,
+} from './config/sdk';
+
+// Database - for direct access by host apps
+export { setDb, getDb, db, GossipDatabase } from './db';
+
+// WASM utilities - for session management
+export { SessionModule, sessionStatusToString } from './wasm/session';
+export {
+  initializeWasm,
+  ensureWasmInitialized,
+  startWasmInitialization,
+} from './wasm/loader';
+export {
+  EncryptionKey,
+  Nonce,
+  generateEncryptionKey,
+  generateEncryptionKeyFromSeed,
+  encryptionKeyFromBytes,
+  generateNonce,
+  nonceFromBytes,
+  encryptAead,
+  decryptAead,
+} from './wasm/encryption';
+export { generateUserKeys } from './wasm/userKeys';
+
+// Utility functions - for direct use
+export {
+  encodeUserId,
+  decodeUserId,
+  isValidUserId,
+  formatUserId,
+  generate as generateUserId,
+} from './utils/userId';
+export {
+  validateUsernameFormat,
+  validatePassword,
+  validateUserIdFormat,
+  validateUsernameAvailability,
+  validateUsernameFormatAndAvailability,
+} from './utils/validation';
+export type { ValidationResult } from './utils/validation';
+export {
+  encodeToBase64,
+  decodeFromBase64,
+  encodeToBase64Url,
+  decodeFromBase64Url,
+} from './utils/base64';
+export type { Result } from './utils/type';
+
+// Message serialization utilities
+export {
+  MESSAGE_TYPE_KEEP_ALIVE,
+  serializeKeepAliveMessage,
+  serializeRegularMessage,
+  serializeReplyMessage,
+  serializeForwardMessage,
+  deserializeMessage,
+} from './utils/messageSerialization';
+export type { DeserializedMessage } from './utils/messageSerialization';
+
+// Crypto utilities
+export {
+  generateMnemonic,
+  validateMnemonic,
+  mnemonicToSeed,
+  accountFromMnemonic,
+  PRIVATE_KEY_VERSION,
+} from './crypto/bip39';
+export { encrypt, decrypt, deriveKey } from './crypto/encryption';
+
+// WASM types and functions re-exported for convenience
+export {
+  UserPublicKeys,
+  UserSecretKeys,
+  SessionStatus,
+  SessionConfig,
+  SessionManagerWrapper,
+  SendMessageOutput,
+  ReceiveMessageOutput,
+  AnnouncementResult,
+  generate_user_keys,
+} from './assets/generated/wasm/gossip_wasm';
+
+export { UserKeys } from './wasm/userKeys';