From fa5cb967cb01cb22fa44b636541b227c4e5ff763 Mon Sep 17 00:00:00 2001 From: Kevin Pearson Date: Mon, 9 Sep 2024 10:28:42 -0700 Subject: [PATCH] add compare for next --- apis/compare/core/Accessibility/index.md | 4 +- .../core/Accessibility/schemas/index.md | 6 +- apis/compare/core/Account/index.md | 4 +- apis/compare/core/Advertising/index.md | 45 ++-- .../compare/core/Advertising/schemas/index.md | 2 +- apis/compare/core/Authentication/index.md | 24 ++- apis/compare/core/Capabilities/index.md | 4 +- .../core/Capabilities/schemas/index.md | 2 +- apis/compare/core/Device/index.md | 193 +++++++++++++---- apis/compare/core/Discovery/index.md | 122 +++++++++-- apis/compare/core/Discovery/schemas/index.md | 2 +- .../core/Entertainment/schemas/index.md | 2 +- apis/compare/core/Entity/schemas/index.md | 2 +- apis/compare/core/Intents/schemas/index.md | 2 +- apis/compare/core/Internal/index.md | 21 +- apis/compare/core/Keyboard/index.md | 4 +- apis/compare/core/Lifecycle/index.md | 4 +- apis/compare/core/Lifecycle/schemas/index.md | 2 +- apis/compare/core/Localization/index.md | 6 +- .../core/Localization/schemas/index.md | 2 +- apis/compare/core/Metrics/index.md | 4 +- apis/compare/core/Parameters/index.md | 4 +- apis/compare/core/Profile/index.md | 4 +- apis/compare/core/SecondScreen/index.md | 10 +- .../core/SecondScreen/schemas/index.md | 2 +- apis/compare/core/SecureStorage/index.md | 4 +- apis/compare/core/Types/schemas/index.md | 22 +- apis/compare/core/changelog.md | 2 +- apis/compare/core/changelog/index.md | 196 ++++++++++++++++++ apis/compare/core/index.md | 2 +- .../discovery/Accessibility/schemas/index.md | 6 +- .../discovery/Advertising/schemas/index.md | 2 +- .../discovery/Capabilities/schemas/index.md | 2 +- apis/compare/discovery/Content/index.md | 4 +- .../discovery/Discovery/schemas/index.md | 2 +- .../discovery/Entertainment/schemas/index.md | 2 +- .../compare/discovery/Entity/schemas/index.md | 2 +- .../discovery/Intents/schemas/index.md | 2 +- .../discovery/Lifecycle/schemas/index.md | 2 +- .../discovery/Localization/schemas/index.md | 2 +- .../discovery/SecondScreen/schemas/index.md | 2 +- apis/compare/discovery/Types/schemas/index.md | 22 +- apis/compare/discovery/changelog.md | 2 +- apis/compare/discovery/index.md | 2 +- apis/compare/index.md | 25 ++- .../manage/Accessibility/schemas/index.md | 6 +- apis/compare/manage/Account/index.md | 4 +- .../manage/AcknowledgeChallenge/index.md | 4 +- apis/compare/manage/Advertising/index.md | 4 +- .../manage/Advertising/schemas/index.md | 2 +- .../compare/manage/AudioDescriptions/index.md | 4 +- .../manage/Capabilities/schemas/index.md | 2 +- apis/compare/manage/ClosedCaptions/index.md | 4 +- apis/compare/manage/Device/index.md | 4 +- apis/compare/manage/Discovery/index.md | 4 +- .../compare/manage/Discovery/schemas/index.md | 2 +- .../manage/Entertainment/schemas/index.md | 2 +- apis/compare/manage/Entity/schemas/index.md | 2 +- apis/compare/manage/HDMIInput/index.md | 4 +- apis/compare/manage/Intents/schemas/index.md | 2 +- apis/compare/manage/Keyboard/index.md | 4 +- .../compare/manage/Lifecycle/schemas/index.md | 2 +- apis/compare/manage/Localization/index.md | 16 +- .../manage/Localization/schemas/index.md | 2 +- apis/compare/manage/Metrics/index.md | 4 +- apis/compare/manage/PinChallenge/index.md | 4 +- apis/compare/manage/Privacy/index.md | 4 +- .../manage/SecondScreen/schemas/index.md | 2 +- apis/compare/manage/SecureStorage/index.md | 4 +- apis/compare/manage/Types/schemas/index.md | 22 +- apis/compare/manage/UserGrants/index.md | 4 +- apis/compare/manage/VoiceGuidance/index.md | 4 +- apis/compare/manage/Wifi/index.md | 4 +- apis/compare/manage/changelog.md | 2 +- apis/compare/manage/changelog/index.md | 93 +++++++++ apis/compare/manage/index.md | 2 +- 76 files changed, 766 insertions(+), 239 deletions(-) create mode 100644 apis/compare/core/changelog/index.md create mode 100644 apis/compare/manage/changelog/index.md diff --git a/apis/compare/core/Accessibility/index.md b/apis/compare/core/Accessibility/index.md index a3b474c1f..9c578b495 100644 --- a/apis/compare/core/Accessibility/index.md +++ b/apis/compare/core/Accessibility/index.md @@ -1,7 +1,7 @@ --- title: Accessibility -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Accessibility 1.3.0 +Version Accessibility 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Accessibility/schemas/index.md b/apis/compare/core/Accessibility/schemas/index.md index d796a18df..2518e935b 100644 --- a/apis/compare/core/Accessibility/schemas/index.md +++ b/apis/compare/core/Accessibility/schemas/index.md @@ -1,7 +1,7 @@ --- title: Accessibility -version: 1.3.0 +version: next layout: default sdk: core --- @@ -56,7 +56,7 @@ undefined ```typescript type VoiceGuidanceSettings = { enabled: boolean // Whether or not voice guidance should be enabled by default - speed: VoiceSpeed // The speed at which voice guidance speech will be read back to the user + speed?: VoiceSpeed // The speed at which voice guidance speech will be read back to the user } ``` @@ -142,7 +142,7 @@ type ClosedCaptionsStyles = { ```typescript type ClosedCaptionsSettings = { enabled: boolean // Whether or not closed-captions should be enabled by default - styles: ClosedCaptionsStyles // The default styles to use when displaying closed-captions + styles?: ClosedCaptionsStyles // The default styles to use when displaying closed-captions preferredLanguages?: string[] } ``` diff --git a/apis/compare/core/Account/index.md b/apis/compare/core/Account/index.md index 08835b989..0b647dfd1 100644 --- a/apis/compare/core/Account/index.md +++ b/apis/compare/core/Account/index.md @@ -1,7 +1,7 @@ --- title: Account -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Account 1.3.0 +Version Account 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Advertising/index.md b/apis/compare/core/Advertising/index.md index d2343251e..0b6777070 100644 --- a/apis/compare/core/Advertising/index.md +++ b/apis/compare/core/Advertising/index.md @@ -1,7 +1,7 @@ --- title: Advertising -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Advertising 1.3.0 +Version Advertising 1.4.0-next.3 ## Table of Contents @@ -31,6 +31,7 @@ Version Advertising 1.3.0 - [AdConfigurationOptions](#adconfigurationoptions) - [AdPolicy](#adpolicy) - [AdvertisingIdOptions](#advertisingidoptions) + - [AdvertisingIdResult](#advertisingidresult) ## Usage @@ -48,10 +49,12 @@ A module for platform provided advertising settings and functionality. ### advertisingId -Get the advertising ID +Get the IAB compliant identifier for advertising (IFA). It is recommended to use the IFA to manage advertising related activities while respecting the user's privacy settings. ```typescript -function advertisingId(options: AdvertisingIdOptions): Promise +function advertisingId( + options: AdvertisingIdOptions, +): Promise ``` Parameters: @@ -62,6 +65,8 @@ Parameters: Promise resolution: +[AdvertisingIdResult](#advertisingidresult) + Capabilities: | Role | Capability | @@ -86,7 +91,7 @@ Value of `advertisingId`: ```javascript { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } ``` @@ -112,7 +117,7 @@ Response: "id": 1, "result": { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } } @@ -138,7 +143,7 @@ Value of `advertisingId`: ```javascript { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } ``` @@ -171,7 +176,7 @@ Response: "id": 1, "result": { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } } @@ -197,7 +202,7 @@ Value of `advertisingId`: ```javascript { "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD", - "ifa_type": "idfa", + "ifa_type": "sspid", "lmt": "0" } ``` @@ -272,7 +277,7 @@ console.log(appBundleId) Value of `appBundleId`: ```javascript -'operator.app' +'app.operator' ```
@@ -294,7 +299,7 @@ Response: { "jsonrpc": "2.0", "id": 1, - "result": "operator.app" + "result": "app.operator" } ``` @@ -599,9 +604,9 @@ Promise resolution: Capabilities: -| Role | Capability | -| ---- | ------------------------------------------------------------------------------------------------- | -| uses | xrn:firebolt:capability:privacy:advertising
xrn:firebolt:capability:advertising:configuration | +| Role | Capability | +| ---- | ------------------------------------------ | +| uses | xrn:firebolt:capability:advertising:policy | #### Examples @@ -769,3 +774,15 @@ type AdvertisingIdOptions = { ``` --- + +### AdvertisingIdResult + +```typescript +type AdvertisingIdResult = { + ifa: string // UUID conforming to IAB standard + ifa_type: string // 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 +} +``` + +--- diff --git a/apis/compare/core/Advertising/schemas/index.md b/apis/compare/core/Advertising/schemas/index.md index 06c839699..937dbae70 100644 --- a/apis/compare/core/Advertising/schemas/index.md +++ b/apis/compare/core/Advertising/schemas/index.md @@ -1,7 +1,7 @@ --- title: Advertising -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Authentication/index.md b/apis/compare/core/Authentication/index.md index 47d75cc68..ad90227b2 100644 --- a/apis/compare/core/Authentication/index.md +++ b/apis/compare/core/Authentication/index.md @@ -1,7 +1,7 @@ --- title: Authentication -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Authentication 1.3.0 +Version Authentication 1.4.0-next.3 ## Table of Contents @@ -24,6 +24,7 @@ Version Authentication 1.3.0 - [token](#token) - [Types](#types) - [TokenType](#tokentype) + - [AuthenticationTokenResult](#authenticationtokenresult) ## Usage @@ -230,7 +231,10 @@ Response: Get a specific `type` of authentication token ```typescript -function token(type: TokenType, options: object): Promise +function token( + type: TokenType, + options: object, +): Promise ``` Parameters: @@ -242,6 +246,8 @@ Parameters: Promise resolution: +[AuthenticationTokenResult](#authenticationtokenresult) + Capabilities: | Role | Capability | @@ -429,3 +435,15 @@ TokenType: { ``` --- + +### AuthenticationTokenResult + +```typescript +type AuthenticationTokenResult = { + value: string + expires?: string + type?: string +} +``` + +--- diff --git a/apis/compare/core/Capabilities/index.md b/apis/compare/core/Capabilities/index.md index 762bc5eb7..25c4a39c5 100644 --- a/apis/compare/core/Capabilities/index.md +++ b/apis/compare/core/Capabilities/index.md @@ -1,7 +1,7 @@ --- title: Capabilities -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Capabilities 1.3.0 +Version Capabilities 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Capabilities/schemas/index.md b/apis/compare/core/Capabilities/schemas/index.md index 5a862f6ff..e337ddeda 100644 --- a/apis/compare/core/Capabilities/schemas/index.md +++ b/apis/compare/core/Capabilities/schemas/index.md @@ -1,7 +1,7 @@ --- title: Capabilities -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Device/index.md b/apis/compare/core/Device/index.md index 5481a5af6..017969e26 100644 --- a/apis/compare/core/Device/index.md +++ b/apis/compare/core/Device/index.md @@ -1,7 +1,7 @@ --- title: Device -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Device 1.3.0 +Version Device 1.4.0-next.3 ## Table of Contents @@ -48,8 +48,12 @@ Version Device 1.3.0 - [Types](#types) - [NetworkState](#networkstate) - [NetworkType](#networktype) + - [HDRFormatMap](#hdrformatmap) - [AudioProfiles](#audioprofiles) - [Resolution](#resolution) + - [NetworkInfoResult](#networkinforesult) + - [DeviceVersion](#deviceversion) + - [HDCPVersionMap](#hdcpversionmap) ## Usage @@ -67,7 +71,9 @@ A module for querying about the device and it's capabilities. ### audio -Get the supported audio profiles +Get the supported audio profiles for the connected devices. + +It is not recommended to use this API for visual badging on content within your app since this does not reflect the settings of the user. To get the value of `audio` call the method like this: @@ -215,7 +221,7 @@ Response: ### distributor -Get the distributor ID for this device +Get the name of the entity which is distributing the current device. There can be multiple distributors which distribute the same device model. To get the value of `distributor` call the method like this: @@ -279,17 +285,19 @@ Response: ### hdcp -Get the supported HDCP profiles +Get the negotiated HDCP profiles for a connected device. + +For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles. To get the value of `hdcp` call the method like this: ```typescript -function hdcp(): Promise +function hdcp(): Promise ``` Promise resolution: -[BooleanMap](../Types/schemas/#BooleanMap) +[HDCPVersionMap](#hdcpversionmap) Capabilities: @@ -299,18 +307,18 @@ Capabilities: #### Examples -Getting the supported HDCP profiles +Getting the supported HDCP versions JavaScript: ```javascript import { Device } from '@firebolt-js/sdk' -let supportedHdcpProfiles = await Device.hdcp() -console.log(supportedHdcpProfiles) +let supportedHdcpVersions = await Device.hdcp() +console.log(supportedHdcpVersions) ``` -Value of `supportedHdcpProfiles`: +Value of `supportedHdcpVersions`: ```javascript { @@ -352,7 +360,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function hdcp(callback: (value) => BooleanMap): Promise +function hdcp(callback: (value) => HDCPVersionMap): Promise ``` Promise resolution: @@ -363,7 +371,7 @@ number #### Examples -Getting the supported HDCP profiles +Getting the supported HDCP versions JavaScript: @@ -376,7 +384,7 @@ let listenerId = await hdcp((value) => { console.log(listenerId) ``` -Value of `supportedHdcpProfiles`: +Value of `supportedHdcpVersions`: ```javascript { @@ -419,17 +427,17 @@ Response: ### hdr -Get the supported HDR profiles +Get the negotiated HDR formats for the connected display and device To get the value of `hdr` call the method like this: ```typescript -function hdr(): Promise +function hdr(): Promise ``` Promise resolution: -[BooleanMap](../Types/schemas/#BooleanMap) +[HDRFormatMap](#hdrformatmap) Capabilities: @@ -439,18 +447,18 @@ Capabilities: #### Examples -Getting the supported HDR profiles +Getting the supported HDR formats JavaScript: ```javascript import { Device } from '@firebolt-js/sdk' -let supportedHdrProfiles = await Device.hdr() -console.log(supportedHdrProfiles) +let supportedHdrFormats = await Device.hdr() +console.log(supportedHdrFormats) ``` -Value of `supportedHdrProfiles`: +Value of `supportedHdrFormats`: ```javascript { @@ -496,7 +504,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function hdr(callback: (value) => BooleanMap): Promise +function hdr(callback: (value) => HDRFormatMap): Promise ``` Promise resolution: @@ -507,7 +515,7 @@ number #### Examples -Getting the supported HDR profiles +Getting the supported HDR formats JavaScript: @@ -520,7 +528,7 @@ let listenerId = await hdr((value) => { console.log(listenerId) ``` -Value of `supportedHdrProfiles`: +Value of `supportedHdrFormats`: ```javascript { @@ -685,7 +693,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio ### make -Get the device make +Get the manufacturer of the device model To get the value of `make` call the method like this: @@ -749,7 +757,7 @@ Response: ### model -Get the device model +Get the manufacturer designated model of the device To get the value of `model` call the method like this: @@ -1032,11 +1040,13 @@ Get the current network status and type To get the value of `network` call the method like this: ```typescript -function network(): Promise +function network(): Promise ``` Promise resolution: +[NetworkInfoResult](#networkinforesult) + Capabilities: | Role | Capability | @@ -1098,7 +1108,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function network(callback: (value) => object): Promise +function network(callback: (value) => NetworkInfoResult): Promise ``` Promise resolution: @@ -1221,7 +1231,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio ### platform -Get the platform ID for this device +Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms. To get the value of `platform` call the method like this: @@ -1285,7 +1295,19 @@ Response: ### screenResolution -Get the current screen resolution +Get the resolution for the graphical surface of the app. + +The pairs returned will be of a [width, height] format and will correspond to the following values: + +NTSC Standard Definition (SD): [720, 480] + +PAL Standard Definition (SD): [720, 576] + +High Definition (HD): [1280, 720] + +Full HD (FHD): [1920, 1080] + +4K Ultra High Definition (UHD): [3840, 2160] To get the value of `screenResolution` call the method like this: @@ -1610,11 +1632,13 @@ Get the SDK, OS and other version info To get the value of `version` call the method like this: ```typescript -function version(): Promise +function version(): Promise ``` Promise resolution: +[DeviceVersion](#deviceversion) + Capabilities: | Role | Capability | @@ -1721,7 +1745,19 @@ Response: ### videoResolution -Get the current video resolution +Get the maximum supported video resolution of the currently connected device and display. + +The pairs returned will be of a [width, height] format and will correspond to the following values: + +NTSC Standard Definition (SD): [720, 480] + +PAL Standard Definition (SD): [720, 576] + +High Definition (HD): [1280, 720] + +Full HD (FHD): [1920, 1080] + +4K Ultra High Definition (UHD): [3840, 2160] To get the value of `videoResolution` call the method like this: @@ -1973,38 +2009,105 @@ NetworkType: { --- +### HDRFormatMap + +The type of HDR format that is supported + +```typescript +type HDRFormatMap = { + hdr10: boolean + hdr10Plus: boolean + dolbyVision: boolean + hlg: boolean +} +``` + +--- + ### AudioProfiles ```typescript type AudioProfiles = { - STEREO?: boolean + stereo: boolean + dolbyDigital5_1: boolean + dolbyDigital5_1_plus: boolean + dolbyAtmos: boolean +} +``` - DOLBY_DIGITAL_5_1?: boolean +--- + +### Resolution - DOLBY_DIGITAL_7_1?: boolean +```typescript +type Resolution = + | [ + 720, // undefined Width in pixels item + 480, // undefined Height in pixels item + ] + | [ + 720, // undefined Width in pixels item + 576, // undefined Height in pixels item + ] + | [ + 1280, // undefined Width in pixels item + 720, // undefined Height in pixels item + ] + | [ + 1920, // undefined Width in pixels item + 1080, // undefined Height in pixels item + ] + | [ + 3840, // undefined Width in pixels item + 2160, // undefined Height in pixels item + ] +``` - DOLBY_DIGITAL_5_1_PLUS?: boolean +--- - DOLBY_DIGITAL_7_1_PLUS?: boolean +### NetworkInfoResult - DOLBY_ATMOS?: boolean +```typescript +type NetworkInfoResult = { + state: NetworkState // The type of network that is currently active + type: NetworkType // The type of network that is currently active } ``` See also: -[BooleanMap](../Types/schemas/#BooleanMap) -[AudioProfile](../Types/schemas/#AudioProfile) +[NetworkState](#networkstate) +[NetworkType](#networktype) --- -### Resolution +### DeviceVersion ```typescript -type Resolution = [ - number, // undefined item - number, // undefined item -] +type DeviceVersion = { + sdk?: SemanticVersion // The Firebolt SDK version + api: SemanticVersion // The latest Firebolt API version supported by the current device. + firmware: SemanticVersion // The firmware version as reported by the device + os: SemanticVersion // **Deprecated** Use `firmware`, instead. + debug?: string // Detailed version as a string, for debugging purposes +} +``` + +See also: + +[SemanticVersion](../Types/schemas/#SemanticVersion) + +--- + +### HDCPVersionMap + +The type of HDCP versions that is supported + +```typescript +type HDCPVersionMap = { + hdcp1_4: boolean + hdcp2_2: boolean +} ``` --- diff --git a/apis/compare/core/Discovery/index.md b/apis/compare/core/Discovery/index.md index 9af69a123..c3227be8b 100644 --- a/apis/compare/core/Discovery/index.md +++ b/apis/compare/core/Discovery/index.md @@ -1,7 +1,7 @@ --- title: Discovery -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Discovery 1.3.0 +Version Discovery 1.4.0-next.3 ## Table of Contents @@ -2325,18 +2325,15 @@ JavaScript: ```javascript import { Discovery } from '@firebolt-js/sdk' -let success = await Discovery.launch( - 'xrn:firebolt:application-type:settings ', - { - action: 'section', - data: { - sectionName: 'settings', - }, - context: { - source: 'voice', - }, +let success = await Discovery.launch('xrn:firebolt:application-type:settings', { + action: 'section', + data: { + sectionName: 'settings', }, -) + context: { + source: 'voice', + }, +}) console.log(success) ``` @@ -2356,7 +2353,7 @@ Request: "id": 1, "method": "Discovery.launch", "params": { - "appId": "xrn:firebolt:application-type:settings ", + "appId": "xrn:firebolt:application-type:settings", "intent": { "action": "section", "data": { @@ -2504,6 +2501,91 @@ Response: +Launch the Aggregated Experience to it's search screen. + +JavaScript: + +```javascript +import { Discovery } from '@firebolt-js/sdk' + +let success = await Discovery.launch('xrn:firebolt:application-type:main', { + action: 'search', + data: { + query: 'a cool show', + suggestions: [ + { + entityType: 'program', + programType: 'movie', + entityId: 'xyz', + }, + { + entityType: 'music', + musicType: 'song', + entityId: 'abc', + }, + ], + }, + context: { + source: 'voice', + }, +}) +console.log(success) +``` + +Value of `success`: + +```javascript +true +``` + +
+JSON-RPC: +Request: + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "method": "Discovery.launch", + "params": { + "appId": "xrn:firebolt:application-type:main", + "intent": { + "action": "search", + "data": { + "query": "a cool show", + "suggestions": [ + { + "entityType": "program", + "programType": "movie", + "entityId": "xyz" + }, + { + "entityType": "music", + "musicType": "song", + "entityId": "abc" + } + ] + }, + "context": { + "source": "voice" + } + } + } +} +``` + +Response: + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +``` + +
+ --- ### listen @@ -3572,12 +3654,12 @@ function watched( 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-1 for VOD, number of seconds for live)
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
format: date-time | +| 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)
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
format: date-time | Promise resolution: diff --git a/apis/compare/core/Discovery/schemas/index.md b/apis/compare/core/Discovery/schemas/index.md index ae31c0049..73f89ef4b 100644 --- a/apis/compare/core/Discovery/schemas/index.md +++ b/apis/compare/core/Discovery/schemas/index.md @@ -1,7 +1,7 @@ --- title: Discovery -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Entertainment/schemas/index.md b/apis/compare/core/Entertainment/schemas/index.md index 2a83879bc..a827bd27b 100644 --- a/apis/compare/core/Entertainment/schemas/index.md +++ b/apis/compare/core/Entertainment/schemas/index.md @@ -1,7 +1,7 @@ --- title: Entertainment -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Entity/schemas/index.md b/apis/compare/core/Entity/schemas/index.md index 411b0f397..17d629f35 100644 --- a/apis/compare/core/Entity/schemas/index.md +++ b/apis/compare/core/Entity/schemas/index.md @@ -1,7 +1,7 @@ --- title: Entity -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Intents/schemas/index.md b/apis/compare/core/Intents/schemas/index.md index 78cf9a96a..f5fa246ba 100644 --- a/apis/compare/core/Intents/schemas/index.md +++ b/apis/compare/core/Intents/schemas/index.md @@ -1,7 +1,7 @@ --- title: Intents -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Internal/index.md b/apis/compare/core/Internal/index.md index d6a3a5b23..9d414fb56 100644 --- a/apis/compare/core/Internal/index.md +++ b/apis/compare/core/Internal/index.md @@ -1,7 +1,7 @@ --- title: Internal -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Internal 1.3.0 +Version Internal 1.4.0-next.3 ## Table of Contents @@ -19,6 +19,7 @@ Version Internal 1.3.0 - [Methods](#methods) - [initialize](#initialize) - [Types](#types) + - [InitializeResult](#initializeresult) ## Overview @@ -40,6 +41,8 @@ Parameters: Result: +[InitializeResult](#initializeresult) + Capabilities: | Role | Capability | @@ -90,3 +93,17 @@ Response: --- ## Types + +### InitializeResult + +```typescript +type InitializeResult = { + version: SemanticVersion // The semantic version of the FEE. +} +``` + +See also: + +[SemanticVersion](../Types/schemas/#SemanticVersion) + +--- diff --git a/apis/compare/core/Keyboard/index.md b/apis/compare/core/Keyboard/index.md index f44aa38e8..2d524d861 100644 --- a/apis/compare/core/Keyboard/index.md +++ b/apis/compare/core/Keyboard/index.md @@ -1,7 +1,7 @@ --- title: Keyboard -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Keyboard 1.3.0 +Version Keyboard 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Lifecycle/index.md b/apis/compare/core/Lifecycle/index.md index b95f6a9b8..b2cc20b1a 100644 --- a/apis/compare/core/Lifecycle/index.md +++ b/apis/compare/core/Lifecycle/index.md @@ -1,7 +1,7 @@ --- title: Lifecycle -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Lifecycle 1.3.0 +Version Lifecycle 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Lifecycle/schemas/index.md b/apis/compare/core/Lifecycle/schemas/index.md index a62a49e2e..9589a8662 100644 --- a/apis/compare/core/Lifecycle/schemas/index.md +++ b/apis/compare/core/Lifecycle/schemas/index.md @@ -1,7 +1,7 @@ --- title: Lifecycle -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Localization/index.md b/apis/compare/core/Localization/index.md index b069d14d9..dd4c562ee 100644 --- a/apis/compare/core/Localization/index.md +++ b/apis/compare/core/Localization/index.md @@ -1,7 +1,7 @@ --- title: Localization -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Localization 1.3.0 +Version Localization 1.4.0-next.3 ## Table of Contents @@ -54,7 +54,7 @@ Methods for accessessing location and language preferences ### additionalInfo -Get any platform-specific localization information, in an Map +Get any platform-specific localization information ```typescript function additionalInfo(): Promise diff --git a/apis/compare/core/Localization/schemas/index.md b/apis/compare/core/Localization/schemas/index.md index a94465654..c393caa87 100644 --- a/apis/compare/core/Localization/schemas/index.md +++ b/apis/compare/core/Localization/schemas/index.md @@ -1,7 +1,7 @@ --- title: Localization -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/Metrics/index.md b/apis/compare/core/Metrics/index.md index e16a44030..d02e672b7 100644 --- a/apis/compare/core/Metrics/index.md +++ b/apis/compare/core/Metrics/index.md @@ -1,7 +1,7 @@ --- title: Metrics -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Metrics 1.3.0 +Version Metrics 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Parameters/index.md b/apis/compare/core/Parameters/index.md index 2abfc3b7d..cfb1cbaef 100644 --- a/apis/compare/core/Parameters/index.md +++ b/apis/compare/core/Parameters/index.md @@ -1,7 +1,7 @@ --- title: Parameters -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Parameters 1.3.0 +Version Parameters 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Profile/index.md b/apis/compare/core/Profile/index.md index 87effd0f5..4bbe03b77 100644 --- a/apis/compare/core/Profile/index.md +++ b/apis/compare/core/Profile/index.md @@ -1,7 +1,7 @@ --- title: Profile -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version Profile 1.3.0 +Version Profile 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/SecondScreen/index.md b/apis/compare/core/SecondScreen/index.md index b9fd65c4e..7d2a83902 100644 --- a/apis/compare/core/SecondScreen/index.md +++ b/apis/compare/core/SecondScreen/index.md @@ -1,7 +1,7 @@ --- title: SecondScreen -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version SecondScreen 1.3.0 +Version SecondScreen 1.4.0-next.3 ## Table of Contents @@ -361,9 +361,9 @@ Promise resolution: Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | -| uses | xrn:firebolt:capability:device:info | +| Role | Capability | +| ---- | --------------------------------------------- | +| uses | xrn:firebolt:capability:secondscreen:protocol | #### Examples diff --git a/apis/compare/core/SecondScreen/schemas/index.md b/apis/compare/core/SecondScreen/schemas/index.md index e9104b431..f4d9b5127 100644 --- a/apis/compare/core/SecondScreen/schemas/index.md +++ b/apis/compare/core/SecondScreen/schemas/index.md @@ -1,7 +1,7 @@ --- title: SecondScreen -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/SecureStorage/index.md b/apis/compare/core/SecureStorage/index.md index ea79bddf7..4245e09da 100644 --- a/apis/compare/core/SecureStorage/index.md +++ b/apis/compare/core/SecureStorage/index.md @@ -1,7 +1,7 @@ --- title: SecureStorage -version: 1.3.0 +version: next layout: default sdk: core --- @@ -10,7 +10,7 @@ sdk: core --- -Version SecureStorage 1.3.0 +Version SecureStorage 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/core/Types/schemas/index.md b/apis/compare/core/Types/schemas/index.md index f5ad6e907..fc657dffd 100644 --- a/apis/compare/core/Types/schemas/index.md +++ b/apis/compare/core/Types/schemas/index.md @@ -1,7 +1,7 @@ --- title: Types -version: 1.3.0 +version: next layout: default sdk: core --- @@ -19,9 +19,9 @@ Version Types 0.0.0-unknown.0 - [Types](#types) - [AudioProfile](#audioprofile) - [SemanticVersion](#semanticversion) - - [BooleanMap](#booleanmap) - [LocalizedString](#localizedstring) - [FlatMap](#flatmap) + - [BooleanMap](#booleanmap) - [Timeout](#timeout) ## Overview @@ -36,9 +36,7 @@ undefined AudioProfile: { STEREO: 'stereo', DOLBY_DIGITAL_5_1: 'dolbyDigital5.1', - DOLBY_DIGITAL_7_1: 'dolbyDigital7.1', DOLBY_DIGITAL_5_1_PLUS: 'dolbyDigital5.1+', - DOLBY_DIGITAL_7_1_PLUS: 'dolbyDigital7.1+', DOLBY_ATMOS: 'dolbyAtmos', }, @@ -59,14 +57,6 @@ type SemanticVersion = { --- -### BooleanMap - -```typescript -type BooleanMap = {} -``` - ---- - ### LocalizedString Localized string supports either a simple `string` or a Map of language codes to strings. When using a simple `string`, the current preferred langauge from `Localization.langauge()` is assumed. @@ -85,6 +75,14 @@ type LocalizedString = string | object --- +### BooleanMap + +```typescript +type BooleanMap = {} +``` + +--- + ### Timeout Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error. diff --git a/apis/compare/core/changelog.md b/apis/compare/core/changelog.md index 79e71a84e..793ddb5b7 100644 --- a/apis/compare/core/changelog.md +++ b/apis/compare/core/changelog.md @@ -1,7 +1,7 @@ --- title: Change Log -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/core/changelog/index.md b/apis/compare/core/changelog/index.md new file mode 100644 index 000000000..74560e37a --- /dev/null +++ b/apis/compare/core/changelog/index.md @@ -0,0 +1,196 @@ +--- +title: Change Log + +version: next +layout: default +sdk: core +--- +# [0.17.1](https://github.com/rdkcentral/firebolt-apis/compare/v0.17.0...v0.17.1) (2023-09-15) + +### Bug Fixes + +fix: Add enumerated values for fontFamily/fontEdge (#181) + +# [0.17.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.16.0...v0.17.0) (2023-09-07) + +### Bug Fixes + +* fix: Using 3 letter ISO639 language codes ([#173](https://github.com/rdkcentral/firebolt-apis/issues/173)) + +# [0.15.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.14.0...v0.15.0) (2023-07-31) + +### Bug Fixes + +* Rename Advisory "Committee" to "Board" ([#135](https://github.com/rdkcentral/firebolt-apis/issues/135)) ([ef410c4](https://github.com/rdkcentral/firebolt-apis/commit/ef410c43bbb32414c3aa1d11b43093565cc90edf)) +* window fix from firebolt-openrpc 2.0.3 ([8c06dd1](https://github.com/rdkcentral/firebolt-apis/commit/8c06dd1432822719f5634e2877b36efdf02a4809)) + +### Features + +* **Nullable CC Styles** Added support to set and get null in ClosedCaptions style fields ([#150](https://github.com/rdkcentral/firebolt-apis/issues/150)) ([9c511e4](https://github.com/rdkcentral/firebolt-apis/commit/9c511e4fddebcdf5dfc04e9e8e31f98ab7eef680)) +* **Window CC Styles** Added windowColor and windowOpacity to closedCaptions style ([#145](https://github.com/rdkcentral/firebolt-apis/issues/145)) ([f65b901](https://github.com/rdkcentral/firebolt-apis/commit/f65b9019bda22400df9b9634c332e720db38118d)) +* **Audio Descriptions** Audio Description and Preferred Audio Languages Settings ([#45](https://github.com/rdkcentral/firebolt-apis/issues/45)) ([58f6ea1](https://github.com/rdkcentral/firebolt-apis/commit/58f6ea1dde7a819883eb3da24f879b6a9ecc9a41)) + +# [0.14.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.13.0...v0.14.0) (2023-06-22) + +### Bug Fixes + +* **VoiceGuidance** Change voice guidance limits to 0.5 and 2 ([#137](https://github.com/rdkcentral/firebolt-apis/issues/137)) ([b8f1944](https://github.com/rdkcentral/firebolt-apis/commit/b8f19449efd808639599b162aba61c08ec089c41)) + +### Features + +* **Capabilities** Allow granted in capability.info and capability.granted to be null ([#134](https://github.com/rdkcentral/firebolt-apis/issues/134)) ([c5c31ee](https://github.com/rdkcentral/firebolt-apis/commit/c5c31ee3c744ec018a57232d2e7b1caf41158ed6)) + +# [0.13.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.12.0...v0.13.0) (2023-06-09) + +### Bug Fixes + +* Point to `firebolt-openrpc` 2.0.1 ([c57cb21](https://github.com/rdkcentral/firebolt-apis/commit/c57cb218343fd058e2e6e676d52d9d0c904ad9a8)) + +### Features + +* Add SecureStorage.clear method. ([#127](https://github.com/rdkcentral/firebolt-apis/issues/127)) ([4422c79](https://github.com/rdkcentral/firebolt-apis/commit/4422c79122fc35e7b35180254be52bf33c64ab5b)) + + +# [0.12.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.11.0...v0.12.0) (2023-05-18) + +### Bug Fixes + +* The `title` and `identifiers` parameters are now required for `Discovery.watchNext()` ([#124](https://github.com/rdkcentral/firebolt-core-sdk/issues/124)) ([96d7b2b](https://github.com/rdkcentral/firebolt-core-sdk/commit/96d7b2bb7464d6044346440d37feecba9dbc7899)) +* Fixed handling of context parameters for `Capabilities.listen()`. + +# [0.11.0](https://github.com/rdkcentral/firebolt-core-sdk/compare/v0.10.0...v0.11.0) (2023-05-01) + + +### Bug Fixes + +* Change doc examples to https ([#79](https://github.com/rdkcentral/firebolt-core-sdk/issues/79)) ([0da43e6](https://github.com/rdkcentral/firebolt-core-sdk/commit/0da43e666842bb75d20f9585c0d1f3f0236388ee)) +* Updated secure storage spec to allow null as result value ([#84](https://github.com/rdkcentral/firebolt-core-sdk/issues/84)) ([7ed1fed](https://github.com/rdkcentral/firebolt-core-sdk/commit/7ed1fed9ab9f5d84927c4e31c2816e15da0d6f44)) + + +# [0.10.0](https://github.com/rdkcentral/firebolt-core-sdk/compare/v0.9.0...v0.10.0) (2023-02-06) + + +### Bug Fixes + +* Capability module needs capability tags ([#71](https://github.com/rdkcentral/firebolt-core-sdk/issues/71)) ([6f0af1b](https://github.com/rdkcentral/firebolt-core-sdk/commit/6f0af1b9712faab137b1652ea337d5f284196ad4)) +* Change doc examples to https ([#79](https://github.com/rdkcentral/firebolt-core-sdk/issues/79)) ([c7047af](https://github.com/rdkcentral/firebolt-core-sdk/commit/c7047af9f3fa47e8cd7d252c3bbd321fa8f3d125)) +* FIRESDK-31 returned response from Lifecycle.ready method ([#81](https://github.com/rdkcentral/firebolt-core-sdk/issues/81)) ([efc740f](https://github.com/rdkcentral/firebolt-core-sdk/commit/efc740f7899897981cc840f12efe30f3e9543be4)) +* Updated openrpc version to 1.8.0-next.2 ([#85](https://github.com/rdkcentral/firebolt-core-sdk/issues/85)) ([b988c41](https://github.com/rdkcentral/firebolt-core-sdk/commit/b988c4159b154f8c041b766f794618250448bce0)) +* Updated secure storage spec to allow null as result value ([#84](https://github.com/rdkcentral/firebolt-core-sdk/issues/84)) ([4117ad7](https://github.com/rdkcentral/firebolt-core-sdk/commit/4117ad79322c8a3decd59f5ad52d5dfe6cf2f2a4)) +* Use new openrpc template code with bug fixes ([#69](https://github.com/rdkcentral/firebolt-core-sdk/issues/69)) ([9fed6fc](https://github.com/rdkcentral/firebolt-core-sdk/commit/9fed6fcb71b9914e91674f5e80f7d61673cc66fe)) +* Word publish scripts ([#78](https://github.com/rdkcentral/firebolt-core-sdk/issues/78)) ([a3846e0](https://github.com/rdkcentral/firebolt-core-sdk/commit/a3846e0db22e1221547ad97a019aba3850c51f6a)) + + +### Features + +* Add content-access api, deprecate entitlements, remove availabi… ([#83](https://github.com/rdkcentral/firebolt-core-sdk/issues/83)) ([f3c8017](https://github.com/rdkcentral/firebolt-core-sdk/commit/f3c8017eb391119e47d810426fdae4b11d8e0c38)) +* Add Secure Storage module ([#77](https://github.com/rdkcentral/firebolt-core-sdk/issues/77)) ([f62e4ae](https://github.com/rdkcentral/firebolt-core-sdk/commit/f62e4aeb9325df00c6a2484cf3aaa0b756bd8113)) +* New Capabilities API ([#63](https://github.com/rdkcentral/firebolt-core-sdk/issues/63)) ([0ba5ef5](https://github.com/rdkcentral/firebolt-core-sdk/commit/0ba5ef5e030ce740e40fd5ad30ca5cfd100cf32e)) +* Trigger ([607825b](https://github.com/rdkcentral/firebolt-core-sdk/commit/607825bd5547c74a8a7707f751446ab0e069d9f9)) +* Turn on dryRun ([dcddc60](https://github.com/rdkcentral/firebolt-core-sdk/commit/dcddc6068f91505d97457ed04eb8e2996dab9278)) + + +# 0.9.0 + +### Features + +* Adding Availabilities API ([#65](https://github.com/rdkcentral/firebolt-core-sdk/issues/65)) ([ec940dd](https://github.com/rdkcentral/firebolt-core-sdk/commit/ec940dd1a7a6865f18d64ada69793c87556a172e)) +* Tagging Capabilities ([e3b6ee2](https://github.com/rdkcentral/firebolt-core-sdk/commit/e3b6ee2475fbd9157a40bc92490c06df135ebc34)) + +### Bug Fixes + +* Don't ignore source files when publishing to npm [skip ci] ([cb26ff2](https://github.com/rdkcentral/firebolt-core-sdk/commit/cb26ff2e09416613c5557e76966eccbe0ec66d54)) +* Build SDK before npm publish ([#64](https://github.com/rdkcentral/firebolt-core-sdk/issues/64)) ([f221fa3](https://github.com/rdkcentral/firebolt-core-sdk/commit/f221fa34e24e29e86487b1ec98468b64f495d134)) +* **Lifecycle:** lifecycle state api returns correct state in all circumstances ([31e405c](https://github.com/rdkcentral/firebolt-core-sdk/commit/31e405c124d29a3e87294dc4b356ff8df9972af8)) + +# 0.8.1 + +- Added Device.version().firmware to surface the underlying hardware firmware version +- Added Device.version().api to surface the latest Firebolt API supported by this device +- Deprecated Device.version().os which does not have a formal specification. Use `firmware` instead. + +# 0.8.0 + +- Tune Intents are now supported in `navigateTo` events +- Added TypeScript declarations for Settings and Events +- Fixed/Removed test-enabling code from SDK +- Fixed bug where the SDK would initialize itself even when not being used + +# 0.7.0 + +- Removed all `bigint` types from TypeScript declarations, in favor of `number`, since bigint is not widely supported across browsers. This changes impacts: + - Device.screenResolution + - Device.videoResolution + - Discovery.purchasedContent + - Metrics.mediaProgress + - Metrics.mediaSeeking + - Metrics.mediaSeeked + - Parameters.initialization + +To upgrade to 0.7.0 simply change the type of any Firebolt Promise resolutions from `bigint` to `number`, e.g.: + +```typescript +const res:[bigint, bigint] = await Device.screenResolution() +``` + +Should become: + +```typescript +const res:[number, number] = await Device.screenResolution() +``` + +# 0.6.2 + +- Fixed incompatibility with Jest 26 due to [jest/issues/10565](https://github.com/facebook/jest/issues/10565) + + +# 0.6.1 + +- Changed Firebolt build to use `.mjs` extension +- Firebolt builds are now pure ES6 modules, not bundled with Webpack +- Added `types` path to package.json +- Fixed TypeScript declarations for `FlatMap` and `BooleanMap` +- Added TypeScript return type declarations for `listen` and `once` (all modules) +- Added TypeScript declaration for `clear` method (all modules) +- Changed `{}` return type to `void` for listener callbacks + +# 0.6.0 + +- Added support for [rdkcentral/mock-firebolt](https://github.com/rdkcentral/mock-firebolt/) via a WebSocket transport layer +- Deprecated Accessibility.closedCaptions and voiceGuidance, created properties for Accessibility.closedCaptionsSettings and voiceGuidanceSettings, which support subscribers +- Deprecated Device.listen('deviceNameChanged'), added support for subscribing to Device.name() +- Added support for subscribing to property changes: Device.audio, hdcp, hdr, name, network, screenResolution, videoResolution, Advertising.policy, Discovery.policy, Localization.language +- Added proper TypeScript declarations for Discovery.entityInfo and Discovery.purchasedContent +- Fixed race condition w/ Transport Layer initialization + +# 0.5.2 + +- Added Parameters modules +- Fixed typo in Advertising.config example result for docs/Mock +- Updated Metrics.error signature to include `type` as first parameter +- Created window.__firebolt.testHarness handshake (for Mock TL only) +- Added `LocalizedString` type for localized string dictionaries +- Updated `Discovery.watchNext` to use `LocalizedString` for `title` and each property of `images` +- Added `OfferingType` and `ProgramType` parameters to `Discovery.purchasedContent` + +# 0.5.1 + +- Cleaned up errors in various Mock responses +- Methods that call private Metrics APIs, e.g. Lifecycle.ready, now do so **after** promise resolution + +# 0.5.0 + +- Updated TS declarations (.d.ts) to detect which event is being passed to `.listen()` methods +- Updated all `listen()` and `once()` methods to return a `Promise` +- Renamed `verifyContentRating` and `verifyPurchase` to `approveContentRating` and `approvePurchase` respectively +- Added `Profile.flags()` for distributor-specific profile flags +- Added optional `source` field to all `LifecycleEvents` +- Complete rewrite of `Metrics` APIs (see docs) +- Added `policyChanged` events to `Discovery` and `Advertising` +- Fixed duplicate RPC `listen` calls when listening to an event in slightly different ways, e.g. `once()` vs `listen()` +- Added Account, Authentication, Keyboard, Profile, SecondScreen modules +- Added Federated Search APIs to Discovery +- Added TypeScript/Intellisense declarations file +- Fixed spelling error on Accessibility module name +- Moved the `coppa` parameter for `Advertising.confg()` into the `options` object, and made it optional +- Final version of `Advertising.policy().skipRestriction` semantics diff --git a/apis/compare/core/index.md b/apis/compare/core/index.md index 7fc00606c..fcfe22522 100644 --- a/apis/compare/core/index.md +++ b/apis/compare/core/index.md @@ -1,7 +1,7 @@ --- title: Firebolt Core SDK -version: 1.3.0 +version: next layout: default sdk: core --- diff --git a/apis/compare/discovery/Accessibility/schemas/index.md b/apis/compare/discovery/Accessibility/schemas/index.md index 7536e90f0..8b7f9c702 100644 --- a/apis/compare/discovery/Accessibility/schemas/index.md +++ b/apis/compare/discovery/Accessibility/schemas/index.md @@ -1,7 +1,7 @@ --- title: Accessibility -version: 1.3.0 +version: next layout: default sdk: discovery --- @@ -56,7 +56,7 @@ undefined ```typescript type VoiceGuidanceSettings = { enabled: boolean // Whether or not voice guidance should be enabled by default - speed: VoiceSpeed // The speed at which voice guidance speech will be read back to the user + speed?: VoiceSpeed // The speed at which voice guidance speech will be read back to the user } ``` @@ -142,7 +142,7 @@ type ClosedCaptionsStyles = { ```typescript type ClosedCaptionsSettings = { enabled: boolean // Whether or not closed-captions should be enabled by default - styles: ClosedCaptionsStyles // The default styles to use when displaying closed-captions + styles?: ClosedCaptionsStyles // The default styles to use when displaying closed-captions preferredLanguages?: string[] } ``` diff --git a/apis/compare/discovery/Advertising/schemas/index.md b/apis/compare/discovery/Advertising/schemas/index.md index 82dbf905d..3a73eee72 100644 --- a/apis/compare/discovery/Advertising/schemas/index.md +++ b/apis/compare/discovery/Advertising/schemas/index.md @@ -1,7 +1,7 @@ --- title: Advertising -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Capabilities/schemas/index.md b/apis/compare/discovery/Capabilities/schemas/index.md index a7eb7273a..89bc95598 100644 --- a/apis/compare/discovery/Capabilities/schemas/index.md +++ b/apis/compare/discovery/Capabilities/schemas/index.md @@ -1,7 +1,7 @@ --- title: Capabilities -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Content/index.md b/apis/compare/discovery/Content/index.md index f9c792268..e8850efd4 100644 --- a/apis/compare/discovery/Content/index.md +++ b/apis/compare/discovery/Content/index.md @@ -1,7 +1,7 @@ --- title: Content -version: 1.3.0 +version: next layout: default sdk: discovery --- @@ -10,7 +10,7 @@ sdk: discovery --- -Version Content 1.3.0 +Version Content 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/discovery/Discovery/schemas/index.md b/apis/compare/discovery/Discovery/schemas/index.md index ba244eb3c..7f443b7bf 100644 --- a/apis/compare/discovery/Discovery/schemas/index.md +++ b/apis/compare/discovery/Discovery/schemas/index.md @@ -1,7 +1,7 @@ --- title: Discovery -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Entertainment/schemas/index.md b/apis/compare/discovery/Entertainment/schemas/index.md index 6cb4799d6..2591cdd60 100644 --- a/apis/compare/discovery/Entertainment/schemas/index.md +++ b/apis/compare/discovery/Entertainment/schemas/index.md @@ -1,7 +1,7 @@ --- title: Entertainment -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Entity/schemas/index.md b/apis/compare/discovery/Entity/schemas/index.md index 28ad211c3..42d80199d 100644 --- a/apis/compare/discovery/Entity/schemas/index.md +++ b/apis/compare/discovery/Entity/schemas/index.md @@ -1,7 +1,7 @@ --- title: Entity -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Intents/schemas/index.md b/apis/compare/discovery/Intents/schemas/index.md index 37dfebe70..0e8603841 100644 --- a/apis/compare/discovery/Intents/schemas/index.md +++ b/apis/compare/discovery/Intents/schemas/index.md @@ -1,7 +1,7 @@ --- title: Intents -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Lifecycle/schemas/index.md b/apis/compare/discovery/Lifecycle/schemas/index.md index ee223ca06..cd833f8fa 100644 --- a/apis/compare/discovery/Lifecycle/schemas/index.md +++ b/apis/compare/discovery/Lifecycle/schemas/index.md @@ -1,7 +1,7 @@ --- title: Lifecycle -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Localization/schemas/index.md b/apis/compare/discovery/Localization/schemas/index.md index c7d1f72d9..382100f81 100644 --- a/apis/compare/discovery/Localization/schemas/index.md +++ b/apis/compare/discovery/Localization/schemas/index.md @@ -1,7 +1,7 @@ --- title: Localization -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/SecondScreen/schemas/index.md b/apis/compare/discovery/SecondScreen/schemas/index.md index cbbe0451a..014d7f118 100644 --- a/apis/compare/discovery/SecondScreen/schemas/index.md +++ b/apis/compare/discovery/SecondScreen/schemas/index.md @@ -1,7 +1,7 @@ --- title: SecondScreen -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/Types/schemas/index.md b/apis/compare/discovery/Types/schemas/index.md index 94adb312b..f9ac143be 100644 --- a/apis/compare/discovery/Types/schemas/index.md +++ b/apis/compare/discovery/Types/schemas/index.md @@ -1,7 +1,7 @@ --- title: Types -version: 1.3.0 +version: next layout: default sdk: discovery --- @@ -19,9 +19,9 @@ Version Types 0.0.0-unknown.0 - [Types](#types) - [AudioProfile](#audioprofile) - [SemanticVersion](#semanticversion) - - [BooleanMap](#booleanmap) - [LocalizedString](#localizedstring) - [FlatMap](#flatmap) + - [BooleanMap](#booleanmap) - [Timeout](#timeout) ## Overview @@ -36,9 +36,7 @@ undefined AudioProfile: { STEREO: 'stereo', DOLBY_DIGITAL_5_1: 'dolbyDigital5.1', - DOLBY_DIGITAL_7_1: 'dolbyDigital7.1', DOLBY_DIGITAL_5_1_PLUS: 'dolbyDigital5.1+', - DOLBY_DIGITAL_7_1_PLUS: 'dolbyDigital7.1+', DOLBY_ATMOS: 'dolbyAtmos', }, @@ -59,14 +57,6 @@ type SemanticVersion = { --- -### BooleanMap - -```typescript -type BooleanMap = {} -``` - ---- - ### LocalizedString Localized string supports either a simple `string` or a Map of language codes to strings. When using a simple `string`, the current preferred langauge from `Localization.langauge()` is assumed. @@ -85,6 +75,14 @@ type LocalizedString = string | object --- +### BooleanMap + +```typescript +type BooleanMap = {} +``` + +--- + ### Timeout Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error. diff --git a/apis/compare/discovery/changelog.md b/apis/compare/discovery/changelog.md index 836064726..8f9209543 100644 --- a/apis/compare/discovery/changelog.md +++ b/apis/compare/discovery/changelog.md @@ -1,7 +1,7 @@ --- title: Change Log -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/discovery/index.md b/apis/compare/discovery/index.md index e1b7df2ce..095d9fbb4 100644 --- a/apis/compare/discovery/index.md +++ b/apis/compare/discovery/index.md @@ -1,7 +1,7 @@ --- title: Firebolt Discovery SDK -version: 1.3.0 +version: next layout: default sdk: discovery --- diff --git a/apis/compare/index.md b/apis/compare/index.md index 1bfaf77c1..005b9fb23 100644 --- a/apis/compare/index.md +++ b/apis/compare/index.md @@ -74,7 +74,7 @@ The schemas are used to generate SDK and Documentation artifacts. | Uses | | ---- | -| [Advertising.config](./core/Advertising/#config)
[Advertising.policy](./core/Advertising/#policy)
[Advertising.deviceAttributes](./core/Advertising/#deviceattributes)
[Advertising.appBundleId](./core/Advertising/#appbundleid)
[Advertising.onPolicyChanged](./core/Advertising/#policychanged) | +| [Advertising.config](./core/Advertising/#config)
[Advertising.deviceAttributes](./core/Advertising/#deviceattributes)
[Advertising.appBundleId](./core/Advertising/#appbundleid) | @@ -96,6 +96,13 @@ The schemas are used to generate SDK and Documentation artifacts. | [Advertising.resetIdentifier](./manage/Advertising/#resetidentifier) | +### `xrn:firebolt:capability:advertising:policy` + +| Uses | +| ---- | +| [Advertising.policy](./core/Advertising/#policy)
[Advertising.onPolicyChanged](./core/Advertising/#policychanged) | + + ### `xrn:firebolt:capability:approve:content` | Uses | @@ -154,7 +161,7 @@ The schemas are used to generate SDK and Documentation artifacts. | Uses | | ---- | -| [Device.platform](./core/Device/#platform)
[Device.type](./core/Device/#type)
[Device.version](./core/Device/#version)
[Device.hdcp](./core/Device/#hdcp)
[Device.hdr](./core/Device/#hdr)
[Device.audio](./core/Device/#audio)
[Device.screenResolution](./core/Device/#screenresolution)
[Device.videoResolution](./core/Device/#videoresolution)
[Device.onHdcpChanged](./core/Device/#hdcpchanged)
[Device.onHdrChanged](./core/Device/#hdrchanged)
[Device.onAudioChanged](./core/Device/#audiochanged)
[Device.onScreenResolutionChanged](./core/Device/#screenresolutionchanged)
[Device.onVideoResolutionChanged](./core/Device/#videoresolutionchanged)
[SecondScreen.protocols](./core/SecondScreen/#protocols) | +| [Device.platform](./core/Device/#platform)
[Device.type](./core/Device/#type)
[Device.version](./core/Device/#version)
[Device.hdcp](./core/Device/#hdcp)
[Device.hdr](./core/Device/#hdr)
[Device.audio](./core/Device/#audio)
[Device.screenResolution](./core/Device/#screenresolution)
[Device.videoResolution](./core/Device/#videoresolution)
[Device.onHdcpChanged](./core/Device/#hdcpchanged)
[Device.onHdrChanged](./core/Device/#hdrchanged)
[Device.onAudioChanged](./core/Device/#audiochanged)
[Device.onScreenResolutionChanged](./core/Device/#screenresolutionchanged)
[Device.onVideoResolutionChanged](./core/Device/#videoresolutionchanged) | ### `xrn:firebolt:capability:device:make` @@ -466,13 +473,6 @@ The schemas are used to generate SDK and Documentation artifacts. | [Device.network](./core/Device/#network)
[Device.onNetworkChanged](./core/Device/#networkchanged) | -### `xrn:firebolt:capability:privacy:advertising` - -| Uses | -| ---- | -| [Advertising.policy](./core/Advertising/#policy)
[Advertising.onPolicyChanged](./core/Advertising/#policychanged) | - - ### `xrn:firebolt:capability:privacy:settings` | Uses | @@ -514,6 +514,13 @@ The schemas are used to generate SDK and Documentation artifacts. | [rpc.discover](./manage/rpc/#discover) | +### `xrn:firebolt:capability:secondscreen:protocol` + +| Uses | +| ---- | +| [SecondScreen.protocols](./core/SecondScreen/#protocols) | + + ### `xrn:firebolt:capability:storage:secure` | Uses | diff --git a/apis/compare/manage/Accessibility/schemas/index.md b/apis/compare/manage/Accessibility/schemas/index.md index f082ebba9..869dc1f25 100644 --- a/apis/compare/manage/Accessibility/schemas/index.md +++ b/apis/compare/manage/Accessibility/schemas/index.md @@ -1,7 +1,7 @@ --- title: Accessibility -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -56,7 +56,7 @@ undefined ```typescript type VoiceGuidanceSettings = { enabled: boolean // Whether or not voice guidance should be enabled by default - speed: VoiceSpeed // The speed at which voice guidance speech will be read back to the user + speed?: VoiceSpeed // The speed at which voice guidance speech will be read back to the user } ``` @@ -142,7 +142,7 @@ type ClosedCaptionsStyles = { ```typescript type ClosedCaptionsSettings = { enabled: boolean // Whether or not closed-captions should be enabled by default - styles: ClosedCaptionsStyles // The default styles to use when displaying closed-captions + styles?: ClosedCaptionsStyles // The default styles to use when displaying closed-captions preferredLanguages?: string[] } ``` diff --git a/apis/compare/manage/Account/index.md b/apis/compare/manage/Account/index.md index 0581c9783..ae3b9903b 100644 --- a/apis/compare/manage/Account/index.md +++ b/apis/compare/manage/Account/index.md @@ -1,7 +1,7 @@ --- title: Account -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Account 1.3.0 +Version Account 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/AcknowledgeChallenge/index.md b/apis/compare/manage/AcknowledgeChallenge/index.md index 9c8efbf76..911b803a8 100644 --- a/apis/compare/manage/AcknowledgeChallenge/index.md +++ b/apis/compare/manage/AcknowledgeChallenge/index.md @@ -1,7 +1,7 @@ --- title: AcknowledgeChallenge -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version AcknowledgeChallenge 1.3.0 +Version AcknowledgeChallenge 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Advertising/index.md b/apis/compare/manage/Advertising/index.md index 1b8538f37..b3081b5a6 100644 --- a/apis/compare/manage/Advertising/index.md +++ b/apis/compare/manage/Advertising/index.md @@ -1,7 +1,7 @@ --- title: Advertising -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Advertising 1.3.0 +Version Advertising 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Advertising/schemas/index.md b/apis/compare/manage/Advertising/schemas/index.md index c1bf7242d..571bf6a0c 100644 --- a/apis/compare/manage/Advertising/schemas/index.md +++ b/apis/compare/manage/Advertising/schemas/index.md @@ -1,7 +1,7 @@ --- title: Advertising -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/AudioDescriptions/index.md b/apis/compare/manage/AudioDescriptions/index.md index 8dd1ff8cc..432b80d14 100644 --- a/apis/compare/manage/AudioDescriptions/index.md +++ b/apis/compare/manage/AudioDescriptions/index.md @@ -1,7 +1,7 @@ --- title: AudioDescriptions -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version AudioDescriptions 1.3.0 +Version AudioDescriptions 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Capabilities/schemas/index.md b/apis/compare/manage/Capabilities/schemas/index.md index 6084ad2c2..2d440e2b3 100644 --- a/apis/compare/manage/Capabilities/schemas/index.md +++ b/apis/compare/manage/Capabilities/schemas/index.md @@ -1,7 +1,7 @@ --- title: Capabilities -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/ClosedCaptions/index.md b/apis/compare/manage/ClosedCaptions/index.md index 2a0cc21e0..2c05c8a23 100644 --- a/apis/compare/manage/ClosedCaptions/index.md +++ b/apis/compare/manage/ClosedCaptions/index.md @@ -1,7 +1,7 @@ --- title: ClosedCaptions -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version ClosedCaptions 1.3.0 +Version ClosedCaptions 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Device/index.md b/apis/compare/manage/Device/index.md index 2a5540027..eda6e8423 100644 --- a/apis/compare/manage/Device/index.md +++ b/apis/compare/manage/Device/index.md @@ -1,7 +1,7 @@ --- title: Device -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Device 1.3.0 +Version Device 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Discovery/index.md b/apis/compare/manage/Discovery/index.md index c21d9e634..a6b89d4d1 100644 --- a/apis/compare/manage/Discovery/index.md +++ b/apis/compare/manage/Discovery/index.md @@ -1,7 +1,7 @@ --- title: Discovery -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Discovery 1.3.0 +Version Discovery 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Discovery/schemas/index.md b/apis/compare/manage/Discovery/schemas/index.md index eb9066c7c..29f1a97f8 100644 --- a/apis/compare/manage/Discovery/schemas/index.md +++ b/apis/compare/manage/Discovery/schemas/index.md @@ -1,7 +1,7 @@ --- title: Discovery -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/Entertainment/schemas/index.md b/apis/compare/manage/Entertainment/schemas/index.md index fb4c634b2..59623d792 100644 --- a/apis/compare/manage/Entertainment/schemas/index.md +++ b/apis/compare/manage/Entertainment/schemas/index.md @@ -1,7 +1,7 @@ --- title: Entertainment -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/Entity/schemas/index.md b/apis/compare/manage/Entity/schemas/index.md index 339dba470..34333617f 100644 --- a/apis/compare/manage/Entity/schemas/index.md +++ b/apis/compare/manage/Entity/schemas/index.md @@ -1,7 +1,7 @@ --- title: Entity -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/HDMIInput/index.md b/apis/compare/manage/HDMIInput/index.md index 789fe698a..22373ce22 100644 --- a/apis/compare/manage/HDMIInput/index.md +++ b/apis/compare/manage/HDMIInput/index.md @@ -1,7 +1,7 @@ --- title: HDMIInput -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version HDMIInput 1.3.0 +Version HDMIInput 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Intents/schemas/index.md b/apis/compare/manage/Intents/schemas/index.md index 3cb8d6285..a5418612e 100644 --- a/apis/compare/manage/Intents/schemas/index.md +++ b/apis/compare/manage/Intents/schemas/index.md @@ -1,7 +1,7 @@ --- title: Intents -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/Keyboard/index.md b/apis/compare/manage/Keyboard/index.md index 8c82d1ea2..f166b36bd 100644 --- a/apis/compare/manage/Keyboard/index.md +++ b/apis/compare/manage/Keyboard/index.md @@ -1,7 +1,7 @@ --- title: Keyboard -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Keyboard 1.3.0 +Version Keyboard 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Lifecycle/schemas/index.md b/apis/compare/manage/Lifecycle/schemas/index.md index 8ad8f77f1..6d4957640 100644 --- a/apis/compare/manage/Lifecycle/schemas/index.md +++ b/apis/compare/manage/Lifecycle/schemas/index.md @@ -1,7 +1,7 @@ --- title: Lifecycle -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/Localization/index.md b/apis/compare/manage/Localization/index.md index d4cdfd154..8332d535f 100644 --- a/apis/compare/manage/Localization/index.md +++ b/apis/compare/manage/Localization/index.md @@ -1,7 +1,7 @@ --- title: Localization -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Localization 1.3.0 +Version Localization 1.4.0-next.3 ## Table of Contents @@ -59,15 +59,15 @@ Methods for accessessing location and language preferences Add any platform-specific localization information in key/value pair ```typescript -function addAdditionalInfo(key: string, value: string): Promise +function addAdditionalInfo(key: string, value: number): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ---------------------------------- | -| `key` | `string` | true | Key to add additionalInfo | -| `value` | `string` | true | Value to be set for additionalInfo | +| Param | Type | Required | Description | +| ------- | -------- | -------- | ---------------------------------------------------------------------------- | +| `key` | `string` | true | Key to add additionalInfo | +| `value` | `number` | true | Value to be set for additionalInfo. Value can be a number, string or boolean | Promise resolution: @@ -128,7 +128,7 @@ Response: ### additionalInfo -Get any platform-specific localization information, in an Map +Get any platform-specific localization information ```typescript function additionalInfo(): Promise diff --git a/apis/compare/manage/Localization/schemas/index.md b/apis/compare/manage/Localization/schemas/index.md index 18bbaeaaa..0fdf98175 100644 --- a/apis/compare/manage/Localization/schemas/index.md +++ b/apis/compare/manage/Localization/schemas/index.md @@ -1,7 +1,7 @@ --- title: Localization -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/Metrics/index.md b/apis/compare/manage/Metrics/index.md index 40ef1f237..be8feca1d 100644 --- a/apis/compare/manage/Metrics/index.md +++ b/apis/compare/manage/Metrics/index.md @@ -1,7 +1,7 @@ --- title: Metrics -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Metrics 1.3.0 +Version Metrics 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/PinChallenge/index.md b/apis/compare/manage/PinChallenge/index.md index 55741377a..78750603f 100644 --- a/apis/compare/manage/PinChallenge/index.md +++ b/apis/compare/manage/PinChallenge/index.md @@ -1,7 +1,7 @@ --- title: PinChallenge -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version PinChallenge 1.3.0 +Version PinChallenge 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Privacy/index.md b/apis/compare/manage/Privacy/index.md index 75f8a5287..837fbfc10 100644 --- a/apis/compare/manage/Privacy/index.md +++ b/apis/compare/manage/Privacy/index.md @@ -1,7 +1,7 @@ --- title: Privacy -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Privacy 1.3.0 +Version Privacy 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/SecondScreen/schemas/index.md b/apis/compare/manage/SecondScreen/schemas/index.md index 3714ca95f..0c3e06cdb 100644 --- a/apis/compare/manage/SecondScreen/schemas/index.md +++ b/apis/compare/manage/SecondScreen/schemas/index.md @@ -1,7 +1,7 @@ --- title: SecondScreen -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/SecureStorage/index.md b/apis/compare/manage/SecureStorage/index.md index 9e75feb58..205820733 100644 --- a/apis/compare/manage/SecureStorage/index.md +++ b/apis/compare/manage/SecureStorage/index.md @@ -1,7 +1,7 @@ --- title: SecureStorage -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version SecureStorage 1.3.0 +Version SecureStorage 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Types/schemas/index.md b/apis/compare/manage/Types/schemas/index.md index 7027d9597..f723606dd 100644 --- a/apis/compare/manage/Types/schemas/index.md +++ b/apis/compare/manage/Types/schemas/index.md @@ -1,7 +1,7 @@ --- title: Types -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -19,9 +19,9 @@ Version Types 0.0.0-unknown.0 - [Types](#types) - [AudioProfile](#audioprofile) - [SemanticVersion](#semanticversion) - - [BooleanMap](#booleanmap) - [LocalizedString](#localizedstring) - [FlatMap](#flatmap) + - [BooleanMap](#booleanmap) - [Timeout](#timeout) ## Overview @@ -36,9 +36,7 @@ undefined AudioProfile: { STEREO: 'stereo', DOLBY_DIGITAL_5_1: 'dolbyDigital5.1', - DOLBY_DIGITAL_7_1: 'dolbyDigital7.1', DOLBY_DIGITAL_5_1_PLUS: 'dolbyDigital5.1+', - DOLBY_DIGITAL_7_1_PLUS: 'dolbyDigital7.1+', DOLBY_ATMOS: 'dolbyAtmos', }, @@ -59,14 +57,6 @@ type SemanticVersion = { --- -### BooleanMap - -```typescript -type BooleanMap = {} -``` - ---- - ### LocalizedString Localized string supports either a simple `string` or a Map of language codes to strings. When using a simple `string`, the current preferred langauge from `Localization.langauge()` is assumed. @@ -85,6 +75,14 @@ type LocalizedString = string | object --- +### BooleanMap + +```typescript +type BooleanMap = {} +``` + +--- + ### Timeout Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error. diff --git a/apis/compare/manage/UserGrants/index.md b/apis/compare/manage/UserGrants/index.md index ae129b627..bf0c94b43 100644 --- a/apis/compare/manage/UserGrants/index.md +++ b/apis/compare/manage/UserGrants/index.md @@ -1,7 +1,7 @@ --- title: UserGrants -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version UserGrants 1.3.0 +Version UserGrants 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/VoiceGuidance/index.md b/apis/compare/manage/VoiceGuidance/index.md index e0207f12d..e44492f87 100644 --- a/apis/compare/manage/VoiceGuidance/index.md +++ b/apis/compare/manage/VoiceGuidance/index.md @@ -1,7 +1,7 @@ --- title: VoiceGuidance -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version VoiceGuidance 1.3.0 +Version VoiceGuidance 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/Wifi/index.md b/apis/compare/manage/Wifi/index.md index 547ec19f6..9352d93a9 100644 --- a/apis/compare/manage/Wifi/index.md +++ b/apis/compare/manage/Wifi/index.md @@ -1,7 +1,7 @@ --- title: Wifi -version: 1.3.0 +version: next layout: default sdk: manage --- @@ -10,7 +10,7 @@ sdk: manage --- -Version Wifi 1.3.0 +Version Wifi 1.4.0-next.3 ## Table of Contents diff --git a/apis/compare/manage/changelog.md b/apis/compare/manage/changelog.md index 8eb1ddb1c..84946ea5e 100644 --- a/apis/compare/manage/changelog.md +++ b/apis/compare/manage/changelog.md @@ -1,7 +1,7 @@ --- title: Change Log -version: 1.3.0 +version: next layout: default sdk: manage --- diff --git a/apis/compare/manage/changelog/index.md b/apis/compare/manage/changelog/index.md new file mode 100644 index 000000000..4a41f47d9 --- /dev/null +++ b/apis/compare/manage/changelog/index.md @@ -0,0 +1,93 @@ +--- +title: Change Log + +version: next +layout: default +sdk: manage +--- +# [0.17.1](https://github.com/rdkcentral/firebolt-apis/compare/v0.17.0...v0.17.1) (2023-09-15) + +### Bug Fixes + +fix: Add enumerated values for fontFamily/fontEdge (#181) + +# [0.17.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.16.0...v0.17.0) (2023-09-07) + +### Bug Fixes + +* fix: Using 3 letter ISO639 language codes ([#173](https://github.com/rdkcentral/firebolt-apis/issues/173)) + +# [0.16.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.15.0...v0.16.0) (2023-08-14) + +### Features + +* Added Manage APIs for `windlowColor` and `windowOpacity` ([#157](https://github.com/rdkcentral/firebolt-apis/issues/157)) ([f508358](https://github.com/rdkcentral/firebolt-apis/commit/f508358aeb2f58bb3893bbfaf09e2340fcadac8f)) + +# [0.15.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.14.0...v0.15.0) (2023-07-31) + +### Bug Fixes + +* Rename Advisory "Committee" to "Board" ([#135](https://github.com/rdkcentral/firebolt-apis/issues/135)) ([ef410c4](https://github.com/rdkcentral/firebolt-apis/commit/ef410c43bbb32414c3aa1d11b43093565cc90edf)) +* window fix from firebolt-openrpc 2.0.3 ([8c06dd1](https://github.com/rdkcentral/firebolt-apis/commit/8c06dd1432822719f5634e2877b36efdf02a4809)) + +### Features + +* **Nullable CC Styles** Added support to set and get null in ClosedCaptions style fields ([#150](https://github.com/rdkcentral/firebolt-apis/issues/150)) ([9c511e4](https://github.com/rdkcentral/firebolt-apis/commit/9c511e4fddebcdf5dfc04e9e8e31f98ab7eef680)) +* **Window CC Styles** Added windowColor and windowOpacity to closedCaptions style ([#145](https://github.com/rdkcentral/firebolt-apis/issues/145)) ([f65b901](https://github.com/rdkcentral/firebolt-apis/commit/f65b9019bda22400df9b9634c332e720db38118d)) +* **Audio Descriptions** Audio Description and Preferred Audio Languages Settings ([#45](https://github.com/rdkcentral/firebolt-apis/issues/45)) ([58f6ea1](https://github.com/rdkcentral/firebolt-apis/commit/58f6ea1dde7a819883eb3da24f879b6a9ecc9a41)) + +# [0.14.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.13.0...v0.14.0) (2023-06-22) + +### Bug Fixes + +* **Advertising:** put resetAdvertisingIdentifier back in manage sdk ([ce92ae7](https://github.com/rdkcentral/firebolt-apis/commit/ce92ae7bfff58fa1d3e4bee78c88d5edf0266473)) +* * **VoiceGuidance** Change voice guidance limits to 0.5 and 2 ([#137](https://github.com/rdkcentral/firebolt-apis/issues/137)) ([b8f1944](https://github.com/rdkcentral/firebolt-apis/commit/b8f19449efd808639599b162aba61c08ec089c41)) + +### Features + +* **Discovery** Add an event when apps call signIn or signOut ([#133](https://github.com/rdkcentral/firebolt-apis/issues/133)) ([8ba2515](https://github.com/rdkcentral/firebolt-apis/commit/8ba2515948c433ccc38662f223f5fb399cf34841)) + +# [0.13.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.12.0...v0.13.0) (2023-06-09) + +### Bug Fixes + +* Grant providers should allow null responses for deferred challenges ([#128](https://github.com/rdkcentral/firebolt-apis/issues/128)) ([0ddd11a](https://github.com/rdkcentral/firebolt-apis/commit/0ddd11af282aed85112fb739993ae58cfc1c4910)) +* Point to `firebolt-openrpc` 2.0.1 ([c57cb21](https://github.com/rdkcentral/firebolt-apis/commit/c57cb218343fd058e2e6e676d52d9d0c904ad9a8)) +* Added Changelog note about accessory removal ([02e81c0](https://github.com/rdkcentral/firebolt-apis/commit/02e81c0f0233862e2d2386989943a840eddc5b6a)) + +### Features + +* Add SecureStorage.setForApp, removeForApp, .clearForApp methods. ([#127](https://github.com/rdkcentral/firebolt-apis/issues/127)) ([4422c79](https://github.com/rdkcentral/firebolt-apis/commit/4422c79122fc35e7b35180254be52bf33c64ab5b)) + +# [0.12.0](https://github.com/rdkcentral/firebolt-apis/compare/v0.11.0...v0.12.0) (2023-05-18) + +### Bug Fixes + +* Updated `Advertising.resetIdentifier` capability ([47e730c](https://github.com/rdkcentral/firebolt-core-sdk/commit/47e730c4572ca2b8b9fdc3b2062121ef802914aa)) +* Removed `Accessory` module, which was not finished or ready for release ([6bcbb3f](https://github.com/rdkcentral/firebolt-apis/commit/6bcbb3fa347cb412e0d973beb6ecff7fe966607a)) + +### Features + +* Add the `Advertising.skipRestriction` API and included in Manage SDK ([#122](https://github.com/rdkcentral/firebolt-core-sdk/issues/122)) ([da9d75f](https://github.com/rdkcentral/firebolt-core-sdk/commit/da9d75f8c29bf04674e3de692874888796665a9a)) + + +# [0.11.0](https://github.com/rdkcentral/firebolt-core-sdk/compare/v0.10.0...v0.11.0) (2023-05-01) + +This is the first release of the Firebolt Manage SDK, which is used by first party, or trusted, apps to manage a Firebolt device. + +### Features + +* Accessory module +* Account module +* AcknowledgeChallenge module +* Advertising module +* ClosedCaptions module +* Device module +* Keyboard module +* Localization module +* Metrics module +* PinChallenge module +* Privacy module +* UserGrants module +* VoiceGuidance module +* Wifi module diff --git a/apis/compare/manage/index.md b/apis/compare/manage/index.md index 1939764fd..2db1edb92 100644 --- a/apis/compare/manage/index.md +++ b/apis/compare/manage/index.md @@ -1,7 +1,7 @@ --- title: Firebolt Manage SDK -version: 1.3.0 +version: next layout: default sdk: manage ---