@api-client/core 0.10.13 → 0.11.0

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

@@ -1,295 +0,0 @@
-import { EventEmitter } from 'events';
-import { Kind as EnvironmentKind } from '../../models/Environment.js';
-import { RequestLog } from '../../models/RequestLog.js';
-import { Kind as ProjectRequestKind } from '../../models/ProjectRequest.js';
-import { SentRequest } from '../../models/SentRequest.js';
-import { ErrorResponse } from '../../models/ErrorResponse.js';
-import { VariablesProcessor } from '../variables/VariablesProcessor.js';
-import { State } from './enums.js';
-import { HttpRequestRunner } from '../http-runner/HttpRequestRunner.js';
-import { ProjectFolderKind } from '../../models/kinds.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 {
-    logger;
-    project;
-    /**
-     * An instance of a cookie jar (store) to put/read cookies.
-     */
-    cookies;
-    masterEnvironment;
-    extraVariables;
-    /**
-     * The variables processor instance.
-     */
-    variablesProcessor = new VariablesProcessor();
-    _state = State.Idle;
-    get state() {
-        return this._state;
-    }
-    constructor(project, opts = {}) {
-        super();
-        this.project = project;
-        this.logger = opts.logger;
-        this.masterEnvironment = opts.environment;
-        this.extraVariables = opts.variables;
-        this.cookies = opts.cookies;
-    }
-    /**
-     * 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 root = options.parent ? project.findFolder(options.parent) : project;
-        if (!root) {
-            throw new Error(`The parent folder not found: ${options.parent}.`);
-        }
-        const variables = await this.getVariables(root);
-        const executed = [];
-        for await (const result of this.runIterator(options, variables)) {
-            executed.push(result);
-        }
-        return {
-            items: executed,
-            variables,
-        };
-    }
-    /**
-     * Creates an async iterator that allows to iterate over execution results.
-     * The result is yielded after the request is executed.
-     *
-     * @param options The iterator configuration.
-     */
-    async *runIterator(options = {}, variables) {
-        const { project } = this;
-        const root = options.parent ? project.findFolder(options.parent) : project;
-        if (!root) {
-            throw new Error(`The parent folder not found: ${options.parent}.`);
-        }
-        this._state = State.Running;
-        const envVariables = variables || await this.getVariables(root);
-        const { items } = root;
-        const it = this._runIterator(items, envVariables, options);
-        for await (const request of it) {
-            yield request;
-        }
-    }
-    async *_runIterator(items, variables, options) {
-        for (const item of items) {
-            const current = item.getItem();
-            if (!current) {
-                continue;
-            }
-            if (current.kind === ProjectRequestKind) {
-                if (Array.isArray(options.ignore) && options.ignore.includes(current.key)) {
-                    continue;
-                }
-                if (Array.isArray(options.requests) && !options.requests.includes(current.key) && !options.requests.includes(current.info.name || '')) {
-                    continue;
-                }
-                const info = await this._runItem(current, variables);
-                yield info;
-            }
-            else if (current.kind === ProjectFolderKind) {
-                if (!options.recursive) {
-                    continue;
-                }
-                const parent = current;
-                // make a copy so the variables executed in the encapsulated environment won't leak out to the current environment.
-                let encapsulated = false;
-                // we restore the `baseUri` after exiting the folder.
-                const currentBaseUri = variables.baseUri;
-                const { items: parentItems } = parent;
-                const envItem = parentItems.find(i => i.kind === EnvironmentKind);
-                let parentVariables = {};
-                let childVariables = variables;
-                if (envItem) {
-                    const parentEnv = envItem.getItem();
-                    if (parentEnv) {
-                        encapsulated = parentEnv.encapsulated;
-                        parentVariables = await this.applyVariables([parentEnv]);
-                        if (encapsulated) {
-                            childVariables = parentVariables;
-                        }
-                        else {
-                            childVariables = { ...childVariables, ...parentVariables };
-                        }
-                    }
-                }
-                const it = this._runIterator(parentItems, childVariables, options);
-                for await (const request of it) {
-                    yield request;
-                }
-                if (!encapsulated) {
-                    // now we set the variables set on children to the main variables object, except for these
-                    // declared on the child environments, so these won't leak to other folders.
-                    // However, variables set by a request in a folder always is propagated to the main environment.
-                    const ignore = Object.keys(parentVariables);
-                    Object.keys(childVariables).forEach((key) => {
-                        if (!ignore.includes(key)) {
-                            variables[key] = childVariables[key];
-                        }
-                    });
-                }
-                variables.baseUri = currentBaseUri;
-            }
-        }
-    }
-    /**
-     * Aborts the current run.
-     * The promise returned by the `run()` method will reject if not yet resolved.
-     */
-    abort() {
-        this._state = State.Aborted;
-    }
-    /**
-     * 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]() {
-        for await (const result of this.runIterator({ recursive: true })) {
-            yield result;
-        }
-    }
-    async _runItem(request, variables) {
-        if (this._state === State.Aborted) {
-            throw new Error(`The execution has been aborted.`);
-        }
-        const info = await this.execute(request, variables);
-        const folder = request.getParent();
-        if (folder && folder !== this.project) {
-            info.parent = folder.key;
-        }
-        return info;
-    }
-    async execute(request, variables) {
-        const config = request.getConfig();
-        const factory = new HttpRequestRunner();
-        factory.variables = variables;
-        const auth = request.readAuthorization();
-        if (auth.length) {
-            factory.authorization = auth.map(i => i.toJSON());
-        }
-        if (request.flows) {
-            factory.flows = request.flows;
-        }
-        if (request.assertions) {
-            factory.assertions = request.assertions;
-        }
-        if (request.clientCertificate) {
-            factory.certificates = [request.clientCertificate.toJSON()];
-        }
-        if (config.enabled !== false) {
-            factory.config = config.toJSON();
-        }
-        if (this.logger) {
-            factory.logger = this.logger;
-        }
-        if (this.cookies) {
-            factory.cookies = this.cookies;
-        }
-        const info = {
-            key: request.key,
-        };
-        let url;
-        const typedProject = request;
-        if (typeof typedProject.readUrl === 'function') {
-            url = typedProject.readUrl({ variables });
-        }
-        const requestData = request.expects.toJSON();
-        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.
-            requestData.url = url || factory.prepareRequestUrl(requestData.url, variables);
-            const requestCopy = await factory.applyVariables(requestData);
-            await factory.applyAuthorization(requestCopy);
-            await factory.applyCookies(requestCopy);
-            this.emit('request', request.key, { ...requestCopy });
-            await factory.runRequestFlows(requestCopy);
-            const result = await factory.executeRequest(requestCopy);
-            result.requestId = request.key;
-            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);
-        }
-        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({ parent: 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);
-    }
-}
-//# sourceMappingURL=ProjectRequestRunner.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ProjectRequestRunner.js","sourceRoot":"","sources":["../../../../../src/runtime/node/ProjectRequestRunner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAe,IAAI,IAAI,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEnF,OAAO,EAAe,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAGrE,OAAO,EAAkB,IAAI,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAG5F,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAExE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAGxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AA6B1D;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,MAAM,CAAU;IAChB,OAAO,CAAc;IACrB;;OAEG;IACH,OAAO,CAAa;IAEV,iBAAiB,CAAe;IAChC,cAAc,CAA0B;IAElD;;OAEG;IACO,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAE9C,MAAM,GAAU,KAAK,CAAC,IAAI,CAAC;IAErC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,YAAY,OAAoB,EAAE,OAA8B,EAAE;QAChE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,UAAoC,EAAE;QAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC3E,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACrE,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAClC,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;YAChE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;QACD,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,SAAS;SACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,CAAE,WAAW,CAAC,UAAoC,EAAE,EAAE,SAAkC;QACtG,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC3E,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACrE,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,OAAgB,CAAC;QACrC,MAAM,YAAY,GAAG,SAAS,IAAI,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAC3D,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,EAAE,EAAE,CAAC;YAC/B,MAAM,OAAO,CAAC;QAChB,CAAC;IACH,CAAC;IAES,KAAK,CAAC,CAAE,YAAY,CAAC,KAAoB,EAAE,SAAiC,EAAE,OAAiC;QACvH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,SAAS;YACX,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;gBACxC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1E,SAAS;gBACX,CAAC;gBACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;oBACtI,SAAS;gBACX,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAyB,EAAE,SAAS,CAAC,CAAC;gBACvE,MAAM,IAAI,CAAC;YACb,CAAC;iBAAM,IAAI,OAAO,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAC9C,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBACvB,SAAS;gBACX,CAAC;gBACD,MAAM,MAAM,GAAG,OAAwB,CAAC;gBACxC,mHAAmH;gBACnH,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,qDAAqD;gBACrD,MAAM,cAAc,GAAG,SAAS,CAAC,OAAO,CAAC;gBACzC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;gBACtC,MAAM,OAAO,GAAI,WAA6B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC;gBACrF,IAAI,eAAe,GAA2B,EAAE,CAAC;gBACjD,IAAI,cAAc,GAAG,SAAS,CAAC;gBAC/B,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAA6B,CAAC;oBAC/D,IAAI,SAAS,EAAE,CAAC;wBACd,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;wBACtC,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;wBACzD,IAAI,YAAY,EAAE,CAAC;4BACjB,cAAc,GAAG,eAAe,CAAC;wBACnC,CAAC;6BAAM,CAAC;4BACN,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,eAAe,EAAE,CAAC;wBAC7D,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;gBACnE,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,EAAE,EAAE,CAAC;oBAC/B,MAAM,OAAO,CAAC;gBAChB,CAAC;gBACD,IAAI,CAAC,YAAY,EAAE,CAAC;oBAClB,0FAA0F;oBAC1F,4EAA4E;oBAC5E,gGAAgG;oBAChG,MAAM,MAAM,GAAa,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;oBACtD,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;4BAC1B,SAAS,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;wBACtC,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;gBACD,SAAS,CAAC,OAAO,GAAG,cAAc,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAA,CAAE,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YACjE,MAAM,MAAM,CAAC;QACf,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,OAAuB,EAAE,SAAiC;QAC/E,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;QACnC,IAAI,MAAM,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,OAAuB,EAAE,SAAiC;QAChF,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACxC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;QAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAChC,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAC1C,CAAC;QACD,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC9B,OAAO,CAAC,YAAY,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC7B,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QACjC,CAAC;QACD,MAAM,IAAI,GAAe;YACvB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC;QACF,IAAI,GAAuB,CAAC;QAC5B,MAAM,YAAY,GAAG,OAAyB,CAAC;QAC/C,IAAI,OAAO,YAAY,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YAC/C,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAE7C,IAAI,CAAC;YACH,4EAA4E;YAC5E,mFAAmF;YACnF,WAAW,CAAC,GAAG,GAAG,GAAG,IAAI,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC/E,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YAC9D,MAAM,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC9C,MAAM,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;YACtD,MAAM,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YAC3C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YACzD,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;YAC/B,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;QACpD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,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;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,MAAmC;QAC9D,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvD,CAAC;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,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC9D,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,CAAC;gBACX,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;YAC7B,CAAC;YACD,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxB,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,CAAC;wBACjB,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;oBAC5B,CAAC;yBAAM,CAAC;wBACN,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACvB,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;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,CAAC;YACnB,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;QACL,CAAC;QACD,2EAA2E;QAC3E,GAAG,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;CACF"}

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

@@ -1,191 +0,0 @@
-import { HttpProject } from '../../models/HttpProject.js';
-import { ProjectFolder } from '../../models/ProjectFolder.js';
-import { Environment } from '../../models/Environment.js';
-import { IRequestLog } from '../../models/RequestLog.js';
-import { IHttpRequest } from '../../models/HttpRequest.js';
-import { ProjectRequestRunner } from './ProjectRequestRunner.js';
-import { IProjectExecutionIteration, IProjectExecutionLog } from '../../models/ProjectExecution.js';
-import { BaseRunner } from './BaseRunner.js';
-import { IProjectRunnerOptions, IRequestRunnerOptions } from './InteropInterfaces.js';
-import { State } from './enums.js';
-type ProjectParent = HttpProject | ProjectFolder;
-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
-     */
-    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;
-    /**
-     * 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
-     */
-    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;
-}
-/**
- * A class to be extended to run an entire API Project for the given configuration options.
- *
- * 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 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;
-    /**
-     * 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;
-    /**
-     * When executing, this is the last user request runner.
-     */
-    protected _runner?: ProjectRequestRunner;
-    protected _state: State;
-    get state(): State;
-    protected _signal?: AbortSignal;
-    /**
-     * The abort signal to set on this request.
-     * Aborts the request when the signal fires.
-     * @type {(AbortSignal | undefined)}
-     */
-    get signal(): AbortSignal | undefined;
-    set signal(value: AbortSignal | undefined);
-    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>;
-    /**
-     * Aborts the current run.
-     * The promise returned by the `execute()` method will reject if not yet resolved.
-     */
-    abort(): void;
-    /**
-     * Handler for the `abort` event on the `AbortSignal`.
-     */
-    protected _abortHandler(): void;
-    /**
-     * 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>;
-    protected getProjectRunnerOptions(): Promise<IRequestRunnerOptions>;
-    /**
-     * Runs the requests from the project as configured.
-     */
-    protected executeIteration(): Promise<void>;
-    /**
-     * Retargets the "request" event from the factory.
-     */
-    protected _requestHandler(key: string, request: IHttpRequest): void;
-    /**
-     * Retargets the "response" event from the factory.
-     */
-    protected _responseHandler(key: string, log: IRequestLog): void;
-    /**
-     * Retargets the "error" event from the factory.
-     */
-    protected _errorHandler(key: string, log: IRequestLog, message: string): void;
-    /**
-     * @returns Reads the system variables based on the library configuration.
-     */
-    protected prepareVariables(): Record<string, string>;
-    private _readSystemVariables;
-}
-export {};