1.3.0 (https://github.com/rdkcentral/firebolt-apis/compare/v1.2.0…v1.3.0) (2024-08-12)

Features

• Add Metrics.appInfo API (#294) (47264b5)
• CPP App-Passthrough Logic (#286) (4eb84ee)
• OpenRPC version upgraded to 3.1.0 (#298) (16b3305)

1.2.0 (https://github.com/rdkcentral/firebolt-apis/compare/v1.1.0…v1.2.0) (2024-06-14)

Bug Fixes

• Add PlaylistEntity to EntityIntent (9769d6d (https://github.com/rdkcentral/firebolt-apis/commit/9769d6d7d43f1d61dfcda16ba4806175c5cf7658))
• Remove x-alternatives that don’t exist (#278 (https://github.com/rdkcentral/firebolt-apis/issues/278)) (e38ad5a (https://github.com/rdkcentral/firebolt-apis/commit/e38ad5a508fccb5c724cf0f03cbd67ad4a28378c))
• Removed sdk as required field from Device.version (#231 (https://github.com/rdkcentral/firebolt-apis/issues/231)) (ef3de3e (https://github.com/rdkcentral/firebolt-apis/commit/ef3de3e68619c6f666dd1d751b0acc25f6438122))

Features

• Command and Control Intents (#251 (https://github.com/rdkcentral/firebolt-apis/issues/251)) (c8f8dae (https://github.com/rdkcentral/firebolt-apis/commit/c8f8dae5a9a0f14a3815c04df5a55763823d4898))
• User Interest (#170 (https://github.com/rdkcentral/firebolt-apis/issues/170)) (48a1094 (https://github.com/rdkcentral/firebolt-apis/commit/48a1094aaab6418f09db662dbc81f090a34f32ed))

1.1.0 (2024-02-09)

Bug Fixes

• Add Music to Playable entities (#225 (https://github.com/rdkcentral/firebolt-apis/issues/225)) (22c9b71 (https://github.com/rdkcentral/firebolt-apis/commit/22c9b71d3c0ee98d32585d1b365afabf8e64d6ed))
• Modified account:uid to SHOULD (#224 (https://github.com/rdkcentral/firebolt-apis/issues/224)) (70c8b24 (https://github.com/rdkcentral/firebolt-apis/commit/70c8b24decfcbff2c32fb1b0d21290afc00a8432))

1.0.0 (2023-11-03)

Upgraded to 1.0 at part of RDK6 release. This API is still compatibile with 0.x versions.

Bug Fixes

• Updated Discovery.launch example with xrn:firebolt: application-type (#187 (https://github.com/rdkcentral/firebolt-apis/issues/187)) (4dbbab3 (https://github.com/rdkcentral/firebolt-apis/commit/4dbbab3d9fa68c0e5185ca72fd0170bae8a30139))

Features

• Added scope parameter for advertisingId (#188 (https://github.com/rdkcentral/firebolt-apis/issues/188))
• Play Intent (#151 (https://github.com/rdkcentral/firebolt-apis/issues/151)) (d1ddf3f (https://github.com/rdkcentral/firebolt-apis/commit/d1ddf3fb3b1f758315686ad2f6dc57c2b270f33a))

0.17.1 (2023-09-15)

Bug Fixes

fix: Add enumerated values for fontFamily/fontEdge (#181)

0.17.0 (2023-09-07)

Bug Fixes

• fix: Using 3 letter ISO639 language codes (#173)

0.15.0 (2023-07-31)

Bug Fixes

• Rename Advisory “Committee” to “Board” (#135) (ef410c4)
• window fix from firebolt-openrpc 2.0.3 (8c06dd1)

Features

• Nullable CC Styles Added support to set and get null in ClosedCaptions style fields (#150) (9c511e4)
• Window CC Styles Added windowColor and windowOpacity to closedCaptions style (#145) (f65b901)
• Audio Descriptions Audio Description and Preferred Audio Languages Settings (#45) (58f6ea1)

0.14.0 (2023-06-22)

Bug Fixes

• VoiceGuidance Change voice guidance limits to 0.5 and 2 (#137) (b8f1944)

Features

• Capabilities Allow granted in capability.info and capability.granted to be null (#134) (c5c31ee)

0.13.0 (2023-06-09)

Bug Fixes

• Point to firebolt-openrpc 2.0.1 (c57cb21)

Features

• Add SecureStorage.clear method. (#127) (4422c79)

0.12.0 (2023-05-18)

Bug Fixes

• The title and identifiers parameters are now required for Discovery.watchNext() (#124) (96d7b2b)
• Fixed handling of context parameters for Capabilities.listen().

0.11.0 (2023-05-01)

Bug Fixes

• Change doc examples to https (#79) (0da43e6)
• Updated secure storage spec to allow null as result value (#84) (7ed1fed)

0.10.0 (2023-02-06)

Bug Fixes

• Capability module needs capability tags (#71) (6f0af1b)
• Change doc examples to https (#79) (c7047af)
• FIRESDK-31 returned response from Lifecycle.ready method (#81) (efc740f)
• Updated openrpc version to 1.8.0-next.2 (#85) (b988c41)
• Updated secure storage spec to allow null as result value (#84) (4117ad7)
• Use new openrpc template code with bug fixes (#69) (9fed6fc)
• Word publish scripts (#78) (a3846e0)

Features

• Add content-access api, deprecate entitlements, remove availabi… (#83) (f3c8017)
• Add Secure Storage module (#77) (f62e4ae)
• New Capabilities API (#63) (0ba5ef5)
• Trigger (607825b)
• Turn on dryRun (dcddc60)

0.9.0

Features

• Adding Availabilities API (#65) (ec940dd)
• Tagging Capabilities (e3b6ee2)

Bug Fixes

• Don’t ignore source files when publishing to npm [skip ci] (cb26ff2)
• Build SDK before npm publish (#64) (f221fa3)
• Lifecycle: lifecycle state api returns correct state in all circumstances (31e405c)

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.:

const res:[bigint, bigint] = await Device.screenResolution()

Should become:

const res:[number, number] = await Device.screenResolution()

0.6.2

• Fixed incompatibility with Jest 26 due to 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 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