@usebruno/filestore 0.3.1 → 0.5.0

package/src/formats/bru/index.ts

@@ -24,11 +24,19 @@ export const bruRequestToJson = (data: string | any, parsed: boolean = false): a
       case 'grpc':
         requestType = 'grpc-request';
         break;
+      case 'ws':
+        requestType = 'ws-request';
+        break;
       default:
         requestType = 'http-request';
     }
 
     const sequence = _.get(json, 'meta.seq');
+    const urlPath: Record<typeof requestType, string> = {
+      'grpc-request': 'grpc.url',
+      'ws-request': 'ws.url',
+      'default': 'http.url'
+    };
     const transformedJson = {
       type: requestType,
       name: _.get(json, 'meta.name'),
@@ -38,8 +46,10 @@ export const bruRequestToJson = (data: string | any, parsed: boolean = false): a
       request: {
         // Preserving special characters in custom methods. Using _.upperCase strips special characters.
         method:
-          requestType === 'grpc-request' ? _.get(json, 'grpc.method', '') : String(_.get(json, 'http.method') ?? '').toUpperCase(),
-        url: _.get(json, requestType === 'grpc-request' ? 'grpc.url' : 'http.url'),
+          requestType === 'grpc-request'
+            ? _.get(json, 'grpc.method', '')
+            : String(_.get(json, 'http.method') ?? '').toUpperCase(),
+        url: _.get(json, urlPath[requestType], _.get(json, urlPath.default)),
         headers: requestType === 'grpc-request' ? _.get(json, 'metadata', []) : _.get(json, 'headers', []),
         auth: _.get(json, 'auth', {}),
         body: _.get(json, 'body', {}),
@@ -48,8 +58,11 @@ export const bruRequestToJson = (data: string | any, parsed: boolean = false): a
         assertions: _.get(json, 'assertions', []),
         tests: _.get(json, 'tests', ''),
         docs: _.get(json, 'docs', '')
-      }
-    };
+      },
+      examples: _.get(json, 'examples', []).map((e: any) => {
+        return bruExampleToJson(e, true, requestType, _.get(json, 'http.method'));
+      })
+    } as any;
 
     // Add request type specific fields
     if (requestType === 'grpc-request') {
@@ -67,6 +80,17 @@ export const bruRequestToJson = (data: string | any, parsed: boolean = false): a
           }
         ])
       });
+    } else if (requestType === 'ws-request') {
+      transformedJson.request.auth.mode = _.get(json, 'ws.auth', 'none');
+      transformedJson.request.body = _.get(json, 'body', {
+        mode: 'ws',
+        ws: _.get(json, 'body.ws', [
+          {
+            name: 'message 1',
+            content: '{}'
+          }
+        ])
+      });
     } else {
       // For HTTP and GraphQL
       (transformedJson.request as any).params = _.get(json, 'params', []);
@@ -83,9 +107,9 @@ export const bruRequestToJson = (data: string | any, parsed: boolean = false): a
         transformedJson.request.auth.oauth2.additionalParameters = additionalParameters;
       }
     }
-
     return transformedJson;
   } catch (error) {
+    console.log('bruRequestToJson error', error);
     throw error;
   }
 };
@@ -103,6 +127,9 @@ export const jsonRequestToBru = (json: any): string => {
       case 'grpc-request':
         type = 'grpc';
         break;
+      case 'ws-request':
+        type = 'ws';
+        break;
       default:
         type = 'http';
     }
@@ -156,6 +183,22 @@ export const jsonRequestToBru = (json: any): string => {
           }
         ])
       });
+    } else if (type === 'ws') {
+      bruJson.ws = {
+        url: _.get(json, 'request.url'),
+        auth: _.get(json, 'request.auth.mode', 'none'),
+        body: _.get(json, 'request.body.mode', 'ws')
+      };
+
+      bruJson.body = _.get(json, 'request.body', {
+        mode: 'ws',
+        ws: _.get(json, 'request.body.ws', [
+          {
+            name: 'message 1',
+            content: '{}'
+          }
+        ])
+      });
     }
 
     // Common fields for all request types
@@ -175,6 +218,7 @@ export const jsonRequestToBru = (json: any): string => {
     bruJson.tests = _.get(json, 'request.tests', '');
     bruJson.settings = _.get(json, 'settings', {});
     bruJson.docs = _.get(json, 'request.docs', '');
+    bruJson.examples = _.get(json, 'examples', []).map((e: any) => jsonExampleToBru(e));
 
     const bru = jsonToBruV2(bruJson);
     return bru;
@@ -295,3 +339,91 @@ export const jsonEnvironmentToBru = (json: any): string => {
     throw error;
   }
 };
+
+// New functions for example handling
+export const bruExampleToJson = (data: string | any, parsed: boolean = false, parentType?: string, parentMethod?: string): any => {
+  try {
+    const json = parsed ? data : bruToJsonV2(data);
+
+    // Use parent request's type and method if provided
+    const requestType = parentType || _.get(json, 'meta.type', 'http');
+    const requestMethod = parentMethod || _.get(json, 'http.method', 'GET');
+
+    let transformedType = requestType;
+    switch (requestType) {
+      case 'http':
+        transformedType = 'http-request';
+        break;
+      case 'graphql':
+        transformedType = 'graphql-request';
+        break;
+      case 'grpc':
+        transformedType = 'grpc-request';
+        break;
+      case 'ws':
+        transformedType = 'ws-request';
+        break;
+      default:
+        transformedType = 'http-request';
+    }
+
+    // Follow the same structure as the main request, but with missing fields for examples
+    const transformedJson = {
+      type: transformedType,
+      name: _.get(json, 'name'),
+      description: _.get(json, 'description', ''),
+      // Examples don't have seq, settings, tags
+      request: {
+        method: _.get(json, 'request.method') || requestMethod,
+        url: _.get(json, 'request.url'),
+        headers: _.get(json, 'request.headers', []),
+        body: _.get(json, 'request.body', {
+          mode: 'none'
+        }),
+        // Examples don't have script, vars, assertions, tests, docs
+        params: _.get(json, 'request.params', [])
+      },
+      response: {
+        headers: _.get(json, 'response.headers', []).map((header: any) => ({
+          name: header.name,
+          value: header.value
+        })),
+        status: String(_.get(json, 'response.status', '200')),
+        statusText: _.get(json, 'response.statusText', 'OK'),
+        body: {
+          type: _.get(json, 'response.body.type', 'json'),
+          content: _.get(json, 'response.body.content', '')
+        }
+      }
+    } as any;
+
+    return transformedJson;
+  } catch (error) {
+    console.log('bruExampleToJson error', error);
+    throw error;
+  }
+};
+
+export const jsonExampleToBru = (json: any) => {
+  try {
+    // Transform the JSON to match the same structure as main request, but with missing fields
+    const exampleJson = {
+      name: _.get(json, 'name'),
+      description: _.get(json, 'description', ''),
+      // Examples don't have seq, settings, tags
+      request: {
+        method: _.get(json, 'request.method'),
+        url: _.get(json, 'request.url'),
+        headers: _.get(json, 'request.headers', []),
+        body: _.get(json, 'request.body', {}),
+        // Examples don't have script, vars, assertions, tests, docs
+        params: _.get(json, 'request.params', [])
+      },
+      response: _.get(json, 'response', {})
+    };
+
+    return exampleJson;
+  } catch (error) {
+    throw error;
+  }
+};