generate functions for sending messages

[derberg]

After we merge #220 the last bad user experience is 👇🏼

    client.app.send(
        { command: "off" },
        {},
        "smartylighting/streetlights/1/0/action/12/turn/on"
    );

we should generate

function turnOn(message){
    app.send(
        message,
        {},
        "smartylighting/streetlights/1/0/action/12/turn/on"
    );
}

so later user can just do:

turnOn({ command: "off" })

[PUNEET-EMM]

Hello @derberg , i am new to asyncapi i want to work on this can you tell me more about it..

[derberg]

hey, thanks, but it is already in progress in #220 PR

[PUNEET-EMM]

Okay , is their any other issue available ?? for new comer ...

[derberg]

@PUNEET-EMM maybe have a look at https://www.asyncapi.com/community/dashboard

[kaushik-rishi]

@PUNEET-EMM #220 Has been merged, would you like to work on this issue ?

@derberg I hope we still need this.

[derberg]

yeah definitely, as for now to send a message somebody has to use client app api directly for sending, and remember topics names, instead of using a generated send functions, like we have for receiving

[ibishal]

Hey @derberg i want to solve this , but i need a little bit more clarity on the issue

[derberg]

sure, what do you need

me and @kaushik-rishi are here to help

[ibishal]

can you elaborate some more details on the issue ?
cc @derberg @kaushik-rishi

[derberg]

it's hard without specific question

you need to get this template, generate code using readme instruction and play with https://github.com/asyncapi/nodejs-template/blob/master/test/example/script.js example script.

you can see that in the example script, available generated client have helpers like client.registerReceiveLightMeasurementMiddleware. They are generated basing on AsyncAPI document content (examine the AsyncAPI document referred in readme, see what names are there and how them map to generated code). So it is super easy to use such a client to subscribe to topic, and provide a callback that will react to incoming messages.

Problem is with sending, to send a message you have to manually write code like

client.app.send(
    { command: 'off' },
    {},
    'smartylighting/streetlights/1/0/action/12/turn/on'
  );

as you can see, the topic address is hardcoded, and person that writes this code, need to look into docs, and make sure they use proper topic. Better would be if client would already give you access to turnOn function that accepts a message payload as argument. And such function name could be generated from the operation id that in in AsyncAPI document -> https://github.com/asyncapi/nodejs-template/blob/master/test/mocks/mqtt/asyncapi-v3.yml#L111C3-L111C9

[kaushik-rishi]

@derberg fyi, i have connected with @ibishal on slack.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️