@volley/webostv

Automated npm distribution of LG's webOSTV.js library with modern module formats (ESM + CommonJS) and ES5 transpilation for legacy browser support.

Why This Package?

The official webOSTV.js library from LG is distributed as a single JavaScript file without npm support. This package:

• ✅ Provides proper npm distribution
• ✅ Supports both ESM (import) and CommonJS (require)
• ✅ Includes TypeScript type definitions
• ✅ Transpiled to ES5 for maximum compatibility
• ✅ Separate development builds with better debugging
• ✅ Automatically updated weekly via GitHub Actions

Installation

npm install @volley/webostv
# or
pnpm add @volley/webostv
# or
yarn add @volley/webostv

Usage

ESM (Recommended)

import webOS from '@volley/webostv';

// Use webOS APIs
const appId = webOS.fetchAppId();
console.log('App ID:', appId);

// Call webOS service
webOS.service.request('luna://com.webos.service.tv/getCurrentTime', {
  method: 'getCurrentTime',
  onSuccess: (result) => {
    console.log('Current time:', result);
  },
  onFailure: (error) => {
    console.error('Error:', error);
  }
});

CommonJS

const webOS = require('@volley/webostv');

// Same API as above

TypeScript

import webOS, { WebOSTV } from '@volley/webostv';

// Full type support
const appId: string = webOS.fetchAppId();

Vite + Legacy Plugin

This package is specifically designed to work with @vitejs/plugin-legacy:

// vite.config.js
import { defineConfig } from 'vite';
import legacy from '@vitejs/plugin-legacy';

export default defineConfig({
  plugins: [
    legacy({
      targets: ['defaults', 'not IE 11']
    })
  ]
});

The package will automatically use development builds in dev mode and production builds in production.

Version

This package mirrors the version of the upstream webOSTV.js library. Current version: 1.2.12

Updates are checked weekly via GitHub Actions.

API Documentation

For full API documentation, visit the official webOSTV.js documentation.

License

This is a repackaged distribution of LG's webOSTV.js library. The original library and its license are included in this package.

Contributing

This package is automatically maintained. If you find issues with the packaging or build process, please open an issue.