fix: Use new app provider pattern

rdkcentral · Mar 18, 2024 · 73a1e7c · 73a1e7c
1 parent 4592de0
commit 73a1e7c
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 226 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/openrpc/content.json b/src/openrpc/content.json
@@ -290,7 +290,14 @@
                     "name": "type",
                     "required": true,
                     "schema": {
-                        "type": "string"
+                        "$ref": "https://meta.comcast.com/firebolt/discovery#/definitions/InterestType"
+                    }
+                },
+                {
+                    "name": "reason",
+                    "required": true,
+                    "schema": {
+                        "$ref": "https://meta.comcast.com/firebolt/discovery#/definitions/InterestReason"
                     }
                 }
             ],
@@ -309,6 +316,10 @@
                         {
                             "name": "type",
                             "value": "interest"
+                        },
+                        {
+                            "name": "reason",
+                            "value": "playlist"
                         }
                     ],
                     "result": {

diff --git a/src/openrpc/discovery.json b/src/openrpc/discovery.json
@@ -1475,136 +1475,6 @@
           }
         }
       ]
-    },
-    {
-      "name": "userInterest",
-      "summary": "Notify the platform that content was marked as interesting to the user.",
-      "tags": [
-        {
-          "name": "capabilities",
-          "x-provides": "xrn:firebolt:capability:discovery:interest"
-        }
-      ],
-      "params": [
-        {
-          "name": "type",
-          "required": true,
-          "schema": {
-            "$ref": "https://meta.comcast.com/firebolt/discovery#/definitions/UserInterestType"
-          },
-          "summary": "The entity Id of the watched content."
-        },
-        {
-          "name": "entity",
-          "schema": {
-            "$ref": "https://meta.comcast.com/firebolt/entertainment#/definitions/EntityInfo"
-          }
-        }
-      ],
-      "result": {
-        "name": "default",
-        "schema": {
-          "type": "null"
-        }
-      },
-      "examples": [
-        {
-          "name": "Notify the platform of interest.",
-          "params": [
-            {
-              "name": "type",
-              "value": "interest"
-            },
-            {
-              "name": "entity",
-              "value": {
-                "identifiers": {
-                  "entityId": "xyz"
-                },
-                "entityType": "program",
-                "programType": "movie",
-                "title": "Interesting Movie Title"
-              }
-            }
-          ],
-          "result": {
-            "name": "default",
-            "value": null
-          }
-        },
-        {
-          "name": "Notify the platform of disinterest.",
-          "params": [
-            {
-              "name": "type",
-              "value": "disinterest"
-            },
-            {
-              "name": "entity",
-              "value": {
-                "identifiers": {
-                  "entityId": "xyz"
-                },
-                "entityType": "program",
-                "programType": "movie",
-                "title": "Uninteresting Movie Title"
-              }
-            }
-          ],
-          "result": {
-            "name": "default",
-            "value": null
-          }
-        }
-      ]
-    },
-    {
-      "name": "onRequestUserInterest",
-      "summary": "Invoked when the platform is requesting metadata for content that the user finds interesting.",
-      "tags": [
-        {
-          "name": "event",
-          "x-response": {
-            "$ref": "https://meta.comcast.com/firebolt/entertainment#/definitions/EntityInfo",
-            "examples": [
-              {
-                  "identifiers": {
-                    "entityId": "xyz"
-                  },
-                  "entityType": "program",
-                  "programType": "movie",
-                  "title": "Interesting Movie Title"
-              }
-            ]
-          }
-        },
-        {
-          "name": "capabilities",
-          "x-provides": "xrn:firebolt:capability:discovery:interest"
-        }
-      ],
-      "params": [],
-      "result": {
-        "name": "request",
-        "schema": {
-          "$ref": "#/components/schemas/UserInterestProviderRequest"
-        }
-      },
-      "examples": [
-        {
-          "name": "Platform requests the currently displayed content.",
-          "params": [],
-          "result": {
-            "name": "request",
-            "value": {
-              "correlationId": "1",
-              "parameters": {
-                "type": "interest"
-              }
-            }
-          }
-        }
-      ]
     }
   ],
   "components": {
@@ -1923,36 +1793,6 @@
         "enum": [
           "xrn:firebolt:channel:any"
         ]
-      },
-      "UserInterestProviderRequest": {
-        "title": "UserInterestProviderRequest",
-        "type": "object",
-        "required": [
-          "correlationId",
-          "parameters"
-        ],
-        "properties": {
-          "correlationId": {
-            "type": "string",
-            "description": "An id to correlate the provider response with this request"
-          },
-          "parameters": {
-            "description": "The request to initiate a user interest session",
-            "$ref": "#/components/schemas/UserInterestParameters"
-          }
-        }
-      },
-      "UserInterestParameters": {
-        "title": "UserInterestParameters",
-        "type": "object",
-        "required": [
-          "type"
-        ],
-        "properties": {
-          "type": {
-            "$ref": "https://meta.comcast.com/firebolt/discovery#/definitions/UserInterestType"
-          }
-        }
       }
     }
   }

diff --git a/src/schemas/discovery.json b/src/schemas/discovery.json
@@ -101,6 +101,23 @@
             }
           }
         }
-      }        
+      },
+      "InterestType": {
+        "title": "InterestType",
+        "type": "string",
+        "enum": [
+          "interest",
+          "disinterest"
+        ]
+      },
+      "InterestReason": {
+        "title": "InterestReason",
+        "type": "string",
+        "enum": [
+          "playlist",
+          "reaction",
+          "recording"
+        ]
+      }
     }  
   }
diff --git a/src/schemas/intents.json b/src/schemas/intents.json
@@ -104,9 +104,6 @@
                                 },
                                 {
                                     "$ref": "#/definitions/DialogIntent"
-                                },
-                                {
-                                    "$ref": "#/definitions/InterestedInIntent"
                                 }
                             ]
                         },
@@ -1791,63 +1788,7 @@
                 }
             ]
         },
-        "InterestedInIntent": {
-            "description": "A Firebolt compliant representation of a user's interest in a piece of content.",
-            "title": "InterestedInIntent",
-            "allOf": [
-                {
-                    "title": "InterestedInIntent",
-                    "$ref": "#/definitions/Intent"
-                },
-                {
-                    "title": "InterestedInIntent",
-                    "$ref": "#/definitions/IntentProperties"
-                },
-                {
-                    "title": "InterestedInIntent",
-                    "type": "object",
-                    "properties": {
-                        "action": {
-                            "const": "interestedIn"
-                        },
-                        "data": {
-                            "type": "object",
-                            "properties": {
-                                "appId": {
-                                    "type": "string"
-                                },
-                                "type": {
-                                    "$ref": "https://meta.comcast.com/firebolt/discovery#/definitions/UserInterestType"
-                                },
-                                "entity": {
-                                    "$ref": "https://meta.comcast.com/firebolt/entertainment#/definitions/EntityInfo"
-                                }
-                            }
-                        }
-                    }
-                }
-            ],
-            "examples": [
-                {
-                    "action": "interestedIn",
-                    "data": {
-                        "appId": "coolapp",
-                        "type": "interest",
-                        "entity": {
-                            "identifiers": {
-                                "entityId": "xyz"
-                            },
-                            "entityType": "program",
-                            "programType": "movie",
-                            "title": "Interesting Movie Title"
-                        }
-                    },
-                    "context": {
-                        "source": "voice"
-                    }
-                }
-            ]
-        },        
+
         "Identifier": {
             "type": "string"
         },

diff --git a/src/sdks/discovery/package.json b/src/sdks/discovery/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@firebolt-js/discovery-sdk",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"description": "The Firebolt Discovery JS SDK",
 	"main": "./dist/lib/firebolt-discovery.mjs",
 	"types": "./dist/lib/firebolt-discovery.d.ts",

diff --git a/src/sdks/discovery/sdk.config.json b/src/sdks/discovery/sdk.config.json
@@ -9,7 +9,7 @@
                 "xrn:firebolt:capability:discovery:providers",
                 "xrn:firebolt:capability:discovery:purchased-content",
                 "xrn:firebolt:capability:discovery:entity-info",
-                "xrn:firebolt:capability:discovery:interest"
+                "xrn:firebolt:capability:discovery:user-interest"
             ]
         }
     ]

diff --git a/src/sdks/discovery/test/suite/content.test.ts b/src/sdks/discovery/test/suite/content.test.ts
@@ -21,8 +21,9 @@ import { Content } from "../../build/javascript/src/firebolt-discovery";
 
 test("Content.requestUserInterest()", () => {
   const expTime: number = new Date().getTime() + 100;
-  return Content.requestUserInterest(Content.InterestType.INTEREST).then((entity:Content.EntityInfo) => {
+  Content.requestDetails
+  return Content.requestUserInterest(Content.InterestType.INTEREST, Content.InterestReason.PLAYLIST).then((entity:Content.EntityDetails) => {
     expect(entity).toBeDefined()
-    expect(entity.title).toBe("Interesting Movie Title")
+    expect(entity.info.title).toBe("Cool Runnings")
   })
 });