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

package/dist/firebolt-core-app-open-rpc.json

@@ -0,0 +1,1082 @@
+{
+	"openrpc": "1.2.4",
+	"info": {
+		"title": "Firebolt Core Client",
+		"version": "1.0.0-next.5"
+	},
+	"methods": [
+		{
+			"name": "Accessibility.onAudioDescriptionChanged",
+			"summary": "Returns the audio description setting of the device",
+			"params": [
+				{
+					"name": "setting",
+					"summary": "the audio description setting",
+					"schema": {
+						"type": "boolean"
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Accessibility.audioDescription",
+					"x-event": "Accessibility.onAudioDescriptionChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:accessibility:audio-descriptions"
+					]
+				}
+			],
+			"examples": [
+				{
+					"name": "Getting the audio description setting",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": true
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Accessibility.onClosedCaptionsSettingsChanged",
+			"summary": "Returns captions settings: enabled, and a list of zero or more languages in order of decreasing preference",
+			"params": [
+				{
+					"name": "enabled",
+					"schema": {
+						"type": "boolean",
+						"description": "Whether or not closed-captions should be enabled by default"
+					}
+				},
+				{
+					"name": "preferredLanguages",
+					"schema": {
+						"type": "array",
+						"items": {
+							"$ref": "#/x-schemas/Localization/ISO639_2Language"
+						}
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-params-flattening": "true",
+					"x-notifier-for": "Accessibility.closedCaptionsSettings",
+					"x-event": "Accessibility.onClosedCaptionsSettingsChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:accessibility:closed-captions"
+					]
+				}
+			],
+			"examples": [
+				{
+					"name": "Getting the closed captions settings",
+					"params": [
+						{
+							"name": "enabled",
+							"value": true
+						},
+						{
+							"name": "preferredLanguages",
+							"value": [
+								"eng",
+								"spa"
+							]
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Accessibility.onHighContrastUIChanged",
+			"summary": "Returns the high contrast UI device setting",
+			"params": [
+				{
+					"name": "highContrastUI",
+					"summary": "Whether high-contrast UI mode is enabled",
+					"schema": {
+						"type": "boolean"
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Accessibility.highContrastUI",
+					"x-event": "Accessibility.onHighContrastUIChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:accessibility:high-contrast-ui"
+					]
+				}
+			],
+			"examples": [
+				{
+					"name": "High-contrast UI mode is enabled",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": true
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Accessibility.onVoiceGuidanceSettingsChanged",
+			"summary": "Returns voice guidance settings: enabled, rate, and verbosity",
+			"params": [
+				{
+					"name": "enabled",
+					"schema": {
+						"type": "boolean",
+						"description": "Whether or not voice guidance should be enabled by default"
+					}
+				},
+				{
+					"name": "rate",
+					"schema": {
+						"$ref": "#/x-schemas/Accessibility/SpeechRate",
+						"description": "The rate at which voice guidance speech will be read back to the user"
+					}
+				},
+				{
+					"name": "navigationHints",
+					"schema": {
+						"type": "boolean",
+						"description": "Whether or not voice guidance should include additional navigation hints"
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-params-flattening": "true",
+					"x-notifier-for": "Accessibility.voiceGuidanceSettings",
+					"x-event": "Accessibility.onVoiceGuidanceSettingsChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:accessibility:voice-guidance"
+					]
+				}
+			],
+			"examples": [
+				{
+					"name": "Getting the voice guidance settings",
+					"params": [
+						{
+							"name": "enabled",
+							"value": true
+						},
+						{
+							"name": "rate",
+							"value": 0.8
+						},
+						{
+							"name": "navigationHints",
+							"value": true
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Device.onHdrChanged",
+			"summary": "Returns the HDR standards that are supported by the attached TV or the integral display",
+			"params": [
+				{
+					"name": "negotiatedHdrFormats",
+					"summary": "the negotiated HDR formats",
+					"schema": {
+						"$ref": "#/components/schemas/HDRFormatMap"
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Device.hdr",
+					"x-event": "Device.onHdrChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:device:info"
+					]
+				}
+			],
+			"examples": [
+				{
+					"name": "Getting the negotiated HDR formats",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": {
+								"hdr10": true,
+								"hdr10Plus": true,
+								"dolbyVision": true,
+								"hlg": true
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Lifecycle2.onStateChanged",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-contextual-parameters": 0,
+					"x-event": "Lifecycle2.onStateChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:lifecycle2:general"
+					]
+				}
+			],
+			"summary": "Notification of lifecycle state change, raised after the platform has transitioned the app/runtime to the new lifecycle state",
+			"params": [
+				{
+					"name": "history",
+					"schema": {
+						"type": "array",
+						"minItems": 1,
+						"items": {
+							"title": "StateChange",
+							"$ref": "#/components/schemas/StateChange"
+						}
+					}
+				}
+			],
+			"examples": [
+				{
+					"name": "App is active after being initialized",
+					"params": [
+						{
+							"name": "states",
+							"value": [
+								{
+									"newState": "paused",
+									"oldState": "initializing"
+								},
+								{
+									"newState": "active",
+									"oldState": "paused"
+								}
+							]
+						}
+					]
+				},
+				{
+					"name": "Single transition to paused state",
+					"params": [
+						{
+							"name": "states",
+							"value": [
+								{
+									"newState": "paused",
+									"oldState": "initializing"
+								}
+							]
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Localization.onCountryChanged",
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Localization.country",
+					"x-event": "Localization.onCountryChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:localization:country-code"
+					]
+				}
+			],
+			"summary": "Returns the ISO 3166-1 alpha-2 code for the country device is located in.",
+			"params": [
+				{
+					"name": "code",
+					"summary": "The device country code.",
+					"schema": {
+						"$ref": "#/x-schemas/Localization/CountryCode"
+					}
+				}
+			],
+			"examples": [
+				{
+					"name": "Default example",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": "US"
+						}
+					]
+				},
+				{
+					"name": "Another example",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": "GB"
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Localization.onPreferredAudioLanguagesChanged",
+			"summary": "Returns a list of ISO 639-2/B codes for the preferred audio languages on this device.",
+			"params": [
+				{
+					"name": "languages",
+					"summary": "The preferred audio languages.",
+					"schema": {
+						"type": "array",
+						"items": {
+							"$ref": "#/x-schemas/Localization/ISO639_2Language"
+						}
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Localization.preferredAudioLanguages",
+					"x-event": "Localization.onPreferredAudioLanguagesChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:localization:preferred-audio-languages"
+					]
+				}
+			],
+			"examples": [
+				{
+					"name": "Default example",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": [
+								"spa",
+								"eng"
+							]
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Localization.onPresentationLanguageChanged",
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Localization.presentationLanguage",
+					"x-event": "Localization.onPresentationLanguageChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:localization:locale"
+					]
+				}
+			],
+			"summary": "Get the *full* BCP 47 code, including script, region, variant, etc., for the preferred locale",
+			"params": [
+				{
+					"name": "locale",
+					"summary": "The device locale.",
+					"schema": {
+						"$ref": "#/x-schemas/Localization/Locale"
+					}
+				}
+			],
+			"examples": [
+				{
+					"name": "Default example",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": "en-US"
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Presentation.onFocusedChanged",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-notifier-for": "Presentation.focused",
+					"x-event": "Presentation.onFocusedChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:presentation:general"
+					]
+				}
+			],
+			"summary": "Whether the app is in focus, i.e. receiving key presses. Provided for those apps/runtimes that cannot use Wayland",
+			"params": [
+				{
+					"name": "focused",
+					"summary": "Whether the app is in focus.",
+					"schema": {
+						"type": "boolean"
+					}
+				}
+			],
+			"examples": [
+				{
+					"name": "Default example",
+					"params": [
+						{
+							"name": "Default Result",
+							"value": true
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "Network.onConnectedChanged",
+			"summary": "Returns whether the device currently has a usable network connection.",
+			"tags": [
+				{
+					"name": "notifier",
+					"x-notifier-for": "Network.connected",
+					"x-event": "Network.onConnectedChanged"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:network:connected"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "success",
+					"summary": "Whether the device currently has a usable network connection.",
+					"schema": {
+						"$ref": "#/components/schemas/Connected"
+					}
+				}
+			],
+			"examples": [
+				{
+					"name": "Connected example",
+					"params": [
+						{
+							"name": "success",
+							"value": true
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onWillspeak",
+			"summary": "Text to speech conversion is about to start.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onWillspeak"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onSpeechstart",
+			"summary": "Utterance is about to be spoken.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onSpeechstart"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onSpeechpause",
+			"summary": "Ongoing speech was paused.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onSpeechpause"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onSpeechresume",
+			"summary": "Paused speech was resumed.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onSpeechresume"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onSpeechcomplete",
+			"summary": "Speech completed successfully.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onSpeechcomplete"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onSpeechinterrupted",
+			"summary": "Speech was stopped, due to another call to speak or cancel.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onSpeechinterrupted"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onNetworkerror",
+			"summary": "Utterance failed due to network error.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onNetworkerror"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		},
+		{
+			"name": "TextToSpeech.onPlaybackerror",
+			"summary": "Utterance failed during playback.",
+			"tags": [
+				{
+					"name": "rpc-only"
+				},
+				{
+					"name": "notifier",
+					"x-event": "TextToSpeech.onPlaybackerror"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:text-to-speech:general"
+					]
+				}
+			],
+			"params": [
+				{
+					"name": "SpeechId",
+					"summary": "Identifier for the speech call",
+					"schema": {
+						"$ref": "#/components/schemas/SpeechIdEvent"
+					},
+					"required": true
+				}
+			],
+			"examples": [
+				{
+					"name": "Default Example",
+					"params": [
+						{
+							"name": "SpeechId",
+							"value": {
+								"speechid": 1
+							}
+						}
+					]
+				}
+			]
+		}
+	],
+	"components": {
+		"schemas": {
+			"HDRFormatMap": {
+				"title": "HDRFormatMap",
+				"type": "object",
+				"properties": {
+					"hdr10": {
+						"type": "boolean"
+					},
+					"hdr10Plus": {
+						"type": "boolean"
+					},
+					"dolbyVision": {
+						"type": "boolean"
+					},
+					"hlg": {
+						"type": "boolean"
+					}
+				},
+				"required": [
+					"hdr10",
+					"hdr10Plus",
+					"dolbyVision",
+					"hlg"
+				],
+				"description": "The type of HDR format"
+			},
+			"LifecycleState": {
+				"title": "LifecycleState",
+				"description": "The application Lifecycle state",
+				"type": "string",
+				"enum": [
+					"initializing",
+					"active",
+					"paused",
+					"suspended",
+					"hibernated",
+					"terminating"
+				]
+			},
+			"StateChange": {
+				"title": "StateChange",
+				"type": "object",
+				"properties": {
+					"newState": {
+						"$ref": "#/components/schemas/LifecycleState"
+					},
+					"oldState": {
+						"$ref": "#/components/schemas/LifecycleState"
+					}
+				}
+			},
+			"Connected": {
+				"type": "boolean",
+				"description": "Indicates whether the device currently has a usable network connection."
+			},
+			"SpeechId": {
+				"type": "integer"
+			},
+			"SpeechIdEvent": {
+				"type": "object",
+				"properties": {
+					"speechid": {
+						"$ref": "#/components/schemas/SpeechId"
+					}
+				},
+				"required": [
+					"speechid"
+				]
+			}
+		}
+	},
+	"x-schemas": {
+		"Types": {
+			"uri": "https://meta.comcast.com/firebolt/types",
+			"SemanticVersion": {
+				"title": "SemanticVersion",
+				"type": "object",
+				"properties": {
+					"major": {
+						"type": "integer",
+						"minimum": 0
+					},
+					"minor": {
+						"type": "integer",
+						"minimum": 0
+					},
+					"patch": {
+						"type": "integer",
+						"minimum": 0
+					},
+					"readable": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"major",
+					"minor",
+					"patch",
+					"readable"
+				],
+				"additionalProperties": false
+			},
+			"FlatMap": {
+				"type": "object",
+				"additionalProperties": {
+					"oneOf": [
+						{
+							"type": "string"
+						},
+						{
+							"type": "number"
+						},
+						{
+							"type": "boolean"
+						}
+					]
+				}
+			}
+		},
+		"Accessibility": {
+			"uri": "https://meta.comcast.com/firebolt/accessibility",
+			"ClosedCaptionsSettings": {
+				"title": "ClosedCaptionsSettings",
+				"type": "object",
+				"required": [
+					"enabled"
+				],
+				"properties": {
+					"enabled": {
+						"type": "boolean",
+						"description": "Whether or not closed-captions should be enabled by default"
+					},
+					"preferredLanguages": {
+						"type": "array",
+						"items": {
+							"$ref": "#/x-schemas/Localization/ISO639_2Language"
+						}
+					}
+				},
+				"examples": [
+					{
+						"enabled": true,
+						"styles": {
+							"fontFamily": "monospaced_serif",
+							"fontSize": 1,
+							"fontColor": "#ffffff",
+							"fontEdge": "none",
+							"fontEdgeColor": "#7F7F7F",
+							"fontOpacity": 100,
+							"backgroundColor": "#000000",
+							"backgroundOpacity": 100,
+							"textAlign": "center",
+							"textAlignVertical": "middle",
+							"windowColor": "white",
+							"windowOpacity": 50
+						},
+						"preferredLanguages": [
+							"eng",
+							"spa"
+						]
+					}
+				]
+			},
+			"VoiceGuidanceSettings": {
+				"title": "VoiceGuidanceSettings",
+				"type": "object",
+				"required": [
+					"enabled",
+					"navigationHints",
+					"rate"
+				],
+				"properties": {
+					"enabled": {
+						"type": "boolean",
+						"description": "Whether or not voice guidance should be enabled by default"
+					},
+					"rate": {
+						"$ref": "#/x-schemas/Accessibility/SpeechRate",
+						"description": "The rate at which voice guidance speech will be read back to the user"
+					},
+					"navigationHints": {
+						"type": "boolean",
+						"description": "Whether or not voice guidance should include additional navigation hints"
+					}
+				},
+				"examples": [
+					{
+						"enabled": true,
+						"navigationHints": true,
+						"rate": 0.8
+					}
+				]
+			},
+			"SpeechRate": {
+				"title": "SpeechRate",
+				"type": "number",
+				"minimum": 0.1,
+				"maximum": 10
+			}
+		},
+		"Localization": {
+			"uri": "https://meta.comcast.com/firebolt/localization",
+			"ISO639_2Language": {
+				"type": "string",
+				"pattern": "^[a-z]{3}$"
+			},
+			"CountryCode": {
+				"type": "string",
+				"pattern": "^[A-Z]{2}$"
+			},
+			"Locale": {
+				"type": "string",
+				"pattern": "^[a-zA-Z]+([a-zA-Z0-9\\-]*)$"
+			}
+		},
+		"Policies": {
+			"uri": "https://meta.comcast.com/firebolt/policies",
+			"AgePolicy": {
+				"title": "AgePolicy",
+				"description": "The policy that describes various age groups to which content is directed. See distributor documentation for further details.",
+				"anyOf": [
+					{
+						"type": "string"
+					},
+					{
+						"type": "string",
+						"enum": [
+							"app:adult",
+							"app:child",
+							"app:teen"
+						]
+					}
+				]
+			}
+		}
+	}
+}