uptalktv-plugin 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,209 @@
-# Temporary Holding Version
+# UpTalkTV Plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm version](https://img.shields.io/npm/v/uptalktv-plugin.svg)](https://www.npmjs.com/package/uptalktv-plugin)
+[![types](https://img.shields.io/npm/types/uptalktv-plugin.svg)](https://www.npmjs.com/package/uptalktv-plugin)
+
+> Lightweight, framework-agnostic TypeScript plugin for embedding and managing the UpTalkTV chat interface.
+
+---
+
+## Installation
+
+```bash
+npm install uptalktv-plugin
+# or using Yarn:
+yarn add uptalktv-plugin
+# or using pnpm
+pnpm add uptalktv-plugin
+```
+
+---
+
+## Quick Start
+
+### ES Modules / TypeScript
+
+```typescript
+import { UpTalkTV } from 'uptalktv-plugin';
+import type { Config } from 'uptalktv-plugin';
+
+const container = document.getElementById('player-container');
+const config: Config = {
+  apiKey: 'YOUR_API_KEY',
+  chatId: 'chat_room_123',
+};
+
+// Initialize the plugin
+const plugin = new UpTalkTV(container, config);
+```
+
+### CommonJS
+
+```javascript
+const { UpTalkTV } = require('uptalktv-plugin');
+
+const container = document.getElementById('player-container');
+const plugin = new UpTalkTV(container, {
+  apiKey: 'YOUR_API_KEY',
+  chatId: 'chat_room_123',
+});
+```
+
+---
+
+## Type Definitions
+
+### `Config`
+
+Main configuration object required to initialize the UpTalkTV chat plugin.
+
+| Parameter | Type | Required | Description |
+| :--- | :--- | :---: | :--- |
+| `apiKey` | `string` | **Yes** | Authentication API key for the UpTalkTV service. |
+| `chatId` | `string` | Conditional | Unique identifier of the target chat room to join. Required if `content` is not specified. |
+| `content` | [`Content`](#content) | Conditional | OpenRTB Content object describing the surrounding media context. Required if `chatId` is not specified. |
+| `deviceId` | `string` | No | Unique device identifier. |
+| `layout` | [`Layout`](#layout) | No | Visual positioning and rendering choices for the chat iframe. |
+
+---
+
+### `Layout`
+
+Layout configuration options for the UpTalkTV chat iframe.
+
+| Property | Type | Default | Description |
+| :--- | :--- | :---: | :--- |
+| `left` | `boolean` | `false` | Whether the chat container should align to the left side of the screen. |
+| `reversed` | `boolean` | `false` | Whether the interactive features should be shown on the top corner (false) or chat (true). |
+| `zIndex` | `number` | `1000` | The CSS `z-index` applied to the iframe element. |
+
+---
+
+## OpenRTB Content Structure
+
+### `Content`
+
+Represents OpenRTB Content object (Section 3.2.16) describing the media in which the ad/chat is embedded.
+
+| Parameter | Type | Required | Description |
+| :--- | :--- | :---: | :--- |
+| `id` | `string` | **Yes** | ID uniquely identifying the content. |
+| `title` | `string` | **Yes** | Content title (e.g., `"Search Committee"`, `"A New Hope"`). |
+| `genre` | `string` | No | Genre describing the content (e.g., `"rock"`, `"pop"`). |
+| `episode` | `number` | No | Episode number. |
+| `series` | `string` | No | Content series (e.g., `"The Office"`, `"Star Wars"`). |
+| `season` | `string` | No | Content season (e.g., `"Season 3"`). |
+| `artist` | `string` | No | Artist credited with the content. |
+| `album` | `string` | No | Album to which the content belongs (typically for audio). |
+| `isrc` | `string` | No | International Standard Recording Code conforming to ISO 3901. |
+| `producer` | [`Producer`](#producer) | No | Details about the content Producer (OpenRTB Section 3.2.17). |
+| `url` | `string` | No | URL of the content, for buy-side contextualization or review. |
+| `cattax` | [`CategoryTaxonomy`](#categorytaxonomy) | No | The taxonomy in use (defaults to `1`: IAB Content Category Taxonomy 1.0). |
+| `cat` | `string[]` | No | Array of IAB content categories describing the content (uses taxonomy from `cattax`). |
+| `prodq` | [`ProductionQuality`](#productionquality) | No | Production quality rating per AdCOM 1.0. |
+| `context` | [`Context`](#context) | No | Type of content context (e.g., game, video, text) per AdCOM 1.0 Content Contexts. |
+| `contentrating` | `string` | No | Content rating (e.g., `"MPAA"`, `"TV-MA"`). |
+| `userrating` | `string` | No | User rating of the content (e.g., number of stars, likes). |
+| `qagmediarating` | [`MediaRating`](#mediarating) | No | Media rating per IQG guidelines. Refer to AdCOM 1.0 Media Ratings. |
+| `keywords` | `string` | No | Comma-separated list of keywords. *Mutually exclusive with `kwarray`.* |
+| `kwarray` | `string[]` | No | Array of keywords describing the content. *Mutually exclusive with `keywords`.* |
+| `livestream` | `0 \| 1` | No | Live stream indicator: `0` = Not live, `1` = Content is live. |
+| `sourcerelationship` | `0 \| 1` | No | Source relationship indicator: `0` = Indirect, `1` = Direct. |
+| `len` | `number` | No | Length of content in seconds (appropriate for video or audio). |
+| `language` | `string` | No | Content language using ISO-639-1-alpha-2 format. *Mutually exclusive with `langb`.* |
+| `langb` | `string` | No | Content language using IETF BCP 47 format. *Mutually exclusive with `language`.* |
+| `embeddable` | `0 \| 1` | No | Indicator of whether content is embeddable: `0` = No, `1` = Yes. |
+| `data` | [`Data[]`](#data) | No | Additional content data objects (OpenRTB Section 3.2.21). |
+| `network` | [`Network`](#network) | No | Details about the network (OpenRTB Section 3.2.23) the content is on. |
+| `channel` | [`Channel`](#channel) | No | Details about the channel (OpenRTB Section 3.2.24) the content is on. |
+| `ext` | `Record<string, unknown>` | No | Placeholder for exchange-specific extensions to OpenRTB. |
+
+---
+
+## Auxiliary Interfaces
+
+### `Producer`
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `id` | `string` | Content producer ID |
+| `name` | `string` | Content producer name |
+| `cattax` | [`CategoryTaxonomy`](#categorytaxonomy) | Category taxonomy in use |
+| `cat` | `string[]` | Producer content categories |
+| `domain` | `string` | Producer domain |
+| `ext` | `Record<string, unknown>` | Extension field |
+
+### `Network`
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `id` | `string` | Network identifier |
+| `name` | `string` | Network name |
+| `domain` | `string` | Network domain |
+| `ext` | `Record<string, unknown>` | Extension field |
+
+### `Channel`
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `id` | `string` | Channel identifier |
+| `name` | `string` | Channel name |
+| `domain` | `string` | Channel domain |
+| `ext` | `Record<string, unknown>` | Extension field |
+
+### `Data`
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `id` | `string` | Data provider ID |
+| `name` | `string` | Data provider name |
+| `segment` | [`Segment[]`](#segment) | Array of data segments |
+| `cids` | `string[]` | Array of Extended Content IDs |
+| `ext` | `Record<string, unknown>` | Extension field |
+
+### `Segment`
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `id` | `string` | Segment ID |
+| `name` | `string` | Segment name |
+| `value` | `string` | Segment value |
+| `ext` | `Record<string, unknown>` | Extension field |
+
+---
+
+## Enums
+
+### `CategoryTaxonomy`
+| Key | Value | Description |
+| :--- | :---: | :--- |
+| `AD_PRODUCT_TAXONOMY_1_0` | `3` | IAB Tech Lab Ad Product Taxonomy 1.0 |
+| `AUDIENCE_TAXONOMY_1_1` | `4` | IAB Tech Lab Audience Taxonomy 1.1 |
+| `CONTENT_TAXONOMY_2_1` | `5` | IAB Tech Lab Content Taxonomy 2.1 |
+| `CONTENT_TAXONOMY_2_2` | `6` | IAB Tech Lab Content Taxonomy 2.2 |
+| `CONTENT_TAXONOMY_3_0` | `7` | IAB Tech Lab Content Taxonomy 3.0 |
+| `AD_PRODUCT_TAXONOMY_2_0` | `8` | IAB Tech Lab Ad Product Taxonomy 2.0 |
+| `CONTENT_TAXONOMY_3_1` | `9` | IAB Tech Lab Content Taxonomy 3.1 |
+
+### `ProductionQuality`
+| Key | Value | Description |
+| :--- | :---: | :--- |
+| `UNKNOWN` | `0` | Unknown |
+| `PROFESSIONAL` | `1` | Professionally Produced |
+| `PROSUMER` | `2` | Prosumer |
+| `USER_GENERATED` | `3` | User Generated Content (UGC) |
+
+### `MediaRating`
+| Key | Value | Description |
+| :--- | :---: | :--- |
+| `ALL_AUDIENCES` | `1` | All Audiences |
+| `OVER_12` | `2` | Everyone Over Age 12 |
+| `MATURE` | `3` | Mature Audiences |
+
+### `Context`
+| Key | Value | Description |
+| :--- | :---: | :--- |
+| `VIDEO` | `1` | Video file or stream such as Internet TV broadcasts |
+| `GAME` | `2` | Interactive software game |
+| `MUSIC` | `3` | Audio file or stream such as Internet radio broadcasts |
+| `APPLICATION` | `4` | Interactive software application |
+| `TEXT` | `5` | Primarily textual document such as a web page, eBook, or news article |
+| `OTHER` | `6` | None of the other categories applies |
+| `UNKNOWN` | `7` | Unknown content context |
+
+---

package/dist/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=class{constructor(e,t){if(this.baseUrl=`https://iframe.uptalktv.com/chat`,this.iframeElement=null,!t.apiKey)throw Error(`API key is required`);if(!t.chatId&&(!t.content||!t.content.id||!t.content.title))throw Error(`Either Chat Id or Content object with Id and Title is required`);this.iframeElement=document.createElement(`iframe`),this.iframeElement.src=this.baseUrl,this.iframeElement.className=`uptalktv-plugin`,this.iframeElement.onload=()=>{this.iframeElement?.contentWindow?.postMessage({type:`INIT_CONFIG`,payload:t},this.baseUrl)},this.iframeElement.setAttribute(`allowtransparency`,`true`),this.iframeElement.setAttribute(`tabindex`,`-1`),Object.assign(this.iframeElement.style,{position:`absolute`,top:`0`,left:`0`,width:`100%`,height:`100%`,border:`none`,zIndex:(t.layout?.zIndex??1e3).toString(),backgroundColor:`transparent`,pointerEvents:`none`}),e.appendChild(this.iframeElement)}destroy(){this.iframeElement&&=(this.iframeElement.remove(),null)}};exports.UpTalkTV=e;

package/dist/index.d.cts

@@ -0,0 +1,366 @@
+//#region src/types.d.ts
+/**
+ * Represents OpenRTB Content object (Section 3.2.16) describing the media in which the ad/chat is embedded.
+ *
+ * @see {@link https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf | OpenRTB 2.6 Specification}
+ * @public
+ */
+interface Content {
+  /**
+   * ID uniquely identifying the content.
+   */
+  id: string;
+  /**
+   * Content title.
+   *
+   * @example
+   * Video: "Search Committee", "A New Hope"
+   * @example
+   * Article: "Why an Antarctic Glacier Is Melting So Quickly"
+   */
+  title: string;
+  /**
+   * Genre describing the content (e.g., `"rock"`, `"pop"`).
+   */
+  genre?: string;
+  /**
+   * Episode number.
+   */
+  episode?: number;
+  /**
+   * Content series.
+   *
+   * @example
+   * Video: "The Office", "Star Wars"
+   * @example
+   * Article/Blog: "Ecocentric"
+   */
+  series?: string;
+  /**
+   * Content season (e.g., `"Season 3"`).
+   */
+  season?: string;
+  /**
+   * Artist credited with the content.
+   */
+  artist?: string;
+  /**
+   * Album to which the content belongs (typically for audio).
+   */
+  album?: string;
+  /**
+   * International Standard Recording Code conforming to ISO 3901.
+   */
+  isrc?: string;
+  /**
+   * Details about the content Producer (OpenRTB Section 3.2.17).
+   */
+  producer?: Producer;
+  /**
+   * URL of the content, for buy-side contextualization or review.
+   */
+  url?: string;
+  /**
+   * The taxonomy in use. Refer to AdCOM 1.0 Category Taxonomies list.
+   *
+   * @defaultValue `1` (IAB Content Category Taxonomy 1.0)
+   */
+  cattax?: CategoryTaxonomy;
+  /**
+   * Array of IAB content categories that describe the content.
+   *
+   * @remarks
+   * The taxonomy used is defined by {@link Content.cattax}. If no `cattax` is supplied,
+   * IAB Content Category Taxonomy 1.0 is assumed.
+   */
+  cat?: string[];
+  /**
+   * Production quality rating per AdCOM 1.0.
+   */
+  prodq?: ProductionQuality;
+  /**
+   * Type of content context (e.g., game, video, text). Refer to AdCOM 1.0 Content Contexts.
+   */
+  context?: Context;
+  /**
+   * Content rating (e.g., `"MPAA"`, `"TV-MA"`).
+   */
+  contentrating?: string;
+  /**
+   * User rating of the content (e.g., number of stars, likes).
+   */
+  userrating?: string;
+  /**
+   * Media rating per IQG guidelines. Refer to AdCOM 1.0 Media Ratings.
+   */
+  qagmediarating?: MediaRating;
+  /**
+   * Comma-separated list of keywords describing the content.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.kwarray}. Only one should be present.
+   */
+  keywords?: string;
+  /**
+   * Array of keywords describing the content.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.keywords}. Only one should be present.
+   */
+  kwarray?: string[];
+  /**
+   * Live stream indicator.
+   * - `0` = Not live
+   * - `1` = Content is live (e.g., stream, live blog)
+   */
+  livestream?: 0 | 1;
+  /**
+   * Source relationship indicator.
+   * - `0` = Indirect
+   * - `1` = Direct
+   */
+  sourcerelationship?: 0 | 1;
+  /**
+   * Length of content in seconds (appropriate for video or audio).
+   */
+  len?: number;
+  /**
+   * Content language using ISO-639-1-alpha-2 format.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.langb}. Only one should be present.
+   */
+  language?: string;
+  /**
+   * Content language using IETF BCP 47 format.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.language}. Only one should be present.
+   */
+  langb?: string;
+  /**
+   * Indicator of whether the content is embeddable (e.g., embeddable video player).
+   * - `0` = No
+   * - `1` = Yes
+   */
+  embeddable?: 0 | 1;
+  /**
+   * Additional content data objects (OpenRTB Section 3.2.21).
+   */
+  data?: Data[];
+  /**
+   * Details about the network (OpenRTB Section 3.2.23) the content is on.
+   */
+  network?: Network;
+  /**
+   * Details about the channel (OpenRTB Section 3.2.24) the content is on.
+   */
+  channel?: Channel;
+  /**
+   * Placeholder for exchange-specific extensions to OpenRTB.
+   */
+  ext?: Record<string, unknown>;
+}
+interface Producer {
+  /** Content producer ID */
+  id?: string;
+  /** Content producer name */
+  name?: string;
+  /** Category taxonomy in use */
+  cattax?: CategoryTaxonomy;
+  /** Producer content categories */
+  cat?: string[];
+  /** Producer domain */
+  domain?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+declare const enum CategoryTaxonomy {
+  /** IAB Tech Lab Ad Product Taxonomy 1.0 */
+  AD_PRODUCT_TAXONOMY_1_0 = 3,
+  /** IAB Tech Lab Audience Taxonomy 1.1 */
+  AUDIENCE_TAXONOMY_1_1 = 4,
+  /** IAB Tech Lab Content Taxonomy 2.1 */
+  CONTENT_TAXONOMY_2_1 = 5,
+  /** IAB Tech Lab Content Taxonomy 2.2 */
+  CONTENT_TAXONOMY_2_2 = 6,
+  /** IAB Tech Lab Content Taxonomy 3.0 */
+  CONTENT_TAXONOMY_3_0 = 7,
+  /** IAB Tech Lab Ad Product Taxonomy 2.0 */
+  AD_PRODUCT_TAXONOMY_2_0 = 8,
+  /** IAB Tech Lab Content Taxonomy 3.1 */
+  CONTENT_TAXONOMY_3_1 = 9
+}
+declare const enum ProductionQuality {
+  /** Unknown */
+  UNKNOWN = 0,
+  /** Professionally Produced */
+  PROFESSIONAL = 1,
+  /** Prosumer */
+  PROSUMER = 2,
+  /** User Generated Content (UGC) */
+  USER_GENERATED = 3
+}
+declare const enum MediaRating {
+  ALL_AUDIENCES = 1,
+  /** Everyone Over Age 12 */
+  OVER_12 = 2,
+  /** Mature Audiences */
+  MATURE = 3
+}
+interface Network {
+  /** Network identifier */
+  id?: string;
+  /** Network name */
+  name?: string;
+  /** Network domain */
+  domain?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+interface Channel {
+  /** Channel identifier */
+  id?: string;
+  /** Channel name */
+  name?: string;
+  /** Channel domain */
+  domain?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+interface Segment {
+  /** Segment ID */
+  id?: string;
+  /** Segment name */
+  name?: string;
+  /** Segment value */
+  value?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+interface Data {
+  /** Data provider ID */
+  id?: string;
+  /** Data provider name */
+  name?: string;
+  /** Array of data segments */
+  segment?: Segment[];
+  /** Array of Extended Content IDs */
+  cids?: string[];
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+declare const enum Context {
+  /** Video (i.e., video file or stream such as Internet TV broadcasts) */
+  VIDEO = 1,
+  /** Game (i.e., an interactive software game) */
+  GAME = 2,
+  /** Music (i.e., audio file or stream such as Internet radio broadcasts) */
+  MUSIC = 3,
+  /** Application (i.e., an interactive software application) */
+  APPLICATION = 4,
+  /** Text (i.e., primarily textual document such as a web page, eBook, or news article) */
+  TEXT = 5,
+  /** Other (i.e., none of the other categories applies) */
+  OTHER = 6,
+  /** Unknown content context */
+  UNKNOWN = 7
+}
+/**
+ * Layout configuration options for the UpTalkTV chat iframe.
+ *
+ * @public
+ */
+interface Layout {
+  /**
+   * Whether the chat container should align to the left side of the screen.
+   *
+   * @defaultValue `false`
+   */
+  left?: boolean;
+  /**
+   * Whether the message thread order or UI layout should be reversed.
+   *
+   * @defaultValue `false`
+   */
+  reversed?: boolean;
+  /**
+   * The CSS `z-index` applied to the iframe element.
+   *
+   * @defaultValue `1000`
+   */
+  zIndex?: number;
+}
+/**
+ * Main configuration object required to initialize the UpTalkTV chat plugin.
+ *
+ * @public
+ */
+interface Config {
+  /**
+   * Authentication API key for the UpTalkTV service.
+   */
+  apiKey: string;
+  /**
+   * Unique identifier of the target chat room to join.
+   *
+   * @remarks
+   * Required if {@link Config.content} is not specified.
+   */
+  chatId?: string;
+  /**
+   * OpenRTB Content object describing the surrounding media context.
+   *
+   * @remarks
+   * Required if {@link Config.chatId} is not specified.
+   */
+  content?: Content;
+  /**
+   * Unique device identifier.
+   */
+  deviceId?: string;
+  /**
+   * Visual positioning and rendering choices for the chat iframe.
+   */
+  layout?: Layout;
+}
+//#endregion
+//#region src/plugin.d.ts
+/**
+ * Manages the embedding, messaging, and lifecycle of the UpTalkTV chat plugin.
+ *
+ * @example
+ * ```ts
+ * const playerContainer = document.getElementById("player-container");
+ * const plugin = new UpTalkTV(playerContainer, {
+ *   apiKey: 'your-api-key',
+ *   chatId: '12345'
+ * });
+ *
+ * // Cleanup when unmounting:
+ * plugin.destroy();
+ * ```
+ */
+export declare class UpTalkTV {
+  /** Base URL for loading the chat iframe interface. */
+  private readonly baseUrl;
+  /** Internal reference to the created iframe element. */
+  private iframeElement;
+  /**
+   * Initializes the UpTalkTV chat plugin, constructs the DOM element, and handles
+   * initial configuration dispatch.
+   *
+   * @param container - The target HTML element where the chat iframe will be appended.
+   * @param config - Options to configure authentication, target content, and visual layout.
+   *
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} Thrown if `apiKey` is missing.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} Thrown if `chatId` is missing or `content.id` and `content.title` are not supplied.
+   */
+  constructor(container: HTMLElement, config: Config);
+  /**
+   * Removes the chat iframe from the DOM and releases internal element references.
+   */
+  destroy(): void;
+}
+//#endregion
+export type { CategoryTaxonomy, Channel, Config, Content, Context, Data, Layout, MediaRating, Network, Producer, ProductionQuality, Segment };

package/dist/index.d.mts

@@ -0,0 +1,366 @@
+//#region src/types.d.ts
+/**
+ * Represents OpenRTB Content object (Section 3.2.16) describing the media in which the ad/chat is embedded.
+ *
+ * @see {@link https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf | OpenRTB 2.6 Specification}
+ * @public
+ */
+interface Content {
+  /**
+   * ID uniquely identifying the content.
+   */
+  id: string;
+  /**
+   * Content title.
+   *
+   * @example
+   * Video: "Search Committee", "A New Hope"
+   * @example
+   * Article: "Why an Antarctic Glacier Is Melting So Quickly"
+   */
+  title: string;
+  /**
+   * Genre describing the content (e.g., `"rock"`, `"pop"`).
+   */
+  genre?: string;
+  /**
+   * Episode number.
+   */
+  episode?: number;
+  /**
+   * Content series.
+   *
+   * @example
+   * Video: "The Office", "Star Wars"
+   * @example
+   * Article/Blog: "Ecocentric"
+   */
+  series?: string;
+  /**
+   * Content season (e.g., `"Season 3"`).
+   */
+  season?: string;
+  /**
+   * Artist credited with the content.
+   */
+  artist?: string;
+  /**
+   * Album to which the content belongs (typically for audio).
+   */
+  album?: string;
+  /**
+   * International Standard Recording Code conforming to ISO 3901.
+   */
+  isrc?: string;
+  /**
+   * Details about the content Producer (OpenRTB Section 3.2.17).
+   */
+  producer?: Producer;
+  /**
+   * URL of the content, for buy-side contextualization or review.
+   */
+  url?: string;
+  /**
+   * The taxonomy in use. Refer to AdCOM 1.0 Category Taxonomies list.
+   *
+   * @defaultValue `1` (IAB Content Category Taxonomy 1.0)
+   */
+  cattax?: CategoryTaxonomy;
+  /**
+   * Array of IAB content categories that describe the content.
+   *
+   * @remarks
+   * The taxonomy used is defined by {@link Content.cattax}. If no `cattax` is supplied,
+   * IAB Content Category Taxonomy 1.0 is assumed.
+   */
+  cat?: string[];
+  /**
+   * Production quality rating per AdCOM 1.0.
+   */
+  prodq?: ProductionQuality;
+  /**
+   * Type of content context (e.g., game, video, text). Refer to AdCOM 1.0 Content Contexts.
+   */
+  context?: Context;
+  /**
+   * Content rating (e.g., `"MPAA"`, `"TV-MA"`).
+   */
+  contentrating?: string;
+  /**
+   * User rating of the content (e.g., number of stars, likes).
+   */
+  userrating?: string;
+  /**
+   * Media rating per IQG guidelines. Refer to AdCOM 1.0 Media Ratings.
+   */
+  qagmediarating?: MediaRating;
+  /**
+   * Comma-separated list of keywords describing the content.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.kwarray}. Only one should be present.
+   */
+  keywords?: string;
+  /**
+   * Array of keywords describing the content.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.keywords}. Only one should be present.
+   */
+  kwarray?: string[];
+  /**
+   * Live stream indicator.
+   * - `0` = Not live
+   * - `1` = Content is live (e.g., stream, live blog)
+   */
+  livestream?: 0 | 1;
+  /**
+   * Source relationship indicator.
+   * - `0` = Indirect
+   * - `1` = Direct
+   */
+  sourcerelationship?: 0 | 1;
+  /**
+   * Length of content in seconds (appropriate for video or audio).
+   */
+  len?: number;
+  /**
+   * Content language using ISO-639-1-alpha-2 format.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.langb}. Only one should be present.
+   */
+  language?: string;
+  /**
+   * Content language using IETF BCP 47 format.
+   *
+   * @remarks
+   * Mutually exclusive with {@link Content.language}. Only one should be present.
+   */
+  langb?: string;
+  /**
+   * Indicator of whether the content is embeddable (e.g., embeddable video player).
+   * - `0` = No
+   * - `1` = Yes
+   */
+  embeddable?: 0 | 1;
+  /**
+   * Additional content data objects (OpenRTB Section 3.2.21).
+   */
+  data?: Data[];
+  /**
+   * Details about the network (OpenRTB Section 3.2.23) the content is on.
+   */
+  network?: Network;
+  /**
+   * Details about the channel (OpenRTB Section 3.2.24) the content is on.
+   */
+  channel?: Channel;
+  /**
+   * Placeholder for exchange-specific extensions to OpenRTB.
+   */
+  ext?: Record<string, unknown>;
+}
+interface Producer {
+  /** Content producer ID */
+  id?: string;
+  /** Content producer name */
+  name?: string;
+  /** Category taxonomy in use */
+  cattax?: CategoryTaxonomy;
+  /** Producer content categories */
+  cat?: string[];
+  /** Producer domain */
+  domain?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+declare const enum CategoryTaxonomy {
+  /** IAB Tech Lab Ad Product Taxonomy 1.0 */
+  AD_PRODUCT_TAXONOMY_1_0 = 3,
+  /** IAB Tech Lab Audience Taxonomy 1.1 */
+  AUDIENCE_TAXONOMY_1_1 = 4,
+  /** IAB Tech Lab Content Taxonomy 2.1 */
+  CONTENT_TAXONOMY_2_1 = 5,
+  /** IAB Tech Lab Content Taxonomy 2.2 */
+  CONTENT_TAXONOMY_2_2 = 6,
+  /** IAB Tech Lab Content Taxonomy 3.0 */
+  CONTENT_TAXONOMY_3_0 = 7,
+  /** IAB Tech Lab Ad Product Taxonomy 2.0 */
+  AD_PRODUCT_TAXONOMY_2_0 = 8,
+  /** IAB Tech Lab Content Taxonomy 3.1 */
+  CONTENT_TAXONOMY_3_1 = 9
+}
+declare const enum ProductionQuality {
+  /** Unknown */
+  UNKNOWN = 0,
+  /** Professionally Produced */
+  PROFESSIONAL = 1,
+  /** Prosumer */
+  PROSUMER = 2,
+  /** User Generated Content (UGC) */
+  USER_GENERATED = 3
+}
+declare const enum MediaRating {
+  ALL_AUDIENCES = 1,
+  /** Everyone Over Age 12 */
+  OVER_12 = 2,
+  /** Mature Audiences */
+  MATURE = 3
+}
+interface Network {
+  /** Network identifier */
+  id?: string;
+  /** Network name */
+  name?: string;
+  /** Network domain */
+  domain?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+interface Channel {
+  /** Channel identifier */
+  id?: string;
+  /** Channel name */
+  name?: string;
+  /** Channel domain */
+  domain?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+interface Segment {
+  /** Segment ID */
+  id?: string;
+  /** Segment name */
+  name?: string;
+  /** Segment value */
+  value?: string;
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+interface Data {
+  /** Data provider ID */
+  id?: string;
+  /** Data provider name */
+  name?: string;
+  /** Array of data segments */
+  segment?: Segment[];
+  /** Array of Extended Content IDs */
+  cids?: string[];
+  /** Extension field */
+  ext?: Record<string, unknown>;
+}
+declare const enum Context {
+  /** Video (i.e., video file or stream such as Internet TV broadcasts) */
+  VIDEO = 1,
+  /** Game (i.e., an interactive software game) */
+  GAME = 2,
+  /** Music (i.e., audio file or stream such as Internet radio broadcasts) */
+  MUSIC = 3,
+  /** Application (i.e., an interactive software application) */
+  APPLICATION = 4,
+  /** Text (i.e., primarily textual document such as a web page, eBook, or news article) */
+  TEXT = 5,
+  /** Other (i.e., none of the other categories applies) */
+  OTHER = 6,
+  /** Unknown content context */
+  UNKNOWN = 7
+}
+/**
+ * Layout configuration options for the UpTalkTV chat iframe.
+ *
+ * @public
+ */
+interface Layout {
+  /**
+   * Whether the chat container should align to the left side of the screen.
+   *
+   * @defaultValue `false`
+   */
+  left?: boolean;
+  /**
+   * Whether the message thread order or UI layout should be reversed.
+   *
+   * @defaultValue `false`
+   */
+  reversed?: boolean;
+  /**
+   * The CSS `z-index` applied to the iframe element.
+   *
+   * @defaultValue `1000`
+   */
+  zIndex?: number;
+}
+/**
+ * Main configuration object required to initialize the UpTalkTV chat plugin.
+ *
+ * @public
+ */
+interface Config {
+  /**
+   * Authentication API key for the UpTalkTV service.
+   */
+  apiKey: string;
+  /**
+   * Unique identifier of the target chat room to join.
+   *
+   * @remarks
+   * Required if {@link Config.content} is not specified.
+   */
+  chatId?: string;
+  /**
+   * OpenRTB Content object describing the surrounding media context.
+   *
+   * @remarks
+   * Required if {@link Config.chatId} is not specified.
+   */
+  content?: Content;
+  /**
+   * Unique device identifier.
+   */
+  deviceId?: string;
+  /**
+   * Visual positioning and rendering choices for the chat iframe.
+   */
+  layout?: Layout;
+}
+//#endregion
+//#region src/plugin.d.ts
+/**
+ * Manages the embedding, messaging, and lifecycle of the UpTalkTV chat plugin.
+ *
+ * @example
+ * ```ts
+ * const playerContainer = document.getElementById("player-container");
+ * const plugin = new UpTalkTV(playerContainer, {
+ *   apiKey: 'your-api-key',
+ *   chatId: '12345'
+ * });
+ *
+ * // Cleanup when unmounting:
+ * plugin.destroy();
+ * ```
+ */
+export declare class UpTalkTV {
+  /** Base URL for loading the chat iframe interface. */
+  private readonly baseUrl;
+  /** Internal reference to the created iframe element. */
+  private iframeElement;
+  /**
+   * Initializes the UpTalkTV chat plugin, constructs the DOM element, and handles
+   * initial configuration dispatch.
+   *
+   * @param container - The target HTML element where the chat iframe will be appended.
+   * @param config - Options to configure authentication, target content, and visual layout.
+   *
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} Thrown if `apiKey` is missing.
+   * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error} Thrown if `chatId` is missing or `content.id` and `content.title` are not supplied.
+   */
+  constructor(container: HTMLElement, config: Config);
+  /**
+   * Removes the chat iframe from the DOM and releases internal element references.
+   */
+  destroy(): void;
+}
+//#endregion
+export type { CategoryTaxonomy, Channel, Config, Content, Context, Data, Layout, MediaRating, Network, Producer, ProductionQuality, Segment };

package/dist/index.iife.js

@@ -0,0 +1 @@
+var UpTalkTV=(function(e){return Object.defineProperty(e,Symbol.toStringTag,{value:`Module`}),e.UpTalkTV=class{constructor(e,t){if(this.baseUrl=`https://iframe.uptalktv.com/chat`,this.iframeElement=null,!t.apiKey)throw Error(`API key is required`);if(!t.chatId&&(!t.content||!t.content.id||!t.content.title))throw Error(`Either Chat Id or Content object with Id and Title is required`);this.iframeElement=document.createElement(`iframe`),this.iframeElement.src=this.baseUrl,this.iframeElement.className=`uptalktv-plugin`,this.iframeElement.onload=()=>{this.iframeElement?.contentWindow?.postMessage({type:`INIT_CONFIG`,payload:t},this.baseUrl)},this.iframeElement.setAttribute(`allowtransparency`,`true`),this.iframeElement.setAttribute(`tabindex`,`-1`),Object.assign(this.iframeElement.style,{position:`absolute`,top:`0`,left:`0`,width:`100%`,height:`100%`,border:`none`,zIndex:(t.layout?.zIndex??1e3).toString(),backgroundColor:`transparent`,pointerEvents:`none`}),e.appendChild(this.iframeElement)}destroy(){this.iframeElement&&=(this.iframeElement.remove(),null)}},e})({});

package/dist/index.mjs

@@ -0,0 +1 @@
+var e=class{constructor(e,t){if(this.baseUrl=`https://iframe.uptalktv.com/chat`,this.iframeElement=null,!t.apiKey)throw Error(`API key is required`);if(!t.chatId&&(!t.content||!t.content.id||!t.content.title))throw Error(`Either Chat Id or Content object with Id and Title is required`);this.iframeElement=document.createElement(`iframe`),this.iframeElement.src=this.baseUrl,this.iframeElement.className=`uptalktv-plugin`,this.iframeElement.onload=()=>{this.iframeElement?.contentWindow?.postMessage({type:`INIT_CONFIG`,payload:t},this.baseUrl)},this.iframeElement.setAttribute(`allowtransparency`,`true`),this.iframeElement.setAttribute(`tabindex`,`-1`),Object.assign(this.iframeElement.style,{position:`absolute`,top:`0`,left:`0`,width:`100%`,height:`100%`,border:`none`,zIndex:(t.layout?.zIndex??1e3).toString(),backgroundColor:`transparent`,pointerEvents:`none`}),e.appendChild(this.iframeElement)}destroy(){this.iframeElement&&=(this.iframeElement.remove(),null)}};export{e as UpTalkTV};

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "uptalktv-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "UpTalkTV Video Player Plugin",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "tsdown --watch",
+    "build": "tsdown",
+    "docs": "typedoc src/index.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://bitbucket.org/uptalktv/uptalktv-plugin.git"
+  },
+  "author": "Deivydas Šabaras",
+  "license": "ISC",
+  "devDependencies": {
+    "tsdown": "^0.23.0",
+    "typedoc": "^0.28.20",
+    "typescript": "^6.0.3"
+  }
+}