@firebolt-js/discovery-sdk - npm Package Compare versions

Comparing version 1.3.1-next.3 to 1.4.0-next.2

dist/docs/Accessibility/schemas/index.md

@@ -54,4 +54,4 @@ ---
 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
+  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
 }
@@ -120,14 +120,14 @@ ```
 type ClosedCaptionsStyles = {
-  FONT_FAMILY?: string
-  FONT_SIZE?: number
-  FONT_COLOR?: string
-  FONT_EDGE?: string
-  FONT_EDGE_COLOR?: string
-  FONT_OPACITY?: number
-  BACKGROUND_COLOR?: string
-  BACKGROUND_OPACITY?: number
-  TEXT_ALIGN?: string
-  TEXT_ALIGN_VERTICAL?: string
-  WINDOW_COLOR?: string
-  WINDOW_OPACITY?: number
+  fontFamily?: string
+  fontSize?: number
+  fontColor?: string
+  fontEdge?: string
+  fontEdgeColor?: string
+  fontOpacity?: number
+  backgroundColor?: string
+  backgroundOpacity?: number
+  textAlign?: string
+  textAlignVertical?: string
+  windowColor?: string
+  windowOpacity?: number
 }
@@ -142,5 +142,5 @@ ```
 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
-  PREFERRED_LANGUAGES?: string[]
+  enabled: boolean // Whether or not closed-captions should be enabled by default
+  styles?: ClosedCaptionsStyles // The default styles to use when displaying closed-captions
+  preferredLanguages?: string[]
 }
@@ -147,0 +147,0 @@ ```

dist/docs/Capabilities/schemas/index.md

@@ -84,9 +84,9 @@ ---
 type CapabilityInfo = {
-  CAPABILITY?: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.
-  SUPPORTED: boolean // Provides info whether the capability is supported
-  AVAILABLE: boolean // Provides info whether the capability is available
-  USE: object
-  MANAGE: object
-  PROVIDE: object
-  DETAILS?: DenyReason[] // Reasons why a Capability might not be invokable
+  capability?: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.
+  supported: boolean // Provides info whether the capability is supported
+  available: boolean // Provides info whether the capability is available
+  use: object
+  manage: object
+  provide: object
+  details?: DenyReason[] // Reasons why a Capability might not be invokable
 }
@@ -108,4 +108,4 @@ ```
 type Permission = {
-  ROLE?: Role // Role provides access level for the app for a given capability.
-  CAPABILITY: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.
+  role?: Role // Role provides access level for the app for a given capability.
+  capability: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.
 }
@@ -112,0 +112,0 @@ ```

dist/docs/Content/index.md

@@ -9,3 +9,3 @@ ---
 
-Version Content 1.3.1-next.3
+Version Content 1.4.0-next.2
 
@@ -403,4 +403,4 @@ ## Table of Contents
 type InterestResult = {
-  APP_ID: string
-  ENTITY: EntityDetails
+  appId: string
+  entity: EntityDetails
 }
@@ -419,6 +419,6 @@ ```
 type InterestEvent = {
-  APP_ID: string
-  TYPE: InterestType
-  REASON: InterestReason
-  ENTITY: EntityDetails
+  appId: string
+  type: InterestType
+  reason: InterestReason
+  entity: EntityDetails
 }
@@ -425,0 +425,0 @@ ```

dist/docs/Discovery/schemas/index.md

@@ -58,5 +58,5 @@ ---
 type EntityInfoResult = {
-  EXPIRES: string
-  ENTITY: EntityInfo // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type.
-  RELATED?: EntityInfo[] // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type.
+  expires: string
+  entity: EntityInfo // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type.
+  related?: EntityInfo[] // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type.
 }
@@ -75,5 +75,5 @@ ```
 type PurchasedContentResult = {
-  EXPIRES: string
-  TOTAL_COUNT: number
-  ENTRIES: EntityInfo[] // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type.
+  expires: string
+  totalCount: number
+  entries: EntityInfo[] // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type.
 }
@@ -80,0 +80,0 @@ ```

dist/docs/Entertainment/schemas/index.md

@@ -127,3 +127,3 @@ ---
 type ContentRating = {
-  SCHEME:
+  scheme:
     | 'CA-Movie'
@@ -135,4 +135,4 @@ | 'CA-TV'
     | 'US-TV' // The rating scheme.
-  RATING: string // The content rating.
-  ADVISORIES?: string[] // Optional list of subratings or content advisories.
+  rating: string // The content rating.
+  advisories?: string[] // Optional list of subratings or content advisories.
 }
@@ -155,7 +155,7 @@ ```
 type ContentIdentifiers = {
-  ASSET_ID?: string // Identifies a particular playable asset. For example, the HD version of a particular movie separate from the UHD version.
-  ENTITY_ID?: string // Identifies an entity, such as a Movie, TV Series or TV Episode.
-  SEASON_ID?: string // The TV Season for a TV Episode.
-  SERIES_ID?: string // The TV Series for a TV Episode or TV Season.
-  APP_CONTENT_DATA?: string // App-specific content identifiers.
+  assetId?: string // Identifies a particular playable asset. For example, the HD version of a particular movie separate from the UHD version.
+  entityId?: string // Identifies an entity, such as a Movie, TV Series or TV Episode.
+  seasonId?: string // The TV Season for a TV Episode.
+  seriesId?: string // The TV Series for a TV Episode or TV Season.
+  appContentData?: string // App-specific content identifiers.
 }
@@ -170,5 +170,5 @@ ```
 type Entitlement = {
-  ENTITLEMENT_ID: string
-  START_TIME?: string
-  END_TIME?: string
+  entitlementId: string
+  startTime?: string
+  endTime?: string
 }
@@ -218,15 +218,15 @@ ```
 type WayToWatch = {
-  IDENTIFIERS: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to
-  EXPIRES?: string // Time when the WayToWatch is no longer available.
-  ENTITLED?: boolean // Specify if the user is entitled to watch the entity.
-  ENTITLED_EXPIRES?: string // Time when the entity is no longer entitled.
-  OFFERING_TYPE?: OfferingType // The offering type of the WayToWatch.
-  HAS_ADS?: boolean // True if the streamable asset contains ads.
-  PRICE?: number // For "buy" and "rent" WayToWatch, the price to buy or rent in the user's preferred currency.
-  VIDEO_QUALITY?: 'SD' | 'HD' | 'UHD'[] // List of the video qualities available via the WayToWatch.
-  AUDIO_PROFILE: AudioProfile[] // List of the audio types available via the WayToWatch.
-  AUDIO_LANGUAGES?: string[] // List of audio track languages available on the WayToWatch. The first is considered the primary language. Languages are expressed as ISO 639 1/2 codes.
-  CLOSED_CAPTIONS?: string[] // List of languages for which closed captions are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes.
-  SUBTITLES?: string[] // List of languages for which subtitles are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes.
-  AUDIO_DESCRIPTIONS?: string[] // List of languages for which audio descriptions (DVD) as available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes.
+  identifiers: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to
+  expires?: string // Time when the WayToWatch is no longer available.
+  entitled?: boolean // Specify if the user is entitled to watch the entity.
+  entitledExpires?: string // Time when the entity is no longer entitled.
+  offeringType?: OfferingType // The offering type of the WayToWatch.
+  hasAds?: boolean // True if the streamable asset contains ads.
+  price?: number // For "buy" and "rent" WayToWatch, the price to buy or rent in the user's preferred currency.
+  videoQuality?: 'SD' | 'HD' | 'UHD'[] // List of the video qualities available via the WayToWatch.
+  audioProfile: AudioProfile[] // List of the audio types available via the WayToWatch.
+  audioLanguages?: string[] // List of audio track languages available on the WayToWatch. The first is considered the primary language. Languages are expressed as ISO 639 1/2 codes.
+  closedCaptions?: string[] // List of languages for which closed captions are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes.
+  subtitles?: string[] // List of languages for which subtitles are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes.
+  audioDescriptions?: string[] // List of languages for which audio descriptions (DVD) as available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes.
 }
@@ -262,15 +262,15 @@ ```
 type EntityInfo = {
-  IDENTIFIERS: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to
-  TITLE: string // Title of the entity.
-  ENTITY_TYPE: 'program' | 'music' // The type of the entity, e.g. `program` or `music`.
-  PROGRAM_TYPE?: ProgramType // In the case of a program `entityType`, specifies the program type.
-  MUSIC_TYPE?: MusicType // In the case of a music `entityType`, specifies the type of music entity.
-  SYNOPSIS?: string // Short description of the entity.
-  SEASON_NUMBER?: number // For TV seasons, the season number. For TV episodes, the season that the episode belongs to.
-  SEASON_COUNT?: number // For TV series, seasons, and episodes, the total number of seasons.
-  EPISODE_NUMBER?: number // For TV episodes, the episode number.
-  EPISODE_COUNT?: number // For TV seasons and episodes, the total number of episodes in the current season.
-  RELEASE_DATE?: string // The date that the program or entity was released or first aired.
-  CONTENT_RATINGS?: ContentRating[] // A ContentRating represents an age or content based of an entity. Supported rating schemes and associated types are below.
-  WAYS_TO_WATCH?: WayToWatch[] // A WayToWatch describes a way to watch a video program. It may describe a single
+  identifiers: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to
+  title: string // Title of the entity.
+  entityType: 'program' | 'music' // The type of the entity, e.g. `program` or `music`.
+  programType?: ProgramType // In the case of a program `entityType`, specifies the program type.
+  musicType?: MusicType // In the case of a music `entityType`, specifies the type of music entity.
+  synopsis?: string // Short description of the entity.
+  seasonNumber?: number // For TV seasons, the season number. For TV episodes, the season that the episode belongs to.
+  seasonCount?: number // For TV series, seasons, and episodes, the total number of seasons.
+  episodeNumber?: number // For TV episodes, the episode number.
+  episodeCount?: number // For TV seasons and episodes, the total number of episodes in the current season.
+  releaseDate?: string // The date that the program or entity was released or first aired.
+  contentRatings?: ContentRating[] // A ContentRating represents an age or content based of an entity. Supported rating schemes and associated types are below.
+  waysToWatch?: WayToWatch[] // A WayToWatch describes a way to watch a video program. It may describe a single
 }
@@ -277,0 +277,0 @@ ```

dist/docs/Entity/schemas/index.md

@@ -43,7 +43,7 @@ ---
 type MovieEntity = {
-  ENTITY_TYPE: 'program'
-  PROGRAM_TYPE: 'movie'
-  ENTITY_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityType: 'program'
+  programType: 'movie'
+  entityId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -58,10 +58,10 @@ ```
 type Metadata = {
-  TITLE?: string // Title of the entity.
-  SYNOPSIS?: string // Short description of the entity.
-  SEASON_NUMBER?: number // For TV seasons, the season number. For TV episodes, the season that the episode belongs to.
-  SEASON_COUNT?: number // For TV series, seasons, and episodes, the total number of seasons.
-  EPISODE_NUMBER?: number // For TV episodes, the episode number.
-  EPISODE_COUNT?: number // For TV seasons and episodes, the total number of episodes in the current season.
-  RELEASE_DATE?: string // The date that the program or entity was released or first aired.
-  CONTENT_RATINGS?: ContentRating[] // A ContentRating represents an age or content based of an entity. Supported rating schemes and associated types are below.
+  title?: string // Title of the entity.
+  synopsis?: string // Short description of the entity.
+  seasonNumber?: number // For TV seasons, the season number. For TV episodes, the season that the episode belongs to.
+  seasonCount?: number // For TV series, seasons, and episodes, the total number of seasons.
+  episodeNumber?: number // For TV episodes, the episode number.
+  episodeCount?: number // For TV seasons and episodes, the total number of episodes in the current season.
+  releaseDate?: string // The date that the program or entity was released or first aired.
+  contentRatings?: ContentRating[] // A ContentRating represents an age or content based of an entity. Supported rating schemes and associated types are below.
 }
@@ -80,5 +80,5 @@ ```
 type MusicEntity = {
-  ENTITY_TYPE: 'music'
-  MUSIC_TYPE: MusicType // In the case of a music `entityType`, specifies the type of music entity.
-  ENTITY_ID: string
+  entityType: 'music'
+  musicType: MusicType // In the case of a music `entityType`, specifies the type of music entity.
+  entityId: string
 }
@@ -97,6 +97,6 @@ ```
 type ChannelEntity = {
-  ENTITY_TYPE: 'channel'
-  CHANNEL_TYPE: 'streaming' | 'overTheAir'
-  ENTITY_ID: string // ID of the channel, in the target App's scope.
-  APP_CONTENT_DATA?: string
+  entityType: 'channel'
+  channelType: 'streaming' | 'overTheAir'
+  entityId: string // ID of the channel, in the target App's scope.
+  appContentData?: string
 }
@@ -111,5 +111,5 @@ ```
 type UntypedEntity = {
-  ENTITY_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -126,6 +126,6 @@ ```
 type PlaylistEntity = {
-  ENTITY_TYPE: 'playlist'
-  ENTITY_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityType: 'playlist'
+  entityId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -142,9 +142,9 @@ ```
 type TVEpisodeEntity = {
-  ENTITY_TYPE: 'program'
-  PROGRAM_TYPE: 'episode'
-  ENTITY_ID: string
-  SERIES_ID: string
-  SEASON_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityType: 'program'
+  programType: 'episode'
+  entityId: string
+  seriesId: string
+  seasonId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -161,8 +161,8 @@ ```
 type TVSeasonEntity = {
-  ENTITY_TYPE: 'program'
-  PROGRAM_TYPE: 'season'
-  ENTITY_ID: string
-  SERIES_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityType: 'program'
+  programType: 'season'
+  entityId: string
+  seriesId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -179,7 +179,7 @@ ```
 type TVSeriesEntity = {
-  ENTITY_TYPE: 'program'
-  PROGRAM_TYPE: 'series'
-  ENTITY_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityType: 'program'
+  programType: 'series'
+  entityId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -196,4 +196,4 @@ ```
 type AdditionalEntity = {
-  ENTITY_TYPE: 'program'
-  PROGRAM_TYPE:
+  entityType: 'program'
+  programType:
     | 'concert'
@@ -207,5 +207,5 @@ | 'sportingEvent'
     | 'extra'
-  ENTITY_ID: string
-  ASSET_ID?: string
-  APP_CONTENT_DATA?: string
+  entityId: string
+  assetId?: string
+  appContentData?: string
 }
@@ -257,3 +257,3 @@ ```
 type EntityDetails = {
-  IDENTIFIERS:
+  identifiers:
     | ProgramEntity
@@ -264,4 +264,4 @@ | MusicEntity
     | PlaylistEntity
-  INFO?: Metadata
-  WAYS_TO_WATCH?: WayToWatch[] // A WayToWatch describes a way to watch a video program. It may describe a single
+  info?: Metadata
+  waysToWatch?: WayToWatch[] // A WayToWatch describes a way to watch a video program. It may describe a single
 }
@@ -268,0 +268,0 @@ ```

dist/docs/Intents/schemas/index.md

@@ -59,4 +59,4 @@ ---
 type EntityIntent = {
-  ACTION: 'entity'
-  DATA:
+  action: 'entity'
+  data:
     | ProgramEntity
@@ -67,3 +67,3 @@ | MusicEntity
     | PlaylistEntity
-  CONTEXT: object
+  context: object
 }
@@ -80,5 +80,5 @@ ```
 type PlaybackIntent = {
-  ACTION: 'playback'
-  DATA: PlayableEntity
-  CONTEXT: object
+  action: 'playback'
+  data: PlayableEntity
+  context: object
 }
@@ -99,5 +99,5 @@ ```
 type SearchIntent = {
-  ACTION: 'search'
-  DATA?: object
-  CONTEXT: object
+  action: 'search'
+  data?: object
+  context: object
 }
@@ -114,5 +114,5 @@ ```
 type SectionIntent = {
-  ACTION: 'section'
-  DATA: object
-  CONTEXT: object
+  action: 'section'
+  data: object
+  context: object
 }
@@ -129,5 +129,5 @@ ```
 type TuneIntent = {
-  ACTION: 'tune'
-  DATA: object
-  CONTEXT: object
+  action: 'tune'
+  data: object
+  context: object
 }
@@ -148,5 +148,5 @@ ```
 type PlayEntityIntent = {
-  ACTION: 'play-entity'
-  DATA: object
-  CONTEXT: object
+  action: 'play-entity'
+  data: object
+  context: object
 }
@@ -167,5 +167,5 @@ ```
 type PlayQueryIntent = {
-  ACTION: 'play-query'
-  DATA: object
-  CONTEXT: object
+  action: 'play-query'
+  data: object
+  context: object
 }
@@ -187,4 +187,4 @@ ```
 type HomeIntent = {
-  ACTION: 'home'
-  CONTEXT: object
+  action: 'home'
+  context: object
 }
@@ -201,4 +201,4 @@ ```
 type LaunchIntent = {
-  ACTION: 'launch'
-  CONTEXT: object
+  action: 'launch'
+  context: object
 }
@@ -205,0 +205,0 @@ ```

dist/docs/SecondScreen/schemas/index.md

@@ -30,5 +30,5 @@ ---
 type SecondScreenEvent = {
-  TYPE: 'dial'
-  VERSION?: string
-  DATA?: string
+  type: 'dial'
+  version?: string
+  data?: string
 }
@@ -35,0 +35,0 @@ ```

dist/docs/Types/schemas/index.md

@@ -47,6 +47,6 @@ ---
 type SemanticVersion = {
-  MAJOR: number
-  MINOR: number
-  PATCH: number
-  READABLE: string
+  major: number
+  minor: number
+  patch: number
+  readable: string
 }
@@ -53,0 +53,0 @@ ```

dist/firebolt-discovery-open-rpc.json

@@ -5,3 +5,3 @@ {
 		"title": "Firebolt Discovery SDK",
-		"version": "1.3.1-next.3",
+		"version": "1.4.0-next.2",
 		"x-module-descriptions": {}
@@ -2128,2 +2128,8 @@ },
 										"type": "string"
+									},
+									"suggestions": {
+										"type": "array",
+										"items": {
+											"$ref": "#/x-schemas/Entity/Entity"
+										}
 									}
@@ -2130,0 +2136,0 @@ },

package.json

 {
 	"name": "@firebolt-js/discovery-sdk",
-	"version": "1.3.1-next.3",
+	"version": "1.4.0-next.2",
 	"description": "The Firebolt Discovery JS SDK",
@@ -5,0 +5,0 @@ "main": "./dist/lib/firebolt-discovery.mjs",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

171528

increased by0.02%

Lines of code

4147

increased by0.14%

No dependency changes