Rebase feature/x-subscriber-type

.github/workflows/merge-to-main.yml

@@ -0,0 +1,43 @@
+name: Attempt to merge next to main
+on:
+  workflow_dispatch:
+
+jobs:
+  # Check if next can merge into main
+  perform_merge:
+    name: Perform merge if "next" can merge into "main"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          repo-token: ${{ secrets.SEMANTIC_RELEASE_BOT_PAT }}
+          persist-credentials: true
+
+      # Set user identity
+      - name: Set-Identity
+        run: |
+          git config --global user.email "${{ secrets.GLOBAL_GITHUB_EMAIL }}"
+          git config --global user.name "${{ secrets.GLOBAL_GITHUB_USER }}"
+
+      # Checkout "main"
+      - name: Checkout main
+        run: git checkout "main"
+
+      - name: Perform the merge from next to main
+        run: |
+          git merge next
+          git push origin "main"
+          echo "Push to main succeeded"
+
+  # If the merge cannot be performed, let stakeholders know
+  message_on_failure:
+    name: Merge failure
+    needs: perform_merge
+    runs-on: ubuntu-latest
+    if: ${{ failure() }}
+
+    steps:
+      - name: Post error message (To-Do)
+        run: echo "Next cannot be merged into main cleanly"

.github/workflows/merge-to-next-major.yml

@@ -0,0 +1,72 @@
+name: Attempt to merge next to next-major
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "next"
+
+jobs:
+  # Check if next can merge into next-major
+  perform_merge:
+    name: Perform merge if "next" can merge into "next-major"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          repo-token: ${{ secrets.SEMANTIC_RELEASE_BOT_PAT }}
+          persist-credentials: true
+
+      # Set user identity
+      - name: Set-Identity
+        run: |
+          git config --global user.email "${{ secrets.GLOBAL_GITHUB_EMAIL }}"
+          git config --global user.name "${{ secrets.GLOBAL_GITHUB_USER }}"
+
+      # Checkout "next-major"
+      - name: Checkout next-major
+        run: git checkout "next-major"
+
+      # Get the "next-major" version number
+      - name: Extract next-major version
+        id: extract_version
+        run: echo "::set-output name=version::$(node -e 'console.log(require("./package.json").version)')"
+
+      # Checkout "next"
+      - name: Checkout next
+        run: git checkout "next"
+
+      # Update "next" version to match "next-major"
+      - name: Update "next" version to match "next-major"
+        run: |
+          jq '.version = "${{ steps.extract_version.outputs.version }}"' package.json > temp.json
+
+          if diff -q "package.json" "temp.json" >/dev/null; then
+            echo "Versions are identical. No change required."
+            rm temp.json
+          else
+            mv temp.json package.json
+            git add package.json && git commit -m "Sync version to ${{ steps.extract_version.outputs.version }}"
+          fi
+
+      # Checkout "next-major"
+      - name: Checkout next-major
+        run: git checkout "next-major"
+
+      - name: Perform the merge from next to next-major
+        run: |
+          git merge next
+          git push origin "next-major"
+          echo "Push to next-major succeeded"
+
+  # If the merge cannot be performed, let stakeholders know
+  message_on_failure:
+    name: Merge failure
+    needs: perform_merge
+    runs-on: ubuntu-latest
+    if: ${{ failure() }}
+
+    steps:
+      - name: Post error message (To-Do)
+        run: echo "Next cannot be merged into next-major cleanly"

.gitignore

@@ -4,3 +4,4 @@ node_modules/*
 .DS_Store
 .DS_Store
 coverage
+.vscode/settings.json

CHANGELOG.md

@@ -1,17 +1,74 @@
-# [2.2.0-next.1](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.1.1-next.3...v2.2.0-next.1) (2023-11-30)
+# [3.0.0-next.3](https://github.com/rdkcentral/firebolt-openrpc/compare/v3.0.0-next.2...v3.0.0-next.3) (2024-05-09)
+
+
+### Bug Fixes
+
+* Account for new OpenRPC spec URL contents ([#186](https://github.com/rdkcentral/firebolt-openrpc/issues/186)) ([66bd6ac](https://github.com/rdkcentral/firebolt-openrpc/commit/66bd6acc1ffdaefadcb46d78864d615a116b5a85))
+
+# [3.0.0-next.2](https://github.com/rdkcentral/firebolt-openrpc/compare/v3.0.0-next.1...v3.0.0-next.2) (2024-04-08)
+
+
+### Features
+
+* CI/CD Merging from next ([#183](https://github.com/rdkcentral/firebolt-openrpc/issues/183)) ([14476a9](https://github.com/rdkcentral/firebolt-openrpc/commit/14476a908f2c10d907417187c41ce255ac2ea6a6))
+
+# [3.0.0-next.1](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.3.0-next.1...v3.0.0-next.1) (2024-03-26)
+
+
+* Integration of CPPSDK support (#176) ([89294cc](https://github.com/rdkcentral/firebolt-openrpc/commit/89294cc37f23a94012621130858e01c946a3a9a6)), closes [#176](https://github.com/rdkcentral/firebolt-openrpc/issues/176) [#90](https://github.com/rdkcentral/firebolt-openrpc/issues/90) [#93](https://github.com/rdkcentral/firebolt-openrpc/issues/93) [#94](https://github.com/rdkcentral/firebolt-openrpc/issues/94) [#96](https://github.com/rdkcentral/firebolt-openrpc/issues/96) [#97](https://github.com/rdkcentral/firebolt-openrpc/issues/97) [#100](https://github.com/rdkcentral/firebolt-openrpc/issues/100) [#99](https://github.com/rdkcentral/firebolt-openrpc/issues/99) [#101](https://github.com/rdkcentral/firebolt-openrpc/issues/101) [#102](https://github.com/rdkcentral/firebolt-openrpc/issues/102) [#107](https://github.com/rdkcentral/firebolt-openrpc/issues/107) [#106](https://github.com/rdkcentral/firebolt-openrpc/issues/106) [#105](https://github.com/rdkcentral/firebolt-openrpc/issues/105) [#103](https://github.com/rdkcentral/firebolt-openrpc/issues/103) [#109](https://github.com/rdkcentral/firebolt-openrpc/issues/109) [#112](https://github.com/rdkcentral/firebolt-openrpc/issues/112) [#111](https://github.com/rdkcentral/firebolt-openrpc/issues/111) [#113](https://github.com/rdkcentral/firebolt-openrpc/issues/113) [#114](https://github.com/rdkcentral/firebolt-openrpc/issues/114) [#115](https://github.com/rdkcentral/firebolt-openrpc/issues/115) [#110](https://github.com/rdkcentral/firebolt-openrpc/issues/110) [#90](https://github.com/rdkcentral/firebolt-openrpc/issues/90) [#93](https://github.com/rdkcentral/firebolt-openrpc/issues/93) [#94](https://github.com/rdkcentral/firebolt-openrpc/issues/94) [#96](https://github.com/rdkcentral/firebolt-openrpc/issues/96) [#97](https://github.com/rdkcentral/firebolt-openrpc/issues/97) [#100](https://github.com/rdkcentral/firebolt-openrpc/issues/100) [#99](https://github.com/rdkcentral/firebolt-openrpc/issues/99) [#101](https://github.com/rdkcentral/firebolt-openrpc/issues/101) [#102](https://github.com/rdkcentral/firebolt-openrpc/issues/102) [#107](https://github.com/rdkcentral/firebolt-openrpc/issues/107) [#106](https://github.com/rdkcentral/firebolt-openrpc/issues/106) [#105](https://github.com/rdkcentral/firebolt-openrpc/issues/105) [#103](https://github.com/rdkcentral/firebolt-openrpc/issues/103) [#109](https://github.com/rdkcentral/firebolt-openrpc/issues/109) [#112](https://github.com/rdkcentral/firebolt-openrpc/issues/112) [#111](https://github.com/rdkcentral/firebolt-openrpc/issues/111) [#113](https://github.com/rdkcentral/firebolt-openrpc/issues/113) [#114](https://github.com/rdkcentral/firebolt-openrpc/issues/114) [#115](https://github.com/rdkcentral/firebolt-openrpc/issues/115) [#110](https://github.com/rdkcentral/firebolt-openrpc/issues/110) [#117](https://github.com/rdkcentral/firebolt-openrpc/issues/117) [#116](https://github.com/rdkcentral/firebolt-openrpc/issues/116) [#118](https://github.com/rdkcentral/firebolt-openrpc/issues/118) [#121](https://github.com/rdkcentral/firebolt-openrpc/issues/121) [#119](https://github.com/rdkcentral/firebolt-openrpc/issues/119) [#90](https://github.com/rdkcentral/firebolt-openrpc/issues/90) [#93](https://github.com/rdkcentral/firebolt-openrpc/issues/93) [#94](https://github.com/rdkcentral/firebolt-openrpc/issues/94) [#96](https://github.com/rdkcentral/firebolt-openrpc/issues/96) [#97](https://github.com/rdkcentral/firebolt-openrpc/issues/97) [#100](https://github.com/rdkcentral/firebolt-openrpc/issues/100) [#99](https://github.com/rdkcentral/firebolt-openrpc/issues/99) [#101](https://github.com/rdkcentral/firebolt-openrpc/issues/101) [#102](https://github.com/rdkcentral/firebolt-openrpc/issues/102) [#107](https://github.com/rdkcentral/firebolt-openrpc/issues/107) [#106](https://github.com/rdkcentral/firebolt-openrpc/issues/106) [#105](https://github.com/rdkcentral/firebolt-openrpc/issues/105) [#103](https://github.com/rdkcentral/firebolt-openrpc/issues/103) [#109](https://github.com/rdkcentral/firebolt-openrpc/issues/109) [#112](https://github.com/rdkcentral/firebolt-openrpc/issues/112) [#111](https://github.com/rdkcentral/firebolt-openrpc/issues/111) [#113](https://github.com/rdkcentral/firebolt-openrpc/issues/113) [#114](https://github.com/rdkcentral/firebolt-openrpc/issues/114) [#115](https://github.com/rdkcentral/firebolt-openrpc/issues/115) [#110](https://github.com/rdkcentral/firebolt-openrpc/issues/110) [#117](https://github.com/rdkcentral/firebolt-openrpc/issues/117) [#116](https://github.com/rdkcentral/firebolt-openrpc/issues/116) [#118](https://github.com/rdkcentral/firebolt-openrpc/issues/118) [#121](https://github.com/rdkcentral/firebolt-openrpc/issues/121) [#119](https://github.com/rdkcentral/firebolt-openrpc/issues/119) [#127](https://github.com/rdkcentral/firebolt-openrpc/issues/127) [#137](https://github.com/rdkcentral/firebolt-openrpc/issues/137) [#135](https://github.com/rdkcentral/firebolt-openrpc/issues/135) [#134](https://github.com/rdkcentral/firebolt-openrpc/issues/134) [#136](https://github.com/rdkcentral/firebolt-openrpc/issues/136) [#139](https://github.com/rdkcentral/firebolt-openrpc/issues/139) [#138](https://github.com/rdkcentral/firebolt-openrpc/issues/138) [#140](https://github.com/rdkcentral/firebolt-openrpc/issues/140) [#142](https://github.com/rdkcentral/firebolt-openrpc/issues/142) [#144](https://github.com/rdkcentral/firebolt-openrpc/issues/144) [#145](https://github.com/rdkcentral/firebolt-openrpc/issues/145) [#141](https://github.com/rdkcentral/firebolt-openrpc/issues/141) [#149](https://github.com/rdkcentral/firebolt-openrpc/issues/149) [#150](https://github.com/rdkcentral/firebolt-openrpc/issues/150) [#152](https://github.com/rdkcentral/firebolt-openrpc/issues/152) [#151](https://github.com/rdkcentral/firebolt-openrpc/issues/151) [#153](https://github.com/rdkcentral/firebolt-openrpc/issues/153) [#154](https://github.com/rdkcentral/firebolt-openrpc/issues/154) [#156](https://github.com/rdkcentral/firebolt-openrpc/issues/156) [#157](https://github.com/rdkcentral/firebolt-openrpc/issues/157) [#158](https://github.com/rdkcentral/firebolt-openrpc/issues/158) [#160](https://github.com/rdkcentral/firebolt-openrpc/issues/160) [#159](https://github.com/rdkcentral/firebolt-openrpc/issues/159) [#161](https://github.com/rdkcentral/firebolt-openrpc/issues/161) [#163](https://github.com/rdkcentral/firebolt-openrpc/issues/163) [#164](https://github.com/rdkcentral/firebolt-openrpc/issues/164) [#165](https://github.com/rdkcentral/firebolt-openrpc/issues/165) [#167](https://github.com/rdkcentral/firebolt-openrpc/issues/167) [#169](https://github.com/rdkcentral/firebolt-openrpc/issues/169) [#171](https://github.com/rdkcentral/firebolt-openrpc/issues/171) [#173](https://github.com/rdkcentral/firebolt-openrpc/issues/173) [#172](https://github.com/rdkcentral/firebolt-openrpc/issues/172) [#170](https://github.com/rdkcentral/firebolt-openrpc/issues/170)
+
+
+### BREAKING CHANGES
+
+* Generalized templating engine to support both JavaScript and CPP (and other languages).
+
+* chore: Copy JS templates to C and create language.config.json
+
+* feat(languages): Add support for a distinct JSON-type for each schema
+
+Also started tweaking C templates and adding a few useful macros.
+
+* chore: Dropped debug logs
+
+* fix: Stop passing non-schemas in to getSchemaType
+
+* feat(accessors): New macro section for schema property accessors
+
+# [2.3.0-next.1](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.2.0...v2.3.0-next.1) (2024-01-12)
+
+
+### Bug Fixes
+
+* Insert 'v' in front of version enum names ([d8b9ada](https://github.com/rdkcentral/firebolt-openrpc/commit/d8b9ada1b624df29821b74679291d36167208470))
+* Proper param handling for x-subscriber-type: global ([02204e5](https://github.com/rdkcentral/firebolt-openrpc/commit/02204e5f93d27a21086b4a9bbe5f586f969354f8))
+
+
+### Features
+
+* Support for context-free property subscribers ([9809273](https://github.com/rdkcentral/firebolt-openrpc/commit/980927309fa6efc7b03a490aa5fd7909f39ff4de))
+
+# [2.2.0](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.1.2...v2.2.0) (2023-11-30)
 
 
 ### Features
 
 * Improve generated doc formatting ([#155](https://github.com/rdkcentral/firebolt-openrpc/issues/155)) ([4613281](https://github.com/rdkcentral/firebolt-openrpc/commit/46132810ac5e5b0a8b9baa22903cb8a367b46f63))
 
-## [2.1.1-next.3](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.1.1-next.2...v2.1.1-next.3) (2023-11-09)
+## [2.1.2](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.1.1...v2.1.2) (2023-11-09)
 
 
 ### Bug Fixes
 
 * Provider openrpc response and error methods have a wrapper object ([#148](https://github.com/rdkcentral/firebolt-openrpc/issues/148)) ([373626e](https://github.com/rdkcentral/firebolt-openrpc/commit/373626ed598447bb670ac67e97ca8ed1bf32f28f))
 
+## [2.1.1](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.1.0...v2.1.1) (2023-11-01)
+
+
+### Bug Fixes
+
+* Errors thrown in async provider methods do not send the JSONRPC error response ([#143](https://github.com/rdkcentral/firebolt-openrpc/issues/143)) ([ec8e259](https://github.com/rdkcentral/firebolt-openrpc/commit/ec8e2599d530f9d2bd38fbb53b36e13c038edf2a))
+* Macro not replaced for provider docs ([ef1aecd](https://github.com/rdkcentral/firebolt-openrpc/commit/ef1aecd0092a8652bc7b936604f9478b7b55df27))
+
 ## [2.1.1-next.2](https://github.com/rdkcentral/firebolt-openrpc/compare/v2.1.1-next.1...v2.1.1-next.2) (2023-11-01)
 
 

languages/c-structs/language.config.json

@@ -0,0 +1,27 @@
+{
+    "name": "C",
+    "langcode": "c",
+    "createModuleDirectories": false,
+    "extractSubSchemas": true,
+    "unwrapResultObjects": true,
+    "convertTuplesToArraysOrObjects": true,
+    "templatesPerModule": [
+        "/include/module.h",
+        "/src/module.cpp"
+    ],
+    "templatesPerSchema": [
+        "/include/common/module.h",
+        "/src/module_common.cpp",
+        "/src/jsondata_module.h"
+    ],
+    "persistPermission": true,
+    "primitives": {
+        "boolean": "bool",
+        "integer": "int",
+        "number": "float",
+        "string": "char*"
+    },
+    "additionalSchemaTemplates": [
+        "json-types"
+    ]
+}

languages/c-structs/src/index.mjs

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2021 Comcast Cable Communications Management, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { default as Transport } from './shared/Transport/index.mjs'

languages/c-structs/templates/codeblocks/export.c

@@ -0,0 +1 @@
+export { default as ${info.title} } from './${info.title}/index.mjs'

languages/c-structs/templates/codeblocks/mock-import.c

@@ -0,0 +1 @@
+import { default as _${info.title} } from './${info.title}/defaults.mjs'

languages/c-structs/templates/codeblocks/mock-parameter.c

@@ -0,0 +1 @@
+    ${info.title}: _${info.title},

languages/c-structs/templates/codeblocks/setter.c

@@ -0,0 +1,9 @@
+/* ${method.name} - ${method.description} */
+uint32_t ${info.title}_${method.Name}( ${method.signature.params} )
+{
+    const string method = _T("${info.title}.${method.name}");
+      ${if.params}
+${method.params.serialization}
+      ${end.if.params}
+    return FireboltSDK::Properties::Set(method, jsonParameters);
+}

languages/c-structs/templates/declarations/default.c

@@ -0,0 +1,5 @@
+/*
+ * ${method.summary}
+ * ${method.params}
+ */
+int F${info.title}_${method.Name}(${method.signature.params}${if.result.properties}${if.params}, ${end.if.params}${end.if.result.properties}${method.result.properties});

languages/c-structs/templates/declarations/event.c

@@ -0,0 +1,4 @@
+/* ${method.name} - ${method.description} */
+typedef void (*F${info.Title}${method.Name}Callback)( const void* userData, ${event.signature.callback.params}${if.event.params}, ${end.if.event.params}${method.result.properties} );
+int F${info.title}_Register_${method.Name}( ${event.signature.params}${if.event.params}, ${end.if.event.params}F${info.Title}${method.Name}Callback userCB, const void* userData );
+int F${info.title}_Unregister_${method.Name}( F${info.Title}${method.Name}Callback userCB);

languages/c-structs/templates/declarations/polymorphic-reducer.c

@@ -0,0 +1,5 @@
+/*
+ * ${method.summary}
+ * ${method.params}
+ */
+int F${info.title}_${method.Name}(${method.signature.params}${if.result.properties}${if.params}, ${end.if.params}${end.if.result.properties}${method.result.properties});

languages/c-structs/templates/declarations/property.c

@@ -0,0 +1,5 @@
+/*
+ * ${method.summary}
+ * ${method.params}
+ */
+int F${info.title}_Get${method.Name}(${method.signature.params}${if.params}, ${end.if.params}${method.result.properties});

languages/c-structs/templates/imports/default.cpp

@@ -0,0 +1 @@
+#include "jsondata_${info.title.lowercase}.h"

languages/c-structs/templates/imports/default.h

@@ -0,0 +1 @@
+#include "common/${info.title.lowercase}.h"

languages/c-structs/templates/imports/default.jsondata

@@ -0,0 +1 @@
+#include "jsondata_${info.title.lowercase}.h"

languages/c-structs/templates/json-types/additionalProperties.c

@@ -0,0 +1 @@
+// need cpp code to init, get, set, clear additional properties...

languages/c-structs/templates/json-types/anyOf.c

@@ -0,0 +1 @@
+/* AnyOf is not supported in C: ${title} */

languages/c-structs/templates/json-types/array.c

@@ -0,0 +1,4 @@
+uint32_t ${info.Title}_${Title}Array_Size(${type} handle);
+${type} ${title}Array_Get(${type} handle, uint32_t index);
+void ${info.Title}_${Title}Array_Add(${propertyType} handle, ${valueType} value);
+void ${info.Title}_${Title}Array_Clear(${propertyType} handle);

languages/c-structs/templates/json-types/boolean.c

@@ -0,0 +1 @@
+WPEFramework::Core::JSON::Boolean

languages/c-structs/templates/json-types/default.cpp

@@ -0,0 +1 @@
+${shape}

languages/c-structs/templates/json-types/enum.cpp

@@ -0,0 +1,4 @@
+    /* ${title} ${description} */
+    ENUM_CONVERSION_BEGIN(${name})
+        { ${NAME}_${key}, _T("${value}") },
+    ENUM_CONVERSION_END(${name})

languages/c-structs/templates/json-types/enum.h

@@ -0,0 +1,4 @@
+/* ${title} ${description} */
+typedef enum {
+    ${NAME}_${key},
+} ${name};

languages/c-structs/templates/json-types/float.c

@@ -0,0 +1 @@
+WPEFramework::Core::JSON::Float

languages/c-structs/templates/json-types/integer.c

@@ -0,0 +1 @@
+WPEFramework::Core::JSON::DecSInt32

languages/c-structs/templates/json-types/namespace.c

@@ -0,0 +1 @@
+FireboltSDK::${info.Title}::

languages/c-structs/templates/json-types/object.cpp

@@ -0,0 +1,25 @@
+    class ${title}: public WPEFramework::Core::JSON::Container {
+    public:
+        ~${title}() override = default;
+
+    public:
+        ${title}()
+            : WPEFramework::Core::JSON::Container()
+        {
+            ${properties.register}
+        }
+
+        ${title}(const ${title}& other)
+        {
+            ${properties.assign}
+        }
+
+        ${title}& operator=(const ${title}& other)
+        {
+            ${properties.assign}
+            return (*this);
+        }
+
+    public:
+        ${properties}
+    };

languages/c-structs/templates/json-types/property-assign.cpp

@@ -0,0 +1,2 @@
+Add(_T("${property}"), &${Property});
+${Property} = other.${Property}

languages/c-structs/templates/json-types/property-register.cpp

@@ -0,0 +1 @@
+Add(_T("${property}"), &${Property});

languages/c-structs/templates/json-types/property.cpp

@@ -0,0 +1 @@
+${title} ${Property};

languages/c-structs/templates/json-types/ref.c

@@ -0,0 +1 @@
+${shape}

languages/c-structs/templates/json-types/string.c

@@ -0,0 +1 @@
+FireboltSDK::JSON::String

languages/c-structs/templates/json-types/title.c

@@ -0,0 +1 @@
+JsonData_${Title}