@api-client/core 0.9.21 → 0.9.23

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

@@ -1,232 +1,74 @@
-import { HttpCookie } from "../../models/HttpCookie.js";
-import { FlowSourceEnum, } from '../../models/http-actions/HttpFlows.js';
-import { RequestDataExtractor } from "../../data/RequestDataExtractor.js";
-import { checkCondition } from "./ConditionCheck.js";
-import { ApiSchemaValues } from "../../amf/ApiSchemaValues.js";
-import { ReadDataStep, ReadDataStepKind } from "../../models/http-actions/steps/data/ReadDataStep.js";
-import { SetDataStep, SetDataStepKind } from "../../models/http-actions/steps/data/SetDataStep.js";
-import { SetVariableStep, SetVariableStepKind } from "../../models/http-actions/steps/data/SetVariableStep.js";
-import { SetCookieStep, SetCookieStepKind } from "../../models/http-actions/steps/data/SetCookieStep.js";
-import { DeleteCookieStep, DeleteCookieStepKind } from "../../models/http-actions/steps/data/DeleteCookieStep.js";
-export class HttpFlowRunner {
+import { HttpFlows } from "./HttpFlows.js";
+export class HttpFlowRunner extends HttpFlows {
     /**
-     * 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.
+     * Runs flows before the HTTP request is sent to the remote machine.
+     * The request has to be pre-processed, that is, variables should already be applied to it.
      */
-    variables;
-    /**
-     * An instance of a cookie jar (store) to put/read cookies.
-     */
-    cookies;
     async request(request, flows) {
         if (!flows || !flows.length) {
             return;
         }
-        for (const flow of flows) {
-            const { condition, actions } = flow;
-            if (condition) {
-                try {
-                    const meet = await this._satisfied(condition, request);
-                    if (!meet) {
-                        continue;
-                    }
-                }
-                catch (_) {
-                    continue;
-                }
-            }
-            for (const action of actions) {
-                await this._runAction(action, request);
-            }
-        }
+        await this.runFlows(request, flows);
     }
     async response(request, response, flows) {
         if (!flows || !flows.length) {
             return;
         }
+        await this.runFlows(request, flows, response);
+    }
+    async runFlows(request, flows, response) {
         for (const flow of flows) {
-            for (const action of flow.actions) {
-                await this._runAction(action, request, response);
+            const { condition, actions } = flow;
+            const passedCondition = await this.checkCondition(request, condition, response);
+            if (!passedCondition) {
+                continue;
+            }
+            for (const action of actions) {
+                try {
+                    await this.runAction(action, request, response);
+                }
+                catch (e) {
+                    // eslint-disable-next-line no-console
+                    console.warn(e);
+                    // if the step fails then we stop execution.
+                    // TODO: we should generate a report with the list of execution errors and present it in the UI.
+                    break;
+                }
             }
         }
     }
-    async _runAction(action, request, response) {
+    async runAction(action, request, response) {
         const { steps } = action;
         if (!Array.isArray(steps) || !steps.length) {
             return;
         }
-        // this keeps a value from the last step to be passed to the next step.
-        let lastResult;
-        for (const step of steps) {
-            lastResult = await this._runStep(step, lastResult, request, response);
-        }
-    }
-    async _satisfied(condition, request, response) {
-        const { source, data, path, operator, value } = condition;
-        if (!source || !operator) {
-            return false;
-        }
-        const extractor = new RequestDataExtractor(request, response);
-        const readValue = await extractor.extract(source, data, path);
-        return checkCondition(readValue, operator, value);
+        await this.runSteps(steps, request, response);
     }
-    async _runStep(step, input, request, response) {
-        switch (step.kind) {
-            case ReadDataStepKind: return this._runReadDataStep(step, request, response);
-            case SetDataStepKind: return this._runSetDataStep(step);
-            case SetVariableStepKind: return this._runSetVariableStep(step, input);
-            case SetCookieStepKind: return this._runSetCookieStep(step, input, request);
-            case DeleteCookieStepKind: return this._runDeleteCookieStep(step, request);
-            default: return undefined;
+    async checkCondition(request, condition, response) {
+        if (!condition) {
+            return true;
         }
-    }
-    /**
-     * A step that reads data from the request, response, or variables.
-     *
-     * @param step The step configuration.
-     * @param request The HttpRequest or the SentRequest (for responses)
-     * @param response When available, the response data
-     * @returns The read value or undefined.
-     */
-    async _runReadDataStep(step, request, response) {
-        const instance = new ReadDataStep(step);
-        if (instance.enabled === false || !instance.checkValidity()) {
-            return undefined;
-        }
-        const { source, data, path } = step;
-        if (source === FlowSourceEnum.request) {
-            const extractor = new RequestDataExtractor(request);
-            return extractor.extract(source, data, path);
-        }
-        if (source === FlowSourceEnum.response) {
-            const extractor = new RequestDataExtractor(request, response);
-            return extractor.extract(source, data, path);
-        }
-        if (source === FlowSourceEnum.variable && path && this.variables) {
-            return this.variables[path];
-        }
-        return undefined;
-    }
-    /**
-     * A step that returns a pre-configured value.
-     *
-     * @param step The step configuration.
-     * @returns The read value with applied data type.
-     */
-    _runSetDataStep(step) {
-        const instance = new SetDataStep(step);
-        if (instance.enabled === false || !instance.checkValidity()) {
-            return undefined;
-        }
-        const { value, dataType } = step;
-        if (value === null || value === undefined) {
-            return undefined;
-        }
-        return ApiSchemaValues.parseScalar(value, dataType);
-    }
-    /**
-     * A step that sets a variable in the current environment.
-     *
-     * @param step The step configuration.
-     * @param value The value to set. A value that is `null` or `undefined` deletes the variable.
-     */
-    _runSetVariableStep(step, value) {
-        const instance = new SetVariableStep(step);
-        if (instance.enabled === false || !instance.checkValidity() || !this.variables) {
-            return undefined;
-        }
-        const { name } = step;
-        if (value === null || typeof value === undefined) {
-            delete this.variables[name];
-        }
-        else {
-            this.variables[name] = String(value);
-        }
-        return undefined;
-    }
-    /**
-     * A step that sets a cookie.
-     *
-     * @param step The step configuration.
-     * @param value The value to sent on the cookie.
-     * @param request The request object.
-     */
-    async _runSetCookieStep(step, value, request) {
-        const instance = new SetCookieStep(step);
-        const { cookies } = this;
-        if (instance.enabled === false || !instance.checkValidity() || !cookies) {
-            return undefined;
-        }
-        if (value === null || typeof value === undefined) {
-            return undefined;
-        }
-        const { name, expires, hostOnly, httpOnly, sameSite, secure, session } = step;
-        const typedValue = String(value);
-        let url;
-        if (step.url) {
-            url = step.url;
-        }
-        else {
-            url = request.url;
-        }
-        const cookie = new HttpCookie({
-            name: name,
-            value: typedValue,
-            sameSite: 'unspecified',
-        });
-        if (sameSite) {
-            const typed = sameSite;
-            switch (typed.toLowerCase()) {
-                case 'lax':
-                    cookie.sameSite = 'lax';
-                    break;
-                case 'strict':
-                    cookie.sameSite = 'strict';
-                    break;
-                case 'none':
-                    cookie.sameSite = 'no_restriction';
-                    break;
-            }
-        }
-        if (expires) {
-            cookie.expirationDate = expires;
-        }
-        if (typeof hostOnly === 'boolean') {
-            cookie.hostOnly = hostOnly;
-        }
-        if (typeof httpOnly === 'boolean') {
-            cookie.httpOnly = httpOnly;
+        const { steps = [] } = condition;
+        if (!Array.isArray(steps) || !steps.length) {
+            return true;
         }
-        if (typeof secure === 'boolean') {
-            cookie.secure = secure;
+        // the condition works with assertions. If the condition throws then it is not satisfied.
+        try {
+            await this.runSteps(steps, request, response);
+            return true;
         }
-        if (typeof session === 'boolean') {
-            cookie.session = session;
+        catch (_) {
+            return false;
         }
-        await cookies.setCookies(url, [cookie]);
-        return undefined;
     }
-    /**
-     * A step to delete cookies from the cookie jar.
-     */
-    async _runDeleteCookieStep(step, request) {
-        const instance = new DeleteCookieStep(step);
-        const { cookies } = this;
-        if (instance.enabled === false || !instance.checkValidity() || !cookies) {
-            return undefined;
-        }
-        let url;
-        if (step.url) {
-            url = step.url;
-        }
-        else {
-            url = request.url;
+    async runSteps(steps, request, response) {
+        // this keeps a value from the last step to be passed to the next step.
+        let lastResult = {
+            value: undefined,
+        };
+        for (const step of steps) {
+            lastResult = await this.runStep(request, step, lastResult, response);
         }
-        await cookies.deleteCookies(url, step.name);
-        return undefined;
     }
 }
 //# sourceMappingURL=HttpFlowRunner.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"HttpFlowRunner.js","sourceRoot":"","sources":["../../../../src/runtime/http-runner/HttpFlowRunner.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EACL,cAAc,GAEf,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG/D,OAAO,EAAiB,YAAY,EAAE,gBAAgB,EAAE,MAAM,sDAAsD,CAAC;AACrH,OAAO,EAAgB,WAAW,EAAE,eAAe,EAAE,MAAM,qDAAqD,CAAC;AACjH,OAAO,EAAoB,eAAe,EAAE,mBAAmB,EAAE,MAAM,yDAAyD,CAAC;AACjI,OAAO,EAAkB,aAAa,EAAE,iBAAiB,EAAE,MAAM,uDAAuD,CAAC;AACzH,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAqB,MAAM,0DAA0D,CAAC;AAIrI,MAAM,OAAO,cAAc;IACzB;;;;;;OAMG;IACH,SAAS,CAA0B;IAEnC;;OAEG;IACH,OAAO,CAAa;IAEpB,KAAK,CAAC,OAAO,CAAC,OAAqB,EAAE,KAAmB;QACtD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC3B,OAAO;SACR;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACpC,IAAI,SAAS,EAAE;gBACb,IAAI;oBACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBACvD,IAAI,CAAC,IAAI,EAAE;wBACT,SAAS;qBACV;iBACF;gBAAC,OAAO,CAAC,EAAE;oBACV,SAAS;iBACV;aACF;YACD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACxC;SACF;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAoC,EAAE,QAAoC,EAAE,KAAmB;QAC5G,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC3B,OAAO;SACR;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBACjC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;aAClD;SACF;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAAmB,EAAE,OAAoC,EAAE,QAAqC;QAC/G,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC1C,OAAO;SACR;QACD,uEAAuE;QACvE,IAAI,UAAqB,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SACvE;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAyB,EAAE,OAAoC,EAAE,QAAqC;QACrH,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;QAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE;YACxB,OAAO,KAAK,CAAC;SACd;QACD,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC9D,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9D,OAAO,cAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAe,EAAE,KAAgB,EAAE,OAAoC,EAAE,QAAqC;QAC3H,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,gBAAgB,CAAC,CAAC,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAqB,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9F,KAAK,eAAe,CAAC,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAoB,CAAC,CAAC;YACxE,KAAK,mBAAmB,CAAC,CAAC,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAwB,EAAE,KAAK,CAAC,CAAC;YAC3F,KAAK,iBAAiB,CAAC,CAAC,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAsB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC9F,KAAK,oBAAoB,CAAC,CAAC,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAyB,EAAE,OAAO,CAAC,CAAC;YAChG,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;SAC3B;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAmB,EAAE,OAAoC,EAAE,QAAqC;QACrH,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,EAAE;YAC3D,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACpC,IAAI,MAAM,KAAK,cAAc,CAAC,OAAO,EAAE;YACrC,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAC;YACpD,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;SAC9C;QAED,IAAI,MAAM,KAAK,cAAc,CAAC,QAAQ,EAAE;YACtC,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9D,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;SAC9C;QAED,IAAI,MAAM,KAAK,cAAc,CAAC,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YAChE,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SAC7B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAkB;QAChC,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,EAAE;YAC3D,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACjC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACzC,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,eAAe,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,IAAsB,EAAE,KAAgB;QAC1D,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YAC9E,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;YAChD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;SACtC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAoB,EAAE,KAAgB,EAAE,OAAoC;QAClG,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,EAAG;YACxE,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;YAChD,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAC9E,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,GAAW,CAAC;QAChB,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;SAChB;aAAM;YACL,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;SACnB;QACD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC;YAC5B,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,aAAa;SACxB,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE;YACZ,MAAM,KAAK,GAAG,QAAyB,CAAC;YACxC,QAAQ,KAAK,CAAC,WAAW,EAAE,EAAE;gBAC3B,KAAK,KAAK;oBAAE,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;oBAAC,MAAM;gBAC3C,KAAK,QAAQ;oBAAE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAAC,MAAM;gBACjD,KAAK,MAAM;oBAAE,MAAM,CAAC,QAAQ,GAAG,gBAAgB,CAAC;oBAAC,MAAM;aACxD;SACF;QACD,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,cAAc,GAAG,OAAO,CAAC;SACjC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;SACxB;QACD,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;YAChC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;SAC1B;QACD,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QACxC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAAuB,EAAE,OAAoC;QACtF,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,EAAE;YACvE,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,GAAW,CAAC;QAChB,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;SAChB;aAAM;YACL,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;SACnB;QACD,MAAM,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"HttpFlowRunner.js","sourceRoot":"","sources":["../../../../src/runtime/http-runner/HttpFlowRunner.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAc,MAAM,gBAAgB,CAAC;AAIvD,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC3C;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,OAAqB,EAAE,KAAmB;QACtD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC3B,OAAO;SACR;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAoC,EAAE,QAAoC,EAAE,KAAmB;QAC5G,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC3B,OAAO;SACR;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,OAAoC,EAAE,KAAkB,EAAE,QAAqC;QACtH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACpC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;YAChF,IAAI,CAAC,eAAe,EAAE;gBACpB,SAAS;aACV;YACD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,IAAI;oBACF,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;iBACjD;gBAAC,OAAO,CAAC,EAAE;oBACV,sCAAsC;oBACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAChB,4CAA4C;oBAC5C,gGAAgG;oBAChG,MAAM;iBACP;aACF;SACF;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,MAAmB,EAAE,OAAoC,EAAE,QAAqC;QAC9G,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC1C,OAAO;SACR;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAoC,EAAE,SAAuB,EAAE,QAAqC;QACvH,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,IAAI,CAAC;SACb;QACD,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC1C,OAAO,IAAI,CAAC;SACb;QACD,yFAAyF;QACzF,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9C,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,KAAkB,EAAE,OAAoC,EAAE,QAAqC;QACtH,uEAAuE;QACvE,IAAI,UAAU,GAAe;YAC3B,KAAK,EAAE,SAAS;SACjB,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;SACtE;IACH,CAAC;CACF"}

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

@@ -0,0 +1,119 @@
+import { HttpRequest, IHttpRequest } from "../../models/HttpRequest.js";
+import { ISentRequest } from "../../models/SentRequest.js";
+import { CookieJar } from "../../cookies/CookieJar.js";
+import { IResponse } from "../../models/Response.js";
+import { ErrorResponse, IErrorResponse } from "../../models/ErrorResponse.js";
+import { IHttpStep } from "../../models/http-flows/HttpStep.js";
+import { FlowValue } from "./HttpFlowRunner.js";
+import { FlowRequestDataEnum, FlowResponseDataEnum } from "../../models/http-flows/HttpFlows.js";
+import { IReadDataSourceStep } from "../../models/http-flows/steps/data/ReadDataSourceStep.js";
+import { IReadValueStep } from "../../models/http-flows/steps/data/ReadValueStep.js";
+import { HttpResponse } from "../../models/HttpResponse.js";
+import { IRoundStep } from "../../models/http-flows/steps/transformation/RoundStep.js";
+import { ISubstringStep } from "../../models/http-flows/steps/transformation/SubstringStep.js";
+import { IEqualAssertion } from "../../models/http-flows/steps/assertion/EqualAssertion.js";
+import { INotEqualAssertion } from "../../models/http-flows/steps/assertion/NotEqualAssertion.js";
+import { IGreaterThanAssertion } from "../../models/http-flows/steps/assertion/GreaterThanAssertion.js";
+import { ILessThanAssertion } from "../../models/http-flows/steps/assertion/LessThanAssertion.js";
+import { IIncludesAssertion } from "../../models/http-flows/steps/assertion/IncludesAssertion.js";
+import { INotIncludesAssertion } from "../../models/http-flows/steps/assertion/NotIncludesAssertion.js";
+import { IToBeAssertion } from '../../models/http-flows/steps/assertion/ToBeAssertion.js';
+import { INotToBeAssertion } from '../../models/http-flows/steps/assertion/NotToBeAssertion.js';
+import { ILengthOfAssertion } from '../../models/http-flows/steps/assertion/LengthOfAssertion.js';
+import { IReadDataStep } from "../../models/http-flows/steps/data/ReadDataStep.js";
+import { ISetDataStep } from "../../models/http-flows/steps/data/SetDataStep.js";
+import { ISetVariableStep } from "../../models/http-flows/steps/data/SetVariableStep.js";
+import { ISetCookieStep } from "../../models/http-flows/steps/data/SetCookieStep.js";
+import { IDeleteCookieStep } from "../../models/http-flows/steps/data/DeleteCookieStep.js";
+export interface IStepValue {
+    value: FlowValue;
+    type?: FlowRequestDataEnum | FlowResponseDataEnum;
+    bodyMime?: string;
+}
+/**
+ * A class that supports both assertions and flows.
+ * The derived classes specializes in a specific user flow (either performing flow actions or running assertions).
+ */
+export declare class HttpFlows {
+    /**
+     * 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?: Record<string, string>;
+    /**
+     * An instance of a cookie jar (store) to put/read cookies.
+     */
+    cookies?: CookieJar;
+    protected runStep(request: ISentRequest | IHttpRequest, step: IHttpStep, input: IStepValue, response?: IResponse | IErrorResponse): Promise<IStepValue>;
+    /**
+     * Produces the data source.
+     */
+    protected readDataSource(request: ISentRequest | IHttpRequest, step: IReadDataSourceStep, response?: IResponse | IErrorResponse): Promise<IStepValue>;
+    protected processBody(input: HttpRequest | HttpResponse | ErrorResponse): Promise<IStepValue>;
+    /**
+     * Produces the value from the current input.
+     */
+    protected readValue(input: IStepValue, step: IReadValueStep): Promise<IStepValue>;
+    protected toLowerCase(input: IStepValue): Promise<IStepValue>;
+    protected toUpperCase(input: IStepValue): Promise<IStepValue>;
+    protected asNumber(input: IStepValue): Promise<IStepValue>;
+    protected round(input: IStepValue, step: IRoundStep): Promise<IStepValue>;
+    protected trim(input: IStepValue): Promise<IStepValue>;
+    protected substring(input: IStepValue, step: ISubstringStep): Promise<IStepValue>;
+    protected assertEqual(input: IStepValue, step: IEqualAssertion): Promise<IStepValue>;
+    protected assertNotEqual(input: IStepValue, step: INotEqualAssertion): Promise<IStepValue>;
+    protected assertGreaterThan(input: IStepValue, step: IGreaterThanAssertion): Promise<IStepValue>;
+    protected assertLessThan(input: IStepValue, step: ILessThanAssertion): Promise<IStepValue>;
+    protected assertIncludes(input: IStepValue, step: IIncludesAssertion): Promise<IStepValue>;
+    protected assertNotIncludes(input: IStepValue, step: INotIncludesAssertion): Promise<IStepValue>;
+    protected assertOk(input: IStepValue): Promise<IStepValue>;
+    protected assertNotOk(input: IStepValue): Promise<IStepValue>;
+    protected toBe(input: IStepValue, step: IToBeAssertion): Promise<IStepValue>;
+    protected notToBe(input: IStepValue, step: INotToBeAssertion): Promise<IStepValue>;
+    protected isEmpty(input: IStepValue): Promise<IStepValue>;
+    protected isNotEmpty(input: IStepValue): Promise<IStepValue>;
+    protected lengthOf(input: IStepValue, step: ILengthOfAssertion): Promise<IStepValue>;
+    protected isPrimitive(value: unknown): boolean;
+    /**
+     * A step that reads data from the request, response, or variables.
+     *
+     * @param step The step configuration.
+     * @param request The HttpRequest or the SentRequest (for responses)
+     * @param response When available, the response data
+     * @returns The read value or undefined.
+     */
+    runReadDataStep(input: IStepValue, step: IReadDataStep, request: IHttpRequest | ISentRequest, response?: IResponse | IErrorResponse): Promise<IStepValue>;
+    /**
+     * A step that returns a pre-configured value.
+     *
+     * @param step The step configuration.
+     * @returns The read value with applied data type.
+     */
+    runSetDataStep(input: IStepValue, step: ISetDataStep): IStepValue;
+    /**
+     * A step that sets a variable in the current environment.
+     * Note, this passes the step value through.
+     *
+     * @param step The step configuration.
+     * @param value The value to set. A value that is `null` or `undefined` deletes the variable.
+     */
+    runSetVariableStep(input: IStepValue, step: ISetVariableStep): IStepValue;
+    /**
+     * A step that sets a cookie.
+     * Note, this passes the step value through.
+     *
+     * @param step The step configuration.
+     * @param value The value to sent on the cookie.
+     * @param request The request object.
+     */
+    runSetCookieStep(input: IStepValue, step: ISetCookieStep, request: IHttpRequest | ISentRequest): Promise<IStepValue>;
+    /**
+     * A step to delete cookies from the cookie jar.
+     *
+     * Note, this passes the step value through.
+     */
+    runDeleteCookieStep(input: IStepValue, step: IDeleteCookieStep, request: IHttpRequest | ISentRequest): Promise<IStepValue>;
+}