@api-client/core 0.4.0 → 0.4.1

package/build/src/runtime/store/WsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsClient.js","sourceRoot":"","sources":["../../../../src/runtime/store/WsClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAgB,QAAS,SAAQ,OAAO;CAwB7C"}

package/build/src/runtime/store/WsClientNode.d.ts

@@ -0,0 +1,24 @@
+import WebSocket from 'ws';
+import { WsClient } from './WsClient.js';
+export declare class WsClientNode extends WsClient {
+    /**
+     * Creates a WS client with optional token
+     * @param addr The ws:// address
+     * @param token Optional token to add.
+     */
+    getClient(addr: string, token?: string | undefined): WebSocket;
+    /**
+     * Connect to the WS server
+     *
+     * @param client The client to wait for connection.
+     */
+    connect(client: WebSocket): Promise<void>;
+    /**
+     * Disconnects from the WS server.
+     */
+    disconnect(client: WebSocket): Promise<void>;
+    /**
+     * The combination of `getClient()` and `connect()`.
+     */
+    createAndConnect(addr: string, token?: string): Promise<WebSocket>;
+}

package/build/src/runtime/store/WsClientNode.js

@@ -0,0 +1,66 @@
+import WebSocket from 'ws';
+import { WsClient } from './WsClient.js';
+export class WsClientNode extends WsClient {
+    /**
+     * Creates a WS client with optional token
+     * @param addr The ws:// address
+     * @param token Optional token to add.
+     */
+    getClient(addr, token = this.sdk.token) {
+        let url = addr;
+        if (token) {
+            url += url.includes('?') ? '&' : '?';
+            url += 'token=';
+            url += token;
+        }
+        if (url.startsWith('http:')) {
+            url = `ws:${url.substring(5)}`;
+        }
+        else if (url.startsWith('https:')) {
+            url = `wss:${url.substring(6)}`;
+        }
+        return new WebSocket(url);
+    }
+    /**
+     * Connect to the WS server
+     *
+     * @param client The client to wait for connection.
+     */
+    connect(client) {
+        return new Promise((resolve, reject) => {
+            client.once('open', () => {
+                client.removeAllListeners('error');
+                resolve();
+            });
+            client.once('error', (err) => {
+                client.removeAllListeners('open');
+                reject(err);
+            });
+        });
+    }
+    /**
+     * Disconnects from the WS server.
+     */
+    disconnect(client) {
+        return new Promise((resolve, reject) => {
+            client.once('close', () => {
+                client.removeAllListeners('error');
+                resolve();
+            });
+            client.once('error', (err) => {
+                client.removeAllListeners('close');
+                reject(err);
+            });
+            client.close();
+        });
+    }
+    /**
+     * The combination of `getClient()` and `connect()`.
+     */
+    async createAndConnect(addr, token) {
+        const client = this.getClient(addr, token);
+        await this.connect(client);
+        return client;
+    }
+}
+//# sourceMappingURL=WsClientNode.js.map

package/build/src/runtime/store/WsClientNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsClientNode.js","sourceRoot":"","sources":["../../../../src/runtime/store/WsClientNode.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,IAAI,CAAC;AAC3B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,OAAO,YAAa,SAAQ,QAAQ;IACxC;;;;OAIG;IACH,SAAS,CAAC,IAAY,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK;QAC5C,IAAI,GAAG,GAAG,IAAI,CAAC;QACf,IAAI,KAAK,EAAE;YACT,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;YACrC,GAAG,IAAI,QAAQ,CAAC;YAChB,GAAG,IAAI,KAAK,CAAC;SACd;QACD,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC3B,GAAG,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SAChC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACnC,GAAG,GAAG,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SACjC;QACD,OAAO,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAiB;QACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBACnC,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC3B,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,MAAiB;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACxB,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBACnC,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC3B,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBACnC,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,KAAc;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/src/runtime/store/WsClientWeb.d.ts

@@ -0,0 +1,23 @@
+import { WsClient } from './WsClient.js';
+export declare class WsClientWeb extends WsClient {
+    /**
+     * Creates a WS client with optional token
+     * @param addr The ws:// address
+     * @param token Optional token to add.
+     */
+    getClient(addr: string, token?: string | undefined): WebSocket;
+    /**
+     * Connect to the WS server
+     *
+     * @param client The client to wait for connection.
+     */
+    connect(client: WebSocket): Promise<void>;
+    /**
+     * Disconnects from the WS server.
+     */
+    disconnect(client: WebSocket): Promise<void>;
+    /**
+     * The combination of `getClient()` and `connect()`.
+     */
+    createAndConnect(addr: string, token?: string): Promise<WebSocket>;
+}

package/build/src/runtime/store/WsClientWeb.js

@@ -0,0 +1,73 @@
+import { WsClient } from './WsClient.js';
+export class WsClientWeb extends WsClient {
+    /**
+     * Creates a WS client with optional token
+     * @param addr The ws:// address
+     * @param token Optional token to add.
+     */
+    getClient(addr, token = this.sdk.token) {
+        let url = addr;
+        if (token) {
+            url += url.includes('?') ? '&' : '?';
+            url += 'token=';
+            url += token;
+        }
+        if (url.startsWith('http:')) {
+            url = `ws:${url.substring(5)}`;
+        }
+        else if (url.startsWith('https:')) {
+            url = `wss:${url.substring(6)}`;
+        }
+        return new WebSocket(url);
+    }
+    /**
+     * Connect to the WS server
+     *
+     * @param client The client to wait for connection.
+     */
+    connect(client) {
+        return new Promise((resolve, reject) => {
+            function opened() {
+                client.removeEventListener('open', opened);
+                client.removeEventListener('error', errored);
+                resolve();
+            }
+            function errored() {
+                client.removeEventListener('open', opened);
+                client.removeEventListener('error', errored);
+                reject(new Error(`Unable to connect to: ${client.url}`));
+            }
+            client.addEventListener('open', opened);
+            client.addEventListener('error', errored);
+        });
+    }
+    /**
+     * Disconnects from the WS server.
+     */
+    disconnect(client) {
+        return new Promise((resolve, reject) => {
+            function closed() {
+                client.removeEventListener('close', closed);
+                client.removeEventListener('error', errored);
+                resolve();
+            }
+            function errored() {
+                client.removeEventListener('close', closed);
+                client.removeEventListener('error', errored);
+                reject(new Error(`Unable to connect to: ${client.url}`));
+            }
+            client.addEventListener('close', closed);
+            client.addEventListener('error', errored);
+            client.close();
+        });
+    }
+    /**
+     * The combination of `getClient()` and `connect()`.
+     */
+    async createAndConnect(addr, token) {
+        const client = this.getClient(addr, token);
+        await this.connect(client);
+        return client;
+    }
+}
+//# sourceMappingURL=WsClientWeb.js.map

package/build/src/runtime/store/WsClientWeb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsClientWeb.js","sourceRoot":"","sources":["../../../../src/runtime/store/WsClientWeb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,OAAO,WAAY,SAAQ,QAAQ;IACvC;;;;OAIG;IACH,SAAS,CAAC,IAAY,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK;QAC5C,IAAI,GAAG,GAAG,IAAI,CAAC;QACf,IAAI,KAAK,EAAE;YACT,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;YACrC,GAAG,IAAI,QAAQ,CAAC;YAChB,GAAG,IAAI,KAAK,CAAC;SACd;QACD,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC3B,GAAG,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SAChC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACnC,GAAG,GAAG,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SACjC;QACD,OAAO,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAiB;QACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,SAAS,MAAM;gBACb,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAC3C,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,SAAS,OAAO;gBACd,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAC3C,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,MAAM,CAAC,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACxC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,MAAiB;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,SAAS,MAAM;gBACb,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC5C,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,SAAS,OAAO;gBACd,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC5C,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,MAAM,CAAC,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACzC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,KAAc;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -56,6 +56,7 @@
     "mocha": "^9.1.3",
     "shrink-ray-current": "^4.1.3",
     "sinon": "^13.0.1",
+    "source-map-support": "^0.5.21",
     "ssl-root-cas": "^1.3.1",
     "ts-node": "^10.4.0",
     "typescript": "^4.4.4"
@@ -68,10 +69,7 @@
     "tsc:watch": "tsc --watch",
     "test:browser": "wtr --playwright --browsers chromium firefox webkit --coverage",
     "test:browser:watch": "wtr --watch --playwright --browsers chromium",
-    "test:mocha": "mocha --require test/http-server-fixture.js",
-    "test:mocha:watch": "mocha --watch --require test/http-server-fixture.js",
-    "test:mocha:watch2": "node scripts/test-node-watch.js",
-    "test:mocha:watch3": "mocha --watch --recursive --parallel --require test/http-server-fixture.js",
+    "test:mocha": "npm run build-ts && mocha",
     "test": "npm run test:mocha && npm run test:browser"
   },
   "husky": {
@@ -86,8 +84,8 @@
   },
   "dependencies": {
     "@metrichor/jmespath": "^0.3.1",
-    "@pawel-up/jexl": "^3.0.0",
     "@pawel-up/data-mock": "^0.1.7",
+    "@pawel-up/jexl": "^3.0.0",
     "@xmldom/xmldom": "^0.8.1",
     "console-table-printer": "^2.10.0",
     "form-data": "^4.0.0",

package/src/models/HttpHistory.ts

@@ -48,6 +48,36 @@ export interface IHttpHistory {
   midnight?: number;
 }
 
+/**
+ * An interface used when adding a history in bulk.
+ * The store creates a history object propagating meta values defined here
+ * onto the history objects.
+ * Because of that, bulk operation can only be performed when the requests are made in similar 
+ * context (app, space, project).
+ */
+export interface IHttpHistoryBulkAdd {
+  /**
+   * Optional user space id. Must be set when the originating request belongs to a user space.
+   */
+  space?: string;
+  /**
+   * Optional project id. Must be set when the originating request belongs to a user space.
+   */
+  project?: string;
+  /**
+   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   */
+  app?: string;
+  /**
+   * The optional request id in the project that generated this log.
+   */
+  request?: string;
+  /**
+   * The list of request logs.
+   */
+  log: IRequestLog[];
+}
+
 /**
  * An HTTP history is an object containing an information of a request and response
  * made with the application.

package/src/models/RequestLog.ts

@@ -28,6 +28,10 @@ export interface IRequestLog {
    * Request and response size. Some HTTP clients may not give this information.
    */
   size?: IRequestsSize;
+  /**
+   * Optional request ID defined on an HTTP project that triggered this log.
+   */
+  requestId?: string;
 }
 
 /**
@@ -51,6 +55,10 @@ export class RequestLog {
    * Request and response size. Some HTTP clients may not give this information.
    */
   size?: RequestsSize;
+  /**
+   * Optional request ID defined on an HTTP project that triggered this log.
+   */
+  requestId?: string;
 
   static fromRequest(request: ISentRequest): RequestLog {
     return new RequestLog({
@@ -88,7 +96,7 @@ export class RequestLog {
    * Creates a new response clearing anything that is so far defined.
    */
   new(init: IRequestLog): void {
-    const { request, response, redirects, size } = init;
+    const { request, response, redirects, size, requestId } = init;
     this.kind = Kind;
     if (request) {
       this.request = new SentRequest(request);
@@ -112,6 +120,11 @@ export class RequestLog {
     } else {
       this.size = undefined;
     }
+    if (requestId) {
+      this.requestId = requestId;
+    } else {
+      this.requestId = undefined;
+    }
   }
 
   toJSON(): IRequestLog {
@@ -130,6 +143,9 @@ export class RequestLog {
     if (this.response) {
       result.response = this.response.toJSON();
     }
+    if (this.requestId) {
+      result.requestId = this.requestId;
+    }
     return result;
   }
 

package/src/runtime/node/InteropInterfaces.ts

@@ -0,0 +1,121 @@
+import { IProjectRequestIterator, IHttpProject } from '../../models/HttpProject.js';
+import { Environment } from '../../models/Environment.js';
+import { Logger } from '../../lib/logging/Logger.js';
+import { IRequestLog } from '../../models/RequestLog.js';
+
+export interface ProjectRunnerOptions {
+  /**
+   * When provided it overrides any project / folder defined environment.
+   */
+  environment?: Environment;
+  /**
+   * Additional variables to pass to the selected environment.
+   * This can be use to pass system variables, when needed.
+   * 
+   * To use system variables tou can use `init.variables = process.env`;
+   */
+  variables?: Record<string, string>;
+  /**
+   * Overrides the default logger (console).
+   */
+  logger?: Logger;
+  /**
+   * The event target to use.
+   * By default it creates its own target.
+   */
+  eventTarget?: EventTarget;
+}
+
+export interface ProjectRunnerRunOptions extends IProjectRequestIterator {
+}
+
+export interface RunResult {
+  /**
+   * The key of the request from the HttpProject that was executed.
+   */
+  key: string;
+  /**
+   * The key of parent folder of the executed request.
+   */
+  parent?: string;
+  /**
+   * Set when a fatal error occurred so the request couldn't be executed.
+   * This is not the same as error reported during a request. The log's response can still be IResponseError.
+   */
+  error?: boolean;
+  /**
+   * The error message. Always set when the `error` is `true`.
+   */
+  errorMessage?: string;
+  /**
+   * The request log.
+   * Always set when the `error` is `false`.
+   */
+  log?: IRequestLog;
+}
+
+export interface IProjectParallelRunnerOptions extends IProjectRunnerOptions {
+}
+
+export interface IProjectParallelWorkerOptions extends IProjectRunnerOptions {
+  project: IHttpProject;
+}
+
+export interface IProjectRunnerOptions {
+  /**
+   * The environment to use.
+   * This can be a name or the key of the environment located under the parent or root.
+   * It can also be a path to the environment definition. If the file exists it is used. Otherwise it tried to 
+   * find the environment in the project.
+   */
+  environment?: string;
+  /**
+   * The parent folder to execute.
+   */
+  parent?: string;
+  /**
+   * The names or the keys of requests to execute.
+   * This can be used to limit the number of requests.
+   */
+  request?: string[];
+  /**
+   * The number of times the execution should be repeated.
+   * Default to 1.
+   */
+  iterations?: number;
+  /**
+   * The number of milliseconds to wait between each iteration.
+   * Default to the next frame (vary from 1 to tens of milliseconds).
+   */
+  iterationDelay?: number;
+  /**
+   * When set it performs parallel execution for each iteration.
+   * The number of executions at the same time depends on the number of processor cores
+   * available on the current machine. The maximum of the parallel execution
+   * is the number of available cores. When the `iterations` number is higher
+   * then the "rest" is added to the iterations per each core.
+   */
+  parallel?: boolean;
+  /**
+   * When set it includes requests in the current folder and sub-folder according to the order
+   * defined in the folder.
+   */
+  recursive?: boolean;
+  /**
+   * The opposite of the `requests`. The list of names or keys of requests or folders to ignore.
+   * Note, ignore is tested before the `requests`.
+   */
+  ignore?: string[];
+  /**
+   * The logger to use with the request factory.
+   * When not set it uses the dummy logger (no output).
+   */
+  logger?: Logger;
+  /**
+   * When true it copies all system variables to the execution environment.
+   * When an array of strings, only takes system variables that are listed in the array.
+   * When a map, it uses this map as a list of variables.
+   * When not set it does not read system variables.
+   */
+  variables?: boolean | string[] | Record<string, string>;
+}

package/src/runtime/node/ProjectParallelRunner.ts

@@ -2,10 +2,10 @@ import cluster, { Worker } from 'cluster';
 import { cpus } from 'os';
 import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
-import { HttpProject, IHttpProject } from '../../models/HttpProject.js';
-import { IProjectRunnerOptions } from './ProjectRunner.js';
+import { HttpProject } from '../../models/HttpProject.js';
 import { IProjectExecutionLog, IProjectExecutionIteration } from '../reporters/Reporter.js';
 import { BaseRunner } from './BaseRunner.js';
+import { IProjectParallelRunnerOptions, IProjectParallelWorkerOptions } from './InteropInterfaces.js'
 
 const numCPUs = cpus().length;
 const __dirname = dirname(fileURLToPath(import.meta.url));
@@ -40,13 +40,6 @@ export interface IWorkerMessage {
   data?: unknown;
 }
 
-export interface IProjectParallelRunnerOptions extends IProjectRunnerOptions {
-}
-
-export interface IProjectParallelWorkerOptions extends IProjectRunnerOptions {
-  project: IHttpProject;
-}
-
 export interface ProjectParallelRunner {
   /**
    * Dispatched when a status of a worker change.

package/src/runtime/node/ProjectRequestRunner.ts

@@ -6,64 +6,14 @@ import { Property } from '../../models/Property.js';
 import { ProjectFolder, Kind as ProjectFolderKind } from '../../models/ProjectFolder.js';
 import { ProjectRequest } from '../../models/ProjectRequest.js';
 import { IHttpRequest } from '../../models/HttpRequest.js';
-import { HttpProject, IProjectRequestIterator } from '../../models/HttpProject.js';
+import { HttpProject } from '../../models/HttpProject.js';
 import { SentRequest } from '../../models/SentRequest.js';
 import { ErrorResponse } from '../../models/ErrorResponse.js';
 import { VariablesStore } from './VariablesStore.js';
 import { VariablesProcessor } from '../variables/VariablesProcessor.js';
 import { RequestFactory } from './RequestFactory.js';
 import { EventTypes } from '../../events/EventTypes.js';
-
-export interface ProjectRunnerOptions {
-  /**
-   * When provided it overrides any project / folder defined environment.
-   */
-  environment?: Environment;
-  /**
-   * Additional variables to pass to the selected environment.
-   * This can be use to pass system variables, when needed.
-   * 
-   * To use system variables tou can use `init.variables = process.env`;
-   */
-  variables?: Record<string, string>;
-  /**
-   * Overrides the default logger (console).
-   */
-  logger?: Logger;
-  /**
-   * The event target to use.
-   * By default it creates its own target.
-   */
-  eventTarget?: EventTarget;
-}
-
-export interface ProjectRunnerRunOptions extends IProjectRequestIterator {
-}
-
-export interface RunResult {
-  /**
-   * The key of the request from the HttpProject that was executed.
-   */
-  key: string;
-  /**
-   * The key of parent folder of the executed request.
-   */
-  parent?: string;
-  /**
-   * Set when a fatal error occurred so the request couldn't be executed.
-   * This is not the same as error reported during a request. The log's response can still be IResponseError.
-   */
-  error?: boolean;
-  /**
-   * The error message. Always set when the `error` is `true`.
-   */
-  errorMessage?: string;
-  /**
-   * The request log.
-   * Always set when the `error` is `false`.
-   */
-  log?: IRequestLog;
-}
+import { ProjectRunnerOptions, ProjectRunnerRunOptions, RunResult } from './InteropInterfaces.js';
 
 export interface ProjectRequestRunner {
   /**
@@ -130,20 +80,50 @@ export class ProjectRequestRunner extends EventEmitter {
     const { project } = this;
     const executed: RunResult[] = [];
     for (const request of project.requestIterator(options)) {
-      const parent = request.getParent() || project;
-      let variables: Record<string, string>;
-      if (VariablesStore.has(parent)) {
-        variables = VariablesStore.get(parent);
-      } else {
-        variables = await this.getVariables(parent);
-        VariablesStore.set(parent, variables);
-      }
-      const info = await this.execute(request, variables);
+      const info = await this._runItem(request);
       executed.push(info);
     }
     return executed;
   }
 
+  /**
+   * Allows to iterate over project requests recursively and execute each request
+   * in order. The generator yields the `RunResult` for the request.
+   * 
+   * Example:
+   * 
+   * ```javascript
+   * const runner = new ProjectRequestRunner(...);
+   * for await (let runResult of runner) {
+   *  console.log(runResult);
+   * }
+   * ```
+   */
+  async* [Symbol.asyncIterator](): AsyncGenerator<RunResult> {
+    const { project } = this;
+    for (const request of project.requestIterator({ recursive: true })) {
+      const info = await this._runItem(request);
+      yield info;
+    }
+  }
+
+  private async _runItem(request: ProjectRequest): Promise<RunResult> {
+    const folder = request.getParent();
+    const parent = folder || this.project;
+    let variables: Record<string, string>;
+    if (VariablesStore.has(parent)) {
+      variables = VariablesStore.get(parent);
+    } else {
+      variables = await this.getVariables(parent);
+      VariablesStore.set(parent, variables);
+    }
+    const info = await this.execute(request, variables);
+    if (folder && folder !== this.project) {
+      info.parent = folder.key;
+    }
+    return info;
+  } 
+
   protected async execute(request: ProjectRequest, variables: Record<string, string>): Promise<RunResult> {
     const config = request.getConfig();
     const factory = new RequestFactory(this.eventTarget);
@@ -189,6 +169,7 @@ export class ProjectRequestRunner extends EventEmitter {
       this.emit('request', request.key, { ...requestCopy });
       await factory.processRequestLogic(requestCopy);
       const result = await factory.executeRequest(requestCopy);
+      result.requestId = request.key;
       await factory.processResponse(result);
       request.setLog(result);
       info.log = result;