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

package/dist/lib/firebolt.d.ts

@@ -0,0 +1,795 @@
+/*
+ * Copyright 2021 Comcast Cable Communications Management, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export module Settings {
+  type LogLevel = 'WARN' | 'INFO' | 'DEBUG' | 'ERROR'
+  function setLogLevel(logLevel: LogLevel): void
+  function getLogLevel(): LogLevel
+}
+
+export module Log {
+  function info(...args: any[]): void
+  function debug(...args: any[]): void
+  function error(...args: any[]): void
+  function warn(...args: any[]): void
+}
+
+export module Events {
+  function listen(...args: any[]): Promise<number>
+  function once(...args: any[]): Promise<number>
+  function clear(...args: any[]): boolean
+}
+
+export module Accessibility {
+  type Event =
+    | 'onAudioDescriptionChanged'
+    | 'onClosedCaptionsSettingsChanged'
+    | 'onHighContrastUIChanged'
+    | 'onVoiceGuidanceSettingsChanged'
+
+  // Types
+
+  /**
+   *
+   */
+  type ClosedCaptionsSettings = {
+    enabled: boolean // Whether or not closed-captions should be enabled by default
+    preferredLanguages?: string[]
+  }
+
+  /**
+   *
+   */
+  type VoiceGuidanceSettings = {
+    enabled: boolean // Whether or not voice guidance should be enabled by default
+    rate: SpeechRate // The rate at which voice guidance speech will be read back to the user
+    navigationHints: boolean // Whether or not voice guidance should include additional navigation hints
+  }
+
+  /**
+   *
+   */
+  type SpeechRate = number
+
+  /**
+   *
+   */
+  type ISO639_2Language = string
+
+  /**
+   * Getter: Returns the audio description setting of the device
+   *
+   */
+  function audioDescription(): Promise<boolean>
+
+  /**
+   * Subscriber: Returns the audio description setting of the device
+   *
+   */
+  function audioDescription(
+    subscriber: (setting: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Turn off all listeners previously registered from this module.
+   */
+  function clear(): boolean
+
+  /**
+   * Clear a specific listen by the listener ID.
+   *
+   * @param {number} id The id of the listener to clear
+   */
+  function clear(id: number): boolean
+
+  /**
+   * Getter: Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference
+   *
+   */
+  function closedCaptionsSettings(): Promise<ClosedCaptionsSettings>
+
+  /**
+   * Subscriber: Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference
+   *
+   */
+  function closedCaptionsSettings(
+    subscriber: (closedCaptionsSettings: ClosedCaptionsSettings) => void,
+  ): Promise<number>
+
+  /**
+   * Getter: Returns the high contrast UI device setting
+   *
+   */
+  function highContrastUI(): Promise<boolean>
+
+  /**
+   * Subscriber: Returns the high contrast UI device setting
+   *
+   */
+  function highContrastUI(
+    subscriber: (highContrastUI: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the audio description setting of the device
+   *
+   * @param {'onAudioDescriptionChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onAudioDescriptionChanged',
+    callback: (setting: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the audio description setting of the device
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onAudioDescriptionChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onAudioDescriptionChanged',
+    callback: (setting: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference
+   *
+   * @param {'onClosedCaptionsSettingsChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onClosedCaptionsSettingsChanged',
+    callback: (enabled: boolean, preferredLanguages: string[]) => void,
+  ): Promise<number>
+
+  /**
+   * Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onClosedCaptionsSettingsChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onClosedCaptionsSettingsChanged',
+    callback: (enabled: boolean, preferredLanguages: string[]) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the high contrast UI device setting
+   *
+   * @param {'onHighContrastUIChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onHighContrastUIChanged',
+    callback: (highContrastUI: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the high contrast UI device setting
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onHighContrastUIChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onHighContrastUIChanged',
+    callback: (highContrastUI: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Returns voice guidance settings: enabled, rate, and verbosity
+   *
+   * @param {'onVoiceGuidanceSettingsChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onVoiceGuidanceSettingsChanged',
+    callback: (
+      enabled: boolean,
+      rate: SpeechRate,
+      navigationHints: boolean,
+    ) => void,
+  ): Promise<number>
+
+  /**
+   * Returns voice guidance settings: enabled, rate, and verbosity
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onVoiceGuidanceSettingsChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onVoiceGuidanceSettingsChanged',
+    callback: (
+      enabled: boolean,
+      rate: SpeechRate,
+      navigationHints: boolean,
+    ) => void,
+  ): Promise<number>
+
+  /**
+   * Getter: Returns voice guidance settings: enabled, rate, and verbosity
+   *
+   */
+  function voiceGuidanceSettings(): Promise<VoiceGuidanceSettings>
+
+  /**
+   * Subscriber: Returns voice guidance settings: enabled, rate, and verbosity
+   *
+   */
+  function voiceGuidanceSettings(
+    subscriber: (settings: VoiceGuidanceSettings) => void,
+  ): Promise<number>
+}
+
+export module Advertising {
+  // Types
+
+  /**
+   *
+   */
+  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
+  }
+
+  /**
+   * Returns the IFA.
+   *
+   */
+  function advertisingId(): Promise<AdvertisingIdResult>
+}
+
+export module Device {
+  type Event = 'onHdrChanged'
+
+  // Types
+
+  /**
+   * The type of device
+   */
+  enum DeviceClass {
+    OTT = 'ott',
+    STB = 'stb',
+    TV = 'tv',
+  }
+
+  /**
+   * The type of HDR format
+   */
+  type HDRFormatMap = {
+    hdr10: boolean
+    hdr10Plus: boolean
+    dolbyVision: boolean
+    hlg: boolean
+  }
+
+  /**
+   * Turn off all listeners previously registered from this module.
+   */
+  function clear(): boolean
+
+  /**
+   * Clear a specific listen by the listener ID.
+   *
+   * @param {number} id The id of the listener to clear
+   */
+  function clear(id: number): boolean
+
+  /**
+   * Returns the class of the device
+   *
+   */
+  function deviceClass(): Promise<DeviceClass>
+
+  /**
+   * Getter: Returns the HDR standards that are supported by the attached TV or the integral display
+   *
+   */
+  function hdr(): Promise<HDRFormatMap>
+
+  /**
+   * Subscriber: Returns the HDR standards that are supported by the attached TV or the integral display
+   *
+   */
+  function hdr(
+    subscriber: (negotiatedHdrFormats: HDRFormatMap) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the HDR standards that are supported by the attached TV or the integral display
+   *
+   * @param {'onHdrChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onHdrChanged',
+    callback: (negotiatedHdrFormats: HDRFormatMap) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the HDR standards that are supported by the attached TV or the integral display
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onHdrChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onHdrChanged',
+    callback: (negotiatedHdrFormats: HDRFormatMap) => void,
+  ): Promise<number>
+
+  /**
+   * Returns a persistent unique UUID for the current app and device. The UUID is reset when the app or device is reset
+   *
+   */
+  function uid(): Promise<string>
+}
+
+export module Localization {
+  type Event =
+    | 'onCountryChanged'
+    | 'onPreferredAudioLanguagesChanged'
+    | 'onPresentationLanguageChanged'
+
+  // Types
+
+  /**
+   *
+   */
+  type ISO639_2Language = string
+
+  /**
+   *
+   */
+  type CountryCode = string
+
+  /**
+   *
+   */
+  type Locale = string
+
+  /**
+   * Turn off all listeners previously registered from this module.
+   */
+  function clear(): boolean
+
+  /**
+   * Clear a specific listen by the listener ID.
+   *
+   * @param {number} id The id of the listener to clear
+   */
+  function clear(id: number): boolean
+
+  /**
+   * Getter: Returns the ISO 3166-1 alpha-2 code for the country device is located in.
+   *
+   */
+  function country(): Promise<string>
+
+  /**
+   * Subscriber: Returns the ISO 3166-1 alpha-2 code for the country device is located in.
+   *
+   */
+  function country(subscriber: (code: string) => void): Promise<number>
+
+  /**
+   * Returns the ISO 3166-1 alpha-2 code for the country device is located in.
+   *
+   * @param {'onCountryChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onCountryChanged',
+    callback: (code: string) => void,
+  ): Promise<number>
+
+  /**
+   * Returns the ISO 3166-1 alpha-2 code for the country device is located in.
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onCountryChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onCountryChanged',
+    callback: (code: string) => void,
+  ): Promise<number>
+
+  /**
+   * Returns a list of ISO 639-2/B codes for the preferred audio languages on this device.
+   *
+   * @param {'onPreferredAudioLanguagesChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onPreferredAudioLanguagesChanged',
+    callback: (languages: string[]) => void,
+  ): Promise<number>
+
+  /**
+   * Returns a list of ISO 639-2/B codes for the preferred audio languages on this device.
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onPreferredAudioLanguagesChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onPreferredAudioLanguagesChanged',
+    callback: (languages: string[]) => void,
+  ): Promise<number>
+
+  /**
+   * Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred locale
+   *
+   * @param {'onPresentationLanguageChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onPresentationLanguageChanged',
+    callback: (locale: string) => void,
+  ): Promise<number>
+
+  /**
+   * Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred locale
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onPresentationLanguageChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onPresentationLanguageChanged',
+    callback: (locale: string) => void,
+  ): Promise<number>
+
+  /**
+   * Getter: Returns a list of ISO 639-2/B codes for the preferred audio languages on this device.
+   *
+   */
+  function preferredAudioLanguages(): Promise<string[]>
+
+  /**
+   * Subscriber: Returns a list of ISO 639-2/B codes for the preferred audio languages on this device.
+   *
+   */
+  function preferredAudioLanguages(
+    subscriber: (languages: string[]) => void,
+  ): Promise<number>
+
+  /**
+   * Getter: Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred locale
+   *
+   */
+  function presentationLanguage(): Promise<string>
+
+  /**
+   * Subscriber: Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred locale
+   *
+   */
+  function presentationLanguage(
+    subscriber: (locale: string) => void,
+  ): Promise<number>
+}
+
+export module Metrics {
+  // Types
+
+  /**
+   *
+   */
+  enum ErrorType {
+    NETWORK = 'network',
+    MEDIA = 'media',
+    RESTRICTION = 'restriction',
+    ENTITLEMENT = 'entitlement',
+    OTHER = 'other',
+  }
+
+  /**
+   * Represents a position inside playback content, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration.
+   */
+  type MediaPosition = void | number | number
+
+  /**
+   *
+   */
+  type FlatMap = {}
+
+  /**
+   * The policy that describes various age groups to which content is directed. See distributor documentation for further details.
+   */
+  type AgePolicy = string | 'app:adult' | 'app:child' | 'app:teen'
+
+  /**
+   * Inform the platform about an app's build info.
+   *
+   * @param {string} build The build / version of this app.
+   */
+  function appInfo(build: string): Promise<null>
+
+  /**
+   * Inform the platform of an error that has occurred in your app.
+   *
+   * @param {ErrorType} type The type of error
+   * @param {string} code an app-specific error code
+   * @param {string} description A short description of the error
+   * @param {boolean} visible Whether or not this error was visible to the user.
+   * @param {object} parameters Optional additional parameters to be logged with the error
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function error(
+    type: ErrorType,
+    code: string,
+    description: string,
+    visible: boolean,
+    parameters?: object,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Inform the platform of 1st party distributor metrics. 'data' parameter is a JSON document
+   *
+   * @param {string} schema The schema URI of the metric type
+   * @param {string} data A JSON payload
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function event(
+    schema: string,
+    data: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when playback has stopped because the end of the media was reached.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaEnded(entityId: string, agePolicy?: AgePolicy): Promise<boolean>
+
+  /**
+   * Called when setting the URL of a media asset to play, in order to infer load time.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaLoadStart(
+    entityId: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when media playback will pause due to an intentional pause operation.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaPause(entityId: string, agePolicy?: AgePolicy): Promise<boolean>
+
+  /**
+   * Called when media playback should start due to autoplay, user-initiated play, or unpausing.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaPlay(entityId: string, agePolicy?: AgePolicy): Promise<boolean>
+
+  /**
+   * Called when media playback actually starts due to autoplay, user-initiated play, unpausing, or recovering from a buffering interruption.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaPlaying(
+    entityId: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when the playback rate of media is changed.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {number} rate The new playback rate.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaRateChanged(
+    entityId: string,
+    rate: number,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when the playback rendition (e.g. bitrate, dimensions, profile, etc) is changed.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {number} bitrate The new bitrate in kbps.
+   * @param {number} width The new resolution width.
+   * @param {number} height The new resolution height.
+   * @param {string} profile A description of the new profile, e.g. 'HDR' etc.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaRenditionChanged(
+    entityId: string,
+    bitrate: number,
+    width: number,
+    height: number,
+    profile?: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when a seek is completed during media playback.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {MediaPosition} position Resulting position of the seek operation, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaSeeked(
+    entityId: string,
+    position: MediaPosition,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when a seek is initiated during media playback.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {MediaPosition} target Target destination of the seek, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaSeeking(
+    entityId: string,
+    target: MediaPosition,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Called when media playback will halt due to a network, buffer, or other unintentional constraint.
+   *
+   * @param {string} entityId The entityId of the media.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function mediaWaiting(
+    entityId: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Inform the platform that your user has navigated to a page or view.
+   *
+   * @param {string} pageId Page ID of the content.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function page(pageId: string, agePolicy?: AgePolicy): Promise<boolean>
+
+  /**
+   * Inform the platform that your app is minimally usable. This method is called automatically by `Lifecycle.ready()`
+   *
+   */
+  function ready(): Promise<boolean>
+
+  /**
+   * Inform the platform that your user has started content.
+   *
+   * @param {string} entityId Optional entity ID of the content.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function startContent(
+    entityId?: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+
+  /**
+   * Inform the platform that your user has stopped content.
+   *
+   * @param {string} entityId Optional entity ID of the content.
+   * @param {AgePolicy} agePolicy The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.
+   */
+  function stopContent(
+    entityId?: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+}
+
+export module Network {
+  type Event = 'onConnectedChanged'
+
+  // Types
+
+  /**
+   * Indicates whether the device currently has a usable network connection.
+   */
+  type Connected = boolean
+
+  /**
+   * Turn off all listeners previously registered from this module.
+   */
+  function clear(): boolean
+
+  /**
+   * Clear a specific listen by the listener ID.
+   *
+   * @param {number} id The id of the listener to clear
+   */
+  function clear(id: number): boolean
+
+  /**
+   * Getter: Returns whether the device currently has a usable network connection.
+   *
+   */
+  function connected(): Promise<boolean>
+
+  /**
+   * Subscriber: Returns whether the device currently has a usable network connection.
+   *
+   */
+  function connected(subscriber: (success: boolean) => void): Promise<number>
+
+  /**
+   * Returns whether the device currently has a usable network connection.
+   *
+   * @param {'onConnectedChanged'} event
+   * @param {Function} callback
+   */
+  function listen(
+    event: 'onConnectedChanged',
+    callback: (success: boolean) => void,
+  ): Promise<number>
+
+  /**
+   * Returns whether the device currently has a usable network connection.
+   * When using `once` the callback method will only fire once, and then disconnect your listener
+   *
+   * @param {'onConnectedChanged'} event
+   * @param {Function} callback
+   */
+  function once(
+    event: 'onConnectedChanged',
+    callback: (success: boolean) => void,
+  ): Promise<number>
+}
+
+export module Discovery {
+  // Types
+
+  /**
+   * The policy that describes various age groups to which content is directed. See distributor documentation for further details.
+   */
+  type AgePolicy = string | 'app:adult' | 'app:child' | 'app:teen'
+
+  /**
+   * Notify the platform that content was partially or completely watched
+   *
+   * @param {string} entityId The entity Id of the watched content.
+   * @param {number} progress How much of the content has been watched (percentage as (0-0.999) for VOD, number of seconds for live)
+   * @param {boolean} completed Whether or not this viewing is considered "complete," per the app's definition thereof
+   * @param {string} watchedOn Date/Time the content was watched, ISO 8601 Date/Time
+   * @param {AgePolicy} agePolicy
+   */
+  function watched(
+    entityId: string,
+    progress?: number,
+    completed?: boolean,
+    watchedOn?: string,
+    agePolicy?: AgePolicy,
+  ): Promise<boolean>
+}