@api-client/core 0.3.3 → 0.3.6

package/build/src/runtime/node/ProjectRequestRunner.d.ts

@@ -0,0 +1,125 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Environment } from '../../models/Environment.js';
+import { Logger } from '../../lib/logging/Logger.js';
+import { IRequestLog } from '../../models/RequestLog.js';
+import { ProjectFolder } from '../../models/ProjectFolder.js';
+import { ProjectRequest } from '../../models/ProjectRequest.js';
+import { IHttpRequest } from '../../models/HttpRequest.js';
+import { HttpProject, IProjectRequestIterator } from '../../models/HttpProject.js';
+import { VariablesProcessor } from '../variables/VariablesProcessor.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 ProjectRequestRunner {
+    /**
+     * The request object is prepared and about to be sent to the HTTP engine
+     */
+    on(event: 'request', listener: (key: string, request: IHttpRequest) => void): this;
+    /**
+     * The response is ready.
+     */
+    on(event: 'response', listener: (key: string, log: IRequestLog) => void): this;
+    /**
+     * There was a general error during the request
+     */
+    on(event: 'error', listener: (key: string, log: IRequestLog, message: string) => void): this;
+    /**
+     * The request object is prepared and about to be sent to the HTTP engine
+     */
+    once(event: 'request', listener: (key: string, request: IHttpRequest) => void): this;
+    /**
+     * The response is ready.
+     */
+    once(event: 'response', listener: (key: string, log: IRequestLog) => void): this;
+    /**
+     * There was a general error during the request
+     */
+    once(event: 'error', listener: (key: string, log: IRequestLog, message: string) => void): this;
+}
+/**
+ * Runs requests in a project.
+ * Developers can run the entire project with the `recursive` flag set. They can also
+ * set the starting point with the `parent` options.
+ *
+ * Requests are executed in order defined in the folder.
+ */
+export declare class ProjectRequestRunner extends EventEmitter {
+    eventTarget: EventTarget;
+    logger?: Logger;
+    project: HttpProject;
+    protected masterEnvironment?: Environment;
+    protected extraVariables?: Record<string, string>;
+    /**
+     * The variables processor instance.
+     */
+    protected variablesProcessor: VariablesProcessor;
+    constructor(project: HttpProject, opts?: ProjectRunnerOptions);
+    /**
+     * Runs the request from the project root or a specified folder.
+     * @param options Run options.
+     * @returns A promise with the run result.
+     */
+    run(options?: ProjectRunnerRunOptions): Promise<RunResult[]>;
+    protected execute(request: ProjectRequest, variables: Record<string, string>): Promise<RunResult>;
+    protected getVariables(parent: HttpProject | ProjectFolder): Promise<Record<string, string>>;
+    protected createEnvironment(parent: HttpProject | ProjectFolder): Promise<Record<string, string>>;
+    /**
+     * Reads the list of the environments to apply to this runtime.
+     */
+    protected readEnvironments(parent: HttpProject | ProjectFolder): Promise<Environment[]>;
+    /**
+     * Reads the variables and the base URI from the passed environments.
+     */
+    protected applyVariables(environments: Environment[]): Promise<Record<string, string>>;
+    /**
+     * When defined it applies the serve's base URI to relative URLs.
+     * @param currentUrl The URL to process.
+     */
+    protected prepareRequestUrl(currentUrl: string, variables: Record<string, string>): string;
+}

package/build/src/runtime/node/ProjectRequestRunner.js

@@ -0,0 +1,185 @@
+import { EventEmitter } from 'events';
+import { RequestLog } from '../../models/RequestLog.js';
+import { Kind as ProjectFolderKind } from '../../models/ProjectFolder.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';
+/**
+ * Runs requests in a project.
+ * Developers can run the entire project with the `recursive` flag set. They can also
+ * set the starting point with the `parent` options.
+ *
+ * Requests are executed in order defined in the folder.
+ */
+export class ProjectRequestRunner extends EventEmitter {
+    eventTarget;
+    logger;
+    project;
+    masterEnvironment;
+    extraVariables;
+    /**
+     * The variables processor instance.
+     */
+    variablesProcessor = new VariablesProcessor();
+    constructor(project, opts = {}) {
+        super();
+        this.project = project;
+        this.logger = opts.logger;
+        this.eventTarget = opts.eventTarget || new EventTarget();
+        this.masterEnvironment = opts.environment;
+        this.extraVariables = opts.variables;
+    }
+    /**
+     * Runs the request from the project root or a specified folder.
+     * @param options Run options.
+     * @returns A promise with the run result.
+     */
+    async run(options) {
+        const { project } = this;
+        const executed = [];
+        for (const request of project.requestIterator(options)) {
+            const parent = request.getParent() || project;
+            let variables;
+            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);
+            executed.push(info);
+        }
+        return executed;
+    }
+    async execute(request, variables) {
+        const config = request.getConfig();
+        const factory = new RequestFactory(this.eventTarget);
+        factory.variables = variables;
+        if (request.authorization) {
+            factory.authorization = request.authorization.map(i => i.toJSON());
+        }
+        if (request.actions) {
+            factory.actions = request.actions.toJSON();
+        }
+        if (request.clientCertificate) {
+            factory.certificates = [request.clientCertificate];
+        }
+        if (config.enabled !== false) {
+            factory.config = config.toJSON();
+        }
+        if (this.logger) {
+            factory.logger = this.logger;
+        }
+        const info = {
+            key: request.key,
+        };
+        const requestData = request.expects.toJSON();
+        requestData.url = this.prepareRequestUrl(requestData.url, variables);
+        function variableHandler(e) {
+            if (e.defaultPrevented) {
+                return;
+            }
+            const { name, value } = e.detail;
+            variables[name] = value;
+            e.preventDefault();
+            e.detail.result = Promise.resolve();
+        }
+        this.eventTarget.addEventListener(EventTypes.Environment.set, variableHandler);
+        try {
+            // Below replaces the single call to the `run()` function of the factory to 
+            // report via the events a request object that has evaluated with the Jexl library.
+            const requestCopy = await factory.processRequestVariables(requestData);
+            this.emit('request', request.key, { ...requestCopy });
+            await factory.processRequestLogic(requestCopy);
+            const result = await factory.executeRequest(requestCopy);
+            await factory.processResponse(result);
+            request.setLog(result);
+            info.log = result;
+            this.emit('response', request.key, { ...result });
+        }
+        catch (e) {
+            const cause = e;
+            info.error = true;
+            info.errorMessage = cause.message;
+            const sent = new SentRequest({ ...requestData, startTime: 0, endTime: 0, });
+            const response = ErrorResponse.fromError(info.errorMessage);
+            const log = RequestLog.fromRequestResponse(sent.toJSON(), response.toJSON()).toJSON();
+            this.emit('error', request.key, log, info.errorMessage);
+        }
+        this.eventTarget.removeEventListener(EventTypes.Environment.set, variableHandler);
+        return info;
+    }
+    async getVariables(parent) {
+        if (this.masterEnvironment) {
+            return this.applyVariables([this.masterEnvironment]);
+        }
+        return this.createEnvironment(parent);
+    }
+    async createEnvironment(parent) {
+        const envs = await this.readEnvironments(parent);
+        return this.applyVariables(envs);
+    }
+    /**
+     * Reads the list of the environments to apply to this runtime.
+     */
+    async readEnvironments(parent) {
+        const folderKey = parent.kind === ProjectFolderKind ? parent.key : undefined;
+        return this.project.readEnvironments({ folderKey });
+    }
+    /**
+     * Reads the variables and the base URI from the passed environments.
+     */
+    async applyVariables(environments) {
+        let baseUri = '';
+        const variables = [];
+        environments.forEach((environment) => {
+            const { server, variables: envVariables } = environment;
+            if (server) {
+                baseUri = server.readUri();
+            }
+            if (envVariables.length) {
+                envVariables.forEach((item) => {
+                    const defined = variables.findIndex(i => i.name === item.name);
+                    if (defined >= 0) {
+                        variables[defined] = item;
+                    }
+                    else {
+                        variables.push(item);
+                    }
+                });
+            }
+        });
+        const { extraVariables } = this;
+        const ctx = VariablesProcessor.createContextFromProperties(variables);
+        if (extraVariables) {
+            Object.keys(extraVariables).forEach((key) => {
+                ctx[key] = extraVariables[key];
+            });
+        }
+        // the `baseUri` is reserved and always set to the environment's `baseUri`.
+        ctx.baseUri = baseUri || '';
+        return this.variablesProcessor.buildContext(ctx);
+    }
+    /**
+     * When defined it applies the serve's base URI to relative URLs.
+     * @param currentUrl The URL to process.
+     */
+    prepareRequestUrl(currentUrl, variables) {
+        const { baseUri } = variables;
+        if (!baseUri) {
+            return currentUrl;
+        }
+        if (currentUrl.startsWith('http:') || currentUrl.startsWith('https:')) {
+            return currentUrl;
+        }
+        if (currentUrl.startsWith('/')) {
+            return `${baseUri}${currentUrl}`;
+        }
+        return `${baseUri}/${currentUrl}`;
+    }
+}
+//# sourceMappingURL=ProjectRequestRunner.js.map

package/build/src/runtime/node/ProjectRequestRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectRequestRunner.js","sourceRoot":"","sources":["../../../../src/runtime/node/ProjectRequestRunner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAe,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,EAAiB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAIzF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAgFxD;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,WAAW,CAAc;IACzB,MAAM,CAAU;IAChB,OAAO,CAAc;IAEX,iBAAiB,CAAe;IAChC,cAAc,CAA0B;IAElD;;OAEG;IACO,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAExD,YAAY,OAAoB,EAAE,OAA6B,EAAE;QAC/D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,WAAW,EAAE,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,OAAiC;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,QAAQ,GAAgB,EAAE,CAAC;QACjC,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,OAAO,CAAC;YAC9C,IAAI,SAAiC,CAAC;YACtC,IAAI,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC9B,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aACxC;iBAAM;gBACL,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAC5C,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;aACvC;YACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACpD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,OAAuB,EAAE,SAAiC;QAChF,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAErD,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;QAC9B,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;SAC5C;QACD,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC7B,OAAO,CAAC,YAAY,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SACpD;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;YAC5B,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;SAClC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC9B;QACD,MAAM,IAAI,GAAc;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC;QACF,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAC7C,WAAW,CAAC,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAErE,SAAS,eAAe,CAAC,CAAc;YACrC,IAAI,CAAC,CAAC,gBAAgB,EAAE;gBACtB,OAAO;aACR;YACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC;YACjC,SAAS,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,eAAsB,CAAC,CAAC;QAEtF,IAAI;YACF,4EAA4E;YAC5E,mFAAmF;YACnF,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;YACvE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;YACtD,MAAM,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YACzD,MAAM,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACtC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACvB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;YAClC,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,WAAW,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;YAC5E,MAAM,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC5D,MAAM,GAAG,GAAG,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACtF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SACzD;QAED,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,eAAsB,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,MAAmC;QAC9D,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAES,KAAK,CAAC,iBAAiB,CAAC,MAAmC;QACnE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,gBAAgB,CAAC,MAAmC;QAClE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,KAAK,iBAAiB,CAAC,CAAC,CAAE,MAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QAChG,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,cAAc,CAAC,YAA2B;QACxD,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACnC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;YACxD,IAAI,MAAM,EAAE;gBACV,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;aAC5B;YACD,IAAI,YAAY,CAAC,MAAM,EAAE;gBACvB,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC5B,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC/D,IAAI,OAAO,IAAI,CAAC,EAAE;wBAChB,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;qBAC3B;yBAAM;wBACL,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBACtB;gBACH,CAAC,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAChC,MAAM,GAAG,GAAG,kBAAkB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,cAAc,EAAE;YAClB,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1C,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;SACJ;QACD,2EAA2E;QAC3E,GAAG,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAAkB,EAAE,SAAiC;QAC/E,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,UAAU,CAAC;SACnB;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACrE,OAAO,UAAU,CAAC;SACnB;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC9B,OAAO,GAAG,OAAO,GAAG,UAAU,EAAE,CAAC;SAClC;QACD,OAAO,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC;IACpC,CAAC;CACF"}

package/build/src/runtime/node/ProjectRunner.d.ts

@@ -1,62 +1,87 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
+import { HttpProject } from '../../models/HttpProject.js';
+import { ProjectFolder } from '../../models/ProjectFolder.js';
 import { Environment } from '../../models/Environment.js';
 import { Logger } from '../../lib/logging/Logger.js';
 import { IRequestLog } from '../../models/RequestLog.js';
-import { ProjectFolder } from '../../models/ProjectFolder.js';
-import { ProjectRequest } from '../../models/ProjectRequest.js';
 import { IHttpRequest } from '../../models/HttpRequest.js';
-import { HttpProject, IProjectRequestIterator } from '../../models/HttpProject.js';
-import { VariablesProcessor } from '../variables/VariablesProcessor.js';
-export interface ProjectRunnerOptions {
+import { IProjectExecutionIteration, IProjectExecutionLog } from '../reporters/Reporter.js';
+import { BaseRunner } from './BaseRunner.js';
+declare type ProjectParent = HttpProject | ProjectFolder;
+export interface IProjectRunnerOptions {
     /**
-     * When provided it overrides any project / folder defined environment.
+     * 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?: Environment;
+    environment?: string;
     /**
-     * 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`;
+     * The parent folder to execute.
      */
-    variables?: Record<string, string>;
+    parent?: string;
     /**
-     * Overrides the default logger (console).
+     * The names or the keys of requests to execute.
+     * This can be used to limit the number of requests.
      */
-    logger?: Logger;
+    request?: string[];
     /**
-     * The event target to use.
-     * By default it creates its own target.
+     * The number of times the execution should be repeated.
+     * Default to 1.
      */
-    eventTarget?: EventTarget;
-}
-export interface ProjectRunnerRunOptions extends IProjectRequestIterator {
-}
-export interface RunResult {
+    iterations?: number;
     /**
-     * The key of the request from the HttpProject that was executed.
+     * The number of milliseconds to wait between each iteration.
+     * Default to the next frame (vary from 1 to tens of milliseconds).
      */
-    key: string;
+    iterationDelay?: number;
     /**
-     * The key of parent folder of the executed request.
+     * 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.
      */
-    parent?: string;
+    parallel?: boolean;
+    /**
+     * When set it includes requests in the current folder and sub-folder according to the order
+     * defined in the folder.
+     */
+    recursive?: boolean;
     /**
-     * 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.
+     * The opposite of the `requests`. The list of names or keys of requests or folders to ignore.
+     * Note, ignore is tested before the `requests`.
      */
-    error?: boolean;
+    ignore?: string[];
     /**
-     * The error message. Always set when the `error` is `true`.
+     * The logger to use with the request factory.
+     * When not set it uses the dummy logger (no output).
      */
-    errorMessage?: string;
+    logger?: Logger;
     /**
-     * The request log.
-     * Always set when the `error` is `false`.
+     * 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.
      */
-    log?: IRequestLog;
+    variables?: boolean | string[] | Record<string, string>;
 }
 export interface ProjectRunner {
+    /**
+     * Event dispatched when an iteration is about to start.
+     */
+    on(event: 'before-iteration', listener: (index: number, iterated: boolean) => void): this;
+    /**
+     * Event dispatched when an iteration finished.
+     */
+    on(event: 'after-iteration', listener: (index: number, iterated: boolean) => void): this;
+    /**
+     * Event dispatched before the iteration is going to sleep for the set period of time.
+     */
+    on(event: 'before-sleep', listener: () => void): this;
+    /**
+     * Event dispatched after the iteration is woke up.
+     */
+    on(event: 'after-sleep', listener: () => void): this;
     /**
      * The request object is prepared and about to be sent to the HTTP engine
      */
@@ -68,7 +93,23 @@ export interface ProjectRunner {
     /**
      * There was a general error during the request
      */
-    on(event: 'error', listener: (key: string, request: IHttpRequest, message: string) => void): this;
+    on(event: 'error', listener: (key: string, log: IRequestLog, message: string) => void): this;
+    /**
+     * Event dispatched when an iteration is about to start.
+     */
+    once(event: 'before-iteration', listener: (index: number, iterated: boolean) => void): this;
+    /**
+     * Event dispatched when an iteration finished.
+     */
+    once(event: 'after-iteration', listener: (index: number, iterated: boolean) => void): this;
+    /**
+     * Event dispatched before the iteration is going to sleep for the set period of time.
+     */
+    once(event: 'before-sleep', listener: () => void): this;
+    /**
+     * Event dispatched after the iteration is woke up.
+     */
+    once(event: 'after-sleep', listener: () => void): this;
     /**
      * The request object is prepared and about to be sent to the HTTP engine
      */
@@ -80,46 +121,107 @@ export interface ProjectRunner {
     /**
      * There was a general error during the request
      */
-    once(event: 'error', listener: (key: string, request: IHttpRequest, message: string) => void): this;
+    once(event: 'error', listener: (key: string, log: IRequestLog, message: string) => void): this;
 }
 /**
- * Runs requests in a project.
- * Developers can run the entire project with the `recursive` flag set. They can also
- * set the starting point with the `parent` options.
+ * A class to be extended to run an entire API Project for the given configuration options.
  *
- * Requests are executed in order defined in the folder.
+ * The main purpose of this class (and its children) is to iterate over requests
+ * in the project and execute them one-by-one.
+ *
+ * Implementations allow to execute the requests in a serial model or in parallel mode, where
+ * a separate workers are created to run the same HTTP requests in each worker.
+ *
+ * This class generates a run report which other programs can use to build all kinds of UIs
+ * around the data collected during the run.
  */
-export declare class ProjectRunner extends EventEmitter {
-    eventTarget: EventTarget;
-    logger?: Logger;
-    project: HttpProject;
-    protected masterEnvironment?: Environment;
-    protected extraVariables?: Record<string, string>;
+export declare abstract class ProjectRunner extends BaseRunner {
+    /**
+     * The HTTP project to run requests from.
+     */
+    project?: HttpProject;
+    /**
+     * The execution options for the project.
+     */
+    options?: IProjectRunnerOptions;
+    /**
+     * The root object (project or a folder) where the program starts iterating over the requests.
+     */
+    root?: ProjectParent;
+    /**
+     * The selected environment to apply to the requests.
+     */
+    environment?: Environment;
+    /**
+     * The events target instance for events dispatched by the request factory.
+     */
+    target: EventTarget;
+    /**
+     * This is used with `--iterations`. The index of the current iteration.
+     */
+    protected index: number;
+    /**
+     * The currently executed iteration loop.
+     */
+    protected currentIteration?: IProjectExecutionIteration;
+    /**
+     * The number of remaining iterations to run.
+     */
+    protected remaining: number;
+    /**
+     * Whether the configuration allows iterations (the parallel mode).
+     */
+    protected hasIterations: boolean;
+    /**
+     * When set it won't amit any event.
+     * This can be used in a background worker when events are never handled.
+     */
+    noEmit: boolean;
+    constructor();
+    /**
+     * A required step before running the project.
+     * It configures the execution context. It may throw an error when configuration is not valid.
+     */
+    configure(project: HttpProject, opts?: IProjectRunnerOptions): Promise<void>;
+    /**
+     * Executes the requests in the project.
+     * @returns The execution log created by calling the `createReport()` function.
+     */
+    abstract execute(): Promise<IProjectExecutionLog>;
+    /**
+     * Creates the report of the execution.
+     */
+    protected createReport(): Promise<IProjectExecutionLog>;
+    /**
+     * Reads the environment data to use with the execution.
+     * If the configured environment is a location of a file
+     * it is read as API Client's environment and used in the execution.
+     * Otherwise it searches for the environment in the list of the defined
+     * environments by the name of the key.
+     *
+     * It throws when the environment cannot be found or when the file contents is invalid.
+     */
+    protected getEnvironment(): Promise<Environment | undefined>;
     /**
-     * The variables processor instance.
+     * Runs the requests from the project as configured.
      */
-    protected variablesProcessor: VariablesProcessor;
-    constructor(project: HttpProject, opts?: ProjectRunnerOptions);
+    protected executeIteration(): Promise<void>;
     /**
-     * Runs the request from the project root or a specified folder.
-     * @param options Run options.
-     * @returns A promise with the run result.
+     * Retargets the "request" event from the factory.
      */
-    run(options?: ProjectRunnerRunOptions): Promise<RunResult[]>;
-    protected execute(request: ProjectRequest, variables: Record<string, string>): Promise<RunResult>;
-    protected getVariables(parent: HttpProject | ProjectFolder): Promise<Record<string, string>>;
-    protected createEnvironment(parent: HttpProject | ProjectFolder): Promise<Record<string, string>>;
+    protected _requestHandler(key: string, request: IHttpRequest): void;
     /**
-     * Reads the list of the environments to apply to this runtime.
+     * Retargets the "response" event from the factory.
      */
-    protected readEnvironments(parent: HttpProject | ProjectFolder): Promise<Environment[]>;
+    protected _responseHandler(key: string, log: IRequestLog): void;
     /**
-     * Reads the variables and the base URI from the passed environments.
+     * Retargets the "error" event from the factory.
      */
-    protected applyVariables(environments: Environment[]): Promise<Record<string, string>>;
+    protected _errorHandler(key: string, log: IRequestLog, message: string): void;
     /**
-     * When defined it applies the serve's base URI to relative URLs.
-     * @param currentUrl The URL to process.
+     * @returns Reads the system variables based on the library configuration.
      */
-    protected prepareRequestUrl(currentUrl: string, variables: Record<string, string>): string;
+    protected getSystemVariables(): Record<string, string>;
+    private _readSystemVariables;
 }
+export {};