refactor: move Requires component to @asyncapi/generator-components

Author: Adi-204

packages/components/src/components/FileDependencies.js

@@ -0,0 +1,44 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+/**
+ * @typedef {'python' | 'javascript' | 'typescript' | 'java' | 'csharp' | 'rust' | 'dart'} Language
+ * Supported programming languages.
+ */
+
+/**
+ * Mapping of supported programming languages to their default dependency import statements.
+ *
+ * @type {Record<Language, { dependencies: string[] }>}
+ */
+const dependeciesConfig = {
+  python: {
+    dependecies: ['import json', 'import certifi', 'import threading', 'import websocket']
+  },
+  javascript: {
+    dependecies: ['const WebSocket = require(\'ws\');']
+  },
+  dart: {
+    dependecies: ['import \'dart:convert\';', 'import \'package:web_socket_channel/web_socket_channel.dart\';']
+  }
+};
+
+/**
+ * Renders the top-of-file dependency statements for the selected programming language.
+ *
+ * @param {Object} props - Component props.
+ * @param {Language} props.language - The programming language for which to render dependency statements.
+ * @param {string[]} [props.additionalDependencies=[]] - Optional additional dependencies to include.
+ * @returns {JSX.Element} Rendered list of import/require statements.
+ */
+export function FileDependencies({ language, additionalDependencies = [] }) {
+  const { dependecies } = dependeciesConfig[language];
+  const allDependencies = [...dependecies, ...additionalDependencies];
+    
+  return (
+    <Text>
+      <Text>
+        {allDependencies.join('\n')}
+      </Text>
+    </Text>
+  );
+}

packages/components/src/index.js

@@ -1,2 +1,3 @@
 export { Models } from './components/Models';
-export { FileHeaderInfo } from './components/FileHeaderInfo';
+export { FileHeaderInfo } from './components/FileHeaderInfo';
+export { FileDependencies } from './components/FileDependencies';

packages/components/test/components/FileDependencies.test.js

@@ -0,0 +1,45 @@
+import { render } from '@asyncapi/generator-react-sdk';
+import { FileDependencies } from '../../src/index';
+
+describe('Testing of FileDependencies function', () => {
+  test('render js websockets file dependecies correctly', () => {
+    const result = render(
+      <FileDependencies
+        language="javascript"
+      />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+
+  test('render python websockets file dependecies correctly', () => {
+    const result = render(
+      <FileDependencies
+        language="python"
+      />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+
+  test('render python websockets file dependecies correctly with additionalDependencies', () => {
+    const result = render(
+      <FileDependencies
+        language="python"
+        additionalDependencies={["import os", "from urllib.parse import urlencode"]}
+      />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+
+  test('render dart websockets file dependecies correctly', () => {
+    const result = render(
+      <FileDependencies
+        language="dart"
+      />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,24 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing of FileDependencies function render dart websockets file dependecies correctly 1`] = `
+"import 'dart:convert';
+import 'package:web_socket_channel/web_socket_channel.dart';"
+`;
+
+exports[`Testing of FileDependencies function render js websockets file dependecies correctly 1`] = `"const WebSocket = require('ws');"`;
+
+exports[`Testing of FileDependencies function render python websockets file dependecies correctly 1`] = `
+"import json
+import certifi
+import threading
+import websocket"
+`;
+
+exports[`Testing of FileDependencies function render python websockets file dependecies correctly with additionalDependencies 1`] = `
+"import json
+import certifi
+import threading
+import websocket
+import os
+from urllib.parse import urlencode"
+`;

packages/templates/clients/websocket/dart/components/Requires.js

@@ -1,7 +1,6 @@
 import { File } from '@asyncapi/generator-react-sdk';
 import { getClientName, getServerUrl, getServer, getInfo, getTitle } from '@asyncapi/generator-helpers';
-import { FileHeaderInfo } from '@asyncapi/generator-components';
-import { Requires } from '../components/Requires';
+import { FileHeaderInfo, FileDependencies } from '@asyncapi/generator-components';
 import { ClientClass } from '../components/ClientClass';
 
 export default function ({ asyncapi, params }) {
@@ -18,7 +17,7 @@ export default function ({ asyncapi, params }) {
         server={server}
         language="dart"
       />
-      <Requires />
+      <FileDependencies language="dart" />
       <ClientClass clientName={clientName} serverUrl={serverUrl} title={title} />
     </File>
   );

packages/templates/clients/websocket/dart/template/client.dart.js

@@ -1,7 +1,6 @@
 import { File } from '@asyncapi/generator-react-sdk';
 import { getClientName, getServerUrl, getServer, getInfo, getTitle } from '@asyncapi/generator-helpers';
-import { FileHeaderInfo } from '@asyncapi/generator-components';
-import { Requires } from '../components/Requires';
+import { FileHeaderInfo, FileDependencies } from '@asyncapi/generator-components';
 import { ClientClass } from '../components/ClientClass';
 
 export default function ({ asyncapi, params }) {
@@ -18,7 +17,7 @@ export default function ({ asyncapi, params }) {
         server={server}
         language="javascript"
       />
-      <Requires />
+      <FileDependencies language="javascript"/>
       <ClientClass clientName={clientName} serverUrl={serverUrl} title={title} sendOperations={sendOperations} />
     </File>
   );

packages/templates/clients/websocket/javascript/components/Requires.js

@@ -1,17 +1,16 @@
-import { Text } from '@asyncapi/generator-react-sdk';
+import { FileDependencies } from '@asyncapi/generator-components';
 
 export function Requires({ query }) {
+  const additionalDependencies = [];
+  if (query) {
+    additionalDependencies.push('import os');
+    additionalDependencies.push('from urllib.parse import urlencode');
+  }
+
   return (
-    <Text>
-      <Text>
-        {`import json
-import certifi
-import threading
-import websocket
-${query ? 'import os' : ''}
-${query ? 'from urllib.parse import urlencode' : ''}`}
-      </Text>
-    </Text>
+    <FileDependencies
+      language="python"
+      additionalDependencies={additionalDependencies}
+    />
   );
-}
-
+}

packages/templates/clients/websocket/javascript/template/client.js.js

@@ -1880,8 +1880,6 @@ import certifi
 import threading
 import websocket
 
-
-
 class HoppscotchClient:
 
   def __init__(self, url: str = \\"wss://echo-websocket.hoppscotch.io\\"):
@@ -2062,8 +2060,6 @@ import certifi
 import threading
 import websocket
 
-
-
 class HoppscotchEchoWebSocketClient:
 
   def __init__(self, url: str = \\"wss://echo-websocket.hoppscotch.io\\"):
@@ -2245,8 +2241,6 @@ import certifi
 import threading
 import websocket
 
-
-
 class PostmanEchoWebSocketClientClient:
 
   def __init__(self, url: str = \\"wss://ws.postman-echo.com/raw\\"):