@api-client/core 0.6.29 → 0.7.0

package/src/lib/cookies/Utils.ts

@@ -1,168 +0,0 @@
-import { Cookie } from './Cookie.js';
-
-/**
- * Gets the path for a domain as defined in
- * https://tools.ietf.org/html/rfc6265#section-5.1.4
- *
- * @param urlValue A url to extract path from.
- */
-export function getPath(urlValue: string): string {
-  let url = urlValue;
-  const defaultValue = '/';
-  if (!url) {
-    return defaultValue;
-  }
-  let index = url.indexOf('/', 8); // after `http(s)://` string
-  if (index === -1) {
-    return defaultValue;
-  }
-  url = url.substr(index);
-  if (!url || url[0] !== '/') {
-    return defaultValue;
-  }
-  // removed query string
-  index = url.indexOf('?');
-  if (index !== -1) {
-    url = url.substr(0, index);
-  }
-  // removes hash string
-  index = url.indexOf('#');
-  if (index !== -1) {
-    url = url.substr(0, index);
-  }
-  index = url.indexOf('/', 1);
-  if (index === -1) {
-    return defaultValue;
-  }
-  index = url.lastIndexOf('/');
-  if (index !== 0) {
-    url = url.substr(0, index);
-  }
-  return url;
-}
-
-/**
- * Checks if `domain` of the request url (defined as `this.url`)
- * matches domain defined in a cookie.
- * This follows algorithm defined in https://tools.ietf.org/html/rfc6265#section-5.1.3
- *
- * Note: If `cookieDomain` is not set it returns false, while
- * (according to the spec) it should be set to `domain` and pass the test.
- * Because this function only check if domains matches it will not
- * override domain.
- * Cookie domain should be filled before calling this function.
- *
- * Note: This function will return false if the `this.url` was not set.
- *
- * @param cookieDomain A domain received in the cookie.
- * @param uri
- * @return True if domains matches.
- */
-export function matchesDomain(cookieDomain: string, uri: URL): boolean {
-  if (!uri) {
-    return false;
-  }
-  let domain = uri.hostname;
-  domain = domain && domain.toLowerCase && domain.toLowerCase();
-  // eslint-disable-next-line no-param-reassign
-  cookieDomain =
-    cookieDomain && cookieDomain.toLowerCase && cookieDomain.toLowerCase();
-  if (!cookieDomain) {
-    return false;
-  }
-  if (domain === cookieDomain) {
-    return true;
-  }
-  if (cookieDomain[0] === '.') {
-    const parts = domain.split('.');
-    if (parts.length > 1) {
-      parts.shift();
-      domain = parts.join('.');
-    }
-  }
-  const index = cookieDomain.indexOf(domain);
-  if (index === -1) {
-    return false;
-  }
-  if (cookieDomain.substr(index - 1, index) !== '.') {
-    return false;
-  }
-  return true;
-}
-
-/**
- * Checks if paths mach as defined in
- * https://tools.ietf.org/html/rfc6265#section-5.1.4
- *
- * Note: This function will return false if the `this.url` was not set.
- *
- * @param cookiePath Path from the cookie.
- * @param uri
- * @param url
- * @return True when paths matches.
- */
-export function matchesPath(cookiePath: string, uri: URL, url: string): boolean {
-  if (!uri) {
-    return false;
-  }
-  if (!cookiePath) {
-    return true;
-  }
-  const hostPath = getPath(url);
-  if (hostPath === cookiePath) {
-    return true;
-  }
-  // const index = cookiePath.indexOf(hostPath);
-  const index = hostPath.indexOf(cookiePath);
-  if (index === 0 && cookiePath[cookiePath.length - 1] === '/') {
-    return true;
-  }
-  if (index === 0 && cookiePath.indexOf('/', 1) === -1) {
-    return true;
-  }
-
-  if (index === 0) {
-    // eslint-disable-next-line no-plusplus
-    for (let i = 0, len = hostPath.length; i < len; i++) {
-      if (cookiePath.indexOf(hostPath[i]) === -1 && hostPath[i] === '/') {
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
-/**
- * Clients must fill `path` and `domain` attribute if not set by the
- * server to match current request url.
- *
- * @param uri HTTP request url parsed by the URL class.
- * @param url The HTTP request url.
- * @param cookies Parsed cookies
- */
-export function fillCookieAttributes(uri: URL, url: string, cookies: Cookie[]): void {
-  if (!uri) {
-    return;
-  }
-  let domain = uri.hostname;
-  if (!domain) {
-    return;
-  }
-  domain = domain.toLowerCase();
-  const path = getPath(url);
-  cookies.forEach((cookie) => {
-    if (!cookie.path) {
-      // eslint-disable-next-line no-param-reassign
-      cookie.path = path;
-    }
-    const cDomain = cookie.domain;
-    if (!cDomain) {
-      // eslint-disable-next-line no-param-reassign
-      cookie.domain = domain;
-      // point 6. of https://tools.ietf.org/html/rfc6265#section-5.3
-      // eslint-disable-next-line no-param-reassign
-      cookie.hostOnly = true;
-    }
-    return cookie;
-  });
-}

package/src/mocking/lib/Arc.ts

@@ -1,34 +0,0 @@
-import { Types, IDataMockInit, IHttpRequestInit } from '@pawel-up/data-mock';
-import { IArcHttpRequest, Kind as ArcHttpRequestKind } from '../../models/arc/ArcHttpRequest.js';
-import { Request } from './Request.js';
-
-export class Arc {
-  protected request: Request;
-  protected types: Types;
-
-  constructor(init: IDataMockInit={}) {
-    this.request = new Request(init);
-    this.types = new Types(init.seed);
-    // this.lorem = new Lorem(init);
-    // this.time = new Time(init);
-    // this.http = new Http(init);
-    // this.response = new Response(init);
-  }
-
-  arcRequest(init?: IHttpRequestInit): IArcHttpRequest {
-    const request = this.request.request(init);
-    return {
-      key: this.types.uuid(),
-      ...request,
-      kind: ArcHttpRequestKind,
-    };
-  }
-
-  arcRequests(size = 25, init?: IHttpRequestInit): IArcHttpRequest[] {
-    const result: IArcHttpRequest[] = [];
-    for (let i = 0; i < size; i++) {
-      result.push(this.arcRequest(init));
-    }
-    return result;
-  }
-}

package/src/models/RequestActions.ts

@@ -1,161 +0,0 @@
-import { IRunnableAction, RunnableAction, Kind as RunnableActionKind } from './actions/RunnableAction.js';
-import { RequestActions as LegacyRequestActions } from './legacy/request/ArcRequest.js';
-
-export interface IRequestActions {
-  /**
-   * Actions to be executed before the request is sent to the transport library.
-   */
-  request?: IRunnableAction[];
-  /**
-   * Actions to be executed after the response is fully received but before it is reported back to the application.
-   */
-  response?: IRunnableAction[];
-}
-
-export class RequestActions {
-  /**
-   * Actions to be executed before the request is sent to the transport library.
-   */
-  request?: RunnableAction[];
-  /**
-   * Actions to be executed after the response is fully received but before it is reported back to the application.
-   */
-  response?: RunnableAction[];
-
-  static fromLegacy(action: LegacyRequestActions): RequestActions {
-    const { request, response } = action;
-    const init: IRequestActions = {};
-    if (Array.isArray(request) && request.length) {
-      init.request = request.map(i => RunnableAction.fromLegacy(i).toJSON());
-    }
-    if (Array.isArray(response) && response.length) {
-      init.response = response.map(i => RunnableAction.fromLegacy(i).toJSON());
-    }
-    return new RequestActions(init);
-  }
-
-  static isLegacy(input: unknown): boolean {
-    const { request=[], response=[] } = input as RequestActions;
-    if (!request.length && !response.length) {
-      return false;
-    }
-    if (request[0]) {
-      const r = request[0];
-      if (r.kind === RunnableActionKind) {
-        return false;
-      }
-    }
-    if (response[0]) {
-      const r = response[0];
-      if (r.kind === RunnableActionKind) {
-        return false;
-      }
-    }
-    return true;
-  }
-
-  /**
-   * @param input The request actions definition used to restore the state.
-   */
-  constructor(input?: string | IRequestActions) {
-    let init: IRequestActions;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {};
-    }
-    this.new(init);
-  }
-
-  /**
-   * Creates a new request actions clearing anything that is so far defined.
-   */
-  new(init: IRequestActions): void {
-    const { request, response } = init;
-    if (request) {
-      this.request = request.map(i => new RunnableAction(i));
-    } else {
-      this.request = undefined;
-    }
-    if (response) {
-      this.response = response.map(i => new RunnableAction(i));
-    } else {
-      this.response = undefined;
-    }
-  }
-
-  toJSON(): IRequestActions {
-    const result: IRequestActions = {};
-    if (this.request) {
-      result.request = this.request.map(i => i.toJSON());
-    }
-    if (this.response) {
-      result.response = this.response.map(i => i.toJSON());
-    }
-    return result;
-  }
-
-  /**
-   * Adds a request action to the list of actions.
-   * If the list does not exist it's created by this method.
-   * 
-   * @param action The schema of the action.
-   * @returns Created instance of the action.
-   */
-  addRequestAction(action: IRunnableAction): RunnableAction;
-  /**
-   * Adds a request action to the list of actions.
-   * If the list does not exist it's created by this method.
-   * 
-   * @param action The instance of the action.
-   * @returns The same instance of the action.
-   */
-  addRequestAction(action: RunnableAction): RunnableAction;
-
-  addRequestAction(action: RunnableAction | IRunnableAction): RunnableAction {
-    if (!Array.isArray(this.request)) {
-      this.request = [];
-    }
-    let finalAction: RunnableAction;
-    if (action instanceof RunnableAction) {
-      finalAction = action;
-    } else {
-      finalAction = new RunnableAction(action);
-    }
-    this.request.push(finalAction);
-    return finalAction;
-  }
-
-  /**
-   * Adds a request action to the list of actions.
-   * If the list does not exist it's created by this method.
-   * 
-   * @param action The schema of the action.
-   * @returns Created instance of the action.
-   */
-  addResponseAction(action: IRunnableAction): RunnableAction;
-  /**
-   * Adds a response action to the list of actions.
-   * If the list does not exist it's created by this method.
-   * 
-   * @param action The instance of the action.
-   * @returns The same instance of the action.
-   */
-  addResponseAction(action: RunnableAction): RunnableAction;
-
-  addResponseAction(action: RunnableAction | IRunnableAction): RunnableAction {
-    if (!Array.isArray(this.response)) {
-      this.response = [];
-    }
-    let finalAction: RunnableAction;
-    if (action instanceof RunnableAction) {
-      finalAction = action;
-    } else {
-      finalAction = new RunnableAction(action);
-    }
-    this.response.push(finalAction);
-    return finalAction;
-  }
-}

package/src/models/actions/Action.ts

@@ -1,213 +0,0 @@
-import { IActions } from './runnable/index.js';
-import { Runnable, IRunnable } from './runnable/Runnable.js';
-import { Kind as DeleteCookieKind, DeleteCookieAction, IDeleteCookieAction } from './runnable/DeleteCookieAction.js';
-import { Kind as SetCookieKind, SetCookieAction, ISetCookieAction } from './runnable/SetCookieAction.js';
-import { Kind as SetVariableKind, SetVariableAction, ISetVariableAction } from './runnable/SetVariableAction.js';
-import { Action as LegacyAction, SetCookieConfig, SetVariableConfig, DeleteCookieConfig } from '../legacy/actions/Actions.js';
-
-export const Kind = 'Core#Action';
-
-/**
- * An interface representing a single action.
- */
-export interface IAction {
-  kind?: typeof Kind;
-  /**
-   * Action name.
-   */
-  name?: string;
-  /**
-   * Whether the action is enabled.
-   * An action is enabled by default.
-   * @default true
-   */
-  enabled?: boolean;
-  /**
-   * Action priority. The higher number the higher priority of execution.
-   */
-  priority?: number;
-  /**
-   * The action configuration. The schema depends on the action type.
-   */
-  config?: unknown;
-  /**
-   * Whether or not the action is executed synchronously to request / response
-   */
-  sync?: boolean;
-  /**
-   * Whether or not the request should fail when the action fails.
-   */
-  failOnError?: boolean;
-}
-
-export class Action {
-  kind = Kind;
-  /**
-   * Action name.
-   */
-  name?: string;
-  /**
-   * Whether the action is enabled.
-   */
-  enabled?: boolean;
-  /**
-   * Action priority. The higher number the higher priority of execution.
-   */
-  priority?: number;
-  /**
-   * Action configuration
-   */
-  config?: Runnable;
-  /**
-   * Whether or not the action is executed synchronously to request / response
-   */
-  sync?: boolean;
-  /**
-   * Whether or not the request should fail when the action fails.
-   */
-  failOnError?: boolean;
-
-  static fromLegacy(item: LegacyAction): Action {
-    const { priority, config, enabled, failOnError, name, sync } = item;
-    let newConfig: IRunnable | undefined;
-    switch (name) {
-      case 'set-cookie': newConfig = SetCookieAction.fromLegacy(config as SetCookieConfig).toJSON(); break;
-      case 'set-variable': newConfig = SetVariableAction.fromLegacy(config as SetVariableConfig); break;
-      case 'delete-cookie': newConfig = DeleteCookieAction.fromLegacy(config as DeleteCookieConfig); break;
-    }
-    
-    const init: IAction = {
-      kind: Kind,
-      priority,
-    };
-    if (typeof enabled === 'boolean') {
-      init.enabled = enabled;
-    }
-    if (typeof failOnError === 'boolean') {
-      init.failOnError = failOnError;
-    }
-    if (typeof sync === 'boolean') {
-      init.sync = sync;
-    }
-    if (typeof name === 'string') {
-      init.name = name;
-    }
-    if (newConfig) {
-      init.config = newConfig;
-    }
-    return new Action(init);
-  }
-
-  /**
-   * Creates a default configuration of an action
-   */
-  static defaultAction(): Action {
-    const init: IAction = {
-      name: 'New action',
-      failOnError: false,
-      priority: 0,
-      sync: false,
-      enabled: true,
-    };
-    return new Action(init);
-  }
-
-  constructor(input?: string | IAction) {
-    let init: IAction;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        kind: Kind,
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: IAction): void {
-    const { name, enabled, priority, sync, failOnError, config } = init;
-    this.kind = Kind;
-    if (name) {
-      this.name = name;
-    } else {
-      this.name = undefined;
-    }
-    if (typeof enabled === 'boolean') {
-      this.enabled = enabled;
-    } else {
-      this.enabled = undefined;
-    }
-    if (typeof sync === 'boolean') {
-      this.sync = sync;
-    } else {
-      this.sync = undefined;
-    }
-    if (typeof failOnError === 'boolean') {
-      this.failOnError = failOnError;
-    } else {
-      this.failOnError = undefined;
-    }
-    if (typeof priority === 'number') {
-      this.priority = priority;
-    } else {
-      this.priority = undefined;
-    }
-    if (config) {
-      this.setConfig(config);
-    } else {
-      this.config = undefined;
-    }
-  }
-
-  toJSON(): IAction {
-    const result: IAction = {
-      kind: Kind,
-    };
-    if (this.name) {
-      result.name = this.name;
-    }
-    if (this.config) {
-      result.config = this.config.toJSON() as IActions;
-    }
-    if (typeof this.enabled === 'boolean') {
-      result.enabled = this.enabled;
-    }
-    if (typeof this.sync === 'boolean') {
-      result.sync = this.sync;
-    }
-    if (typeof this.failOnError === 'boolean') {
-      result.failOnError = this.failOnError;
-    }
-    if (typeof this.priority === 'number') {
-      result.priority = this.priority;
-    }
-    return result;
-  }
-
-  setConfig(config: unknown): void {
-    const { kind } = config as IRunnable;
-    switch (kind) {
-      case DeleteCookieKind: this.config = new DeleteCookieAction(config as IDeleteCookieAction); break;
-      case SetCookieKind: this.config = new SetCookieAction(config as ISetCookieAction); break;
-      case SetVariableKind: this.config = new SetVariableAction(config as ISetVariableAction); break;
-      default: throw new Error(`Unknown action config.`)
-    }
-  }
-
-  /**
-   * The sort function for actions to sort them for the execution order.
-   */
-  static sortActions(a: Action, b: Action): number {
-    const { priority: p1=0 } = a;
-    const { priority: p2=0 } = b;
-    if (p1 > p2) {
-      return 1;
-    }
-    if (p2 > p1) {
-      return -1;
-    }
-    return 0;
-  }
-}

package/src/models/actions/ActionView.ts

@@ -1,40 +0,0 @@
-export interface IActionView {
-  /**
-   * Whether the action is "opened" in the editor UI.
-   */
-  opened?: boolean;
-}
-
-export class ActionView {
-  /**
-   * Whether the action is "opened" in the editor UI.
-   */
-  opened?: boolean;
-
-  constructor(input?: string|IActionView) {
-    let init: IActionView;
-    if (typeof input === 'string') {
-      init = JSON.parse(input);
-    } else if (typeof input === 'object') {
-      init = input;
-    } else {
-      init = {
-        opened: false,
-      };
-    }
-    this.new(init);
-  }
-
-  new(init: IActionView): void {
-    const { opened=false } = init;
-    this.opened = opened;
-  }
-
-  toJSON(): IActionView {
-    const result: IActionView = {};
-    if (typeof this.opened === 'boolean') {
-      result.opened = this.opened;
-    }
-    return result;
-  }
-}