Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lastninja294/adgent-sdk/llms.txt

Use this file to discover all available pages before exploring further.

Adgent SDK is currently at v0.1.10 (early version). This guide will be updated with migration instructions as new versions are released.

​
Current Version: 0.1.x

The SDK is in its initial release phase. The API is stable for production use, but may evolve based on community feedback.

​
Stability Guarantee

For the 0.1.x series:

Stable

  • Core API (AdgentSDK class)
  • Event system
  • Platform detection
  • VAST 4.x parsing

May Change

  • Internal implementation details
  • Non-public APIs
  • Debug/logging behavior
  • Error message formatting

​
Semantic Versioning

Adgent SDK follows Semantic Versioning (SemVer):
  • Major (1.0.0): Breaking changes to public API
  • Minor (0.1.0): New features, backward compatible
  • Patch (0.1.1): Bug fixes, backward compatible

​
Future Migration Paths

​
0.1.x → 0.2.x (Future)

When 0.2.0 is released, this section will document:
  • New features added
  • Deprecated APIs (if any)
  • Recommended upgrade steps

​
0.x.x → 1.0.0 (Future)

When 1.0.0 is released, this section will document:
  • API stabilization changes
  • Breaking changes (if any)
  • Migration code examples

​
Upgrade Best Practices

1

Check the changelog

Review Changelog for new features and breaking changes
2

Update dependencies

npm install adgent-sdk@latest
3

Run TypeScript checks

npx tsc --noEmit
TypeScript will catch breaking API changes at compile time.
4

Test on target devices

Always test upgrades on actual Smart TV hardware, not just desktop browsers.
5

Monitor error rates

Track error codes and playback success rates after upgrading.

​
TypeScript Support

Adgent SDK ships with TypeScript type definitions: 
import { AdgentSDK, AdPlayerConfig } from 'adgent-sdk';

// Types are automatically available
const config: AdPlayerConfig = {
  container: document.getElementById('ad-container')!,
  vastUrl: 'https://example.com/vast.xml',
  targetBitrate: 2500
};

const sdk = new AdgentSDK(config);
TypeScript will help catch breaking changes when upgrading. Enable strict mode in tsconfig.json for maximum safety.

​
Reporting Issues

If you encounter issues during migration:
  1. Check the changelog: Verify the change is documented
  2. Review the API docs: Confirm you’re using the correct API
  3. Test on multiple platforms: Reproduce on WebOS, Tizen, etc.
  4. Report on GitHub: Create an issue
Include:
  • SDK version (before and after upgrade)
  • Platform (WebOS, Tizen, etc.)
  • Error messages or unexpected behavior
  • Minimal reproduction code

​
Version History

For detailed version history, see:

​
Staying Updated

To stay informed about new releases:

Watch on GitHub

Get notifications for new releases

Check npm

View latest published version

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us