@usebruno/filestore 0.5.0 → 0.7.0

package/src/types.ts

@@ -1,130 +1,11 @@
+export type CollectionFormat = 'bru' | 'yml';
+
 export interface ParseOptions {
-  format?: 'bru' | 'yaml';
+  format?: CollectionFormat;
 }
 
 export interface StringifyOptions {
-  format?: 'bru' | 'yaml';
-}
-
-export interface RequestBody {
-  mode?: string;
-  raw?: string;
-  formUrlEncoded?: Array<{ name: string; value: string; enabled: boolean }>;
-  multipartForm?: Array<{ name: string; value: string; type: string; enabled: boolean }>;
-  json?: string;
-  xml?: string;
-  sparql?: string;
-  graphql?: {
-    query?: string;
-    variables?: string;
-  };
-}
-
-export interface AuthConfig {
-  mode?: string;
-  basic?: {
-    username?: string;
-    password?: string;
-  };
-  bearer?: {
-    token?: string;
-  };
-  apikey?: {
-    key?: string;
-    value?: string;
-    placement?: string;
-  };
-  awsv4?: {
-    accessKeyId?: string;
-    secretAccessKey?: string;
-    sessionToken?: string;
-    service?: string;
-    region?: string;
-    profileName?: string;
-  };
-  oauth2?: {
-    grantType?: string;
-    callbackUrl?: string;
-    authorizationUrl?: string;
-    accessTokenUrl?: string;
-    clientId?: string;
-    clientSecret?: string;
-    scope?: string;
-    state?: string;
-    pkce?: boolean;
-  };
-}
-
-export interface RequestParam {
-  name: string;
-  value: string;
-  enabled: boolean;
-}
-
-export interface RequestHeader {
-  name: string;
-  value: string;
-  enabled: boolean;
-}
-
-export interface RequestAssertion {
-  name: string;
-  value: string;
-  enabled: boolean;
-}
-
-export interface RequestVars {
-  req?: Array<{ name: string; value: string; enabled: boolean }>;
-  res?: Array<{ name: string; value: string; enabled: boolean }>;
-}
-
-export interface RequestScript {
-  req?: string;
-  res?: string;
-}
-
-export interface RequestSettings {
-  [key: string]: any;
-}
-
-export interface RequestData {
-  method: string;
-  url: string;
-  params: RequestParam[];
-  headers: RequestHeader[];
-  auth: AuthConfig;
-  body: RequestBody;
-  script: RequestScript;
-  vars: RequestVars;
-  assertions: RequestAssertion[];
-  tests: string;
-  docs: string;
-}
-
-export interface ParsedRequest {
-  type: 'http-request' | 'graphql-request';
-  name: string;
-  seq: number;
-  settings: RequestSettings;
-  tags: string[];
-  request: RequestData;
-}
-
-export interface ParsedCollection {
-  name: string;
-  type?: string;
-  version?: string;
-  [key: string]: any;
-}
-
-export interface EnvironmentVariable {
-  name: string;
-  value: string;
-  enabled: boolean;
-}
-
-export interface ParsedEnvironment {
-  variables: EnvironmentVariable[];
+  format?: CollectionFormat;
 }
 
 export interface WorkerTask {
@@ -138,4 +19,4 @@ export interface WorkerTask {
 
 export interface Lane {
   maxSize: number;
-} 
+}

package/src/utils/index.ts

@@ -0,0 +1,25 @@
+const { customAlphabet } = require('nanoid');
+
+export const isString = (value: unknown): value is string => typeof value === 'string';
+
+export const isNumber = (value: unknown): value is number => typeof value === 'number';
+
+export const isNonEmptyString = (value: unknown): value is string => isString(value) && value.trim().length > 0;
+
+export const ensureString = (value: unknown, fallback: string = ''): string => {
+  if (value === null || value === undefined) {
+    return fallback;
+  }
+  if (typeof value === 'string') {
+    return value;
+  }
+  return String(value);
+};
+
+export const uuid = () => {
+  // https://github.com/ai/nanoid/blob/main/url-alphabet/index.js
+  const urlAlphabet = 'useandom26T198340PX75pxJACKVERYMINDBUSHWOLFGQZbfghjklqvwyzrict';
+  const customNanoId = customAlphabet(urlAlphabet, 21);
+
+  return customNanoId();
+};

package/src/workers/WorkerQueue/index.ts

@@ -21,14 +21,14 @@ class WorkerQueue {
   }
 
   async getWorkerForScriptPath(scriptPath: string) {
-    if (!this.workers) this.workers = {}; 
+    if (!this.workers) this.workers = {};
     let worker = this.workers[scriptPath];
     if (!worker || worker.threadId === -1) {
       this.workers[scriptPath] = worker = new Worker(scriptPath);
     }
     return worker;
   }
-  
+
   async enqueue(task: QueuedTask) {
     const { priority, scriptPath, data, taskType } = task;
 
@@ -40,9 +40,9 @@ class WorkerQueue {
   }
 
   async processQueue() {
-    if (this.isProcessing || this.queue.length === 0){
+    if (this.isProcessing || this.queue.length === 0) {
       return;
-    } 
+    }
 
     this.isProcessing = true;
     const { scriptPath, data, taskType, resolve, reject } = this.queue.shift() as QueuedTask;
@@ -61,12 +61,12 @@ class WorkerQueue {
   async runWorker({ scriptPath, data, taskType }: { scriptPath: string; data: any; taskType: 'parse' | 'stringify' }) {
     return new Promise(async (resolve, reject) => {
       let worker = await this.getWorkerForScriptPath(scriptPath);
-      
+
       const messageHandler = (data: any) => {
         worker.off('message', messageHandler);
         worker.off('error', errorHandler);
         worker.off('exit', exitHandler);
-        
+
         if (data?.error) {
           reject(new Error(data?.error));
         } else {
@@ -89,7 +89,7 @@ class WorkerQueue {
         delete this.workers[scriptPath];
         reject(new Error(`Worker stopped with exit code ${code}`));
       };
-      
+
       worker.on('message', messageHandler);
       worker.on('error', errorHandler);
       worker.on('exit', exitHandler);
@@ -99,16 +99,16 @@ class WorkerQueue {
   }
 
   async cleanup() {
-    const promises = Object.values(this.workers).map(worker => {
+    const promises = Object.values(this.workers).map((worker) => {
       if (worker.threadId !== -1) {
         return worker.terminate();
       }
       return Promise.resolve();
     });
-    
+
     await Promise.allSettled(promises);
     this.workers = {};
   }
 }
 
-export default WorkerQueue;
+export default WorkerQueue;

package/src/workers/index.ts

@@ -1,30 +1,31 @@
 import WorkerQueue from './WorkerQueue';
-import { Lane } from '../types';
+import { Lane, CollectionFormat } from '../types';
+import { DEFAULT_COLLECTION_FORMAT } from '../constants';
 import path from 'node:path';
 
 const sizeInMB = (size: number): number => {
   return size / (1024 * 1024);
-}
+};
 
 const getSize = (data: any): number => {
   return sizeInMB(typeof data === 'string' ? Buffer.byteLength(data, 'utf8') : Buffer.byteLength(JSON.stringify(data), 'utf8'));
-}
+};
 
 /**
  * Lanes are used to determine which worker queue to use based on the size of the data.
- * 
+ *
  * The first lane is for smaller files (<0.1MB), the second lane is for larger files (>=0.1MB).
  * This helps with parsing performance.
  */
 const LANES: Lane[] = [{
   maxSize: 0.005
-},{
+}, {
   maxSize: 0.1
-},{
+}, {
   maxSize: 1
-},{
+}, {
   maxSize: 10
-},{
+}, {
   maxSize: 100
 }];
 
@@ -38,7 +39,7 @@ class BruParserWorker {
   private workerQueues: WorkerQueueWithSize[];
 
   constructor() {
-    this.workerQueues = LANES?.map(lane => ({
+    this.workerQueues = LANES?.map((lane) => ({
       maxSize: lane?.maxSize,
       workerQueue: new WorkerQueue()
     }));
@@ -47,40 +48,40 @@ class BruParserWorker {
   private getWorkerQueue(size: number): WorkerQueue {
     // Find the first queue that can handle the given size
     // or fallback to the last queue for largest files
-    const queueForSize = this.workerQueues.find((queue) => 
+    const queueForSize = this.workerQueues.find((queue) =>
       queue.maxSize >= size
     );
 
     return queueForSize?.workerQueue ?? this.workerQueues[this.workerQueues.length - 1].workerQueue;
   }
 
-  private async enqueueTask({ data, taskType }: { data: any; taskType: 'parse' | 'stringify' }): Promise<any> {
+  private async enqueueTask({ data, taskType, format = DEFAULT_COLLECTION_FORMAT }: { data: any; taskType: 'parse' | 'stringify'; format?: CollectionFormat }): Promise<any> {
     const size = getSize(data);
     const workerQueue = this.getWorkerQueue(size);
     const workerScriptPath = path.join(__dirname, './workers/worker-script.js');
-    
+
     return workerQueue.enqueue({
-      data,
+      data: { data, format },
       priority: size,
       scriptPath: workerScriptPath,
-      taskType,
+      taskType
     });
   }
 
-  async parseRequest(data: any): Promise<any> {
-    return this.enqueueTask({ data, taskType: 'parse' });
+  async parseRequest(data: any, format: CollectionFormat = DEFAULT_COLLECTION_FORMAT): Promise<any> {
+    return this.enqueueTask({ data, taskType: 'parse', format });
   }
 
-  async stringifyRequest(data: any): Promise<any> {
-    return this.enqueueTask({ data, taskType: 'stringify' });
+  async stringifyRequest(data: any, format: CollectionFormat = DEFAULT_COLLECTION_FORMAT): Promise<any> {
+    return this.enqueueTask({ data, taskType: 'stringify', format });
   }
 
   async cleanup(): Promise<void> {
-    const cleanupPromises = this.workerQueues.map(({ workerQueue }) => 
+    const cleanupPromises = this.workerQueues.map(({ workerQueue }) =>
       workerQueue.cleanup()
     );
     await Promise.allSettled(cleanupPromises);
   }
 }
 
-export default BruParserWorker; 
+export default BruParserWorker;

package/src/workers/worker-script.ts

@@ -1,20 +1,35 @@
 import { parentPort } from 'node:worker_threads';
-import { bruRequestToJson, jsonRequestToBru } from '../formats/bru';
+import { parseBruRequest, stringifyBruRequest } from '../formats/bru';
+import { parseYmlItem, stringifyYmlItem } from '../formats/yml';
+import { CollectionFormat } from '../types';
+import { DEFAULT_COLLECTION_FORMAT } from '../constants';
 
 interface WorkerMessage {
   taskType: 'parse' | 'stringify';
-  data: any;
+  data: {
+    data: any;
+    format?: CollectionFormat;
+  };
 }
 
 parentPort?.on('message', async (message: WorkerMessage) => {
   try {
-    const { taskType, data } = message;
+    const { taskType, data: messageData } = message;
+    const { data, format = DEFAULT_COLLECTION_FORMAT } = messageData;
     let result: any;
 
     if (taskType === 'parse') {
-      result = bruRequestToJson(data);
+      if (format === 'yml') {
+        result = parseYmlItem(data);
+      } else {
+        result = parseBruRequest(data);
+      }
     } else if (taskType === 'stringify') {
-      result = jsonRequestToBru(data);
+      if (format === 'yml') {
+        result = stringifyYmlItem(data);
+      } else {
+        result = stringifyBruRequest(data);
+      }
     } else {
       throw new Error(`Unknown task type: ${taskType}`);
     }
@@ -24,4 +39,4 @@ parentPort?.on('message', async (message: WorkerMessage) => {
     console.error('Worker error:', error);
     parentPort?.postMessage({ error: error?.message });
   }
-});
+});

package/dist/cjs/formats/bru/index.d.ts

@@ -1,19 +0,0 @@
-export declare const bruRequestToJson: (data: string | any, parsed?: boolean) => any;
-export declare const jsonRequestToBru: (json: any) => string;
-export declare const bruCollectionToJson: (data: string | any, parsed?: boolean) => any;
-export declare const jsonCollectionToBru: (json: any, isFolder?: boolean) => string;
-export declare const bruEnvironmentToJson: (bru: string) => any;
-export declare const jsonEnvironmentToBru: (json: any) => string;
-export declare const bruExampleToJson: (data: string | any, parsed?: boolean, parentType?: string, parentMethod?: string) => any;
-export declare const jsonExampleToBru: (json: any) => {
-    name: any;
-    description: any;
-    request: {
-        method: any;
-        url: any;
-        headers: any;
-        body: any;
-        params: any;
-    };
-    response: any;
-};

package/dist/cjs/formats/bru/utils/oauth2-additional-params.d.ts

@@ -1,38 +0,0 @@
-type T_Oauth2ParameterSendInType = 'headers' | 'queryparams' | 'body';
-export interface T_OAuth2AdditionalParam {
-    name: string;
-    value: string;
-    enabled: boolean;
-    sendIn: T_Oauth2ParameterSendInType;
-}
-export interface T_OAuth2AdditionalParameters {
-    authorization?: T_OAuth2AdditionalParam[];
-    token?: T_OAuth2AdditionalParam[];
-    refresh?: T_OAuth2AdditionalParam[];
-}
-export interface T_Oauth2Auth {
-    grantType: string;
-    additionalParameters?: T_OAuth2AdditionalParameters;
-}
-export interface T_BruJson {
-    auth: {
-        oauth2: T_Oauth2Auth;
-    };
-    oauth2_additional_parameters_auth_req_headers?: any[];
-    oauth2_additional_parameters_auth_req_queryparams?: any[];
-    oauth2_additional_parameters_access_token_req_headers?: any[];
-    oauth2_additional_parameters_access_token_req_queryparams?: any[];
-    oauth2_additional_parameters_access_token_req_bodyvalues?: any[];
-    oauth2_additional_parameters_refresh_token_req_headers?: any[];
-    oauth2_additional_parameters_refresh_token_req_queryparams?: any[];
-    oauth2_additional_parameters_refresh_token_req_bodyvalues?: any[];
-}
-/**
- * This function extracts OAuth2 additional parameters from various sources in the bru json data and organizes
- * them into a structured format based on their usage context (authorization, token, refresh).
- *
- * @param json - json object containing OAuth2 configuration and additional parameters
- * @returns OAuth2 additional parameters
- */
-export declare const getOauth2AdditionalParameters: (json: T_BruJson) => T_OAuth2AdditionalParameters;
-export {};

package/dist/cjs/formats/bru/utils/request-parse-and-redact-body-data.d.ts

@@ -1,9 +0,0 @@
-/**
- * Parses a .bru file and extracts body content while redacting it from the main content
- * @param {string} bruFileContent - The raw content of the .bru file
- * @returns {Object} Object containing redacted file content and extracted body data
- */
-export declare const bruRequestParseAndRedactBodyData: (bruFileContent: string) => {
-    bruFileStringWithRedactedBody: string;
-    extractedBodyContent: Record<string, string>;
-};

package/dist/cjs/index.d.ts

@@ -1,16 +0,0 @@
-import BruParserWorker from './workers';
-import { ParseOptions, StringifyOptions, ParsedRequest, ParsedCollection, ParsedEnvironment } from './types';
-export declare const parseRequest: (content: string, options?: ParseOptions) => any;
-export declare const parseRequestAndRedactBody: (content: string, options?: ParseOptions) => any;
-export declare const stringifyRequest: (requestObj: ParsedRequest, options?: StringifyOptions) => string;
-export declare const parseRequestViaWorker: (content: string) => Promise<any>;
-export declare const stringifyRequestViaWorker: (requestObj: any) => Promise<string>;
-export declare const parseCollection: (content: string, options?: ParseOptions) => any;
-export declare const stringifyCollection: (collectionObj: ParsedCollection, options?: StringifyOptions) => string;
-export declare const parseFolder: (content: string, options?: ParseOptions) => any;
-export declare const stringifyFolder: (folderObj: any, options?: StringifyOptions) => string;
-export declare const parseEnvironment: (content: string, options?: ParseOptions) => any;
-export declare const stringifyEnvironment: (envObj: ParsedEnvironment, options?: StringifyOptions) => string;
-export declare const parseDotEnv: (content: string) => Record<string, string>;
-export { BruParserWorker };
-export * from './types';

package/dist/cjs/types.d.ts

@@ -1,142 +0,0 @@
-export interface ParseOptions {
-    format?: 'bru' | 'yaml';
-}
-export interface StringifyOptions {
-    format?: 'bru' | 'yaml';
-}
-export interface RequestBody {
-    mode?: string;
-    raw?: string;
-    formUrlEncoded?: Array<{
-        name: string;
-        value: string;
-        enabled: boolean;
-    }>;
-    multipartForm?: Array<{
-        name: string;
-        value: string;
-        type: string;
-        enabled: boolean;
-    }>;
-    json?: string;
-    xml?: string;
-    sparql?: string;
-    graphql?: {
-        query?: string;
-        variables?: string;
-    };
-}
-export interface AuthConfig {
-    mode?: string;
-    basic?: {
-        username?: string;
-        password?: string;
-    };
-    bearer?: {
-        token?: string;
-    };
-    apikey?: {
-        key?: string;
-        value?: string;
-        placement?: string;
-    };
-    awsv4?: {
-        accessKeyId?: string;
-        secretAccessKey?: string;
-        sessionToken?: string;
-        service?: string;
-        region?: string;
-        profileName?: string;
-    };
-    oauth2?: {
-        grantType?: string;
-        callbackUrl?: string;
-        authorizationUrl?: string;
-        accessTokenUrl?: string;
-        clientId?: string;
-        clientSecret?: string;
-        scope?: string;
-        state?: string;
-        pkce?: boolean;
-    };
-}
-export interface RequestParam {
-    name: string;
-    value: string;
-    enabled: boolean;
-}
-export interface RequestHeader {
-    name: string;
-    value: string;
-    enabled: boolean;
-}
-export interface RequestAssertion {
-    name: string;
-    value: string;
-    enabled: boolean;
-}
-export interface RequestVars {
-    req?: Array<{
-        name: string;
-        value: string;
-        enabled: boolean;
-    }>;
-    res?: Array<{
-        name: string;
-        value: string;
-        enabled: boolean;
-    }>;
-}
-export interface RequestScript {
-    req?: string;
-    res?: string;
-}
-export interface RequestSettings {
-    [key: string]: any;
-}
-export interface RequestData {
-    method: string;
-    url: string;
-    params: RequestParam[];
-    headers: RequestHeader[];
-    auth: AuthConfig;
-    body: RequestBody;
-    script: RequestScript;
-    vars: RequestVars;
-    assertions: RequestAssertion[];
-    tests: string;
-    docs: string;
-}
-export interface ParsedRequest {
-    type: 'http-request' | 'graphql-request';
-    name: string;
-    seq: number;
-    settings: RequestSettings;
-    tags: string[];
-    request: RequestData;
-}
-export interface ParsedCollection {
-    name: string;
-    type?: string;
-    version?: string;
-    [key: string]: any;
-}
-export interface EnvironmentVariable {
-    name: string;
-    value: string;
-    enabled: boolean;
-}
-export interface ParsedEnvironment {
-    variables: EnvironmentVariable[];
-}
-export interface WorkerTask {
-    data: any;
-    priority: number;
-    scriptPath: string;
-    taskType?: 'parse' | 'stringify';
-    resolve?: (value: any) => void;
-    reject?: (reason?: any) => void;
-}
-export interface Lane {
-    maxSize: number;
-}

package/dist/cjs/workers/WorkerQueue/index.d.ts

@@ -1,26 +0,0 @@
-/// <reference types="node" />
-import { Worker } from 'node:worker_threads';
-interface QueuedTask {
-    priority: number;
-    scriptPath: string;
-    data: any;
-    taskType: 'parse' | 'stringify';
-    resolve?: (value: any) => void;
-    reject?: (reason?: any) => void;
-}
-declare class WorkerQueue {
-    private queue;
-    private isProcessing;
-    private workers;
-    constructor();
-    getWorkerForScriptPath(scriptPath: string): Promise<Worker>;
-    enqueue(task: QueuedTask): Promise<unknown>;
-    processQueue(): Promise<void>;
-    runWorker({ scriptPath, data, taskType }: {
-        scriptPath: string;
-        data: any;
-        taskType: 'parse' | 'stringify';
-    }): Promise<unknown>;
-    cleanup(): Promise<void>;
-}
-export default WorkerQueue;

package/dist/cjs/workers/formats/bru/index.d.ts

@@ -1,19 +0,0 @@
-export declare const bruRequestToJson: (data: string | any, parsed?: boolean) => any;
-export declare const jsonRequestToBru: (json: any) => string;
-export declare const bruCollectionToJson: (data: string | any, parsed?: boolean) => any;
-export declare const jsonCollectionToBru: (json: any, isFolder?: boolean) => string;
-export declare const bruEnvironmentToJson: (bru: string) => any;
-export declare const jsonEnvironmentToBru: (json: any) => string;
-export declare const bruExampleToJson: (data: string | any, parsed?: boolean, parentType?: string, parentMethod?: string) => any;
-export declare const jsonExampleToBru: (json: any) => {
-    name: any;
-    description: any;
-    request: {
-        method: any;
-        url: any;
-        headers: any;
-        body: any;
-        params: any;
-    };
-    response: any;
-};

package/dist/cjs/workers/formats/bru/utils/request-parse-and-redact-body-data.d.ts

@@ -1,9 +0,0 @@
-/**
- * Parses a .bru file and extracts body content while redacting it from the main content
- * @param {string} bruFileContent - The raw content of the .bru file
- * @returns {Object} Object containing redacted file content and extracted body data
- */
-export declare const bruRequestParseAndRedactBodyData: (bruFileContent: string) => {
-    bruFileStringWithRedactedBody: string;
-    extractedBodyContent: Record<string, string>;
-};

package/dist/cjs/workers/index.d.ts

@@ -1,16 +0,0 @@
-import BruParserWorker from './workers';
-import { ParseOptions, StringifyOptions, ParsedRequest, ParsedCollection, ParsedEnvironment } from './types';
-export declare const parseRequest: (content: string, options?: ParseOptions) => any;
-export declare const parseRequestAndRedactBody: (content: string, options?: ParseOptions) => any;
-export declare const stringifyRequest: (requestObj: ParsedRequest, options?: StringifyOptions) => string;
-export declare const parseRequestViaWorker: (content: string) => Promise<any>;
-export declare const stringifyRequestViaWorker: (requestObj: any) => Promise<string>;
-export declare const parseCollection: (content: string, options?: ParseOptions) => any;
-export declare const stringifyCollection: (collectionObj: ParsedCollection, options?: StringifyOptions) => string;
-export declare const parseFolder: (content: string, options?: ParseOptions) => any;
-export declare const stringifyFolder: (folderObj: any, options?: StringifyOptions) => string;
-export declare const parseEnvironment: (content: string, options?: ParseOptions) => any;
-export declare const stringifyEnvironment: (envObj: ParsedEnvironment, options?: StringifyOptions) => string;
-export declare const parseDotEnv: (content: string) => Record<string, string>;
-export { BruParserWorker };
-export * from './types';