{"id":49444,"library":"stormee-websocket","title":"Stormee WebSocket Library","description":"Framework-agnostic WebSocket library for real-time audio streaming with MessagePack and Opus encoding. Version 1.0.5, active development. Supports auto-reconnection, heartbeat, message queuing, resumption from last position after disconnect. Key differentiators: framework-agnostic core with dedicated React hooks and VS Code extension adapters, opinionated audio pipeline with MessagePack decoding and Opus playback, TypeScript-first with full type definitions. Alternative to lower-level libraries like `ws` or `socket.io` for audio streaming use cases. Peer dependency on React >=18.0.0 for the React integration. Release cadence irregular as of initial release.","status":"active","version":"1.0.5","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","websocket","audio","streaming","opus","messagepack","real-time","stormee","tts","typescript"],"install":[{"cmd":"npm install stormee-websocket","lang":"bash","label":"npm"},{"cmd":"yarn add stormee-websocket","lang":"bash","label":"yarn"},{"cmd":"pnpm add stormee-websocket","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"React hooks integration requires React >=18.0.0","package":"react","optional":true}],"imports":[{"note":"Core class is exported from a sub-path 'core', not the main entry point. Default import is not available.","wrong":"import StormeeService from '@stormee-websocket/library'","symbol":"StormeeService","correct":"import { StormeeService } from '@stormee-websocket/library/core'"},{"note":"React hook is exported from 'react' sub-path. Importing from main entry will not provide it.","wrong":"import { useStormee } from '@stormee-websocket/library'","symbol":"useStormee","correct":"import { useStormee } from '@stormee-websocket/library/react'"},{"note":"VS Code adapter is exported from 'vscode' sub-path. Ensure you have VS Code types installed for TypeScript.","wrong":"","symbol":"StormeeVSCodeAdapter","correct":"import { StormeeVSCodeAdapter } from '@stormee-websocket/library/vscode'"}],"quickstart":{"code":"import { StormeeService } from '@stormee-websocket/library/core';\n\nconst service = new StormeeService({\n  websocket: {\n    url: process.env.WS_URL ?? 'ws://localhost:8000/ws',\n    autoReconnect: true,\n    maxReconnectAttempts: 3,\n  },\n  audio: {\n    sampleRate: 24000,\n    channels: 1,\n    autoPlay: true,\n    initialVolume: 1.0,\n  },\n  eventHandlers: {\n    onTranscription: (text) => console.log('Transcription:', text),\n    onAudioChunk: (data) => console.log('Audio received'),\n    onStreamEnd: () => console.log('Stream ended'),\n    onError: (error) => console.error('Error:', error),\n  },\n  debug: true,\n});\n\nawait service.initialize();\nawait service.connect('session-uuid');\nawait service.startStreaming({\n  sessionId: 'session-uuid',\n  conciergeName: 'Stormee',\n  userQuery: 'Hello, how are you?',\n  chat_history: [],\n  metadata: { userName: 'John' },\n  queryNumber: '1',\n});","lang":"typescript","description":"Create a StormeeService instance, initialize, connect, and start an audio streaming session with configuration for WebSocket, audio settings, and event handlers."},"warnings":[{"fix":"Use '@stormee-websocket/library/core' for core service, '@stormee-websocket/library/react' for React hook, '@stormee-websocket/library/vscode' for VS Code adapter.","message":"All named exports are from sub-paths: 'core', 'react', 'vscode'. Importing from the main package entry '@stormee-websocket/library' does not export any of these symbols.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use import syntax or configure your bundler to handle ESM packages. If using Node.js, set 'type': 'module' in package.json or use dynamic import.","message":"The package ships as ESM only. CommonJS require() will not work without a bundler or Node.js ESM support.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Ensure your project has React 18 or later installed. Run 'npm install react@^18.0.0'.","message":"React integration requires React >=18.0.0 as a peer dependency. Older React versions may cause errors.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'1.0.5':21 '18.0.0':87 'activ':22 'adapt':51 'agnost':6,41 'altern':68 'audio':13,53,79,101 'auto':26 'auto-reconnect':25 'cadenc':93 'case':82 'code':49 'core':42 'decod':57 'dedic':44 'definit':67 'depend':84 'develop':23 'differenti':38 'disconnect':36 'encod':19 'extens':50 'first':63 'framework':5,40 'framework-agnost':4,39 'full':65 'heartbeat':28 'hook':46 'initi':97 'integr':91 'irregular':94 'javascript':99 'key':37 'last':33 'level':72 'librari':3,8,73 'like':74 'lower':71 'lower-level':70 'messag':29 'messagepack':16,56,104 'opinion':52 'opus':18,59,103 'peer':83 'pipelin':54 'playback':60 'posit':34 'queu':30 'react':45,86,90 'real':11,106 'real-tim':10,105 'reconnect':27 'releas':92,98 'resumpt':31 'socket.io':77 'storme':1,108 'stream':14,80,102 'support':24 'time':12,107 'tts':109 'type':66 'typescript':62,110 'typescript-first':61 'use':81 'version':20 'vs':48 'websocket':2,7,100 'ws':75","created_at":"2026-06-07T17:01:48.773943+00:00","updated_at":"2026-06-07T17:01:48.773943+00:00","problems":[{"fix":"Import from a specific sub-path: e.g., import { StormeeService } from '@stormee-websocket/library/core'.","cause":"Importing from the main package instead of a sub-path.","error":"Cannot find module '@stormee-websocket/library' or its corresponding type declarations."},{"fix":"Ensure you installed the package correctly (npm install @stormee-websocket/library) and check that your bundler supports the 'exports' field in package.json.","cause":"The sub-path 'react' is not exported or the package is not installed correctly.","error":"Module not found: Error: Package path ./react is not exported from package @stormee-websocket/library"},{"fix":"Use named import: import { StormeeService } from '@stormee-websocket/library/core'.","cause":"Using default import instead of named import, or importing from wrong path.","error":"TypeError: StormeeService is not a constructor"},{"fix":"Install React: npm install react@^18.0.0. Note: React is only required if you use the 'react' sub-path.","cause":"Using the React hook without having React installed.","error":"Uncaught Error: React is not defined"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":null,"github":null,"docs":null,"changelog":null,"pypi":null,"npm":"stormee-websocket","openapi_spec":null,"status_page":null,"smithery":null,"categories":["ai-ml","communication"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}