add new helper to filter out own keys

Author: batchu5

apps/generator/docs/api_components.md

@@ -8,7 +8,7 @@ weight: 77
 <dl>
   <dt>
     <a href="#CloseConnection">CloseConnection</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -17,7 +17,7 @@ Renders a WebSocket close connection method with optional pre- and post-executio
   </dd> 
   <dt>
     <a href="#Connect">Connect</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -26,7 +26,7 @@ Renders a WebSocket connection method for the specified programming language.
   </dd> 
   <dt>
     <a href="#DependencyProvider">DependencyProvider</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -35,7 +35,7 @@ Renders the top-of-file dependency statements for the selected programming langu
   </dd> 
   <dt>
     <a href="#FileHeaderInfo">FileHeaderInfo</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -44,7 +44,7 @@ Renders a file header with metadata information such as title, version, protocol
   </dd> 
   <dt>
     <a href="#HandleMessage">HandleMessage</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -53,7 +53,7 @@ Renders a WebSocket message handler method with optional pre- and post-execution
   </dd> 
   <dt>
     <a href="#MethodGenerator">MethodGenerator</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -62,7 +62,7 @@ Renders a language-specific formatted method definition.
   </dd> 
   <dt>
     <a href="#Models">Models</a>
-      ⇒ `Array.&lt;File&gt;`
+      ⇒ <code>Array.&lt;File&gt;</code>
   </dt>
   <dd>
 
@@ -71,7 +71,7 @@ Renders an array of model files based on the AsyncAPI document.
   </dd> 
   <dt>
     <a href="#OnClose">OnClose</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -80,7 +80,7 @@ Renders a WebSocket onClose event handler for the specified programming language
   </dd> 
   <dt>
     <a href="#OnError">OnError</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -89,7 +89,7 @@ Renders a WebSocket onError event handler for the specified programming language
   </dd> 
   <dt>
     <a href="#OnMessage">OnMessage</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -98,7 +98,7 @@ Renders a WebSocket onMessage event handler for the specified programming langua
   </dd> 
   <dt>
     <a href="#OnOpen">OnOpen</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -107,7 +107,7 @@ Renders a WebSocket onOpen event handler for the specified programming language.
   </dd> 
   <dt>
     <a href="#QueryParamsVariables">QueryParamsVariables</a>
-      ⇒ `Array.&lt;JSX.Element&gt;`
+      ⇒ <code>Array.&lt;JSX.Element&gt;</code>
   </dt>
   <dd>
 
@@ -116,7 +116,7 @@ Renders query parameter variables code blocks.
   </dd> 
   <dt>
     <a href="#AvailableOperations">AvailableOperations</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -125,7 +125,7 @@ Renders a list of AsyncAPI operations with their headers and message examples.
   </dd> 
   <dt>
     <a href="#CoreMethods">CoreMethods</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -134,7 +134,7 @@ Renders a list of core WebSocket client methods for a given target language.
   </dd> 
   <dt>
     <a href="#Installation">Installation</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -143,7 +143,7 @@ Renders the Installation Command for a given language.
   </dd> 
   <dt>
     <a href="#MessageExamples">MessageExamples</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -152,7 +152,7 @@ Renders Message Examples of a given AsyncAPI operation.
   </dd> 
   <dt>
     <a href="#OperationHeader">OperationHeader</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -161,7 +161,7 @@ Renders a header section for a single AsyncAPI operation.
   </dd> 
   <dt>
     <a href="#Overview">Overview</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -171,7 +171,7 @@ Displays the API description, version, and server URL.
   </dd> 
   <dt>
     <a href="#Readme">Readme</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -184,7 +184,7 @@ provided AsyncAPI document, generator parameters, and target language.
   </dd> 
   <dt>
     <a href="#Usage">Usage</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -193,7 +193,7 @@ Renders a usage example snippet for a generated WebSocket client in a given lang
   </dd> 
   <dt>
     <a href="#RegisterErrorHandler">RegisterErrorHandler</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -202,7 +202,7 @@ Renders a WebSocket error handler registration method with optional pre- and pos
   </dd> 
   <dt>
     <a href="#RegisterMessageHandler">RegisterMessageHandler</a>
-      ⇒ `JSX.Element`
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
 
@@ -211,7 +211,7 @@ Renders a WebSocket message handler registration method with optional pre- and p
   </dd> 
   <dt>
     <a href="#SendOperations">SendOperations</a>
-      ⇒ `Array.&lt;JSX.Element&gt;`
+      ⇒ <code>Array.&lt;JSX.Element&gt;</code>
   </dt>
   <dd>
 

packages/components/jsdoc2md-handlebars/api.hbs

@@ -7,21 +7,24 @@ weight: 77
 
 <dl>
 {{#functions}}
+  {{#unless (eq name "ownKeys")}}
   <dt>
     <a href="#{{name}}">{{name}}</a>
     {{#if returns.length}}
-      ⇒ `{{{escapeType returns.[0].type.names.[0]}}}`
+      ⇒ <code>{{{escapeType returns.[0].type.names.[0]}}}</code>
     {{/if}}
   </dt>
   <dd>
 
 {{{description}}}
 
   </dd> 
+  {{/unless}}
 {{/functions}}
 </dl>
 
 {{#functions}}
+{{#unless (eq name "ownKeys")}}
 
 <a name="{{name}}"></a>
 ## **{{name}}()** 
@@ -61,4 +64,5 @@ weight: 77
 
 {{/if}}
 
+{{/unless}}
 {{/functions}}

packages/components/jsdoc2md-helpers/jsdoc-helper.js

@@ -15,4 +15,10 @@ module.exports = {
       .replace(/\{/g, '{')
       .replace(/\}/g, '}');
   },
+  /**
+  * Equality helper for Handlebars templates
+  */
+  eq(a, b) {
+    return a === b;
+  },
 };

packages/components/src/components/HandleMessage.js

@@ -1,15 +1,14 @@
 import { MethodGenerator } from './MethodGenerator';
 
-/**
- * Configuration for WebSocket message handler method logic per language.
- * @type {Record<Language, { methodDocs: string | undefined, methodLogic: string }>}
- */
-
 /**
  * @typedef {'python' | 'javascript' | 'dart'} Language
  * Supported programming languages.
  */
 
+/**
+ * Configuration for WebSocket message handler method logic per language.
+ * @type {Record<Language, { methodDocs: string | undefined, methodLogic: string }>}
+ */
 const websocketHandleMessageConfig = {
   python: {
     methodLogic: `if len(self.message_handlers) == 0:

packages/components/src/components/RegisterErrorHandler.js

@@ -1,15 +1,14 @@
 import { MethodGenerator } from './MethodGenerator';
 
-/**
- * Configuration for WebSocket error handler registration method logic per language.
- * @type {Record<Language, { methodDocs: string | undefined, methodLogic: string }>}
- */
-
 /**
  * @typedef {'python' | 'javascript' | 'dart'} Language
  * Supported programming languages.
  */
 
+/**
+ * Configuration for WebSocket error handler registration method logic per language.
+ * @type {Record<Language, { methodDocs: string | undefined, methodLogic: string }>}
+ */
 const websocketErrorRegisterConfig = {
   python: {
     methodLogic: `if callable(handler):

packages/components/src/components/RegisterMessageHandler.js

@@ -1,15 +1,14 @@
 import { MethodGenerator } from './MethodGenerator';
 
-/**
- * Configuration for WebSocket message handler registration method logic per language.
- * @type {Record<Language, { methodDocs: string | undefined, methodLogic: string }>}
- */
-
 /**
  * @typedef {'python' | 'javascript' | 'dart'} Language
  * Supported programming languages.
  */
 
+/**
+ * Configuration for WebSocket message handler registration method logic per language.
+ * @type {Record<Language, { methodDocs: string | undefined, methodLogic: string }>}
+ */
 const websocketMessageRegisterConfig = {
   python: {
     methodLogic: `if callable(handler):