Flattening the params of the events, setter and notifier. (#283)

* feat: If result is object, add its properties as parameters to the generated notifier and setter

* fix: Issues in generated openrpc spec

* fix: Store context args

* refactor: Rename variale

* fix: Filter non-context parameters needed for the event callback

* fix: Markdown descripton regression issue

* fix: Code clean-up

Author: vladimir-rangelov

languages/javascript/src/shared/Events/index.mjs

@@ -218,11 +218,16 @@ const getClearArgs = function(...args) {
   const module = (args.shift() || '*')
   const event = args.shift() || '*'
   const context = {}
-  
+ 
+  // populate context based on registered context for this module/event
+  // if an argument is not registered in validContext, that is ok meaning it is not a context argument
+  // Needed after introducing x-contextual-params
   for (let i = 0; args.length; i++) {
-    context[validContext[module][event][i]] = args.shift()
+    let currentArg = args.shift()
+    if (validContext[module] && validContext[module][event] && validContext[module][event][i]) {
+     context[validContext[module][event][i]] = currentArg
+    }
   }
-
   return [module, event, context]
 }
 

languages/javascript/templates/declarations/event.js

@@ -1,11 +1,11 @@
-  /**
+   /**
    * ${method.summary}
    * 
    * @param {'${event.name}'} event
    * @param {Function} callback
 ${if.deprecated}   * @deprecated ${method.deprecation}
 ${end.if.deprecated}  */
-function listen(event: '${event.name}'${if.context}, ${event.signature.params}${end.if.context}, callback: (data: ${event.result.type}) => void): Promise<number>
+function listen(event: '${event.name}', ${if.context}${event.signature.params},${end.if.context} callback: (${event.result.type}) => void): Promise<number>
 
 /**
  * ${method.summary}
@@ -15,4 +15,4 @@ function listen(event: '${event.name}'${if.context}, ${event.signature.params}${
  * @param {Function} callback
 ${if.deprecated}   * @deprecated ${method.deprecation}
 ${end.if.deprecated}  */
-function once(event: '${event.name}'${if.context}, ${event.signature.params}${end.if.context}, callback: (data: ${event.result.type}) => void): Promise<number>
+function once(event: '${event.name}', ${if.context}${event.signature.params},${end.if.context} callback: (${event.result.type}) => void): Promise<number>

languages/javascript/templates/declarations/subscriber.js

@@ -5,7 +5,7 @@
    * @param {Function} callback
 ${if.deprecated}   * @deprecated ${method.deprecation}
 ${end.if.deprecated}  */
-function listen(event: '${event.name}'${if.context}, ${event.signature.params}${end.if.context}, callback: (data: ${event.result.type}) => void): Promise<number>
+function listen(event: '${event.name}'${if.context}, ${event.signature.params}${end.if.context}, callback: ( ${event.result.type}) => void): Promise<number>
 
 /**
  * ${method.summary}
@@ -15,4 +15,4 @@ function listen(event: '${event.name}'${if.context}, ${event.signature.params}${
  * @param {Function} callback
 ${if.deprecated}   * @deprecated ${method.deprecation}
 ${end.if.deprecated}  */
-function once(event: '${event.name}'${if.context}, ${event.signature.params}${end.if.context}, callback: (data: ${event.result.type}) => void): Promise<number>
+function once(event: '${event.name}'${if.context}, ${event.signature.params}${end.if.context}, callback: ( ${event.result.type}) => void): Promise<number>

src/macrofier/engine.mjs

@@ -1591,9 +1591,28 @@ function insertMethodMacros(template, methodObj, platformApi, appApi, templates,
 
 
   let eventParams = event.params && event.params.length ? getTemplate('/sections/parameters', templates) + event.params.map(p => insertParameterMacros(getTemplate('/parameters/default', templates), p, event, currentModuleApiForEvent)).join('') : ''
- 
+  const eventForSubscriber = getNotifierForMethod(method, appApi)
+  
+  // Filter parameters to remove context parameters, because only non-context parameters are parameters for the event callback
+  let xContextParams = 0
+  let eventNonContextualParams = ''
+  if (eventForSubscriber) {
+    if (eventForSubscriber.tags) {
+      const tag = eventForSubscriber.tags.find(tag => tag.name === 'notifier');
+      xContextParams = tag['x-contextual-params'] || 0
+    }
+
+    if (eventForSubscriber.params && eventForSubscriber.params.length) {
+      if (xContextParams > 0) {
+        const nonContextParamsArray = eventForSubscriber.params.slice(xContextParams, eventForSubscriber.params.length)
+        eventNonContextualParams = getTemplate('/sections/parameters', templates) + nonContextParamsArray.map(p => insertParameterMacros(getTemplate('/parameters/default', templates), p, eventForSubscriber, appApi)).join(', ')
+      } else
+        eventNonContextualParams = getTemplate('/sections/parameters', templates) + eventForSubscriber.params.map(p => insertParameterMacros(getTemplate('/parameters/default', templates), p, eventForSubscriber, appApi)).join(', ')
+    }
+  }
+
   if (isGeneratingDocs(languages)) {
-    const eventForSubscriber = getNotifierForMethod(method, appApi)
+    eventNonContextualParams = isEventMethod(methodObj) && event.result ? Types.getMethodSignatureResult(event, currentModuleApiForEvent, { callback: true, namespace: !config.copySchemasIntoModules }) : ''
     // If there's a notifier for this method, and it has examples, use its params for the eventParams section
     if (eventForSubscriber && eventForSubscriber.examples && eventForSubscriber.examples.length) {
       eventParams = (eventForSubscriber.params && eventForSubscriber.params.length) ?
@@ -1729,7 +1748,6 @@ function insertMethodMacros(template, methodObj, platformApi, appApi, templates,
     }
   }
 
-
   template = insertExampleMacros(template, examples || [], methodObj, platformApi, templates, appApi, isGeneratingDocs(languages))
 
   template = template.replace(/\$\{method\.name\}/g, method.name)
@@ -1799,7 +1817,7 @@ function insertMethodMacros(template, methodObj, platformApi, appApi, templates,
     .replace(/\$\{method\.result\.type\}/g, Types.getSchemaType(result.schema, platformApi, { templateDir: state.typeTemplateDir, title: true, asPath: false, result: true, namespace: false  })) //, baseUrl: options.baseUrl    
     .replace(/\$\{method\.result\.json\}/g, Types.getSchemaType(result.schema.type === 'null' ? getNonNullSchema(methodObj, event, platformApi, appApi) : result.schema, platformApi, { templateDir: 'json-types', title: true, code: false, link: false, asPath: false, expandEnums: false, namespace: true  }))
     // todo: what does prefix do?
-    .replace(/\$\{event\.result\.type\}/g, isEventMethod(methodObj) && event.result ? Types.getMethodSignatureResult(event, currentModuleApiForEvent, { callback: true, namespace: !config.copySchemasIntoModules }) : '')
+    .replace(/\$\{event\.result\.type\}/g, isEventMethod(methodObj) && eventNonContextualParams ? eventNonContextualParams : '')
     .replace(/\$\{event\.result\.json\.type\}/g, resultJsonType)
     .replace(/\$\{event\.result\.json\.type\}/g, callbackResultJsonType)
     .replace(/\$\{event\.pulls\.param\.name\}/g, pullsEventParamName)

src/macrofier/types.mjs

@@ -749,6 +749,7 @@ const isSupportedTuple = schema => {
 }
 
 function getSchemaType(schema, module, { templateDir = 'types', link = false, code = false, asPath = false, event = false, result = false, expandEnums = true, baseUrl = '', namespace = true } = {}) {
+  namespace = false // disable namespace support
   const wrap = (str, wrapper) => wrapper + str + wrapper
 
   schema = sanitize(schema)