@api-client/core 0.6.30 → 0.7.1

package/src/models/actions/Condition.ts

@@ -1,207 +0,0 @@
-import { ActionTypeEnum, RequestDataSourceEnum, ResponseDataSourceEnum, OperatorEnum } from './Enums.js';
-import { Condition as LegacyCondition } from '../legacy/actions/Actions.js';
-
-export const Kind = 'Core#Condition';
-
-/**
- * A base interface describing a configuration to extract data from a request or a response.
- */
-export interface IDataSource {
-  /**
-   * The main data source. Either the request or the response object.
-   * This is required when the `source` is not equal to `value. In this case it is ignored
-   */
-  type?: ActionTypeEnum;
-  /**
-   * Source of the data.
-   */
-  source: RequestDataSourceEnum | ResponseDataSourceEnum | 'value';
-  /**
-   * The path to the data.
-   * For JSON value use https://jmespath.org/ syntax.
-   * For XML use xpath.
-   * For any other use a simple path to the data separated by dot (e.g. headers.content-type)
-   */
-  path?: string;
-  /**
-   * Only used when the `source` is `value`. The data extraction always returns this value.
-   */
-  value?: string;
-}
-
-/**
- * Describes action's condition configuration.
- */
-export interface ICondition extends IDataSource {
-  kind: typeof Kind,
-  /**
-   * The comparison operator.
-   */
-  operator?: OperatorEnum;
-  /**
-   * Whether the condition always pass.
-   * The condition is not really checked, values can be empty. The condition check always returns `true`.
-   */
-  alwaysPass?: boolean;
-}
-
-export class Condition {
-  kind = Kind;
-  /**
-   * The main data source. Either the request or the response object.
-   * This is required when the `source` is not equal to `value. In this case it is ignored
-   */
-  type?: ActionTypeEnum;
-  /**
-   * Source of the data.
-   */
-  source: RequestDataSourceEnum | ResponseDataSourceEnum | 'value' = RequestDataSourceEnum.url;
-  /** 
-   * The path to the data.
-   * For JSON value use https://jmespath.org/ syntax.
-   * For XML use xpath.
-   * For any other use a simple path to the data separated by dot (e.g. headers.content-type)
-   */
-  path?: string;
-  /**
-   * Only used when the `source` is `value`. The data extraction always returns this value.
-   */
-  value?: string;
-  /**
-   * The comparison operator.
-   */
-  operator?: OperatorEnum;
-  /**
-   * Whether the condition always pass.
-   * The condition is not really checked, values can be empty. The condition check always returns `true`.
-   */
-  alwaysPass?: boolean;
-
-  static defaultCondition(type=ActionTypeEnum.response): Condition {
-    const init: ICondition = {
-      kind: Kind,
-      type,
-      source: RequestDataSourceEnum.url,
-      operator: OperatorEnum.equal,
-      path: '',
-      alwaysPass: false,
-    };
-    return new Condition(init);
-  }
-
-  static fromLegacy(runnable: LegacyCondition): Condition {
-    const { source, alwaysPass, operator, path, predictedValue, type, value } = runnable;
-    const init: ICondition = {
-      kind: Kind,
-      source: source as RequestDataSourceEnum | ResponseDataSourceEnum | 'value',
-    };
-    if (typeof alwaysPass === 'boolean') {
-      init.alwaysPass = alwaysPass;
-    }
-    if (typeof path === 'string') {
-      init.path = path;
-    }
-    if (path === 'value') {
-      init.value = String(value);
-    } else {
-      init.value = String(predictedValue);
-    }
-    if (operator) {
-      switch (operator) {
-        case 'contains': init.operator = OperatorEnum.contains; break;
-        case 'equal': init.operator = OperatorEnum.equal; break;
-        case 'greater-than': init.operator = OperatorEnum.greaterThan; break;
-        case 'greater-than-equal': init.operator = OperatorEnum.greaterThanEqual; break;
-        case 'less-than': init.operator = OperatorEnum.lessThan; break;
-        case 'less-than-equal': init.operator = OperatorEnum.lessThanEqual; break;
-        case 'not-equal': init.operator = OperatorEnum.notEqual; break;
-        case 'regex': init.operator = OperatorEnum.regex; break;
-      }
-    }
-    if (type) {
-      switch (type) {
-        case 'request': init.type = ActionTypeEnum.request; break;
-        case 'response': init.type = ActionTypeEnum.response; break;
-      }
-    }
-    return new Condition(init);
-  }
-
-  static alwaysPass(type=ActionTypeEnum.request): Condition {
-    const init: ICondition = {
-      kind: Kind,
-      type,
-      source: 'value',
-      alwaysPass: true,
-    };
-    return new Condition(init);
-  }
-
-  constructor(input?: string | ICondition) {
-    let init: ICondition;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        kind: Kind,
-        source: RequestDataSourceEnum.url,
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: ICondition): void {
-    const { source = RequestDataSourceEnum.url, alwaysPass, operator, path, type, value } = init;
-    this.source = source;
-    if (typeof alwaysPass === 'boolean') {
-      this.alwaysPass = alwaysPass;
-    } else {
-      this.alwaysPass = undefined;
-    }
-    if (operator) {
-      this.operator = operator;
-    } else {
-      this.operator = undefined;
-    }
-    if (typeof path === 'string') {
-      this.path = path;
-    } else {
-      this.path = undefined;
-    }
-    if (type) {
-      this.type = type;
-    } else {
-      this.type = undefined;
-    }
-    if (value) {
-      this.value = value;
-    } else {
-      this.value = undefined;
-    }
-  }
-
-  toJSON(): ICondition {
-    const result: ICondition = {
-      source: this.source,
-      kind: Kind,
-    };
-    if (this.type) {
-      result.type = this.type;
-    }
-    if (this.path) {
-      result.path = this.path;
-    }
-    if (this.value) {
-      result.value = this.value;
-    }
-    if (this.operator) {
-      result.operator = this.operator;
-    }
-    if (typeof this.alwaysPass === 'boolean') {
-      result.alwaysPass = this.alwaysPass;
-    }
-    return result;
-  }
-}

package/src/models/actions/ConditionView.ts

@@ -1,42 +0,0 @@
-export interface IConditionView {
-  /**
-   * Whether the condition editor is rendered in the "full" view
-   * instead of the summary.
-   */
-  opened?: boolean;
-}
-
-export class ConditionView {
-  /**
-   * Whether the condition editor is rendered in the "full" view
-   * instead of the summary.
-   */
-  opened?: boolean;
-
-  constructor(input?: string|IConditionView) {
-    let init: IConditionView;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        opened: false,
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: IConditionView): void {
-    const { opened=false } = init;
-    this.opened = opened;
-  }
-
-  toJSON(): IConditionView {
-    const result: IConditionView = {};
-    if (typeof this.opened === 'boolean') {
-      result.opened = this.opened;
-    }
-    return result;
-  }
-}

package/src/models/actions/Enums.ts

@@ -1,29 +0,0 @@
-export enum ActionTypeEnum {
-  request = 'request',
-  response = 'response',
-}
-
-export enum OperatorEnum {
-  equal = "equal",
-  notEqual = "not-equal",
-  greaterThan = "greater-than",
-  greaterThanEqual = "greater-than-equal",
-  lessThan = "less-than",
-  lessThanEqual = "less-than-equal",
-  contains = "contains",
-  regex = "regex",
-}
-
-export enum RequestDataSourceEnum {
-  url = "url",
-  method = "method",
-  headers = "headers",
-  body = "body"
-}
-
-export enum ResponseDataSourceEnum {
-  url = "url",
-  status = "status",
-  headers = "headers",
-  body = "body"
-}

package/src/models/actions/RunnableAction.ts

@@ -1,144 +0,0 @@
-import { ICondition, Condition } from './Condition.js';
-import { IAction, Action } from './Action.js';
-import { RunnableAction as LegacyRunnable } from '../legacy/actions/Actions.js';
-
-export const Kind = 'Core#RunnableAction';
-
-/**
- * An interface representing a runnable set of action in a condition.
- * For the actions to be executed the condition first has to be met.
- * The condition can be configured to always pass by setting the `alwaysPass` property.
- */
-export interface IRunnableAction {
-  kind?: typeof Kind;
-  /**
-   * The condition to be checked when executing the runnable,
-   */
-  condition: ICondition;
-  /**
-   * The list of actions to execute.
-   */
-  actions: IAction[];
-  /**
-   * Whether the entire runnable is enabled. This is checked before the condition is executed.
-   * An action is enabled by default.
-   */
-  enabled?: boolean;
-}
-
-export class RunnableAction {
-  kind = Kind;
-  /**
-   * The condition to be checked when executing the runnable,
-   */
-  condition: Condition = new Condition();
-  /**
-   * The list of actions to execute.
-   */
-  actions: Action[] = [];
-  /**
-   * Whether the entire runnable is enabled. This is checked before the condition is executed.
-   */
-  enabled?: boolean;
-
-  static fromLegacy(runnable: LegacyRunnable): RunnableAction {
-    const result = new RunnableAction();
-    result.fromLegacy(runnable);
-    return result;
-  }
-
-  constructor(input?: string | IRunnableAction) {
-    let init: IRunnableAction;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        kind: Kind,
-        condition: new Condition().toJSON(),
-        actions: [],
-        enabled: true,
-      };
-    }
-    if (init.kind === Kind) {
-      this.new(init);
-    } else {
-      this.fromLegacy((init as unknown) as LegacyRunnable);
-    }
-  }
-
-  new(init: IRunnableAction): void {
-    const { enabled, condition, actions } = init;
-    this.enabled = enabled;
-    if (condition) {
-      this.condition = new Condition(condition);
-    } else {
-      this.condition = new Condition();
-    }
-    if (Array.isArray(actions)) {
-      this.actions = actions.map(i => new Action(i));
-    } else {
-      this.actions = [];
-    }
-  }
-
-  toJSON(): IRunnableAction {
-    const result: IRunnableAction = {
-      condition: this.condition.toJSON(),
-      actions: this.actions.map(i => i.toJSON()),
-      kind: Kind,
-    };
-    if (typeof this.enabled === 'boolean') {
-      result.enabled = this.enabled;
-    }
-    return result;
-  }
-
-  fromLegacy(runnable: LegacyRunnable): void {
-    const { actions, condition, enabled } = runnable;
-    if (typeof enabled === 'boolean') {
-      this.enabled = enabled;
-    }
-    if (condition) {
-      this.condition = Condition.fromLegacy(condition);
-    } else {
-      this.condition = new Condition();
-    }
-    if (Array.isArray(actions) && actions.length) {
-      this.actions = actions.map(i => Action.fromLegacy(i));
-    } else {
-      this.actions = [];
-    }
-  }
-
-  /**
-   * Adds a new action to the list of runnable action.
-   * 
-   * @param schema The schema of the action
-   * @returns Created instance of the action.
-   */
-  addAction(schema: IAction): Action;
-
-  /**
-   * Adds a new action to the list of runnable action.
-   * 
-   * @param schema The instance of the action
-   * @returns The same instance of the action.
-   */
-  addAction(instance: Action): Action;
-  
-  addAction(value: Action | IAction): Action {
-    if (!Array.isArray(this.actions)) {
-      this.actions = [];
-    }
-    let finalAction: Action;
-    if (value instanceof Action) {
-      finalAction = value;
-    } else {
-      finalAction = new Action(value);
-    }
-    this.actions.push(finalAction);
-    return finalAction;
-  }
-}

package/src/models/actions/runnable/DeleteCookieAction.ts

@@ -1,113 +0,0 @@
-import { DeleteCookieConfig } from '../../legacy/actions/Actions.js';
-import { Runnable, IRunnable } from './Runnable.js';
-
-export const Kind = 'Core#DeleteCookieAction';
-
-export interface IDeleteCookieAction extends IRunnable {
-  kind?: typeof Kind;
-  /**
-   * When set it uses request URL instead of defined URL in the action.
-   */
-  useRequestUrl?: boolean;
-  /**
-   * An URL associated with the cookie.
-   * Only used when `useRequestUrl` is not `true`.
-   * Either `url` or `useRequestUrl` must be set for the action to be considered valid.
-   */
-  url?: string;
-  /**
-   * Name of the cookie to remove.
-   * When not set it removes all cookies.
-   */
-  name?: string;
-}
-
-export class DeleteCookieAction extends Runnable {
-  kind = Kind;
-  /**
-   * When set it uses request URL instead of defined URL in the action.
-   */
-  useRequestUrl?: boolean;
-  /**
-   * An URL associated with the cookie.
-   * Only used when `useRequestUrl` is not `true`.
-   * Either `url` or `useRequestUrl` must be set for the action to be considered valid.
-   */
-  url?: string;
-  /**
-   * Name of the cookie to remove.
-   * When not set it removes all cookies.
-   */
-  name?: string;
-
-  isValid(): boolean {
-    return !!this.useRequestUrl || !!this.url;
-  }
-
-  static fromLegacy(legacy: DeleteCookieConfig): DeleteCookieAction {
-    const init: IDeleteCookieAction = {
-      kind: Kind,
-      name: legacy.name,
-    };
-    if (legacy.url) {
-      init.url = legacy.url;
-    }
-    if (typeof legacy.useRequestUrl === 'boolean') {
-      init.useRequestUrl = legacy.useRequestUrl;
-    }
-    if (legacy.removeAll) {
-      delete init.name;
-    }
-    return new DeleteCookieAction(init);
-  }
-
-  constructor(input?: string | IDeleteCookieAction) {
-    super();
-    let init: IDeleteCookieAction;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        kind: Kind,
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: IDeleteCookieAction): void {
-    const { useRequestUrl, url, name } = init;
-    if (typeof useRequestUrl === 'boolean') {
-      this.useRequestUrl = useRequestUrl;
-    } else {
-      this.useRequestUrl = undefined;
-    }
-    if (url) {
-      this.url = url;
-    } else {
-      this.url = undefined;
-    }
-    if (name) {
-      this.name = name;
-    } else {
-      this.name = undefined;
-    }
-  }
-
-  toJSON(): IDeleteCookieAction {
-    const result: IDeleteCookieAction = {
-      kind: Kind,
-    };
-    if (this.url) {
-      result.url = this.url;
-    }
-    if (this.name) {
-      result.name = this.name;
-    }
-    if (typeof this.useRequestUrl === 'boolean') {
-      result.useRequestUrl = this.useRequestUrl;
-    }
-    return result;
-  }
-}

package/src/models/actions/runnable/Runnable.ts

@@ -1,9 +0,0 @@
-export interface IRunnable {
-  kind?: unknown;
-}
-
-export abstract class Runnable {
-  kind: unknown;
-  abstract isValid(): boolean;
-  abstract toJSON(): unknown;
-}