@api-client/core 0.20.10 → 0.21.0

package/src/models/http-flows/AssertionError.ts

@@ -1,57 +0,0 @@
-export interface IAssertionError {
-  /**
-   * Set with assertions to show the actual value at the time of testing.
-   */
-  actual?: unknown
-  /**
-   * Set with assertions to show the expected value at the time of testing.
-   */
-  expected?: unknown
-  /**
-   * The operator used to make the assertion.
-   */
-  operator?: string
-  /**
-   * The error message, if any.
-   * Assertions usually don't set error messages. Instead they set other fields.
-   */
-  message?: string
-}
-
-export class AssertionError extends Error {
-  /**
-   * Set with assertions to show the actual value at the time of testing.
-   */
-  actual: unknown
-  /**
-   * Set with assertions to show the expected value at the time of testing.
-   */
-  expected: unknown
-  /**
-   * The operator used to make the assertion.
-   */
-  operator: string
-
-  code = 'ERR_ASSERTION'
-
-  constructor(options: IAssertionError = {}) {
-    super(options.message || 'Unspecified AssertionError')
-    this.name = 'AssertionError'
-    this.actual = options.actual
-    this.expected = options.expected
-    this.operator = options.operator || '[unknown]'
-  }
-
-  toJSON(): IAssertionError {
-    const result: IAssertionError = {}
-    if (this.message) {
-      result.message = this.message
-    }
-    result.actual = this.actual
-    result.expected = this.expected
-    if (this.operator) {
-      result.operator = this.operator
-    }
-    return result
-  }
-}

package/src/models/http-flows/HttpAssertion.ts

@@ -1,90 +0,0 @@
-import { IAssertionError } from './AssertionError.js'
-import { IHttpStep } from './HttpStep.js'
-
-export enum AssertionEnum {
-  equal = 'equal',
-  notEqual = 'not-equal',
-  greaterThan = 'greater-than',
-  greaterThanEqual = 'greater-than-equal',
-  lessThan = 'less-than',
-  lessThanEqual = 'less-than-equal',
-  contains = 'contains',
-  regex = 'regex',
-  ok = 'ok',
-  notOk = 'notOk',
-  toBe = 'toBe',
-  notToBe = 'notToBe',
-}
-
-export enum TransformationEnum {
-  /**
-   * Transformation of the data that reads a value from the given path.
-   * For example, for a body it can be xpath for XML or JSON path for JSON data.
-   */
-  readValue = 'readValue',
-  /**
-   * Transforms the value from the previous step to a number.
-   */
-  asNumber = 'asNumber',
-  /**
-   * Rounds the input value to a nearest numeric value.
-   * If the value is not a number it tries to convert it to a number. When it
-   * can't ba casted to a number then the transformation throws an error.
-   */
-  round = 'round',
-  /**
-   * Transforms the value to a lowercase value.
-   */
-  toLowerCase = 'toLowerCase',
-  /**
-   * Transforms the value to a uppercase value.
-   */
-  toUpperCase = 'toUpperCase',
-  /**
-   * Trims the string value.
-   */
-  trim = 'trim',
-  /**
-   * Transforms 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.
-   *
-   * `substring(indexStart, indexEnd)`
-   */
-  substring = 'substring',
-}
-
-export interface IHttpAssertion {
-  /**
-   * The description of the assertion reported to the UI.
-   */
-  description?: string
-
-  /**
-   * The list of steps to perform. This is an ordered list of action tasks.
-   * Each step is described by the `kind` property which tells the runner what action to perform.
-   */
-  steps: IHttpStep[]
-  /**
-   * Whether the assertions is enabled. By default it is enabled. It is only not enabled when this is set to false.
-   */
-  enabled?: boolean
-}
-
-/**
- * An object representing a result of running a single assertion.
- */
-export interface AssertionResult {
-  /**
-   * Indicates whether assertion result is positive (not failed) or negative (failed).
-   */
-  ok: boolean
-  /**
-   * The description of the association.
-   */
-  description: string
-  /**
-   * This is always set when `ok` is false.
-   * This is also never set when `ok` is true.
-   */
-  error?: IAssertionError
-}

package/src/models/http-flows/HttpFlows.ts

@@ -1,82 +0,0 @@
-import { IHttpStep } from './HttpStep.js'
-
-export enum FlowSourceEnum {
-  /**
-   * The request object.
-   */
-  request = 'request',
-  /**
-   * The response object.
-   */
-  response = 'response',
-  /**
-   * A variable from the current environment.
-   */
-  variable = 'variable',
-}
-
-export enum FlowRequestDataEnum {
-  url = 'url',
-  method = 'method',
-  headers = 'headers',
-  body = 'body',
-}
-
-export enum FlowResponseDataEnum {
-  url = 'url',
-  status = 'status',
-  statusText = 'statusText',
-  headers = 'headers',
-  /**
-   * Reads the value of a cookie in the `set-cookie` header.
-   */
-  cookie = 'cookie',
-  body = 'body',
-}
-
-/**
- * A flow represents a series of actions to be performed one-by-one after the HTTP request is sent or when the response
- * is ready.
- */
-export interface IHttpFlow {
-  /**
-   * The description of the flow
-   */
-  description?: string
-  /**
-   * Describes when the flow is executed.
-   * The `request` means the flow is executed before the request is sent to the HTTP engine.
-   * The `response` means the flow is executed after the response has been received in full, but before reporting
-   * the response to the UI.
-   */
-  trigger: 'request' | 'response'
-  /**
-   * The ordered list of actions to execute.
-   */
-  actions: IHttpAction[]
-  /**
-   * A condition to check before running the flow.
-   */
-  condition?: IHttpAction
-}
-
-/**
- * Describes a single action in a flow.
- * An action can have a condition that is checked against the current context.
- * Action is not executed when the condition is not meet.
- *
- * Each action has one or more steps (when 0 items then the action is ignored). Each step performs a task.
- * The result of a task is passed to the next step as an input. The result of a task may be `void`, `null`,
- * or `undefined` which is treated as `void`.
- */
-export interface IHttpAction {
-  /**
-   * The description of the action
-   */
-  description?: string
-  /**
-   * The list of steps to perform. This is an ordered list of action tasks.
-   * Each step is described by the `kind` property which tells the runner what action to perform.
-   */
-  steps: IHttpStep[]
-}

package/src/models/http-flows/HttpStep.ts

@@ -1,50 +0,0 @@
-/**
- * The action that can be taken on the data.
- */
-export interface IHttpStep {
-  /**
-   * The kind of the action to perform.
-   */
-  kind: string
-  /**
-   * Whether the step is disabled in the flow.
-   */
-  enabled?: boolean
-}
-
-export abstract class HttpStep {
-  /**
-   * The kind of the action to perform.
-   */
-  kind = ''
-
-  /**
-   * Whether the step is disabled in the flow.
-   */
-  enabled?: boolean
-
-  new(init: IHttpStep): void {
-    const { kind, enabled } = init
-    this.kind = kind
-    if (typeof enabled === 'boolean') {
-      this.enabled = enabled
-    } else {
-      this.enabled = undefined
-    }
-  }
-
-  toJSON(): IHttpStep {
-    const result: IHttpStep = {
-      kind: this.kind,
-    }
-    if (typeof this.enabled === 'boolean') {
-      result.enabled = this.enabled
-    }
-    return result
-  }
-
-  /**
-   * A function that returns true when the step is valid and can be executed.
-   */
-  abstract checkValidity(): boolean
-}

package/src/models/http-flows/LegacyTranslator.ts

@@ -1,303 +0,0 @@
-/* eslint-disable @typescript-eslint/no-extraneous-class */
-import { RequestActions as LegacyRequestActions } from '../../models/legacy/request/ArcRequest.js'
-import {
-  RunnableAction as LegacyRunnable,
-  Condition as LegacyCondition,
-  Action as LegacyAction,
-  SetCookieConfig,
-  SetVariableConfig,
-  DeleteCookieConfig,
-  DataSourceConfiguration,
-} from '../../models/legacy/actions/Actions.js'
-import { IHttpFlow, IHttpAction, FlowSourceEnum, FlowRequestDataEnum, FlowResponseDataEnum } from './HttpFlows.js'
-import { AmfNamespace } from '@api-client/amf-core'
-import { IHttpStep } from './HttpStep.js'
-import { IReadDataStep, ReadDataStep, ReadDataStepKind } from './steps/data/ReadDataStep.js'
-import { ISetDataStep, SetDataStepKind } from './steps/data/SetDataStep.js'
-import { ISetCookieStep, SetCookieStepKind } from './steps/data/SetCookieStep.js'
-import { DeleteCookieStepKind, IDeleteCookieStep } from './steps/data/DeleteCookieStep.js'
-import { IncludesAssertion } from './steps/assertion/IncludesAssertion.js'
-import { EqualAssertion } from './steps/assertion/EqualAssertion.js'
-import { GreaterThanAssertion } from './steps/assertion/GreaterThanAssertion.js'
-import { LessThanAssertion } from './steps/assertion/LessThanAssertion.js'
-import { NotEqualAssertion } from './steps/assertion/NotEqualAssertion.js'
-import { MatchesAssertion } from './steps/assertion/MatchesAssertion.js'
-
-/**
- * Allows to translate the old ARC actions into Action flows.
- */
-export class LegacyTranslator {
-  static translate(action: LegacyRequestActions): IHttpFlow[] {
-    const { request, response } = action
-    const result: IHttpFlow[] = []
-
-    if (Array.isArray(request) && request.length) {
-      request.forEach((runnable, index) => {
-        const flow = this._runnableIntoFlow(runnable, 'request')
-        flow.description = `Translated flow ${index + 1}`
-        result.push(flow)
-      })
-    }
-
-    if (Array.isArray(response) && response.length) {
-      response.forEach((runnable, index) => {
-        const flow = this._runnableIntoFlow(runnable, 'response')
-        flow.description = `Translated flow ${index + 1}`
-        result.push(flow)
-      })
-    }
-    return result
-  }
-
-  protected static _runnableIntoFlow(runnable: LegacyRunnable, trigger: 'request' | 'response'): IHttpFlow {
-    const flow: IHttpFlow = {
-      trigger,
-      actions: [],
-    }
-    const { actions, condition } = runnable
-    if (condition) {
-      flow.condition = this._translateCondition(condition)
-    }
-    actions.forEach((action, index) => {
-      const current: IHttpAction = {
-        steps: this._translateAction(action),
-      }
-      if (action.name) {
-        current.description = action.name
-      } else {
-        current.description = `Translated action ${index + 1}`
-      }
-      flow.actions.push(current)
-    })
-    return flow
-  }
-
-  protected static _translateCondition(runnable: LegacyCondition): IHttpAction | undefined {
-    const { source, alwaysPass, operator, path, predictedValue, type } = runnable
-    if (alwaysPass) {
-      // in the flow, if there's no condition the steps are always executed.
-      return undefined
-    }
-    if (!path || !type) {
-      return undefined
-    }
-    if (!['request', 'response'].includes(type)) {
-      return
-    }
-
-    const result: IHttpAction = {
-      steps: [],
-    }
-    const readData = new ReadDataStep()
-    readData.source = type === 'request' ? FlowSourceEnum.request : FlowSourceEnum.response
-    readData.path = path
-    if (source) {
-      if (type === 'request') {
-        readData.data = source as FlowRequestDataEnum
-      } else if (type === 'response') {
-        readData.data = source as FlowResponseDataEnum
-      }
-    }
-    result.steps.push(readData.toJSON())
-    if (!operator) {
-      return result
-    }
-    if (operator === 'contains') {
-      const assertion = new IncludesAssertion()
-      if (predictedValue) {
-        assertion.value = String(predictedValue)
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'equal') {
-      const assertion = new EqualAssertion()
-      if (predictedValue) {
-        assertion.value = String(predictedValue)
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'not-equal') {
-      const assertion = new NotEqualAssertion()
-      if (predictedValue) {
-        assertion.value = String(predictedValue)
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'greater-than') {
-      const assertion = new GreaterThanAssertion()
-      if (predictedValue) {
-        const typed = Number(predictedValue)
-        if (!Number.isNaN(typed)) {
-          assertion.value = typed
-        }
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'greater-than-equal') {
-      const assertion = new GreaterThanAssertion()
-      assertion.equal = true
-      if (predictedValue) {
-        const typed = Number(predictedValue)
-        if (!Number.isNaN(typed)) {
-          assertion.value = typed
-        }
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'less-than') {
-      const assertion = new LessThanAssertion()
-      if (predictedValue) {
-        const typed = Number(predictedValue)
-        if (!Number.isNaN(typed)) {
-          assertion.value = typed
-        }
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'less-than-equal') {
-      const assertion = new LessThanAssertion()
-      assertion.equal = true
-      if (predictedValue) {
-        const typed = Number(predictedValue)
-        if (!Number.isNaN(typed)) {
-          assertion.value = typed
-        }
-      }
-      result.steps.push(assertion.toJSON())
-    } else if (operator === 'regex') {
-      const assertion = new MatchesAssertion()
-      if (predictedValue) {
-        assertion.value = String(predictedValue)
-      }
-      result.steps.push(assertion.toJSON())
-    }
-    return result
-  }
-
-  protected static _translateAction(item: LegacyAction): IHttpStep[] {
-    switch (item.name) {
-      case 'set-cookie':
-        return this._translateSetCookieAction(item)
-      case 'set-variable':
-        return this._translateSetVariableAction(item)
-      case 'delete-cookie':
-        return this._translateDeleteCookieAction(item)
-      default:
-        return []
-    }
-  }
-
-  protected static _translateSetCookieAction(item: LegacyAction): IHttpStep[] {
-    const legacy = item.config as SetCookieConfig
-
-    const steps: IHttpStep[] = []
-    const ds = this._translateDataSource(legacy.source)
-    steps.push(ds)
-
-    const action: ISetCookieStep = {
-      kind: SetCookieStepKind,
-      name: legacy.name,
-    }
-    if (item.enabled === false) {
-      action.enabled = item.enabled
-    }
-    if (legacy.url) {
-      action.url = legacy.url
-    }
-    if (legacy.expires) {
-      action.expires = legacy.expires
-    }
-    if (typeof legacy.hostOnly === 'boolean') {
-      action.hostOnly = legacy.hostOnly
-    }
-    if (typeof legacy.httpOnly === 'boolean') {
-      action.httpOnly = legacy.httpOnly
-    }
-    if (typeof legacy.secure === 'boolean') {
-      action.secure = legacy.secure
-    }
-    if (typeof legacy.session === 'boolean') {
-      action.session = legacy.session
-    }
-    steps.push(action)
-
-    return steps
-  }
-
-  protected static _translateSetVariableAction(item: LegacyAction): IHttpStep[] {
-    const legacy = item.config as SetVariableConfig
-
-    const steps: IHttpStep[] = []
-    const ds = this._translateDataSource(legacy.source)
-    steps.push(ds)
-
-    const action: ISetCookieStep = {
-      kind: SetCookieStepKind,
-      name: legacy.name,
-    }
-    if (item.enabled === false) {
-      action.enabled = item.enabled
-    }
-    steps.push(action)
-
-    return steps
-  }
-
-  protected static _translateDeleteCookieAction(item: LegacyAction): IHttpStep[] {
-    const legacy = item.config as DeleteCookieConfig
-
-    const steps: IHttpStep[] = []
-
-    const action: IDeleteCookieStep = {
-      kind: DeleteCookieStepKind,
-    }
-    if (item.enabled === false) {
-      action.enabled = item.enabled
-    }
-    if (legacy.name && !legacy.removeAll) {
-      action.name = legacy.name
-    }
-    if (legacy.url && !legacy.useRequestUrl) {
-      action.url = legacy.url
-    }
-    steps.push(action)
-
-    return steps
-  }
-
-  protected static _translateDataSource(source: DataSourceConfiguration): IHttpStep {
-    if (source.value) {
-      const dataSet: ISetDataStep = {
-        kind: SetDataStepKind,
-        value: source.value,
-        dataType: AmfNamespace.w3.xmlSchema.string,
-      }
-      return dataSet
-    }
-
-    // Note, there's no way for us to translate the old "iterator" configuration
-    // to the current syntax. We just drop it.
-
-    const { path, type, source: legacySource } = source
-    const result: IReadDataStep = {
-      kind: ReadDataStepKind,
-    }
-
-    if (typeof path === 'string') {
-      result.path = path
-    }
-    if (type) {
-      switch (type) {
-        case 'request':
-          result.source = FlowSourceEnum.request
-          break
-        case 'response':
-          result.source = FlowSourceEnum.response
-          break
-      }
-    }
-    if (type && legacySource) {
-      if (type === 'request') {
-        result.data = legacySource as FlowRequestDataEnum
-      }
-      if (type === 'response') {
-        result.data = legacySource as FlowResponseDataEnum
-      }
-    }
-    return result
-  }
-}

package/src/models/http-flows/steps/assertion/EqualAssertion.ts

@@ -1,124 +0,0 @@
-import { HttpStep, IHttpStep } from '../../HttpStep.js'
-
-export const EqualAssertionKind = 'HttpAction#EqualAssertion'
-
-/**
- * An assertion that makes sure the input value is [strict] equal to the set value.
- */
-export interface IEqualAssertion extends IHttpStep {
-  kind: typeof EqualAssertionKind
-
-  /**
-   * The value to compare to.
-   * This is always a string. Use the `dataType` to determine the correct data type.
-   */
-  value?: string
-
-  /**
-   * The data type of the value. This is a value prefixed with
-   * `http://www.w3.org/2001/XMLSchema#` or `http://a.ml/vocabularies/shapes#`.
-   *
-   * Examples:
-   *
-   * - `http://www.w3.org/2001/XMLSchema#boolean`
-   * - `http://www.w3.org/2001/XMLSchema#string`
-   * - `http://www.w3.org/2001/XMLSchema#number`
-   * - `http://www.w3.org/2001/XMLSchema#integer`
-   * - `http://www.w3.org/2001/XMLSchema#long`
-   * - `http://a.ml/vocabularies/shapes#number`
-   * - `http://a.ml/vocabularies/shapes#integer`
-   * - `http://a.ml/vocabularies/shapes#double`
-   * - ...
-   *
-   * @default `http://www.w3.org/2001/XMLSchema#string`
-   */
-  dataType?: string
-
-  /**
-   * Whether it should check for a value and the data type.
-   */
-  strict?: boolean
-}
-
-/**
- * An assertion that makes sure the input value is [strict] equal to the set value.
- */
-export class EqualAssertion extends HttpStep {
-  override kind = EqualAssertionKind
-
-  /**
-   * The value to compare to.
-   * This is always a string. Use the `dataType` to determine the correct data type.
-   */
-  value?: string
-
-  /**
-   * The data type of the value. This is a value prefixed with
-   * `http://www.w3.org/2001/XMLSchema#` or `http://a.ml/vocabularies/shapes#`.
-   *
-   * Examples:
-   *
-   * - `http://www.w3.org/2001/XMLSchema#boolean`
-   * - `http://www.w3.org/2001/XMLSchema#string`
-   * - `http://www.w3.org/2001/XMLSchema#number`
-   * - `http://www.w3.org/2001/XMLSchema#integer`
-   * - `http://www.w3.org/2001/XMLSchema#long`
-   * - `http://a.ml/vocabularies/shapes#number`
-   * - `http://a.ml/vocabularies/shapes#integer`
-   * - `http://a.ml/vocabularies/shapes#double`
-   * - ...
-   *
-   * @default `http://www.w3.org/2001/XMLSchema#string`
-   */
-  dataType?: string
-
-  /**
-   * Whether it should check for a value and the data type.
-   */
-  strict?: boolean
-
-  constructor(valueOrInit?: IEqualAssertion | string, strict?: boolean, dataType?: string) {
-    super()
-    if (typeof valueOrInit === 'object') {
-      const typed = valueOrInit as IEqualAssertion
-      this.new(typed)
-    } else if (typeof valueOrInit === 'string') {
-      this.new({
-        kind: EqualAssertionKind,
-        value: valueOrInit,
-        dataType,
-        strict,
-        enabled: true,
-      })
-    }
-  }
-
-  override new(init: IEqualAssertion): void {
-    super.new(init)
-    this.kind = EqualAssertionKind
-    this.value = init.value
-    this.dataType = init.dataType
-    this.strict = init.strict
-  }
-
-  checkValidity(): boolean {
-    return !!this.value
-  }
-
-  override toJSON(): IEqualAssertion {
-    const result: IEqualAssertion = {
-      ...super.toJSON(),
-      kind: EqualAssertionKind,
-    }
-    if (this.value) {
-      result.value = this.value
-    }
-    if (this.dataType) {
-      result.dataType = this.dataType
-    }
-    if (typeof this.strict === 'boolean') {
-      result.strict = this.strict
-    }
-    return result
-  }
-}