@api-client/core 0.9.4 → 0.9.6

package/src/models/http-actions/steps/transformation/AsUpperCaseStep.ts

@@ -0,0 +1,41 @@
+import { HttpStep, IHttpStep } from "../../HttpStep.js";
+
+export const AsUpperCaseStepKind = 'HttpAction#AsUpperCase';
+
+/**
+ * Reads the input and returns an upper case value of it.
+ */
+export interface IAsUpperCaseStep extends IHttpStep {
+  kind: typeof AsUpperCaseStepKind;
+}
+
+/**
+ * Reads the input and returns an upper case value of it.
+ */
+export class AsUpperCaseStep extends HttpStep {
+  override kind = AsUpperCaseStepKind;
+
+  constructor(init?: IAsUpperCaseStep) {
+    super();
+    if (typeof init === 'object') {
+      this.new(init);
+    }
+  }
+
+  override new(init: IAsUpperCaseStep): void {
+    super.new(init);
+    this.kind = AsUpperCaseStepKind;
+  }
+  
+  checkValidity(): boolean {
+    return true;
+  }
+
+  override toJSON(): IAsUpperCaseStep {
+    const result: IAsUpperCaseStep = {
+      ...super.toJSON(),
+      kind: AsUpperCaseStepKind,
+    };
+    return result;
+  }
+}

package/src/models/http-actions/steps/transformation/RoundStep.ts

@@ -0,0 +1,86 @@
+import { HttpStep, IHttpStep } from "../../HttpStep.js";
+
+export const RoundStepKind = 'HttpAction#Round';
+
+/**
+ * Formats the input as a number using fixed-point notation.
+ */
+export interface IRoundStep extends IHttpStep {
+  kind: typeof RoundStepKind;
+  /**
+   * The number of digits to appear after the decimal point; should be a value between 0 and 100, inclusive. 
+   * If this argument is omitted, it is treated as 0.
+   * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed.
+   */
+  precision?: number;
+}
+
+/**
+ * Formats the input as a number using fixed-point notation.
+ */
+export class RoundStep extends HttpStep {
+  override kind = RoundStepKind;
+
+  /**
+   * The number of digits to appear after the decimal point; should be a value between 0 and 100, inclusive. 
+   * If this argument is omitted, it is treated as 0.
+   * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed.
+   */
+  precision?: number;
+
+  /**
+   * Creates the step from values.
+   * @param precision The name of the variable to set
+   */
+  constructor(precision: number);
+
+  /**
+   * Creates the step from serialized schema.
+   * @param init The serialized step values.
+   */
+  constructor(init: IRoundStep);
+
+  /**
+   * Creates an empty step.
+   */
+  constructor();
+
+  constructor(precisionOrInit?: number | IRoundStep) {
+    super();
+    if (typeof precisionOrInit === 'object') {
+      const typed = precisionOrInit as IRoundStep;
+      this.new(typed);
+    } else if (typeof precisionOrInit === 'number') {
+      this.new({
+        kind: RoundStepKind,
+        precision: precisionOrInit,
+        enabled: true,
+      });
+    }
+  }
+
+  override new(init: IRoundStep): void {
+    super.new(init);
+    this.kind = RoundStepKind;
+    if (typeof init.precision === 'number') {
+      this.precision = init.precision;
+    } else {
+      this.precision = undefined;
+    }
+  }
+
+  checkValidity(): boolean {
+    return true;
+  }
+
+  override toJSON(): IRoundStep {
+    const result: IRoundStep = {
+      ...super.toJSON(),
+      kind: RoundStepKind,
+    };
+    if (typeof this.precision === 'number') {
+      result.precision = this.precision;
+    }
+    return result;
+  }
+}

package/src/models/http-actions/steps/transformation/SubstringStep.ts

@@ -0,0 +1,93 @@
+import { HttpStep, IHttpStep } from "../../HttpStep.js";
+
+export const SubstringStepKind = 'HttpAction#Substring';
+
+/**
+ * Returns the part of the string from the start index up to and excluding the end index, or to the end of the string if no end index is supplied.
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring
+ */
+export interface ISubstringStep extends IHttpStep {
+  kind: typeof SubstringStepKind;
+
+  /**
+   * The index of the first character to include in the returned substring.
+   */
+  start?: number;
+
+  /**
+   * The index of the first character to exclude from the returned substring.
+   */
+  end?: number;
+}
+
+/**
+ * Returns the part of the string from the start index up to and excluding the end index, or to the end of the string if no end index is supplied.
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring
+ */
+export class SubstringStep extends HttpStep {
+  override kind = SubstringStepKind;
+
+  /**
+   * The index of the first character to include in the returned substring.
+   */
+  start?: number;
+
+  /**
+   * The index of the first character to exclude from the returned substring.
+   */
+  end?: number;
+
+  constructor(start: number, end?: number);
+
+  constructor(init: ISubstringStep);
+
+  constructor();
+
+  constructor(startOrInit?: number | ISubstringStep, end?: number) {
+    super();
+    if (typeof startOrInit === 'object') {
+      const typed = startOrInit as ISubstringStep;
+      this.new(typed);
+    } else if (typeof startOrInit === 'number') {
+      this.new({
+        kind: SubstringStepKind,
+        start: startOrInit,
+        end,
+        enabled: true,
+      });
+    }
+  }
+
+  override new(init: ISubstringStep): void {
+    super.new(init);
+    this.kind = SubstringStepKind;
+    if (typeof init.start === 'number') {
+      this.start = init.start;
+    } else {
+      this.start = undefined;
+    }
+    if (typeof init.end === 'number') {
+      this.end = init.end;
+    } else {
+      this.end = undefined;
+    }
+  }
+  
+  checkValidity(): boolean {
+    return typeof this.start === 'number';
+  }
+
+  override toJSON(): ISubstringStep {
+    const result: ISubstringStep = {
+      ...super.toJSON(),
+      kind: SubstringStepKind,
+    };
+    if (typeof this.start === 'number') {
+      result.start = this.start;
+    }
+    if (typeof this.end === 'number') {
+      result.end = this.end;
+    }
+    return result;
+  }
+}

package/src/models/http-actions/steps/transformation/TrimStep.ts

@@ -0,0 +1,43 @@
+import { HttpStep, IHttpStep } from "../../HttpStep.js";
+
+export const TrimStepKind = 'HttpAction#Trim';
+
+/**
+ * Reads the input and trims it.
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim.
+ */
+export interface ITrimStep extends IHttpStep {
+  kind: typeof TrimStepKind;
+}
+
+/**
+ * Reads the input and trims it.
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim.
+ */
+export class TrimStep extends HttpStep {
+  override kind = TrimStepKind;
+
+  constructor(init?: ITrimStep) {
+    super();
+    if (typeof init === 'object') {
+      this.new(init);
+    }
+  }
+
+  override new(init: ITrimStep): void {
+    super.new(init);
+    this.kind = TrimStepKind;
+  }
+  
+  checkValidity(): boolean {
+    return true;
+  }
+
+  override toJSON(): ITrimStep {
+    const result: ITrimStep = {
+      ...super.toJSON(),
+      kind: TrimStepKind,
+    };
+    return result;
+  }
+}

package/src/proxy/HttpProjectProxy.ts

@@ -5,7 +5,7 @@ import { StoreSdk } from "../runtime/store/StoreSdkNode.js";
 import { ProjectSerialRunner } from "../runtime/node/ProjectSerialRunner.js";
 import { ProjectParallelRunner } from "../runtime/node/ProjectParallelRunner.js";
 import Proxy, { IProxyResult } from "./Proxy.js";
-import { IProjectExecutionLog } from "../runtime/reporters/Reporter.js";
+import { IProjectExecutionLog } from "../models/ProjectExecution.js";
 
 interface ProxyInit {
   kind: typeof HttpProjectKind;

package/src/proxy/Proxy.ts

@@ -1,5 +1,5 @@
 import { IRequestLog } from "../models/RequestLog.js";
-import { IProjectExecutionLog } from "../runtime/reporters/Reporter.js";
+import { IProjectExecutionLog } from "../models/ProjectExecution.js";
 
 export interface IProxyResult<T = IProjectExecutionLog | IRequestLog> {
   /**

package/src/proxy/ProxyService.ts

@@ -1,4 +1,4 @@
-import { IProjectExecutionLog } from "../runtime/reporters/Reporter.js";
+import { IProjectExecutionLog } from "../models/ProjectExecution.js";
 import { IRequestLog } from "../models/RequestLog.js";
 import HttpProjectProxy, { IHttpProjectProxyInit, IHttpProjectStoreProxyInit } from "./HttpProjectProxy.js";
 import { IProxyResult } from "./Proxy.js";

package/src/proxy/RequestProxy.ts

@@ -3,11 +3,12 @@ import { IRequestAuthorization } from '../models/RequestAuthorization.js';
 import { IRequestConfig } from '../models/RequestConfig.js';
 import Proxy, { IProxyResult } from "./Proxy.js";
 import { HttpCertificate } from '../models/ClientCertificate.js';
-import { IHttpActionFlow } from '../models/http-actions/HttpActions.js';
+import { IHttpFlow } from '../models/http-actions/HttpFlows.js';
 import { ApiError } from '../runtime/store/Errors.js';
 import { DummyLogger } from '../lib/logging/DummyLogger.js';
 import { HttpRequestRunner } from '../runtime/http-runner/HttpRequestRunner.js';
 import { IRequestLog } from "../models/RequestLog.js";
+import { IHttpAssertion } from '../models/http-actions/HttpAssertion.js';
 
 export interface IRequestProxyInit {
   kind: typeof HttpRequestKind;
@@ -34,7 +35,11 @@ export interface IRequestProxyInit {
   /**
    * The request flows to execute with the request.
    */
-  flows?: IHttpActionFlow[];
+  flows?: IHttpFlow[];
+  /**
+   * Assertions to execute with the request.
+   */
+  assertions?: IHttpAssertion[];
 }
 
 /**
@@ -66,7 +71,7 @@ export default class RequestProxy extends Proxy {
 
   async execute(): Promise<IProxyResult<IRequestLog>> {
     const data = this.init as IRequestProxyInit;
-    const { request, authorization, certificate, config={}, variables={}, flows } = data;
+    const { request, authorization, certificate, config={}, variables={}, flows, assertions } = data;
     const factory = new HttpRequestRunner();
     factory.variables = variables;
     factory.logger = new DummyLogger();
@@ -77,6 +82,9 @@ export default class RequestProxy extends Proxy {
     if (Array.isArray(flows) && flows.length) {
       factory.flows = flows;
     }
+    if (Array.isArray(assertions) && assertions.length) {
+      factory.assertions = assertions;
+    }
     if (certificate) {
       factory.certificates = [certificate];
     }

package/src/runtime/http-runner/ConditionCheck.ts

@@ -1,5 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { ActionOperatorEnum } from '../../models/http-actions/HttpActions.js';
+import { AssertionEnum } from "../../models/http-actions/HttpAssertion";
 
 /**
  * Checks if values equal.
@@ -7,7 +6,7 @@ import { ActionOperatorEnum } from '../../models/http-actions/HttpActions.js';
  * @param condition Comparator value
  * @returns True if objects matches.
  */
-export function isEqual(value: any, condition: any): boolean {
+export function isEqual(value: unknown, condition: unknown): boolean {
   if (value === condition || String(value) === String(condition)) {
     return true;
   }
@@ -34,7 +33,7 @@ export function isEqual(value: any, condition: any): boolean {
  * @param condition Comparator value
  * @return False if objects matches.
  */
-export function isNotEqual(value: any, condition: any): boolean {
+export function isNotEqual(value: unknown, condition: unknown): boolean {
   return !isEqual(value, condition);
 }
 
@@ -45,7 +44,7 @@ export function isNotEqual(value: any, condition: any): boolean {
  * @param condition Comparator value
  * @returns True if value is less than condition.
  */
-export function isLessThan(value: any, condition: any): boolean {
+export function isLessThan(value: unknown, condition: unknown): boolean {
   const valueNumber = Number(value);
   if (Number.isNaN(valueNumber)) {
     return false;
@@ -64,7 +63,7 @@ export function isLessThan(value: any, condition: any): boolean {
  * @param condition Comparator value
  * @returns True if value is less than or equal to `condition`.
  */
-export function isLessThanEqual(value: any, condition: any): boolean {
+export function isLessThanEqual(value: unknown, condition: unknown): boolean {
   const valueNumber = Number(value);
   if (Number.isNaN(valueNumber)) {
     return false;
@@ -83,7 +82,7 @@ export function isLessThanEqual(value: any, condition: any): boolean {
  * @param condition Comparator value
  * @returns True if value is greater than `condition`.
  */
-export function isGreaterThan(value: any, condition: any): boolean {
+export function isGreaterThan(value: unknown, condition: unknown): boolean {
   const valueNumber = Number(value);
   if (Number.isNaN(valueNumber)) {
     return false;
@@ -102,7 +101,7 @@ export function isGreaterThan(value: any, condition: any): boolean {
  * @param condition Comparator value
  * @returns True if value is greater than or equal to `condition`.
  */
-export function isGreaterThanEqual(value: any, condition: any): boolean {
+export function isGreaterThanEqual(value: unknown, condition: unknown): boolean {
   const valueNumber = Number(value);
   if (Number.isNaN(valueNumber)) {
     return false;
@@ -122,12 +121,12 @@ export function isGreaterThanEqual(value: any, condition: any): boolean {
  * @param condition Comparator value
  * @returns True if value contains the `condition`.
  */
-export function contains(value: any, condition: any): boolean {
+export function contains(value: unknown, condition: unknown): boolean {
   if (!value) {
     return false;
   }
   if (typeof value === 'string') {
-    return value.indexOf(condition) !== -1;
+    return value.indexOf(condition as string) !== -1;
   }
   if (Array.isArray(value)) {
     if (!Number.isNaN(condition) && typeof condition !== 'number') {
@@ -141,7 +140,7 @@ export function contains(value: any, condition: any): boolean {
   if (typeof value !== 'object') {
     return false;
   }
-  return condition in value;
+  return (condition as string) in value;
 }
 
 /**
@@ -151,10 +150,10 @@ export function contains(value: any, condition: any): boolean {
  * @param condition Comparator value - regex string.
  * @returns Value of calling `test()` function on string.
  */
-export function isRegex(value: any, condition: any): boolean {
+export function isRegex(value: unknown, condition: unknown): boolean {
   let re;
   try {
-    re = new RegExp(condition, 'm');
+    re = new RegExp(condition as string, 'm');
   } catch (e) {
     return false;
   }
@@ -170,7 +169,7 @@ export function isRegex(value: any, condition: any): boolean {
  * @param condition Value to compare.
  * @returns True if the condition is satisfied and false otherwise.
  */
-export function checkCondition(value: any, operator: ActionOperatorEnum, condition: string | undefined): boolean {
+export function checkCondition(value: unknown, operator: AssertionEnum, condition: string | undefined): boolean {
   switch (operator) {
     case 'equal':
       return isEqual(value, condition);