Merge branch 'master' into api-generation-for-components

Author: batchu5

Development.md

@@ -195,7 +195,7 @@ For the PR titles you can refer to [this guide](CONTRIBUTING.md?plain=1#L60)
 
 If you encounter any issues during development or testing, please check the following:
 
-1. Ensure you're using the correct Node.js version (18.20.8 or higher) and npm version (10.8.2 or higher).
+1. Ensure you're using the correct Node.js version (24.11 or higher) and npm version (11.5.1 or higher).
 2. Clear the `node_modules` directory and reinstall dependencies if you encounter unexpected behavior.
 3. For Docker-related issues, make sure Docker is running and you have sufficient permissions.
 

apps/generator/docs/model-generation.md

@@ -5,7 +5,7 @@ weight: 200
 
 This guide will walk you through the process of enabling models/types generation in a template by using [Modelina](https://www.asyncapi.com/tools/modelina).
 
-Modelina is an AsyncAPI library designed for generating data models using inputs such as [AsyncAPI](generator/asyncapi-document), OpenAPI, or JSON schema inputs. Its functionality revolves around creating data models from the provided AsyncAPI document and the model template, which defines message payloads. It is better to use Modelina in your template to handle model generation rather than providing custom templates.
+Modelina is an AsyncAPI library designed for generating data models using inputs such as [AsyncAPI](asyncapi-document), OpenAPI, or JSON schema inputs. Its functionality revolves around creating data models from the provided AsyncAPI document and the model template, which defines message payloads. It is better to use Modelina in your template to handle model generation rather than providing custom templates.
 
 You can integrate the work shown in this guide into a template by following the [tutorial about creating a template](https://www.asyncapi.com/docs/tools/generator/generator-template).
 

packages/components/test/components/Usage.test.js

@@ -0,0 +1,30 @@
+import { render } from '@asyncapi/generator-react-sdk';
+import { Usage } from '../../src/components/readme/Usage';
+
+describe('Testing of Usage component', () => {
+  const supportedCases = [
+    {
+      language: 'python',
+      clientFileName: 'my_client.py',
+    },
+    {
+      language: 'javascript',
+      clientFileName: 'myClient.js',
+    },
+  ];
+
+  test.each(supportedCases)(
+    'renders usage snippet for %s',
+    ({ language, clientFileName }) => {
+      const result = render(
+        <Usage
+          clientName="MyClient"
+          clientFileName={clientFileName}
+          language={language}
+        />
+      );
+
+      expect(result.trim()).toMatchSnapshot();
+    }
+  );
+});

packages/components/test/components/__snapshots__/Usage.test.js.snap

@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing of Usage component renders usage snippet for { language: 'javascript', clientFileName: 'myClient.js' } 1`] = `
+"## Usage
+
+\`\`\`javascript
+const MyClient = require('./myClient');
+const wsClient = new MyClient();
+
+async function main() {
+  try {
+    await wsClient.connect();
+    // use wsClient to send/receive messages
+    await wsClient.close();
+  } catch (error) {
+    console.error('Failed to connect:', error);
+  }
+}
+
+main();
+\`\`\`"
+`;
+
+exports[`Testing of Usage component renders usage snippet for { language: 'python', clientFileName: 'my_client.py' } 1`] = `
+"## Usage
+
+\`\`\`python
+from my_client import MyClient
+
+ws_client = MyClient()
+
+async def main():
+    await ws_client.connect()
+    # use ws_client to send/receive messages
+    await ws_client.close()
+\`\`\`"
+`;

packages/templates/clients/websocket/java/quarkus/.ageneratorrc

@@ -2,7 +2,7 @@ apiVersion: v3
 parameters:
   server:
     description: The name of the server described in AsyncAPI document
-    required: false
+    required: true
   appendClientSuffix:
     description: Add 'Client' suffix at the end of the class name. This option has no effect if 'customClientName' is specified.
     required: false

packages/templates/clients/websocket/javascript/README.md

@@ -7,4 +7,4 @@ You can test this template:
 4. Install with `npm install` and run test with `npm run test`
 5. Start example script that uses a client library generated by the test: `node example.js`
 
-> By default this is testing against Hoppscotch echo service. You can modify `packages/templates/clients/websocket/javascript/example.js` and change first line to `const WSClient = require('./tests/temp/snapshotTestResult/client_postman/client.js');` and run `node example.js` again. You will see example still works but now it is using a different API. This is possible since both AsyncAPI documents define the same name of operation for sending messages: `sendEchoMessage` so each client generated has the same API.
+> By default this is testing against Hoppscotch echo service. You can modify `packages/templates/clients/websocket/javascript/example.js` and change first line to `const WSClient = require('./test/temp/snapshotTestResult/client_postman/client.js');` and run `node example.js` again. You will see example still works but now it is using a different API. This is possible since both AsyncAPI documents define the same name of operation for sending messages: `sendEchoMessage` so each client generated has the same API.

packages/templates/clients/websocket/test/integration-test/common-test.js

@@ -59,6 +59,15 @@ function runCommonTests(language, config) {
       await generateAndVerifyClient(config.template, outputPath, asyncapiPath, params);
     });
   });
+
+  describe('When required server param is missing', () => {
+    it('should throw an error when server param is missing during client generation', async () => {
+      const generator = new Generator(config.template, config.testResultPath, {
+        forceWrite: true,
+      });
+      await expect(generator.generateFromFile(asyncapi_v3_path_hoppscotch)).rejects.toThrow('This template requires the following missing params: server');
+    });
+  });
 }
 
 function runCommonSlackTests(language, config) {

packages/templates/clients/websocket/test/integration-test/integration.test.js

@@ -81,16 +81,6 @@ describe('WebSocket Clients Integration Tests', () => {
         const checkClientOutputFileExists = await stat(clientOutputFile);
         expect(checkClientOutputFileExists.isFile()).toBeTruthy();
       });
-
-      it('should throw an error when server param is missing during simple client generation for hoppscotch echo', async () => {
-        const generator = new Generator(config.template, config.testResultPath, {
-          forceWrite: true,
-          templateParams: {
-            clientFileName: config.clientFileName
-          }
-        });
-        await expect(generator.generateFromFile(asyncapi_v3_path_hoppscotch)).rejects.toThrow('This template requires the following missing params: server');
-      });
     });
   });
 });