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

package/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributing
+If you would like to contribute code to this project you can do so through GitHub by forking the repository
+and sending a pull request.
+Before RDK accepts your code into the project you must sign the RDK Contributor License Agreement (CLA).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 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.

package/NOTICE

@@ -0,0 +1,24 @@
+[firebolt-js-client]
+Copyright 2025 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
+
+This product includes software developed at Comcast (http://www.comcast.com/).
+
+The component may include material which is licensed under other licenses / copyrights as
+listed below. Your use of this material within the component is also subject to the terms and
+conditions of these licenses. The LICENSE file contains the text of all the licenses which apply
+within this component..
+
+npm is a registered trademark of npm, Inc.

package/README.md

@@ -0,0 +1,26 @@
+---
+title: Firebolt Core Client
+---
+
+[![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
+# Firebolt Core Client
+The primary Firebolt SDK for building Firebolt compliant apps.
+
+## Usage
+To install, run:
+
+```
+npm install @firebolt-js/core-client
+```
+
+To use the package, import one of it's modules, e.g.:
+
+```js
+import { Accessibility } from '@firebolt-js/core-client'
+```
+
+## Contributing
+The Firebolt Core Client is built using the Firebolt OpenRPC toolset:
+
+See [Firebolt OpenRPC](https://www.github.com/rdkcentral/firebolt-openrpc/), for more info. 

package/dist/docs/Accessibility/index.md

@@ -0,0 +1,384 @@
+---
+title: Accessibility
+---
+
+# Accessibility Module
+
+---
+
+Version Accessibility 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [audioDescription](#audiodescription)
+  - [closedCaptionsSettings](#closedcaptionssettings)
+  - [highContrastUI](#highcontrastui)
+  - [voiceGuidanceSettings](#voiceguidancesettings)
+- [Events](#events)
+  - [onAudioDescriptionChanged](#onaudiodescriptionchanged)
+  - [onClosedCaptionsSettingsChanged](#onclosedcaptionssettingschanged)
+  - [onHighContrastUIChanged](#onhighcontrastuichanged)
+  - [onVoiceGuidanceSettingsChanged](#onvoiceguidancesettingschanged)
+- [Types](#types)
+
+## Usage
+
+To use the Accessibility module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Accessibility } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.
+
+Apps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.
+
+## Methods
+
+### audioDescription
+
+Returns the audio description setting of the device
+
+To get the value of `audioDescription` call the method like this:
+
+```typescript
+function audioDescription(): Promise<boolean>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                               |
+| ---- | -------------------------------------------------------- |
+| uses | xrn:firebolt:capability:accessibility:audio-descriptions |
+
+#### Examples
+
+Getting the audio description setting
+
+JavaScript:
+
+```javascript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let setting = await Accessibility.audioDescription()
+console.log(setting)
+```
+
+Value of `setting`:
+
+```javascript
+true
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function audioDescription(callback: (setting) => boolean): Promise<number>
+```
+
+| Param     | Type      | Required | Description                   |
+| --------- | --------- | -------- | ----------------------------- |
+| `setting` | `boolean` | false    | the audio description setting |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Getting the audio description setting
+
+```typescript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let listenerId = await audioDescription((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+true
+```
+
+---
+
+### closedCaptionsSettings
+
+Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference
+
+To get the value of `closedCaptionsSettings` call the method like this:
+
+```typescript
+function closedCaptionsSettings(): Promise<ClosedCaptionsSettings>
+```
+
+Promise resolution:
+
+[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings)
+
+Capabilities:
+
+| Role | Capability                                            |
+| ---- | ----------------------------------------------------- |
+| uses | xrn:firebolt:capability:accessibility:closed-captions |
+
+#### Examples
+
+Getting the closed captions settings
+
+JavaScript:
+
+```javascript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let closedCaptionsSettings = await Accessibility.closedCaptionsSettings()
+console.log(closedCaptionsSettings)
+```
+
+Value of `closedCaptionsSettings`:
+
+```javascript
+{"enabled":true,"preferredLanguages":["eng","spa"]}
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function closedCaptionsSettings(
+  callback: (closedCaptionsSettings) => ClosedCaptionsSettings,
+): Promise<number>
+```
+
+| Param                | Type       | Required | Description              |
+| -------------------- | ---------- | -------- | ------------------------ |
+| `enabled`            | `boolean`  | false    |                          |
+| `preferredLanguages` | `string[]` | false    | <br/>pattern: ^[a-z]{3}$ |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Getting the closed captions settings
+
+```typescript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let listenerId = await closedCaptionsSettings((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+{
+	"enabled": true,
+	"preferredLanguages": [
+		"eng",
+		"spa"
+	]
+}
+```
+
+---
+
+### highContrastUI
+
+Returns the high contrast UI device setting
+
+To get the value of `highContrastUI` call the method like this:
+
+```typescript
+function highContrastUI(): Promise<boolean>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                             |
+| ---- | ------------------------------------------------------ |
+| uses | xrn:firebolt:capability:accessibility:high-contrast-ui |
+
+#### Examples
+
+High-contrast UI mode is enabled
+
+JavaScript:
+
+```javascript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let highContrastUI = await Accessibility.highContrastUI()
+console.log(highContrastUI)
+```
+
+Value of `highContrastUI`:
+
+```javascript
+true
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function highContrastUI(callback: (highContrastUI) => boolean): Promise<number>
+```
+
+| Param            | Type      | Required | Description                              |
+| ---------------- | --------- | -------- | ---------------------------------------- |
+| `highContrastUI` | `boolean` | false    | Whether high-contrast UI mode is enabled |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+High-contrast UI mode is enabled
+
+```typescript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let listenerId = await highContrastUI((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+true
+```
+
+---
+
+### voiceGuidanceSettings
+
+Returns voice guidance settings: enabled, rate, and verbosity
+
+To get the value of `voiceGuidanceSettings` call the method like this:
+
+```typescript
+function voiceGuidanceSettings(): Promise<VoiceGuidanceSettings>
+```
+
+Promise resolution:
+
+[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings)
+
+Capabilities:
+
+| Role | Capability                                           |
+| ---- | ---------------------------------------------------- |
+| uses | xrn:firebolt:capability:accessibility:voice-guidance |
+
+#### Examples
+
+Getting the voice guidance settings
+
+JavaScript:
+
+```javascript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let settings = await Accessibility.voiceGuidanceSettings()
+console.log(settings)
+```
+
+Value of `settings`:
+
+```javascript
+{"enabled":true,"rate":0.8,"navigationHints":true}
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function voiceGuidanceSettings(
+  callback: (settings) => VoiceGuidanceSettings,
+): Promise<number>
+```
+
+| Param             | Type                                                 | Required | Description       |
+| ----------------- | ---------------------------------------------------- | -------- | ----------------- |
+| `enabled`         | `boolean`                                            | false    |                   |
+| `rate`            | [`SpeechRate`](../Accessibility/schemas/#SpeechRate) | false    | <br/>minumum: 0.1 |
+| maximum: 10       |
+| `navigationHints` | `boolean`                                            | false    |                   |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Getting the voice guidance settings
+
+```typescript
+import { Accessibility } from '@firebolt-js/core-client'
+
+let listenerId = await voiceGuidanceSettings((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+{
+	"enabled": true,
+	"rate": 0.8,
+	"navigationHints": true
+}
+```
+
+---
+
+## Events
+
+### onAudioDescriptionChanged
+
+See: [audioDescription](#audiodescription)
+
+### onClosedCaptionsSettingsChanged
+
+See: [closedCaptionsSettings](#closedcaptionssettings)
+
+### onHighContrastUIChanged
+
+See: [highContrastUI](#highcontrastui)
+
+### onVoiceGuidanceSettingsChanged
+
+See: [voiceGuidanceSettings](#voiceguidancesettings)
+
+## Types

package/dist/docs/Accessibility/schemas/index.md

@@ -0,0 +1,52 @@
+---
+title: Accessibility
+---
+
+# Accessibility
+
+---
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Types](#types)
+  - [ClosedCaptionsSettings](#closedcaptionssettings)
+  - [SpeechRate](#speechrate)
+  - [VoiceGuidanceSettings](#voiceguidancesettings)
+
+## Types
+
+### ClosedCaptionsSettings
+
+```typescript
+type ClosedCaptionsSettings = {
+  enabled: boolean // Whether or not closed-captions should be enabled by default
+  preferredLanguages?: string[]
+}
+```
+
+---
+
+### SpeechRate
+
+```typescript
+type SpeechRate = number
+```
+
+---
+
+### VoiceGuidanceSettings
+
+```typescript
+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
+}
+```
+
+See also:
+
+[SpeechRate](#speechrate)
+
+---