From f0c4c9187c9e01e78b4f92ae27698f6d2f101d64 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Thu, 22 Aug 2024 17:14:27 -0400 Subject: [PATCH 1/9] feat: Included entity array in Search Intent --- package-lock.json | 6 +++--- src/openrpc/discovery.json | 37 +++++++++++++++++++++++++++++++++++++ src/schemas/intents.json | 27 +++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 8af224f25..88f9e5392 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16962,7 +16962,7 @@ }, "src/sdks/core": { "name": "@firebolt-js/sdk", - "version": "1.3.0", + "version": "1.3.1-next.1", "license": "Apache-2.0", "devDependencies": { "jest": "^28.1.0", @@ -16973,7 +16973,7 @@ }, "src/sdks/discovery": { "name": "@firebolt-js/discovery-sdk", - "version": "1.3.0", + "version": "1.3.1-next.1", "license": "Apache-2.0", "devDependencies": { "jest": "^28.1.0", @@ -16984,7 +16984,7 @@ }, "src/sdks/manage": { "name": "@firebolt-js/manage-sdk", - "version": "1.3.0", + "version": "1.3.1-next.1", "license": "Apache-2.0", "devDependencies": { "jest": "^28.1.0", diff --git a/src/openrpc/discovery.json b/src/openrpc/discovery.json index 01ab2205e..6737f8c3a 100644 --- a/src/openrpc/discovery.json +++ b/src/openrpc/discovery.json @@ -1250,6 +1250,43 @@ "name": "success", "value": true } + }, + { + "name": "Launch the Aggregated Experience to it's search screen.", + "params": [ + { + "name": "appId", + "value": "xrn:firebolt:application-type:main" + }, + { + "name": "intent", + "value": { + "action": "search", + "data": { + "query": "a cool show", + "suggestions": [ + { + "entityType": "program", + "programType": "movie", + "entityId": "xyz" + }, + { + "entityType": "program", + "programType": "movie", + "entityId": "abc" + } + ] + }, + "context": { + "source": "voice" + } + } + } + ], + "result": { + "name": "success", + "value": true + } } ] }, diff --git a/src/schemas/intents.json b/src/schemas/intents.json index 8f5a86c38..a4718aab5 100644 --- a/src/schemas/intents.json +++ b/src/schemas/intents.json @@ -609,6 +609,33 @@ "properties": { "query": { "type": "string" + }, + "suggestions": { + "type": "array", + "properties": { + "entity": { + "type": "object", + "items": { + "anyOf": [ + { + "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/MovieEntity" + }, + { + "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/TVEpisodeEntity" + }, + { + "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/TVSeriesEntity" + }, + { + "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/TVSeasonEntity" + }, + { + "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/AdditionalEntity" + } + ] + } + } + } } }, "additionalProperties": false From 17e7f9cf0381855751d640d4b72f263c99f75f68 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Fri, 23 Aug 2024 12:10:34 -0400 Subject: [PATCH 2/9] feat: Included entity array in Search Intent --- src/openrpc/discovery.json | 2 +- src/schemas/intents.json | 27 +++------------------------ 2 files changed, 4 insertions(+), 25 deletions(-) diff --git a/src/openrpc/discovery.json b/src/openrpc/discovery.json index 6737f8c3a..4c5fe8b4a 100644 --- a/src/openrpc/discovery.json +++ b/src/openrpc/discovery.json @@ -1181,7 +1181,7 @@ "params": [ { "name": "appId", - "value": "xrn:firebolt:application-type:settings " + "value": "xrn:firebolt:application-type:settings" }, { "name": "intent", diff --git a/src/schemas/intents.json b/src/schemas/intents.json index a4718aab5..4c01f7c39 100644 --- a/src/schemas/intents.json +++ b/src/schemas/intents.json @@ -612,34 +612,13 @@ }, "suggestions": { "type": "array", - "properties": { - "entity": { - "type": "object", - "items": { - "anyOf": [ - { - "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/MovieEntity" - }, - { - "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/TVEpisodeEntity" - }, - { - "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/TVSeriesEntity" - }, - { - "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/TVSeasonEntity" - }, - { - "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/AdditionalEntity" - } - ] - } - } + "items": { + "$ref": "https://meta.comcast.com/firebolt/entity#/definitions/Entity" } } }, "additionalProperties": false - } + } } } ], From 65482b6c5837556f46052f3ad165956dc67208ff Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Fri, 23 Aug 2024 12:36:04 -0400 Subject: [PATCH 3/9] feat: Updated example to have musicentity --- src/openrpc/discovery.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/openrpc/discovery.json b/src/openrpc/discovery.json index 4c5fe8b4a..a8f8d4f19 100644 --- a/src/openrpc/discovery.json +++ b/src/openrpc/discovery.json @@ -1271,8 +1271,8 @@ "entityId": "xyz" }, { - "entityType": "program", - "programType": "movie", + "entityType": "music", + "musicType": "song", "entityId": "abc" } ] From f8b7aec304a0e0ecbde472ab714fd7d22d7811e0 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Tue, 27 Aug 2024 12:35:04 -0400 Subject: [PATCH 4/9] fix: Reverted openrpc version to next --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1f6fc5dcb..5ed2850f8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19,7 +19,7 @@ "devDependencies": { "@commitlint/cli": "^17.0.3", "@commitlint/config-conventional": "^17.0.3", - "@firebolt-js/openrpc": "rdkcentral/firebolt-openrpc#fix-safe-name-issue", + "@firebolt-js/openrpc": "3.1.1-next.2", "@firebolt-js/schemas": "2.0.0", "@saithodev/semantic-release-backmerge": "^3.2.0", "@semantic-release/changelog": "^6.0.1", @@ -1075,10 +1075,10 @@ "link": true }, "node_modules/@firebolt-js/openrpc": { - "version": "3.1.1-next.3", - "resolved": "git+ssh://git@github.com/rdkcentral/firebolt-openrpc.git#b73c1783c5b521df240243ed9a853302e86cf1b5", + "version": "3.1.1-next.2", + "resolved": "https://registry.npmjs.org/@firebolt-js/openrpc/-/openrpc-3.1.1-next.2.tgz", + "integrity": "sha512-D5b8ovtmRQNSlJ52LRJHtp0rmvlao6axzpmqYjW8wsljNeTj9QcAJ1xiUiYBt2uFitvGM6zQA04e3rbJhErJ+w==", "dev": true, - "license": "Apache-2.0", "dependencies": { "ajv": "^8.12.0", "ajv-formats": "^2.1.1", diff --git a/package.json b/package.json index 38d1652fc..94e0c8eee 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "devDependencies": { "@commitlint/cli": "^17.0.3", "@commitlint/config-conventional": "^17.0.3", - "@firebolt-js/openrpc": "rdkcentral/firebolt-openrpc#fix-safe-name-issue", + "@firebolt-js/openrpc": "3.1.1-next.2", "@firebolt-js/schemas": "2.0.0", "@saithodev/semantic-release-backmerge": "^3.2.0", "@semantic-release/changelog": "^6.0.1", From 18650060462826f86fc448c2b0c643a9bb6f5912 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Tue, 27 Aug 2024 12:38:36 -0400 Subject: [PATCH 5/9] fix: Reverted openrpc version to next --- .github/workflows/release-github.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/release-github.yml b/.github/workflows/release-github.yml index 75f01ab8e..5dfe64c51 100644 --- a/.github/workflows/release-github.yml +++ b/.github/workflows/release-github.yml @@ -92,6 +92,9 @@ jobs: const fs = require('fs'); const path = './src/sdks/core/dist/lib/firebolt.mjs'; return fs.existsSync(path); + - name: File Existence Output + run: | + echo "File exists: ${{ steps.check_build.outputs.result }}" - name: Release Firebolt SDKs to NPM if: steps.check_build.outputs.files_exists == 'true' && github.event_name != 'pull_request' && (github.ref_name != 'main' || github.event_name == 'workflow_dispatch') env: From 571923fb8ac72a8ca31e710016384e77ee31f0ed Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Thu, 29 Aug 2024 15:39:28 -0400 Subject: [PATCH 6/9] fix: Updated descriptions for few APIs --- src/openrpc/device.json | 8 ++++---- src/openrpc/discovery.json | 2 +- src/openrpc/localization.json | 8 ++++---- src/openrpc/second_screen.json | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index 0dd8e11b4..8b149998f 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -41,7 +41,7 @@ }, { "name": "distributor", - "summary": "Get the distributor ID for this device", + "summary": "Get the name of the entity which is distributing the current device. There can be multiple distributors which distribute the same device model.", "params": [], "tags": [ { @@ -74,7 +74,7 @@ }, { "name": "platform", - "summary": "Get the platform ID for this device", + "summary": "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.", "params": [], "tags": [ { @@ -173,7 +173,7 @@ }, { "name": "model", - "summary": "Get the device model", + "summary": "Get the manufacturer designated model of the device, equivalent to the PMI of the device", "params": [], "tags": [ { @@ -239,7 +239,7 @@ }, { "name": "make", - "summary": "Get the device make", + "summary": "Get the manufacturer of the device model", "params": [], "tags": [ { diff --git a/src/openrpc/discovery.json b/src/openrpc/discovery.json index a8f8d4f19..306a10e0a 100644 --- a/src/openrpc/discovery.json +++ b/src/openrpc/discovery.json @@ -561,7 +561,7 @@ }, { "name": "progress", - "summary": "How much of the content has been watched (percentage as 0-1 for VOD, number of seconds for live)", + "summary": "How much of the content has been watched (percentage as (0-0.999) for VOD, number of seconds for live)", "schema": { "type": "number", "minimum": 0 diff --git a/src/openrpc/localization.json b/src/openrpc/localization.json index db92eeb5b..cc2a803ce 100644 --- a/src/openrpc/localization.json +++ b/src/openrpc/localization.json @@ -298,7 +298,7 @@ ] } ], - "summary": "Get any platform-specific localization information, in an Map", + "summary": "Get any platform-specific localization information", "params": [], "result": { "name": "info", @@ -306,7 +306,7 @@ "schema": { "type": "object", "additionalProperties": { - "type": "string", + "type": ["number", "string", "boolean"], "maxLength": 1024 }, "maxProperties": 32 @@ -346,9 +346,9 @@ }, { "name": "value", - "summary": "Value to be set for additionalInfo", + "summary": "Value to be set for additionalInfo. Value can be a number, string or boolean", "schema": { - "type": "string" + "type": ["number", "string", "boolean"] }, "required": true } diff --git a/src/openrpc/second_screen.json b/src/openrpc/second_screen.json index af25e2c9d..e7cd1054b 100644 --- a/src/openrpc/second_screen.json +++ b/src/openrpc/second_screen.json @@ -13,7 +13,7 @@ { "name": "capabilities", "x-uses": [ - "xrn:firebolt:capability:device:info" + "xrn:firebolt:capability:secondscreen:protocol" ] } ], From ef294d0cfc48a9143aa9a70f54bec910cbee3ce4 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Thu, 29 Aug 2024 15:52:14 -0400 Subject: [PATCH 7/9] fix: Updated descriptions for few APIs --- src/sdks/core/sdk.config.json | 2 +- src/sdks/core/test/suite/device.test.ts | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/sdks/core/sdk.config.json b/src/sdks/core/sdk.config.json index f34bf72c8..c682afc3b 100644 --- a/src/sdks/core/sdk.config.json +++ b/src/sdks/core/sdk.config.json @@ -129,7 +129,7 @@ "module": "SecondScreen", "use": [ "xrn:firebolt:capability:protocol:dial", - "xrn:firebolt:capability:device:info" + "xrn:firebolt:capability:secondscreen:protocol" ] }, { diff --git a/src/sdks/core/test/suite/device.test.ts b/src/sdks/core/test/suite/device.test.ts index 7f9601cac..f5a55849d 100644 --- a/src/sdks/core/test/suite/device.test.ts +++ b/src/sdks/core/test/suite/device.test.ts @@ -112,17 +112,17 @@ test("Device.make()", () => { }); test("Device.hdcp()", () => { - const expectedOutput: Device.BooleanMap = { + const expectedOutput: Device.HDCPVersionMap = { "hdcp1.4": true, "hdcp2.2": true, }; - return Device.hdcp().then((res: Device.BooleanMap) => { + return Device.hdcp().then((res: Device.HDCPVersionMap) => { expect(res).toEqual(expectedOutput); }); }); test("Device.hdcp(subscriber)", () => { - return Device.hdcp((supportedHdrProfiles: Device.BooleanMap) => {}).then( + return Device.hdcp((supportedHdrProfiles: Device.HDCPVersionMap) => {}).then( (res: number) => { expect(res > 0).toBe(true); } From 3dfb280b3d0fe5e0c0e8110d7e71f6acda698d80 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Fri, 30 Aug 2024 13:50:16 -0400 Subject: [PATCH 8/9] fix: Latest OpenRPC --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5ed2850f8..2a63aa8a2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19,7 +19,7 @@ "devDependencies": { "@commitlint/cli": "^17.0.3", "@commitlint/config-conventional": "^17.0.3", - "@firebolt-js/openrpc": "3.1.1-next.2", + "@firebolt-js/openrpc": "3.1.1", "@firebolt-js/schemas": "2.0.0", "@saithodev/semantic-release-backmerge": "^3.2.0", "@semantic-release/changelog": "^6.0.1", @@ -1075,9 +1075,9 @@ "link": true }, "node_modules/@firebolt-js/openrpc": { - "version": "3.1.1-next.2", - "resolved": "https://registry.npmjs.org/@firebolt-js/openrpc/-/openrpc-3.1.1-next.2.tgz", - "integrity": "sha512-D5b8ovtmRQNSlJ52LRJHtp0rmvlao6axzpmqYjW8wsljNeTj9QcAJ1xiUiYBt2uFitvGM6zQA04e3rbJhErJ+w==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@firebolt-js/openrpc/-/openrpc-3.1.1.tgz", + "integrity": "sha512-+ypWAo02Q/eYc3PQ0pHii/37u2Q9fIdeGyT8o9ghLO1rIYgB5q7N2rTE0hYEKgbOTAq6GdyFLV/TZ4Vj8D2jCA==", "dev": true, "dependencies": { "ajv": "^8.12.0", diff --git a/package.json b/package.json index 94e0c8eee..4c2afe5e0 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "devDependencies": { "@commitlint/cli": "^17.0.3", "@commitlint/config-conventional": "^17.0.3", - "@firebolt-js/openrpc": "3.1.1-next.2", + "@firebolt-js/openrpc": "3.1.1", "@firebolt-js/schemas": "2.0.0", "@saithodev/semantic-release-backmerge": "^3.2.0", "@semantic-release/changelog": "^6.0.1", From ec6625979f0f399d5b2ad811b1bb7ca79d2a7937 Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Tue, 3 Sep 2024 12:37:01 -0400 Subject: [PATCH 9/9] fix: Updated device.model description --- src/openrpc/device.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/openrpc/device.json b/src/openrpc/device.json index 8b149998f..54c9db7d4 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -173,7 +173,7 @@ }, { "name": "model", - "summary": "Get the manufacturer designated model of the device, equivalent to the PMI of the device", + "summary": "Get the manufacturer designated model of the device", "params": [], "tags": [ {