@api-client/core 0.6.29 → 0.7.0

package/build/src/runtime/{node/RequestFactory.d.ts → http-runner/HttpRequestRunner.d.ts}

@@ -2,39 +2,31 @@ import { IRequest } from '../../models/Request.js';
 import { IHttpRequest } from '../../models/HttpRequest.js';
 import { IRequestConfig } from '../../models/RequestConfig.js';
 import { IRequestAuthorization } from '../../models/RequestAuthorization.js';
-import { IRequestActions } from '../../models/RequestActions.js';
-import { HttpCertificate } from '../../models/ClientCertificate.js';
 import { IRequestLog } from '../../models/RequestLog.js';
 import { VariablesProcessor } from '../variables/VariablesProcessor.js';
-import { IRunnableAction } from '../../models/actions/RunnableAction.js';
+import { IHttpActionFlow } from '../../models/http-actions/HttpActions.js';
 import { HttpEngineOptions } from '../http-engine/HttpEngine.js';
-import { ExecutionContext, RegistryPermission } from '../modules/ModulesRegistry.js';
 import { Logger } from '../../lib/logging/Logger.js';
+import { CookieJar } from '../../cookies/CookieJar.js';
+import { ISentRequest } from "../../models/SentRequest.js";
+import { IResponse } from "../../models/Response.js";
+import { IErrorResponse } from "../../models/ErrorResponse.js";
+import { HttpCertificate } from '../../models/ClientCertificate.js';
 /**
- * The main class to make HTTP requests in the API Client.
- * This factory includes all logic components to perform the entire HTTP request lifecycle. This includes:
- *
- * - variables evaluation on the request object
- * - running request actions
- * - running request modules
- * - choosing the execution engine
- * - performing the request
- * - running response actions
- * - running response modules
- * - reporting the response
+ * A class that takes a single HttpRequest definition and executes it.
  *
- * This class may not be used when not necessary but the logic should take care of the items listed above.
+ * This class does the following (in order):
  *
- * This class splits the `IRequest` object into it's components and use them when defined.
- * This way it is possible to use the factory only with the `IHttpRequest` interface.
+ * - applies variables
+ * - applies authorization configuration
+ * - applies cookies
+ * - runs request actions
+ * - transports the request
+ * - processes response and redirect cookies
+ * - runs response actions
+ * - reports the request log
  */
-export declare class RequestFactory {
-    /**
-     * The main events bus.
-     * This target is used to dispatch the events on.
-     * The runtime should handle the events and proxy them to the corresponding context store.
-     */
-    eventTarget: EventTarget;
+export declare class HttpRequestRunner {
     /**
      * Request processing configuration.
      */
@@ -46,11 +38,7 @@ export declare class RequestFactory {
     /**
      * Actions to be performed when the request is executed.
      */
-    actions?: IRequestActions;
-    /**
-     * The list of certificates to use with the request.
-     */
-    certificates?: HttpCertificate[];
+    flows?: IHttpActionFlow[];
     /**
      * The cumulative list of all variables to be applied to the request and other properties.
      * The variables must be already processed for variables in values (evaluated).
@@ -71,19 +59,18 @@ export declare class RequestFactory {
      */
     signal?: AbortSignal;
     /**
-     * Creates an instance from the IRequest object with setting the corresponding variables.
-     * @param eventTarget The main events bus.
-     * This target is used to dispatch the events on.
-     * The runtime should handle the events and proxy them to the corresponding context store.
-     * @param request The request object to use.
+     * An instance of a cookie jar (store) to put/read cookies.
      */
-    static fromRequest(eventTarget: EventTarget, request: IRequest): RequestFactory;
+    cookies?: CookieJar;
     /**
-     * @param eventTarget The main events bus.
-     * This target is used to dispatch the events on.
-     * The runtime should handle the events and proxy them to the corresponding context store.
+     * Certificates to send with the request.
      */
-    constructor(eventTarget: EventTarget);
+    certificates?: HttpCertificate[];
+    /**
+     * Creates an instance from the IRequest object with setting the corresponding variables.
+     * @param request The request object to use.
+     */
+    static fromRequest(request: IRequest): HttpRequestRunner;
     /**
      * Runs the request and all tasks around the HTTp request execution like gathering
      * environment information, running actions, and HTTP modules.
@@ -100,10 +87,6 @@ export declare class RequestFactory {
      * @returns the authorization data processed by the variables processor.
      */
     readAuthorization(): Promise<IRequestAuthorization[] | undefined>;
-    /**
-     * @returns the actions for the passed type processed by the variables processor.
-     */
-    readActions(type: keyof IRequestActions): Promise<IRunnableAction[] | undefined>;
     /**
      * Prepares the request object before making the HTTP request
      * and runs actions and modules.
@@ -116,18 +99,23 @@ export declare class RequestFactory {
      * Runs the request through the variables processor.
      * @returns A copy of the passed request with possibly changed values.
      */
-    processRequestVariables(request: IHttpRequest): Promise<IHttpRequest>;
+    applyVariables(request: IHttpRequest): Promise<IHttpRequest>;
+    applyAuthorization(request: IHttpRequest): Promise<IHttpRequest>;
+    applyCookies(request: IHttpRequest): Promise<IHttpRequest>;
     /**
      * Executes the request actions and modules.
      */
-    processRequestLogic(request: IHttpRequest): Promise<void>;
+    runRequestFlows(request: IHttpRequest): Promise<void>;
     /**
-     * Runs each action one by one.
-     * @param request The request object associated with actions
-     * @param actions The list of actions to execute.
+     * Executes the request actions and modules.
+     */
+    runResponseFlows(request: ISentRequest, response: IResponse | IErrorResponse): Promise<void>;
+    /**
+     * Reads and evaluates action flows.
+     *
+     * @param trigger The trigger name to read the flows for.
      */
-    processRequestActions(request: IHttpRequest, actions: IRunnableAction[]): Promise<void>;
-    processRequestModules(request: IHttpRequest): Promise<void>;
+    protected readFlows(trigger: 'request' | 'response'): Promise<IHttpActionFlow[]>;
     /**
      * Prepares the HTTP engine configuration and executes the request,
      * @param request The request to execute.
@@ -139,7 +127,5 @@ export declare class RequestFactory {
      */
     prepareEngineConfig(): Promise<HttpEngineOptions>;
     processResponse(log: IRequestLog): Promise<void>;
-    processResponseActions(log: IRequestLog): Promise<void>;
-    processResponseModules(log: IRequestLog): Promise<void>;
-    buildExecutionContext(permissions: RegistryPermission[]): Promise<ExecutionContext>;
+    get sessionCookies(): boolean;
 }

package/build/src/runtime/http-runner/HttpRequestRunner.js

@@ -0,0 +1,316 @@
+import { VariablesProcessor } from '../variables/VariablesProcessor.js';
+import { CoreEngine } from '../http-engine/CoreEngine.js';
+import { RequestAuthorizationProcessor } from './RequestAuthorizationProcessor.js';
+import { RequestCookiesProcessor } from './RequestCookiesProcessor.js';
+import { HttpFlowRunner } from './HttpFlowRunner.js';
+/**
+ * A class that takes a single HttpRequest definition and executes it.
+ *
+ * This class does the following (in order):
+ *
+ * - applies variables
+ * - applies authorization configuration
+ * - applies cookies
+ * - runs request actions
+ * - transports the request
+ * - processes response and redirect cookies
+ * - runs response actions
+ * - reports the request log
+ */
+export class HttpRequestRunner {
+    /**
+     * Request processing configuration.
+     */
+    config;
+    /**
+     * Request authorization configuration
+     */
+    authorization;
+    /**
+     * Actions to be performed when the request is executed.
+     */
+    flows;
+    /**
+     * The cumulative list of all variables to be applied to the request and other properties.
+     * The variables must be already processed for variables in values (evaluated).
+     *
+     * These variables are passed by reference. Changes made anywhere to the variables will result
+     * with updating this list.
+     */
+    variables;
+    /**
+     * The variables processor instance.
+     */
+    variablesProcessor = new VariablesProcessor();
+    logger;
+    /**
+     * The abort signal to set on this request.
+     * Aborts the request when the signal fires.
+     * @type {(AbortSignal | undefined)}
+     */
+    signal;
+    /**
+     * An instance of a cookie jar (store) to put/read cookies.
+     */
+    cookies;
+    /**
+     * Certificates to send with the request.
+     */
+    certificates;
+    /**
+     * Creates an instance from the IRequest object with setting the corresponding variables.
+     * @param request The request object to use.
+     */
+    static fromRequest(request) {
+        const instance = new HttpRequestRunner();
+        instance.flows = request.flows;
+        instance.authorization = request.authorization;
+        instance.config = request.config;
+        return instance;
+    }
+    /**
+     * Runs the request and all tasks around the HTTp request execution like gathering
+     * environment information, running actions, and HTTP modules.
+     *
+     * @param request The request object to execute.
+     * @returns The execution log.
+     */
+    async run(request) {
+        const requestCopy = await this.processRequest(request);
+        const result = await this.executeRequest(requestCopy);
+        await this.processResponse(result);
+        return result;
+    }
+    /**
+     * @returns the configuration processed by the variables processor.
+     */
+    async readConfig() {
+        const { config, variables, variablesProcessor } = this;
+        if (!config) {
+            return undefined;
+        }
+        if (!variables) {
+            return config;
+        }
+        return variablesProcessor.evaluateVariablesWithContext(config, variables);
+    }
+    /**
+     * @returns the authorization data processed by the variables processor.
+     */
+    async readAuthorization() {
+        const { variables, authorization, variablesProcessor } = this;
+        if (!Array.isArray(authorization) || !authorization.length) {
+            return undefined;
+        }
+        if (!variables) {
+            return authorization;
+        }
+        const ps = authorization.filter(i => i.enabled !== false).map(async (item) => {
+            const copy = await variablesProcessor.evaluateVariablesWithContext(item, variables);
+            if (copy.config) {
+                copy.config = await variablesProcessor.evaluateVariablesWithContext(copy.config, variables);
+            }
+            return copy;
+        });
+        const result = await Promise.all(ps);
+        return result;
+    }
+    /**
+     * Prepares the request object before making the HTTP request
+     * and runs actions and modules.
+     *
+     * @param request The request to execute.
+     * @returns the copy of the request object.
+     */
+    async processRequest(request) {
+        let copy = await this.applyVariables(request);
+        copy = await this.applyAuthorization(copy);
+        copy = await this.applyCookies(copy);
+        await this.runRequestFlows(copy);
+        return copy;
+    }
+    /**
+     * Runs the request through the variables processor.
+     * @returns A copy of the passed request with possibly changed values.
+     */
+    async applyVariables(request) {
+        const { variables, variablesProcessor } = this;
+        let copy = { ...request };
+        if (variables) {
+            copy = await variablesProcessor.evaluateVariablesWithContext(copy, variables);
+        }
+        return copy;
+    }
+    async applyAuthorization(request) {
+        const auth = await this.readAuthorization();
+        RequestAuthorizationProcessor.setAuthorization(request, auth);
+        return request;
+    }
+    async applyCookies(request) {
+        const { cookies } = this;
+        if (!cookies || !this.sessionCookies) {
+            return request;
+        }
+        const list = await cookies.listCookies(request.url);
+        RequestCookiesProcessor.request(request, list);
+        return request;
+    }
+    /**
+     * Executes the request actions and modules.
+     */
+    async runRequestFlows(request) {
+        const flows = await this.readFlows('request');
+        const runner = new HttpFlowRunner();
+        runner.cookies = this.cookies;
+        runner.variables = this.variables;
+        await runner.request(request, flows);
+    }
+    /**
+     * Executes the request actions and modules.
+     */
+    async runResponseFlows(request, response) {
+        const flows = await this.readFlows('response');
+        const runner = new HttpFlowRunner();
+        runner.cookies = this.cookies;
+        runner.variables = this.variables;
+        await runner.response(request, response, flows);
+    }
+    /**
+     * Reads and evaluates action flows.
+     *
+     * @param trigger The trigger name to read the flows for.
+     */
+    async readFlows(trigger) {
+        const result = [];
+        const { flows, variables = {}, variablesProcessor } = this;
+        if (!Array.isArray(flows) || !flows.length) {
+            return result;
+        }
+        for (const flow of flows) {
+            if (flow.trigger !== trigger) {
+                continue;
+            }
+            if (!Array.isArray(flow.actions) || !flow.actions.length) {
+                continue;
+            }
+            const copy = { ...flow };
+            const actions = copy.actions.map(async (action) => {
+                const actionCopy = { ...action };
+                if (actionCopy.condition) {
+                    actionCopy.condition = await variablesProcessor.evaluateVariablesWithContext(actionCopy.condition, variables);
+                }
+                if (Array.isArray(actionCopy.steps) && actionCopy.steps.length) {
+                    const stepsPromises = actionCopy.steps.map((step) => variablesProcessor.evaluateVariablesWithContext(step, variables));
+                    actionCopy.steps = await Promise.all(stepsPromises);
+                }
+                return actionCopy;
+            });
+            copy.actions = await Promise.all(actions);
+            result.push(copy);
+        }
+        return result;
+    }
+    /**
+     * Prepares the HTTP engine configuration and executes the request,
+     * @param request The request to execute.
+     * @returns The execution log.
+     */
+    async executeRequest(request) {
+        const opts = await this.prepareEngineConfig();
+        const engine = new CoreEngine(request, opts);
+        return engine.send();
+    }
+    /**
+     * Creates a configuration options for the HTTP engine.
+     */
+    async prepareEngineConfig() {
+        const { logger, signal } = this;
+        const auth = await this.readAuthorization();
+        const config = await this.readConfig();
+        const cert = RequestAuthorizationProcessor.readCertificate(auth);
+        const opts = {};
+        if (cert) {
+            opts.certificates = [cert];
+        }
+        if (this.certificates) {
+            if (!opts.certificates) {
+                opts.certificates = [];
+            }
+            opts.certificates = opts.certificates.concat(this.certificates);
+        }
+        if (Array.isArray(auth)) {
+            opts.authorization = auth;
+        }
+        if (logger) {
+            opts.logger = logger;
+        }
+        if (signal) {
+            opts.signal = signal;
+        }
+        if (!config || config.enabled === false) {
+            return opts;
+        }
+        if (typeof config.timeout === 'number') {
+            opts.timeout = config.timeout;
+        }
+        if (typeof config.sentMessageLimit === 'number') {
+            opts.sentMessageLimit = config.sentMessageLimit;
+        }
+        if (typeof config.followRedirects === 'boolean') {
+            opts.followRedirects = config.followRedirects;
+        }
+        if (typeof config.defaultHeaders === 'boolean') {
+            opts.defaultHeaders = config.defaultHeaders;
+        }
+        if (typeof config.validateCertificates === 'boolean') {
+            opts.validateCertificates = config.validateCertificates;
+        }
+        if (config.defaultUserAgent) {
+            opts.defaultUserAgent = config.defaultUserAgent;
+        }
+        if (config.defaultAccept) {
+            opts.defaultAccept = config.defaultAccept;
+        }
+        if (config.proxy) {
+            opts.proxy = config.proxy;
+        }
+        if (config.proxyUsername) {
+            opts.proxyUsername = config.proxyUsername;
+        }
+        if (config.proxyPassword) {
+            opts.proxyPassword = config.proxyPassword;
+        }
+        if (Array.isArray(config.hosts)) {
+            opts.hosts = config.hosts;
+        }
+        return opts;
+    }
+    async processResponse(log) {
+        const { request, response } = log;
+        if (!request || !response) {
+            return;
+        }
+        if (this.cookies && this.sessionCookies) {
+            const cookies = RequestCookiesProcessor.response(log);
+            if (cookies) {
+                const ps = Object.keys(cookies).map((url) => {
+                    const items = cookies[url];
+                    this.cookies?.setCookies(url, items);
+                });
+                await Promise.allSettled(ps);
+            }
+        }
+        await this.runResponseFlows(request, response);
+    }
+    get sessionCookies() {
+        const { config } = this;
+        if (!config) {
+            return true;
+        }
+        if (config.enabled === false) {
+            return true;
+        }
+        return !config.ignoreSessionCookies;
+    }
+}
+//# sourceMappingURL=HttpRequestRunner.js.map

package/build/src/runtime/http-runner/HttpRequestRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpRequestRunner.js","sourceRoot":"","sources":["../../../../src/runtime/http-runner/HttpRequestRunner.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAGxE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAG1D,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAMrD;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,iBAAiB;IAC5B;;OAEG;IACH,MAAM,CAAkB;IAExB;;OAEG;IACH,aAAa,CAA2B;IAExC;;OAEG;IACH,KAAK,CAAqB;IAE1B;;;;;;OAMG;IACH,SAAS,CAA0B;IAEnC;;OAEG;IACH,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAE9C,MAAM,CAAU;IAEhB;;;;OAIG;IACH,MAAM,CAAe;IAErB;;OAEG;IACH,OAAO,CAAa;IAEpB;;OAEG;IACH,YAAY,CAAoB;IAEhC;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,OAAiB;QAClC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACzC,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC/B,QAAQ,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC/C,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACjC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,OAAqB;QAC7B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QACvD,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,MAAM,CAAC;SACf;QACD,OAAO,kBAAkB,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAC9D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;YAC1D,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,aAAa,CAAC;SACtB;QAED,MAAM,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC3E,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACpF,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,IAAI,CAAC,MAAM,GAAG,MAAM,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;aAC7F;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,OAAqB;QACxC,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,OAAqB;QACxC,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAC/C,IAAI,IAAI,GAAiB,EAAE,GAAG,OAAO,EAAE,CAAC;QACxC,IAAI,SAAS,EAAE;YACb,IAAI,GAAG,MAAM,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;SAC/E;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAqB;QAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC5C,6BAA6B,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC9D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAqB;QACtC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACpC,OAAO,OAAO,CAAC;SAChB;QACD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpD,uBAAuB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,OAAqB;QACzC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACpC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAqB,EAAE,QAAoC;QAChF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACpC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,SAAS,CAAC,OAA+B;QACvD,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,EAAE,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAC3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC1C,OAAO,MAAM,CAAC;SACf;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE;gBAC5B,SAAS;aACV;YACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACxD,SAAS;aACV;YACD,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,EAAqB,CAAC;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBAChD,MAAM,UAAU,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;gBACjC,IAAI,UAAU,CAAC,SAAS,EAAE;oBACxB,UAAU,CAAC,SAAS,GAAG,MAAM,kBAAkB,CAAC,4BAA4B,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;iBAC/G;gBACD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE;oBAC9D,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;oBACvH,UAAU,CAAC,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;iBACrD;gBACD,OAAO,UAAU,CAAC;YACpB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACnB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,OAAqB;QACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,6BAA6B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,IAAI,GAAsB,EAAE,CAAC;QACnC,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,CAAC;SAC5B;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;gBACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;aACxB;YACD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SACjE;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;QACD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;YACvC,OAAO,IAAI,CAAC;SACb;QACD,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE;YACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,OAAO,MAAM,CAAC,gBAAgB,KAAK,QAAQ,EAAE;YAC/C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;SACjD;QACD,IAAI,OAAO,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;SAC/C;QACD,IAAI,OAAO,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE;YAC9C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;SAC7C;QACD,IAAI,OAAO,MAAM,CAAC,oBAAoB,KAAK,SAAS,EAAE;YACpD,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;SACzD;QACD,IAAI,MAAM,CAAC,gBAAgB,EAAE;YAC3B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;SACjD;QACD,IAAI,MAAM,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;SAC3C;QACD,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;SAC3B;QACD,IAAI,MAAM,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;SAC3C;QACD,IAAI,MAAM,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;SAC3C;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAG;YAChC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;SAC3B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAgB;QACpC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC;QAClC,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE;YACzB,OAAO;SACR;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE;YACvC,MAAM,OAAO,GAAG,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,OAAO,EAAE;gBACX,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;oBAC3B,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBACH,MAAM,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;aAC9B;SACF;QACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,cAAc;QAChB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC;SACb;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IACtC,CAAC;CACF"}

package/build/src/runtime/http-runner/HttpRuntimeEnvironment.d.ts

@@ -0,0 +1,25 @@
+import { CookieJar } from "../../cookies/CookieJar";
+/**
+ * The request(s) execution environment.
+ * An environment is applied to each request in the iteration (if running a project request)
+ * or to the HTTP request (when running a single request).
+ *
+ * In the iteration mode, the environment is shared across all requests in the iteration.
+ * After that the environment is discarded and re-created for the next iteration.
+ *
+ * Cookies, depending on the implementation, most likely are shared across all iterations.
+ * This is why the implementation must to make sure it is safe to run the cookie functions
+ * in the parallel mode of a project runner.
+ */
+export interface IHttpRuntimeEnvironment {
+    /**
+     * The computed environment variables to use with this request or iteration.
+     * Variables can be changed but this change is not persistent. After each iteration
+     * the environment is restored it its default values.
+     */
+    variables: Record<string, string>;
+    /**
+     * An instance of a cookie jar (store) to put/read cookies.
+     */
+    cookies: CookieJar;
+}

package/build/src/runtime/http-runner/HttpRuntimeEnvironment.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=HttpRuntimeEnvironment.js.map

package/build/src/runtime/http-runner/HttpRuntimeEnvironment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpRuntimeEnvironment.js","sourceRoot":"","sources":["../../../../src/runtime/http-runner/HttpRuntimeEnvironment.ts"],"names":[],"mappings":""}

package/build/src/runtime/http-runner/RequestAuthorizationProcessor.d.ts

@@ -0,0 +1,56 @@
+import { IHttpRequest } from '../../models/HttpRequest.js';
+import { IRequestAuthorization } from '../../models/RequestAuthorization.js';
+import { IBearerAuthorization, IBasicAuthorization, IOidcAuthorization, IOAuth2Authorization } from '../../models/Authorization.js';
+import { HttpCertificate } from '../../models/ClientCertificate.js';
+/**
+ * Applies authorization data to the HttpRequest from
+ * request authorization configuration.
+ */
+export declare class RequestAuthorizationProcessor {
+    /**
+     * Applies the auth data from the authorization config.
+     *
+     * Note, this mutates the original request. Make a copy of you don't want to change
+     * the values in the source request.
+     *
+     * Note, this does not process client certificates. Use the `#readCertificates()` method to
+     * get a certificate to use with the HTTP request,
+     *
+     * @param request The request to apply the authorization to.
+     * @returns The same request (a reference)
+     */
+    static setAuthorization(request: IHttpRequest, authorization?: IRequestAuthorization[]): IHttpRequest;
+    /**
+     * Reads the client certificate from the authorization configuration.
+     *
+     * @param authorization The HTTP request authorization configuration.
+     * @returns The certificate to use with the HTTP request or undefined when not configured.
+     */
+    static readCertificate(authorization?: IRequestAuthorization[]): HttpCertificate | undefined;
+    /**
+     * Injects basic auth header into the request headers.
+     */
+    protected static processBasicAuth(request: IHttpRequest, config: IBasicAuthorization): void;
+    /**
+     * Injects oauth 2 auth header into the request headers.
+     */
+    protected static processOAuth2(request: IHttpRequest, config: IOAuth2Authorization): void;
+    /**
+     * Injects OpenID Connect auth header into the request headers.
+     */
+    protected static processOpenId(request: IHttpRequest, config: IOidcAuthorization): void;
+    /**
+     * Injects bearer auth header into the request headers.
+     */
+    protected static processBearer(request: IHttpRequest, config: IBearerAuthorization): void;
+    /**
+     * Applies the basic authorization data to the request.
+     *
+     * If the header value have changed then it fires `request-headers-changed` custom event.
+     * It sets computed value of the readers to the event's detail object.
+     *
+     * @param request The event's detail object. Changes made here will be propagated to the event.
+     * @param data The authorization data to apply.
+     */
+    protected static applyRequestBasicAuthData(request: IHttpRequest, data: IBasicAuthorization): void;
+}