Merge branch 'app-passthrough-additions' of github.com:rdkcentral/fir…

…ebolt-apis into app-passthrough-additions
rdkcentral · Aug 21, 2024 · d9be113 · d9be113
2 parents 26a6e81 + ce31b0f
commit d9be113
Show file tree

Hide file tree

Showing 41 changed files with 1,985 additions and 184 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,71 @@
+## [1.3.1-next.1](https://github.com/rdkcentral/firebolt-apis/compare/v1.3.0...v1.3.1-next.1) (2024-08-19)
+
+
+### Bug Fixes
+
+* Spec and Doc fixes ([#302](https://github.com/rdkcentral/firebolt-apis/issues/302)) ([6010a85](https://github.com/rdkcentral/firebolt-apis/commit/6010a85e9883480aba71378391f5b6223645fb28))
+
+# [1.3.0](https://github.com/rdkcentral/firebolt-apis/compare/v1.2.0...v1.3.0) (2024-08-12)
+
+
+### Bug Fixes
+
+* Added Lifecycle template in cpp ([#292](https://github.com/rdkcentral/firebolt-apis/issues/292)) ([046adc1](https://github.com/rdkcentral/firebolt-apis/commit/046adc18ca7f2d35d02b9ce597be6f330c3b1972))
+* Added Static Metrics template in CPP ([#293](https://github.com/rdkcentral/firebolt-apis/issues/293)) ([a1f75cb](https://github.com/rdkcentral/firebolt-apis/commit/a1f75cb22577c3eded0968ca51ca656336a88506))
+* **core, manage:** update C++ tests to run simultaneously for core and manage SDKs ([ef7bc4c](https://github.com/rdkcentral/firebolt-apis/commit/ef7bc4ce117cbce799ddab8c9b44522730374514))
+* Pointed to latest OpenRPC release ([#298](https://github.com/rdkcentral/firebolt-apis/issues/298)) ([16b3305](https://github.com/rdkcentral/firebolt-apis/commit/16b3305201624acf904c98d8c414b9756d42aaa7))
+* Small update to Manage SDK test ([#297](https://github.com/rdkcentral/firebolt-apis/issues/297)) ([95e3b0f](https://github.com/rdkcentral/firebolt-apis/commit/95e3b0f211f4a80d4573adc9c1b35d2e74a78777))
+* Sort capabilities in Firebolt Specification JSON ([46dd188](https://github.com/rdkcentral/firebolt-apis/commit/46dd1887e09cc3c75ebb7b41028b10b3a8d3596e))
+* Update to CHANGELOG.md for Release 1.3.0 ([9454527](https://github.com/rdkcentral/firebolt-apis/commit/9454527c684e6cfee3d9f99ad4c1c0fa8a6e4167))
+
+
+### Features
+
+* Add Metrics.appInfo API ([#294](https://github.com/rdkcentral/firebolt-apis/issues/294)) ([47264b5](https://github.com/rdkcentral/firebolt-apis/commit/47264b5c5c71fd117a52ca50f2e57315932905ad))
+* CPP App-Passthrough Logic ([#286](https://github.com/rdkcentral/firebolt-apis/issues/286)) ([4eb84ee](https://github.com/rdkcentral/firebolt-apis/commit/4eb84ee08c463915e3b13afec6603541ea0b1ae4))
+
+# [1.3.0-next.4](https://github.com/rdkcentral/firebolt-apis/compare/v1.3.0-next.3...v1.3.0-next.4) (2024-08-09)
+
+
+### Bug Fixes
+
+* Pointed to latest OpenRPC release ([#298](https://github.com/rdkcentral/firebolt-apis/issues/298)) ([16b3305](https://github.com/rdkcentral/firebolt-apis/commit/16b3305201624acf904c98d8c414b9756d42aaa7))
+
+# [1.3.0-next.3](https://github.com/rdkcentral/firebolt-apis/compare/v1.3.0-next.2...v1.3.0-next.3) (2024-08-08)
+
+
+### Bug Fixes
+
+* Small update to Manage SDK test ([#297](https://github.com/rdkcentral/firebolt-apis/issues/297)) ([95e3b0f](https://github.com/rdkcentral/firebolt-apis/commit/95e3b0f211f4a80d4573adc9c1b35d2e74a78777))
+
+# [1.3.0-next.2](https://github.com/rdkcentral/firebolt-apis/compare/v1.3.0-next.1...v1.3.0-next.2) (2024-08-02)
+
+
+### Features
+
+* Add Metrics.appInfo API ([#294](https://github.com/rdkcentral/firebolt-apis/issues/294)) ([47264b5](https://github.com/rdkcentral/firebolt-apis/commit/47264b5c5c71fd117a52ca50f2e57315932905ad))
+
+# [1.3.0-next.1](https://github.com/rdkcentral/firebolt-apis/compare/v1.2.1-next.4...v1.3.0-next.1) (2024-07-29)
+
+
+### Features
+
+* CPP App-Passthrough Logic ([#286](https://github.com/rdkcentral/firebolt-apis/issues/286)) ([4eb84ee](https://github.com/rdkcentral/firebolt-apis/commit/4eb84ee08c463915e3b13afec6603541ea0b1ae4))
+
+## [1.2.1-next.4](https://github.com/rdkcentral/firebolt-apis/compare/v1.2.1-next.3...v1.2.1-next.4) (2024-07-29)
+
+
+### Bug Fixes
+
+* Added Static Metrics template in CPP ([#293](https://github.com/rdkcentral/firebolt-apis/issues/293)) ([a1f75cb](https://github.com/rdkcentral/firebolt-apis/commit/a1f75cb22577c3eded0968ca51ca656336a88506))
+
+## [1.2.1-next.3](https://github.com/rdkcentral/firebolt-apis/compare/v1.2.1-next.2...v1.2.1-next.3) (2024-07-29)
+
+
+### Bug Fixes
+
+* Added Lifecycle template in cpp ([#292](https://github.com/rdkcentral/firebolt-apis/issues/292)) ([046adc1](https://github.com/rdkcentral/firebolt-apis/commit/046adc18ca7f2d35d02b9ce597be6f330c3b1972))
+
 ## [1.2.1-next.2](https://github.com/rdkcentral/firebolt-apis/compare/v1.2.1-next.1...v1.2.1-next.2) (2024-07-01)
 
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@firebolt-js/sdks",
-  "version": "1.2.1-next.2",
+  "version": "1.3.1-next.1",
   "description": "The Firebolt JS SDK",
   "type": "module",
   "bin": {
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
-    "@firebolt-js/openrpc": "3.0.0",
+    "@firebolt-js/openrpc": "3.1.0",
     "@firebolt-js/schemas": "2.0.0",
     "@saithodev/semantic-release-backmerge": "^3.2.0",
     "@semantic-release/changelog": "^6.0.1",

diff --git a/src/json/firebolt-specification.json b/src/json/firebolt-specification.json
@@ -147,9 +147,6 @@
         "negotiable": false
       }
     },
-    "xrn:firebolt:capability:privacy:advertising": {
-      "level": "could"
-    },
     "xrn:firebolt:capability:metrics:distributor": {
       "level": "could"
     },

diff --git a/src/openrpc/_internal.json b/src/openrpc/_internal.json
@@ -35,15 +35,7 @@
         "name": "session",
         "summary": "Info about the SDK/FEE session",
         "schema": {
-          "type": "object",
-          "required": ["version"],
-          "properties": {
-            "version": {
-              "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion",
-              "description": "The semantic version of the FEE."
-            }
-          },
-          "additionalProperties": false
+          "$ref": "#/components/schemas/InitializeResult"
         }
       },
       "examples": [
@@ -76,7 +68,19 @@
     }
   ],
   "components": {
-    "schemas": {    
+    "schemas": {
+      "InitializeResult": {
+        "title": "InitializeResult",
+        "type": "object",
+        "required": ["version"],
+        "properties": {
+          "version": {
+            "$ref": "https://meta.comcast.com/firebolt/types#/definitions/SemanticVersion",
+            "description": "The semantic version of the FEE."
+          }
+        },
+        "additionalProperties": false
+      }
     }
   }
 }
diff --git a/src/openrpc/advertising.json b/src/openrpc/advertising.json
@@ -81,8 +81,7 @@
         {
           "name": "capabilities",
           "x-uses": [
-            "xrn:firebolt:capability:privacy:advertising",
-            "xrn:firebolt:capability:advertising:configuration"
+            "xrn:firebolt:capability:advertising:policy"
           ]
         }
       ],
@@ -157,7 +156,7 @@
           ]
         }
       ],
-      "summary": "Get the advertising ID",
+      "summary": "Get the IAB compliant identifier for advertising (IFA). It is recommended to use the IFA to manage advertising related activities while respecting the user's privacy settings.",
       "params": [
         {
           "name": "options",
@@ -172,21 +171,7 @@
         "name": "advertisingId",
         "summary": "the advertising ID",
         "schema": {
-          "type": "object",
-          "properties": {
-            "ifa": {
-              "type": "string"
-            },
-            "ifa_type": {
-              "type": "string"
-            },
-            "lmt": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "ifa"
-          ]
+          "$ref": "#/components/schemas/AdvertisingIdResult"
         }
       },
       "examples": [
@@ -197,7 +182,7 @@
             "name": "Default Result",
             "value": {
               "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-              "ifa_type": "idfa",
+              "ifa_type": "sspid",
               "lmt": "0"
             }
           }
@@ -219,7 +204,7 @@
             "name": "Default Result",
             "value": {
               "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-              "ifa_type": "idfa",
+              "ifa_type": "sspid",
               "lmt": "0"
             }
           }
@@ -303,7 +288,7 @@
           "params": [],
           "result": {
             "name": "Default Result",
-            "value": "operator.app"
+            "value": "app.operator"
           }
         }
       ]
@@ -404,6 +389,33 @@
             }
           }
         }
+      },
+      "AdvertisingIdResult": {
+        "title": "AdvertisingIdResult",
+        "type": "object",
+        "properties": {
+          "ifa": {
+            "type": "string",
+            "description": "UUID conforming to IAB standard"
+          },
+          "ifa_type": {
+            "type": "string",
+            "description": "source of the IFA as defined by IAB"
+          },
+          "lmt": {
+            "type": "string",
+            "enum": [
+              "0",
+              "1"
+            ],
+            "description": "boolean that if set to 1, user has requested ad tracking and measurement is disabled"
+          }
+        },
+        "required": [
+          "ifa",
+          "ifa_type",
+          "lmt"
+        ]
       }
     }
   }

diff --git a/src/openrpc/authentication.json b/src/openrpc/authentication.json
@@ -44,22 +44,7 @@
         "name": "token",
         "summary": "the token value, type, and expiration",
         "schema": {
-          "type": "object",
-          "properties": {
-            "value": {
-              "type": "string"
-            },
-            "expires": {
-              "type": "string",
-              "format": "date-time"
-            },
-            "type": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "value"
-          ]
+          "$ref": "#/components/schemas/AuthenticationTokenResult"
         }
       },
       "examples": [
@@ -233,6 +218,25 @@
           "device",
           "distributor"
         ]
+      },
+      "AuthenticationTokenResult": {
+        "title": "AuthenticationTokenResult",
+        "type": "object",
+        "properties": {
+          "value": {
+            "type": "string"
+          },
+          "expires": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "type": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "value"
+        ]
       }
     }
   }