@api-client/core 0.6.29 → 0.7.0

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

@@ -1,216 +0,0 @@
-import { SetCookieConfig } from '../../legacy/actions/Actions.js';
-import { Runnable, IRunnable } from './Runnable.js';
-import { IDataSource } from '../Condition.js';
-import { RequestDataSourceEnum } from '../Enums.js';
-
-export const Kind = 'Core#SetCookieAction';
-
-export interface ISetCookieAction extends IRunnable {
-  kind?: typeof Kind;
-  /**
-   * Name of the cookie
-   */
-  name: string;
-  /**
-   * Source of the cookie value
-   */
-  source: IDataSource;
-  /**
-   * When set it uses request URL instead of defined URL in the action
-   */
-  useRequestUrl?: boolean;
-  /**
-   * An URL associated with the cookie
-   */
-  url?: string;
-  /**
-   * The cookie expiration time
-   */
-  expires?: string;
-  /**
-   * Whether the cookie is host only
-   */
-  hostOnly?: boolean;
-  /**
-   * Whether the cookie is HTTP only
-   */
-  httpOnly?: boolean;
-  /**
-   * Whether the cookie is HTTPS only
-   */
-  secure?: boolean;
-  /**
-   * Whether the cookie is a session cookie
-   */
-  session?: boolean;
-}
-
-export class SetCookieAction extends Runnable {
-  kind = Kind;
-  /**
-   * Name of the cookie
-   */
-  name = '';
-  /**
-   * Source of the cookie value
-   */
-  source: IDataSource = { source: RequestDataSourceEnum.url, };
-  /**
-   * When set it uses request URL instead of defined URL in the action
-   */
-  useRequestUrl?: boolean;
-  /**
-   * An URL associated with the cookie
-   */
-  url?: string;
-  /**
-   * The cookie expiration time
-   */
-  expires?: string;
-  /**
-   * Whether the cookie is host only
-   */
-  hostOnly?: boolean;
-  /**
-   * Whether the cookie is HTTP only
-   */
-  httpOnly?: boolean;
-  /**
-   * Whether the cookie is HTTPS only
-   */
-  secure?: boolean;
-  /**
-   * Whether the cookie is a session cookie
-   */
-  session?: boolean;
-
-  static fromLegacy(legacy: SetCookieConfig): SetCookieAction {
-    const source = ({ ...legacy.source } as unknown) as IDataSource;
-    // @ts-ignore
-    delete source.iterator;
-    // @ts-ignore
-    delete source.iteratorEnabled;
-    const init: ISetCookieAction = {
-      kind: Kind,
-      name: legacy.name,
-      source,
-    };
-    if (legacy.url) {
-      init.url = legacy.url;
-    }
-    if (typeof legacy.useRequestUrl === 'boolean') {
-      init.useRequestUrl = legacy.useRequestUrl;
-    }
-    if (legacy.expires) {
-      init.expires = legacy.expires;
-    }
-    if (typeof legacy.hostOnly === 'boolean') {
-      init.hostOnly = legacy.hostOnly;
-    }
-    if (typeof legacy.httpOnly === 'boolean') {
-      init.httpOnly = legacy.httpOnly;
-    }
-    if (typeof legacy.secure === 'boolean') {
-      init.secure = legacy.secure;
-    }
-    if (typeof legacy.session === 'boolean') {
-      init.session = legacy.session;
-    }
-    return new SetCookieAction(init);
-  }
-
-  constructor(input?: string | ISetCookieAction) {
-    super();
-    let init: ISetCookieAction;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        kind: Kind,
-        name: '',
-        source: { source: RequestDataSourceEnum.url, },
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: ISetCookieAction): void {
-    const { source={ source: RequestDataSourceEnum.url, }, name, useRequestUrl, url, expires, hostOnly, httpOnly, secure, session } = init;
-    this.source = source;
-    this.name = name;
-    if (typeof useRequestUrl === 'boolean') {
-      this.useRequestUrl = useRequestUrl;
-    }
-    if (url) {
-      this.url = url;
-    } else {
-      this.url = undefined;
-    }
-    if (expires) {
-      this.expires = expires;
-    } else {
-      this.expires = undefined;
-    }
-    if (typeof hostOnly === 'boolean') {
-      this.hostOnly = hostOnly;
-    } else {
-      this.hostOnly = undefined;
-    }
-    if (typeof httpOnly === 'boolean') {
-      this.httpOnly = httpOnly;
-    } else {
-      this.httpOnly = undefined;
-    }
-    if (typeof secure === 'boolean') {
-      this.secure = secure;
-    } else {
-      this.secure = undefined;
-    }
-    if (typeof session === 'boolean') {
-      this.session = session;
-    } else {
-      this.session = undefined;
-    }
-  }
-
-  toJSON(): ISetCookieAction {
-    const result: ISetCookieAction = {
-      kind: Kind,
-      source: this.source,
-      name: this.name,
-    };
-    if (this.url) {
-      result.url = this.url;
-    }
-    if (this.expires) {
-      result.expires = this.expires;
-    }
-    if (typeof this.useRequestUrl === 'boolean') {
-      result.useRequestUrl = this.useRequestUrl;
-    }
-    if (typeof this.hostOnly === 'boolean') {
-      result.hostOnly = this.hostOnly;
-    }
-    if (typeof this.httpOnly === 'boolean') {
-      result.httpOnly = this.httpOnly;
-    }
-    if (typeof this.secure === 'boolean') {
-      result.secure = this.secure;
-    }
-    if (typeof this.session === 'boolean') {
-      result.session = this.session;
-    }
-    return result;
-  }
-
-  isValid(): boolean {
-    const hasTarget = !!this.useRequestUrl || !!this.url;
-    if (!hasTarget) {
-      return hasTarget;
-    }
-    const { source } = this.source;
-    return !!source;
-  }
-}

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

@@ -1,81 +0,0 @@
-import { SetVariableConfig } from '../../legacy/actions/Actions.js';
-import { Runnable, IRunnable } from './Runnable.js';
-import { IDataSource } from '../Condition.js';
-import { RequestDataSourceEnum } from '../Enums.js';
-
-export const Kind = 'Core#SetVariableAction';
-
-export interface ISetVariableAction extends IRunnable {
-  kind?: typeof Kind;
-  /**
-   * Name of the variable to set
-   */
-  name: string;
-  /**
-   * Source of the cookie value
-   */
-  source: IDataSource;
-}
-
-export class SetVariableAction extends Runnable {
-  kind = Kind;
-  /**
-   * Name of the variable to set
-   */
-  name = '';
-  /**
-   * Source of the cookie value
-   */
-  source: IDataSource = { source: RequestDataSourceEnum.url, };
-
-  static fromLegacy(legacy: SetVariableConfig): SetVariableAction {
-    const source = ({ ...legacy.source } as unknown) as IDataSource;
-    // @ts-ignore
-    delete source.iterator;
-    // @ts-ignore
-    delete source.iteratorEnabled;
-    const init: ISetVariableAction = {
-      kind: Kind,
-      name: legacy.name,
-      source,
-    };
-    return new SetVariableAction(init);
-  }
-
-  constructor(input?: string | ISetVariableAction) {
-    super();
-    let init: ISetVariableAction;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        kind: Kind,
-        name: '',
-        source: { source: RequestDataSourceEnum.url, },
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: ISetVariableAction): void {
-    const { source={ source: RequestDataSourceEnum.url, }, name, } = init;
-    this.kind = Kind;
-    this.source = source;
-    this.name = name;
-  }
-
-  toJSON(): ISetVariableAction {
-    const result: ISetVariableAction = {
-      kind: Kind,
-      source: this.source,
-      name: this.name,
-    };
-    return result;
-  }
-
-  isValid(): boolean {
-    return !!this.name && !!this.source;
-  }
-}

package/src/models/arc/ArcHttpRequest.ts

@@ -1,121 +0,0 @@
-import { IRequest, Request } from "../Request.js";
-import v4 from "../../lib/uuid.js";
-import { HttpRequest, IHttpRequest } from "../HttpRequest.js";
-import { Thing } from "../Thing.js";
-
-export const Kind = 'Arc#ArcRequest';
-
-export interface IArcHttpRequest extends IRequest {
-  kind: typeof Kind;
-  key: string;
-}
-
-export class ArcHttpRequest extends Request {
-  kind = Kind;
-
-  /**
-   * The identifier of the request.
-   */
-  key = '';
-
-  /**
-   * Creates a project request from an URL.
-   * 
-   * @param url The Request URL. This is required.
-   */
-  static fromUrl(url: string): ArcHttpRequest {
-    const now: number = Date.now();
-    const request = new ArcHttpRequest({
-      key: v4(),
-      kind: Kind,
-      created: now,
-      updated: now,
-      expects: HttpRequest.fromBaseValues({ url, method: 'GET' }).toJSON(),
-      info: Thing.fromName(url).toJSON(),
-    });
-    return request;
-  }
-
-  /**
-   * Creates a project request from a name.
-   * 
-   * @param name The Request name.
-   */
-  static fromName(name: string): ArcHttpRequest {
-    const now: number = Date.now();
-    const request = new ArcHttpRequest({
-      key: v4(),
-      kind: Kind,
-      created: now,
-      updated: now,
-      expects: new HttpRequest().toJSON(),
-      info: Thing.fromName(name).toJSON(),
-    });
-    return request;
-  }
-
-  /**
-   * Creates a request from an HttpRequest definition.
-   * 
-   * @param info The request data.
-   */
-  static fromHttpRequest(info: IHttpRequest): ArcHttpRequest {
-    const now: number = Date.now();
-    const request = new ArcHttpRequest({
-      key: v4(),
-      kind: Kind,
-      created: now,
-      updated: now,
-      expects: HttpRequest.fromBaseValues({ method: info.method, url: info.url, headers: info.headers, payload: info.payload }).toJSON(),
-      info: Thing.fromName(info.url).toJSON(),
-    });
-    return request;
-  }
-
-  /**
-   * Creates a request for a schema of a Request.
-   */
-  static fromRequest(request: IArcHttpRequest): ArcHttpRequest {
-    const key = v4();
-    const init: IArcHttpRequest = { 
-      ...request, 
-      key, 
-      kind: Kind 
-    };
-    const result = new ArcHttpRequest(init);
-    return result;
-  }
-
-  constructor(input?: string | IArcHttpRequest) {
-    super(input);
-
-    let init: IArcHttpRequest | undefined;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    }
-    if (init) {
-      this.key = init.key || v4();
-    }
-    this.kind = Kind;
-  }
-
-  new(init: IArcHttpRequest): void {
-    super.new(init);
-    
-    const { key } = init;
-    this.key = key || v4();
-    this.kind = Kind;
-  }
-
-  toJSON(): IArcHttpRequest {
-    const request = super.toJSON();
-    const result: IArcHttpRequest = { 
-      ...request, 
-      key: this.key, 
-      kind: Kind 
-    };
-    return result;
-  }
-}

package/src/models/arc/readme.md

@@ -1,3 +0,0 @@
-# ARC models
-
-The modules used in the Advanced REST Client application.

package/src/runtime/actions/ActionRunner.ts

@@ -1,83 +0,0 @@
-import { Action } from '../../models/actions/Action.js';
-import { Runnable as ModelRunnable } from '../../models/actions/runnable/Runnable.js';
-import { IHttpRequest } from '../../models/HttpRequest.js';
-import { IRequestLog } from '../../models/RequestLog.js';
-import { Kind as DeleteCookieKind } from '../../models/actions/runnable/DeleteCookieAction.js';
-import { Kind as SetCookieKind } from '../../models/actions/runnable/SetCookieAction.js';
-import { Kind as SetVariableKind } from '../../models/actions/runnable/SetVariableAction.js';
-import { ActionRunnable } from './runnable/ActionRunnable.js';
-import { DeleteCookieRunnable } from './runnable/DeleteCookieRunnable.js';
-import { SetCookieRunnable } from './runnable/SetCookieRunnable.js';
-import { SetVariableRunnable } from './runnable/SetVariableRunnable.js';
-
-/**
- * A class that is responsible for running a single action.
- */
-export class ActionRunner {
-  action: Action;
-  eventTarget: EventTarget;
-
-  constructor(action: Action, eventTarget: EventTarget) {
-    this.action = action;
-    this.eventTarget = eventTarget;
-  }
-
-  async request(request: IHttpRequest): Promise<void> {
-    const runnable = this.getActionRunnable();
-    if (!runnable) {
-      throw new Error(`Invalid action configuration. The runnable configuration is not defined.`);
-    }
-    const { action } = this;
-    if (action.sync === false) {
-      this.requestAsync(runnable, request);
-      return;
-    }
-    await runnable.request(request);
-  }
-
-  async requestAsync(runnable: ActionRunnable, request: IHttpRequest): Promise<void> {
-    const { action } = this;
-    try {
-      await runnable.request(request);
-    } catch (e) {
-      const err = e as Error;
-      console.error(`Unable to run a request action: ${action.name || 'unknown name'}: ${err.message}`);
-    }
-  }
-
-  getActionRunnable(): ActionRunnable | undefined {
-    const { action, eventTarget } = this;
-    const config = action.config as ModelRunnable;
-    if (!config) {
-      return;
-    }
-    switch (config.kind) {
-      case DeleteCookieKind: return new DeleteCookieRunnable(config.toJSON(), eventTarget);
-      case SetCookieKind: return new SetCookieRunnable(config.toJSON(), eventTarget);
-      case SetVariableKind: return new SetVariableRunnable(config.toJSON(), eventTarget);
-    }
-  }
-
-  async response(log: IRequestLog): Promise<void> {
-    const runnable = this.getActionRunnable();
-    if (!runnable) {
-      throw new Error(`Invalid action configuration. The runnable configuration is not defined.`);
-    }
-    const { action } = this;
-    if (action.sync === false) {
-      this.responseAsync(runnable, log);
-      return;
-    }
-    await runnable.response(log);
-  }
-
-  async responseAsync(runnable: ActionRunnable, log: IRequestLog): Promise<void> {
-    const { action } = this;
-    try {
-      await runnable.response(log);
-    } catch (e) {
-      const err = e as Error;
-      console.error(`Unable to run a response action: ${action.name || 'unknown name'}: ${err.message}`);
-    }
-  }
-}

package/src/runtime/actions/RunnableCondition.ts

@@ -1,56 +0,0 @@
-import { IRunnableAction, RunnableAction } from '../../models/actions/RunnableAction.js';
-import { IHttpRequest } from '../../models/HttpRequest.js';
-import { IResponse } from '../../models/Response.js';
-import { ISentRequest } from '../../models/SentRequest.js';
-import { IErrorResponse } from '../../models/ErrorResponse.js';
-import { RequestDataExtractor } from '../../data/RequestDataExtractor.js';
-import { checkCondition } from './ConditionRunner.js';
-
-/**
- * A class that represents API Client condition that runs actions when the condition is met.
- */
-export class RunnableCondition extends RunnableAction {
-  /**
-   * Tests whether the condition is satisfied for request and/or response.
-   *
-   * @param request The API Client request object.
-   * @param response The API Client response object, if available.
-   * @return True when the condition is satisfied.
-   */
-  async satisfied(request: IHttpRequest | ISentRequest, response?: IResponse | IErrorResponse): Promise<boolean> {
-    if (this.enabled === false) {
-      return false;
-    }
-    if (this.condition.alwaysPass === true) {
-      return true;
-    }
-    const extractor = new RequestDataExtractor(request, response);
-    const value = await extractor.extract(this.condition);
-    
-    const op = this.condition.operator;
-    if (!op || !this.condition.value) {
-      return false;
-    }
-    return checkCondition(value, op, this.condition.value);
-  }
-}
-
-/**
- * Maps runnables interface to 
- * If an item is not an instance of `RunnableCondition` then it creates an instance of it
- * by passing the map as an argument.
- *
- * @param value Passed list of actions.
- * @returns Mapped actions.
- */
-export const mapRunnables = (value: (IRunnableAction | RunnableCondition)[]): RunnableCondition[] => {
-  if (!Array.isArray(value)) {
-    return [];
-  }
-  return value.map((item) => {
-    if (!(item instanceof RunnableCondition)) {
-      return new RunnableCondition(item as IRunnableAction);
-    }
-    return item;
-  });
-};

package/src/runtime/actions/runnable/ActionRunnable.ts

@@ -1,19 +0,0 @@
-import { IHttpRequest } from '../../../models/HttpRequest.js';
-import { IRequestLog } from '../../../models/RequestLog.js';
-
-export abstract class ActionRunnable {
-  /**
-   * The specific action configuration.
-   * This depends on the action.
-   */
-  config: unknown;
-  eventTarget: EventTarget;
-
-  constructor(config: unknown, eventTarget: EventTarget) {
-    this.config = Object.freeze(config);
-    this.eventTarget = eventTarget;
-  }
-
-  abstract request(request: IHttpRequest): Promise<void>;
-  abstract response(log: IRequestLog): Promise<void>;
-}

package/src/runtime/actions/runnable/DeleteCookieRunnable.ts

@@ -1,39 +0,0 @@
-import { IHttpRequest } from '../../../models/HttpRequest.js';
-import { ActionRunnable } from './ActionRunnable.js';
-import { IDeleteCookieAction } from '../../../models/actions/runnable/DeleteCookieAction.js';
-import { Events } from '../../../events/Events.js';
-import { IRequestLog } from '../../../models/RequestLog.js';
-
-export class DeleteCookieRunnable extends ActionRunnable {
-  async response(log: IRequestLog): Promise<void> {
-    if (!log.request) {
-      return;
-    }
-    const config = this.config as IDeleteCookieAction;
-    let url;
-    if (config.useRequestUrl) {
-      url = log.request.url;
-    } else {
-      url = config.url;
-    }
-    if (!url) {
-      return;
-    }
-    Events.Cookie.deleteUrl(url, config.name, this.eventTarget);
-  }
-
-  async request(request: IHttpRequest): Promise<void> {
-    const config = this.config as IDeleteCookieAction;
-
-    let url;
-    if (config.useRequestUrl) {
-      url = request.url;
-    } else {
-      url = config.url;
-    }
-    if (!url) {
-      return;
-    }
-    Events.Cookie.deleteUrl(url, config.name, this.eventTarget);
-  } 
-}