@firebolt-js/openrpc - npm Package Compare versions

Comparing version 1.7.0-next.5 to 1.7.0-next.6

CHANGELOG.md

@@ -1,2 +0,2 @@
-# [1.7.0-next.5](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.4...v1.7.0-next.5) (2022-11-04)
+# [1.7.0-next.6](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.5...v1.7.0-next.6) (2022-11-18)
 
@@ -6,39 +6,12 @@
 
-* Reverted code of Fire-52 ([#73](https://github.com/rdkcentral/firebolt-openrpc/issues/73)) ([c599e62](https://github.com/rdkcentral/firebolt-openrpc/commit/c599e6299cae33d03ee2ac189746fb73381bbbdc))
+* Capabilities for property setters to be manages instead of uses ([#77](https://github.com/rdkcentral/firebolt-openrpc/issues/77)) ([a2fa157](https://github.com/rdkcentral/firebolt-openrpc/commit/a2fa157fac3ace0c3cec9f283b59bc4768e17373))
+* Properly document context params ([#75](https://github.com/rdkcentral/firebolt-openrpc/issues/75)) ([325858c](https://github.com/rdkcentral/firebolt-openrpc/commit/325858c98116edd4708eacce644bbdb95a2e18e4))
 
-# [1.7.0-next.4](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.3...v1.7.0-next.4) (2022-11-04)
+## 1.7.0
 
+### Features
 
-### Bug Fixes
-
-* Updated logic to return error on failing to listen the events ([#65](https://github.com/rdkcentral/firebolt-openrpc/issues/65)) ([846709e](https://github.com/rdkcentral/firebolt-openrpc/commit/846709ea0ce22cba60a95ebfd0e02872f3756e57))
-
-# [1.7.0-next.3](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.2...v1.7.0-next.3) (2022-10-31)
-
-
-### Bug Fixes
-
 * Only generate docs for used schema files ([ff08978](https://github.com/rdkcentral/firebolt-openrpc/commit/ff08978477ef8eb048c9f4c9d9a96e2fe66fc868))
-
-# [1.7.0-next.2](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.1...v1.7.0-next.2) (2022-10-31)
-
-
-### Bug Fixes
-
-* Interfaceless providers ([#68](https://github.com/rdkcentral/firebolt-openrpc/issues/68)) ([ceb3040](https://github.com/rdkcentral/firebolt-openrpc/commit/ceb304018c2e0eb7cf5ac6f9bcd5b44bab0cb083))
-
-# [1.7.0-next.1](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.6.2-next.1...v1.7.0-next.1) (2022-10-24)
-
-
-### Features
-
 * Context Params and Request Methods ([d36586e](https://github.com/rdkcentral/firebolt-openrpc/commit/d36586e76ce5ff864012a97be10c71123f97f191))
 
-## 1.7.0-next
-
-### Features
-
-- Context Parameters
-- Response Methods
-
 ### Bug Fixes
@@ -53,3 +26,3 @@
 
-# 1.5.0
+## 1.5.0
 
@@ -56,0 +29,0 @@ - Much more beautiful validation error messages

package.json

 {
   "name": "@firebolt-js/openrpc",
-  "version": "1.7.0-next.5",
+  "version": "1.7.0-next.6",
   "description": "The Firebolt SDK Code & Doc Generator",
@@ -5,0 +5,0 @@ "main": "src/js/sdk/index.mjs",

src/template/markdown/methods/polymorphic-property.md

@@ -6,3 +6,3 @@ ### ${method.name}
 
-To get the value, call the method with no parameters:
+To get the value of `${method.name}` call the method like this:
 
@@ -12,3 +12,3 @@ ${if.javascript}
 ```typescript
-function ${method.name}(): Promise<${method.result.type}>
+${method.signature}
 ```
@@ -18,2 +18,12 @@
 
+${if.params}
+
+Parameters:
+
+| Param                  | Type                 | Required                 | Summary                 |
+| ---------------------- | -------------------- | ------------------------ | ----------------------- |
+| `${method.param.name}` | ${method.param.type} | ${method.param.required} | ${method.param.summary} ${method.param.constraints} |
+
+${end.if.params}
+
 Promise resolution:
@@ -62,3 +72,3 @@
 ${method.2}
-To set the value, pass in the new value as the only parameter:
+To set the value of `${method.name}` call the method like this:
 
@@ -68,3 +78,3 @@ ${if.javascript}
 ```typescript
-function ${method.name}(${method.params}): Promise<void>
+${method.signature}
 ```
@@ -98,5 +108,2 @@
 ${module}.${method.name}(${example.params})
-    .then(${method.result.name} => {
-        // property value has been set
-    })
 ```
@@ -127,3 +134,3 @@
 ${method.3}
-To subscribe to notifications when the value changes, pass a function as the only parameter:
+To subscribe to notifications when the value changes, call the method like this:
 
@@ -133,3 +140,3 @@ ${if.javascript}
 ```typescript
-function ${method.name}(subscriber: (${method.params}) => void): Promise<boolean>
+function ${method.name} (${method.params} ${if.params}, ${end.if.params}subscriber: (${method.result.name}) => void): Promise<listenerId>
 ```
@@ -143,4 +150,6 @@
 | ---------------------- | -------------------- | ------------------------ | ----------------------- |
-| `subscriber` | `Function` | Yes | A callback that gets invoked when the value for ${method.name} changes |
+| `${method.param.name}` | ${method.param.type} | ${method.param.required} | ${method.param.summary} ${method.param.constraints} |
+| `subscriber`           | `function`             | Yes                      | Callback to execute when the value changes. |
 
+
 Promise resolution:
@@ -156,3 +165,3 @@
 | ---------------------- | -------------------- | ------------------------ | ----------------------- |
-| `${method.param.name}` | ${method.param.type} | Yes | ${method.param.summary} ${method.param.constraints} |
+| `${method.result.name}` | `${event.result.type}` | Yes | ${method.result.summary} |
 
@@ -170,5 +179,5 @@ **Examples**
 
-${module}.${method.name}(${method.paramNames} => {
+${module}.${method.name}(${method.paramNames} ${if.params}, ${end.if.params}(value) => {
   // property value was changed
-  console.log(${method.paramNames})
+  console.log(value)
 }).then(listenerId => {
@@ -179,3 +188,3 @@ // you can clear this listener w/ ${module}.clear(listenerId)
 
-value of `${method.paramNames}`:
+value of `value`:
 
@@ -182,0 +191,0 @@ ```javascript

No alert changes

Worsened metrics

Total package byte prevSize

342371

decreased by-0.69%

Lines of code

7807

decreased by-0.99%

No dependency changes