@firebolt-js/core-client 1.0.0-next.5

package/dist/docs/Advertising/index.md

@@ -0,0 +1,120 @@
+---
+title: Advertising
+---
+
+# Advertising Module
+
+---
+
+Version Advertising 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [advertisingId](#advertisingid)
+- [Types](#types)
+  - [AdvertisingIdResult](#advertisingidresult)
+
+## Usage
+
+To use the Advertising module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Advertising } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+A module for platform provided advertising settings and functionality.
+
+## Methods
+
+### advertisingId
+
+Returns the IFA.
+
+```typescript
+function advertisingId(): Promise<AdvertisingIdResult>
+```
+
+Promise resolution:
+
+[AdvertisingIdResult](#advertisingidresult)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:advertising:identifier |
+
+#### Examples
+
+Getting the advertising ID
+
+JavaScript:
+
+```javascript
+import { Advertising } from '@firebolt-js/core-client'
+
+let advertisingId = await Advertising.advertisingId()
+console.log(advertisingId)
+```
+
+Value of `advertisingId`:
+
+```javascript
+{"ifa":"bd87dd10-8d1d-4b93-b1a6-a8e5d410e400","ifa_type":"sspid","lmt":"0"}
+```
+
+Getting the advertising ID with scope browse
+
+JavaScript:
+
+```javascript
+import { Advertising } from '@firebolt-js/core-client'
+
+let advertisingId = await Advertising.advertisingId()
+console.log(advertisingId)
+```
+
+Value of `advertisingId`:
+
+```javascript
+{"ifa":"bd87dd10-8d1d-4b93-b1a6-a8e5d410e400","ifa_type":"sspid","lmt":"0"}
+```
+
+Getting the advertising ID with scope content
+
+JavaScript:
+
+```javascript
+import { Advertising } from '@firebolt-js/core-client'
+
+let advertisingId = await Advertising.advertisingId()
+console.log(advertisingId)
+```
+
+Value of `advertisingId`:
+
+```javascript
+{"ifa":"bd87dd10-8d1d-4b93-b1a6-a8e5d410e400","ifa_type":"sspid","lmt":"0"}
+```
+
+---
+
+## Types
+
+### AdvertisingIdResult
+
+```typescript
+type AdvertisingIdResult = {
+  ifa: string // UUID conforming to IAB standard
+  ifa_type: 'dpid' | 'sspid' | 'sessionid' // Source of the IFA as defined by IAB
+  lmt: '0' | '1' // Boolean that if set to 1, user has requested ad tracking and measurement is disabled
+}
+```
+
+---

package/dist/docs/Device/index.md

@@ -0,0 +1,297 @@
+---
+title: Device
+---
+
+# Device Module
+
+---
+
+Version Device 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [chipsetId](#chipsetid)
+  - [deviceClass](#deviceclass)
+  - [hdr](#hdr)
+  - [timeInActiveState](#timeinactivestate)
+  - [uid](#uid)
+  - [uptime](#uptime)
+- [Events](#events)
+  - [onHdrChanged](#onhdrchanged)
+- [Types](#types)
+  - [DeviceClass](#deviceclass-1)
+  - [HDRFormatMap](#hdrformatmap)
+
+## Usage
+
+To use the Device module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Device } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+A module for querying about the device and it's capabilities.
+
+## Methods
+
+### chipsetId
+
+_This is a private RPC method._
+
+Returns chipset ID as a printable string, e.g. BCM72180
+
+Result:
+
+Capabilities:
+
+| Role | Capability                          |
+| ---- | ----------------------------------- |
+| uses | xrn:firebolt:capability:device:info |
+
+#### Examples
+
+Getting the device chipset ID
+
+---
+
+### deviceClass
+
+Returns the class of the device
+
+```typescript
+function deviceClass(): Promise<DeviceClass>
+```
+
+Promise resolution:
+
+[DeviceClass](#deviceclass-1)
+
+Capabilities:
+
+| Role | Capability                                  |
+| ---- | ------------------------------------------- |
+| uses | xrn:firebolt:capability:device:device-class |
+
+#### Examples
+
+Getting the device class
+
+JavaScript:
+
+```javascript
+import { Device } from '@firebolt-js/core-client'
+
+let deviceClass = await Device.deviceClass()
+console.log(deviceClass)
+```
+
+Value of `deviceClass`:
+
+```javascript
+'ott'
+```
+
+---
+
+### hdr
+
+Returns the HDR standards that are supported by the attached TV or the integral display
+
+To get the value of `hdr` call the method like this:
+
+```typescript
+function hdr(): Promise<HDRFormatMap>
+```
+
+Promise resolution:
+
+[HDRFormatMap](#hdrformatmap)
+
+Capabilities:
+
+| Role | Capability                          |
+| ---- | ----------------------------------- |
+| uses | xrn:firebolt:capability:device:info |
+
+#### Examples
+
+Getting the negotiated HDR formats
+
+JavaScript:
+
+```javascript
+import { Device } from '@firebolt-js/core-client'
+
+let negotiatedHdrFormats = await Device.hdr()
+console.log(negotiatedHdrFormats)
+```
+
+Value of `negotiatedHdrFormats`:
+
+```javascript
+{"hdr10":true,"hdr10Plus":true,"dolbyVision":true,"hlg":true}
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function hdr(callback: (negotiatedHdrFormats) => HDRFormatMap): Promise<number>
+```
+
+| Param                  | Type                            | Required | Description                |
+| ---------------------- | ------------------------------- | -------- | -------------------------- |
+| `negotiatedHdrFormats` | [`HDRFormatMap`](#hdrformatmap) | false    | the negotiated HDR formats |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Getting the negotiated HDR formats
+
+```typescript
+import { Device } from '@firebolt-js/core-client'
+
+let listenerId = await hdr((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+{
+	"hdr10": true,
+	"hdr10Plus": true,
+	"dolbyVision": true,
+	"hlg": true
+}
+```
+
+---
+
+### timeInActiveState
+
+_This is a private RPC method._
+
+Returns the number of seconds since the device transitioned to the ON power state
+
+Result:
+
+Capabilities:
+
+| Role | Capability                          |
+| ---- | ----------------------------------- |
+| uses | xrn:firebolt:capability:device:info |
+
+#### Examples
+
+Getting the number of seconds since the device transitioned to the ON power state
+
+---
+
+### uid
+
+Returns a persistent unique UUID for the current app and device. The UUID is reset when the app or device is reset
+
+```typescript
+function uid(): Promise<string>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                         |
+| ---- | ---------------------------------- |
+| uses | xrn:firebolt:capability:device:uid |
+
+#### Examples
+
+Getting the unique UUID
+
+JavaScript:
+
+```javascript
+import { Device } from '@firebolt-js/core-client'
+
+let uniqueId = await Device.uid()
+console.log(uniqueId)
+```
+
+Value of `uniqueId`:
+
+```javascript
+'ee6723b8-7ab3-462c-8d93-dbf61227998e'
+```
+
+---
+
+### uptime
+
+_This is a private RPC method._
+
+Returns the number of seconds since most recent device boot, including any time spent during deep sleep
+
+Result:
+
+Capabilities:
+
+| Role | Capability                          |
+| ---- | ----------------------------------- |
+| uses | xrn:firebolt:capability:device:info |
+
+#### Examples
+
+Getting the device uptime
+
+---
+
+## Events
+
+### onHdrChanged
+
+See: [hdr](#hdr)
+
+## Types
+
+### DeviceClass
+
+The type of device
+
+```typescript
+DeviceClass: {
+    OTT: 'ott',
+    STB: 'stb',
+    TV: 'tv',
+},
+
+```
+
+---
+
+### HDRFormatMap
+
+The type of HDR format
+
+```typescript
+type HDRFormatMap = {
+  hdr10: boolean
+  hdr10Plus: boolean
+  dolbyVision: boolean
+  hlg: boolean
+}
+```
+
+---

package/dist/docs/Discovery/index.md

@@ -0,0 +1,128 @@
+---
+title: Discovery
+---
+
+# Discovery Module
+
+---
+
+Version Discovery 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+  - [Localization](#localization)
+- [Methods](#methods)
+  - [watched](#watched)
+- [Types](#types)
+
+## Usage
+
+To use the Discovery module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Discovery } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+Your App likely wants to integrate with the Platform's discovery capabilities. For example to add a "Watch Next" tile that links to your app from the platform's home screen.
+
+Getting access to this information requires to connect to lower level APIs made available by the platform. Since implementations differ between operators and platforms, the Firebolt SDK offers a Discovery module, that exposes a generic, agnostic interface to the developer.
+
+Under the hood, an underlying transport layer will then take care of calling the right APIs for the actual platform implementation that your App is running on.
+
+The Discovery plugin is used to _send_ information to the Platform.
+
+### Localization
+
+Apps should provide all user-facing strings in the device's language, as specified by the Firebolt `Localization.language` property.
+
+Apps should provide prices in the same currency presented in the app. If multiple currencies are supported in the app, the app should provide prices in the user's current default currency.
+
+## Methods
+
+### watched
+
+Notify the platform that content was partially or completely watched
+
+```typescript
+function watched(
+  entityId: string,
+  progress: number,
+  completed: boolean,
+  watchedOn: string,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                            |
+| ----------- | --------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `entityId`  | `string`                                      | true     | The entity Id of the watched content.                                                                                  |
+| `progress`  | `number`                                      | false    | How much of the content has been watched (percentage as (0-0.999) for VOD, number of seconds for live) <br/>minumum: 0 |
+| `completed` | `boolean`                                     | false    | Whether or not this viewing is considered "complete," per the app's definition thereof                                 |
+| `watchedOn` | `string`                                      | false    | Date/Time the content was watched, ISO 8601 Date/Time <br/>format: date-time                                           |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    |                                                                                                                        |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                |
+| ---- | ----------------------------------------- |
+| uses | xrn:firebolt:capability:discovery:watched |
+
+#### Examples
+
+Notify the platform of watched content
+
+JavaScript:
+
+```javascript
+import { Discovery } from '@firebolt-js/core-client'
+
+let success = await Discovery.watched(
+  'partner.com/entity/123',
+  0.95,
+  true,
+  '2021-04-23T18:25:43.511Z',
+)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+Notify the platform that child-directed content was watched
+
+JavaScript:
+
+```javascript
+import { Discovery } from '@firebolt-js/core-client'
+
+let success = await Discovery.watched(
+  'partner.com/entity/123',
+  0.95,
+  true,
+  '2021-04-23T18:25:43.511Z',
+  'app:child',
+)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+## Types

package/dist/docs/Display/index.md

@@ -0,0 +1,87 @@
+---
+title: Display
+---
+
+# Display Module
+
+---
+
+Version Display 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [edid](#edid)
+  - [maxResolution](#maxresolution)
+  - [size](#size)
+- [Types](#types)
+
+## Overview
+
+A module for querying about the display
+
+## Methods
+
+### edid
+
+_This is a private RPC method._
+
+Returns the EDID (and extensions) of the connected or integral display, as a Base64 encoded string
+
+Result:
+
+Capabilities:
+
+| Role | Capability                           |
+| ---- | ------------------------------------ |
+| uses | xrn:firebolt:capability:display:info |
+
+#### Examples
+
+Getting the display EDID
+
+---
+
+### maxResolution
+
+_This is a private RPC method._
+
+Returns the physical/native resolution of the connected or integral display, in pixels. Returns 0, 0 on a OTT/STB device when a display is not connected over HDMI
+
+Result:
+
+Capabilities:
+
+| Role | Capability                           |
+| ---- | ------------------------------------ |
+| uses | xrn:firebolt:capability:display:info |
+
+#### Examples
+
+Getting the display size
+
+---
+
+### size
+
+_This is a private RPC method._
+
+Returns the physical dimensions of the connected or integral display, in centimeters. Returns 0, 0 on a OTT/STB device when a display is not connected over HDMI
+
+Result:
+
+Capabilities:
+
+| Role | Capability                           |
+| ---- | ------------------------------------ |
+| uses | xrn:firebolt:capability:display:info |
+
+#### Examples
+
+Getting the display size
+
+---
+
+## Types

package/dist/docs/Internal/index.md

@@ -0,0 +1,68 @@
+---
+title: Internal
+---
+
+# Internal Module
+
+---
+
+Version Internal 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [initialize](#initialize)
+- [Types](#types)
+  - [InitializeResult](#initializeresult)
+
+## Overview
+
+Internal methods for SDK / FEE integration
+
+## Methods
+
+### initialize
+
+_This is a private RPC method._
+
+Initialize the SDK / FEE session.
+
+Parameters:
+
+| Param     | Type                                                   | Required | Description                      |
+| --------- | ------------------------------------------------------ | -------- | -------------------------------- |
+| `version` | [`SemanticVersion`](../Types/schemas/#SemanticVersion) | true     | The semantic version of the SDK. |
+
+Result:
+
+[InitializeResult](#initializeresult)
+
+Capabilities:
+
+| Role | Capability                                   |
+| ---- | -------------------------------------------- |
+| uses | xrn:firebolt:capability:lifecycle:initialize |
+
+#### Examples
+
+Default Example
+
+---
+
+## Types
+
+### InitializeResult
+
+```typescript
+type InitializeResult = {
+  version: SemanticVersion // The semantic version of the FEE.
+}
+```
+
+See also:
+
+[Types.SemanticVersion](../Types/schemas/#SemanticVersion)
+
+---