@api-client/core 0.6.29 → 0.7.0

package/src/lib/cookies/Cookie.ts

@@ -1,312 +0,0 @@
-import { CookieSameSiteType } from '../../models/HttpCookie.js';
-
-/**
- * Cookie creation options.
- */
-export interface CookieOptions {
-  'max-age'?: number;
-  /**
-   * When the cookie expires.
-   * Note that this value is parsed to a timestamp in the Cookie class.
-   */
-  expires?: Date | number | string;
-  /**
-   * A string representing the domain the cookie belongs to
-   * (e.g. "www.google.com", "example.com")
-   */
-  domain?: string;
-  /**
-   * Cookie path
-   */
-  path?: string;
-  /**
-   * A boolean, `true` if the cookie is marked as secure
-   * (i.e. its scope is limited to secure channels, typically HTTPS),
-   * or `false` otherwise.
-   */
-  secure?: boolean;
-  /**
-   * A boolean, `true` if the cookie is marked as HttpOnly
-   * (i.e. the cookie is inaccessible to client-side scripts),
-   * or `false` otherwise.
-   */
-  httpOnly?: boolean;
-  /**
-   * A boolean, `true` if the cookie is a `host-only` cookie
-   * (i.e. the request's host must exactly match the domain of the cookie),
-   * or `false` otherwise.
-   */
-  hostOnly?: boolean;
-  /**
-   * The SameSite attribute of the Set-Cookie HTTP response header allows you to declare if your cookie should be restricted to a first-party or same-site context.
-   */
-  sameSite?: CookieSameSiteType;
-}
-
-/* eslint-disable no-control-regex */
-const fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
-
-/**
- * A Cookie object.
- * It is based on https://github.com/pillarjs/cookies/blob/master/lib/cookies.js
- */
-export class Cookie {
-  protected _maxAge?: number;
-  protected _expires: number;
-  protected _domain?: string;
-  name: string;
-  value: string;
-  created: number;
-  lastAccess: number;
-  persistent?: boolean;
-  hostOnly?: boolean;
-  path?: string;
-  secure?: boolean;
-  httpOnly?: boolean;
-  sameSite?: CookieSameSiteType;
-
-  /**
-   * Constructs a new cookie.
-   *
-   * @param name Cookie name
-   * @param value Cookie value
-   * @param opts Additional cookie attributes.
-   */
-  constructor(name: string, value = '', opts: CookieOptions = {}) {
-    if (!fieldContentRegExp.test(name)) {
-      throw new TypeError('Argument `name` is invalid');
-    }
-    if (value && !fieldContentRegExp.test(value)) {
-      throw new TypeError('Argument `value` is invalid');
-    }
-    if (opts.path && !fieldContentRegExp.test(opts.path)) {
-      throw new TypeError('Option `path` is invalid');
-    }
-    if (opts.domain && !fieldContentRegExp.test(opts.domain)) {
-      throw new TypeError('Option `domain` is invalid');
-    }
-    this._expires = 0;
-    this._domain = undefined;
-    this._maxAge = undefined;
-    this.name = name;
-    this.value = value;
-    this.created = Date.now();
-    this.lastAccess = this.created;
-
-    if ('max-age' in opts) {
-      this.maxAge = opts['max-age'];
-    } else if (typeof opts.expires !== 'undefined') {
-      this.setExpires(opts.expires);
-    } else {
-      this.persistent = false;
-      // see http://stackoverflow.com/a/11526569/1127848
-      this._expires = new Date(8640000000000000).getTime();
-    }
-    if ('hostOnly' in opts) {
-      this.hostOnly = opts.hostOnly;
-    }
-    if ('domain' in opts) {
-      this.domain = opts.domain;
-    } else {
-      this.hostOnly = false;
-    }
-    if ('path' in opts) {
-      this.path = opts.path;
-    }
-    if ('secure' in opts) {
-      this.secure = opts.secure;
-    }
-    if ('httpOnly' in opts) {
-      this.httpOnly = opts.httpOnly;
-    }
-    if ('sameSite' in opts) {
-      this.sameSite = opts.sameSite;
-    }
-  }
-
-  /**
-   * @param max The max age value
-   */
-  set maxAge(max: number | undefined) {
-    const typedMax = Number(max);
-    if (Number.isNaN(typedMax)) {
-      return;
-    }
-    this._maxAge = typedMax;
-    if (typedMax <= 0) {
-      // see http://stackoverflow.com/a/11526569/1127848
-      // and https://tools.ietf.org/html/rfc6265#section-5.2.2
-      this._expires = new Date(-8640000000000000).getTime();
-    } else {
-      let now = Date.now();
-      now += typedMax * 1000;
-      this._expires = now;
-    }
-    this.persistent = true;
-  }
-
-  /**
-   * @return Returns a value of maxAge property
-   */
-  get maxAge(): number | undefined {
-    return this._maxAge;
-  }
-
-  get ['max-age'](): number | undefined {
-    return this.maxAge;
-  }
-
-  set ['max-age'](value: number | undefined) {
-    this.maxAge = value;
-  }
-
-  /**
-   * @param expires The value for expires
-   */
-  set expires(expires: number | Date | string) {
-    const any = expires as unknown;
-    if ((expires && typeof any === 'string') || any instanceof Date) {
-      this.setExpires(any);
-      return;
-    }
-    this._expires = expires as number;
-    this.persistent = true;
-  }
-
-  /**
-   * @return the current expires value
-   */
-  get expires(): number {
-    return this._expires;
-  }
-
-  /**
-   * @param domain The cookie domain
-   */
-  set domain(domain: string | undefined) {
-    this._domain = domain;
-    if (!domain) {
-      this.hostOnly = false;
-    } else {
-      this.hostOnly = true;
-    }
-  }
-
-  /**
-   * @return The cookie domain
-   */
-  get domain(): string | undefined {
-    return this._domain;
-  }
-
-  get samesite(): CookieSameSiteType | undefined {
-    return this.sameSite;
-  }
-
-  set samesite(value: CookieSameSiteType | undefined) {
-    this.sameSite = value;
-  }
-
-  get httponly(): boolean | undefined {
-    return this.httpOnly;
-  }
-
-  set httponly(value: boolean | undefined) {
-    this.httpOnly = value;
-  }
-
-  get hostonly(): boolean | undefined {
-    return this.hostOnly;
-  }
-
-  set hostonly(value: boolean | undefined) {
-    this.hostOnly = value;
-  }
-
-  /**
-   * @return Cookie's `name=value` string.
-   */
-  toString(): string {
-    const { name, value } = this;
-    return `${name}=${value}`;
-  }
-
-  /**
-   * Returns a Cookie as a HTTP header string.
-   * @return Cookie string as a HTTP header value
-   */
-  toHeader(): string {
-    let header = this.toString();
-    let expires;
-    if (this._expires) {
-      expires = new Date(this._expires);
-      if (expires.toString() === 'Invalid Date') {
-        expires = new Date(0);
-      }
-    }
-    if (expires) {
-      header += `; expires=${expires.toUTCString()}`;
-    }
-    const { path, domain, httpOnly, sameSite, secure } = this;
-    if (path) {
-      header += `; path=${path}`;
-    }
-    if (domain) {
-      header += `; domain=${domain}`;
-    }
-    if (httpOnly) {
-      header += `; httpOnly=${httpOnly}`;
-    }
-    if (sameSite) {
-      header += `; SameSite=${sameSite}`;
-    }
-    if (secure) {
-      header += `; Secure`;
-    }
-    return header;
-  }
-
-  /**
-   * Override toJSON behaviour so it will eliminate
-   * all _* properties and replace it with a proper ones.
-   *
-   * @return {object}
-   */
-  toJSON(): Record<string, string> {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const copy: any = {};
-    const keys: (keyof Cookie)[] = Object.keys(this) as (keyof Cookie)[];
-    keys.forEach((key) => {
-      if (key.indexOf('_') === 0) {
-        const realKey = key.substring(1);
-        copy[realKey] = this[key];
-      } else {
-        copy[key] = this[key];
-      }
-    });
-    return copy;
-  }
-
-  /**
-   * Sets value for `expirers` propr from other types.
-   * @param expires The value for `expires`
-   */
-  setExpires(expires: Date | string | number): void {
-    let value: number;
-    if (expires instanceof Date) {
-      value = expires.getTime();
-    } else if (typeof expires === 'string') {
-      const tmp = new Date(expires);
-      if (tmp.toString() === 'Invalid Date') {
-        value = 0;
-      } else {
-        value = tmp.getTime();
-      }
-    } else if (typeof expires === 'number') {
-      value = expires;
-    } else {
-      value = 0;
-    }
-    this.expires = value;
-  }
-}

package/src/lib/cookies/Cookies.ts

@@ -1,326 +0,0 @@
-import { Cookie, CookieOptions } from './Cookie.js';
-import {
-  getPath,
-  matchesDomain,
-  matchesPath,
-  fillCookieAttributes,
-} from './Utils.js';
-
-export const urlSymbol = Symbol('url');
-
-/**
- * A library to handle Cookie parsing.
- */
-export class Cookies {
-  cookies: Cookie[];
-  uri: URL | undefined;
-
-  [urlSymbol]: string | undefined;
-
-  /**
-   * Constructs an object.
-   *
-   * @param header A HTTP cookie string to parse.
-   * @param url A request url for this cookie. If empty some cookie computations (like checking if cookies matches) will be omitted.
-   */
-  constructor(header = '', url?: string) {
-    /**
-     * A base URL for this object.
-     */
-    this.url = url;
-
-    /**
-     * A list of parsed cookies.
-     */
-    this.cookies = Cookies.parse(header);
-    if (this.uri && url) {
-      fillCookieAttributes(this.uri, url, this.cookies);
-    }
-  }
-
-  /**
-   * Set's the URL and parses it setting `uri` property.
-   * @param url Cookie URL
-   */
-  set url(url: string | undefined) {
-    if (url) {
-      this[urlSymbol] = url;
-      this.uri = new URL(url);
-    } else {
-      this[urlSymbol] = undefined;
-      this.uri = undefined;
-    }
-  }
-
-  /**
-   * @returns {string} Cookie URL
-   */
-  get url(): string | undefined {
-    return this[urlSymbol];
-  }
-
-  /**
-   * Parses a cookie string to a list of Cookie objects.
-   *
-   * @param cookies A HTTP cookie string
-   * @returns List of parsed cookies.
-   */
-  static parse(cookies: string): Cookie[] {
-    const cookieParts: (keyof Cookie)[] = [
-      'path',
-      'domain',
-      'max-age',
-      'expires',
-      'secure',
-      'httponly',
-      'samesite',
-      'hostonly',
-    ];
-    const booleanParts: (keyof Cookie)[] = [
-      'secure', 'httponly', 'hostonly'
-    ];
-    const list: Cookie[] = [];
-    if (!cookies || !cookies.trim()) {
-      return list;
-    }
-    const blocks = cookies.split(';').map(i => i.trim());
-    blocks.forEach((part, index) => {
-      // Consider the following set-cookie string:
-      // c1=v1; Path=/; Expires=Wed, 09 Feb 2022 01:30:04 GMT; HttpOnly,c2=v2; Path=/,c3=v3; Path=/; Secure; SameSite=Strict
-      // It is a valid set-cookie header event though it mixes different formatting making it harder to parse cookies.
-      // This loop looks for invalid parts and creates a canonical cookie parts array.
-      const periodIndex = part.indexOf(',');
-      if (periodIndex === -1) {
-        return;
-      }
-      if (part.toLowerCase().startsWith('expires=')) {
-        return;
-      }
-      const tmp = part.split(',');
-      // remove current
-      blocks.splice(index, 1);
-      // add the new two
-      blocks.splice(index, 0, ...tmp);
-    });
-
-    blocks.forEach((cookie) => {
-      const parts = cookie.split(/=/, 2);
-      if (parts.length === 0) {
-        return;
-      }
-      const name = decodeURIComponent(parts[0].trim());
-      if (!name) {
-        return;
-      }
-      const lowerName = name.toLowerCase() as keyof Cookie;
-      let value: string | boolean | undefined;
-      if (parts.length > 1) {
-        try {
-          value = decodeURIComponent(parts[1].trim());
-        } catch (e) {
-          value = parts[1];
-        }
-      } else {
-        value = true;
-      }
-      // if this is an attribute of previous cookie, set it for last
-      // added cookie.
-      if (cookieParts.includes(lowerName)) {
-        if (list.length - 1 >= 0) {
-          const attr = lowerName as keyof Cookie;
-          const previousCookie = list[list.length - 1];
-          previousCookie[attr] = value as never;
-        }
-      } else {
-        try {
-          list.push(new Cookie(name, value as string));
-        } catch (e) {
-          // ..
-        }
-      }
-    });
-    return list;
-  }
-
-  /**
-   * Get a cookie by name.
-   *
-   * @param name Cookie name
-   * @returns A Cookie object or null.
-   */
-  get(name: string): Cookie | null {
-    const { cookies } = this;
-    // eslint-disable-next-line no-plusplus
-    for (let i = 0, len = cookies.length; i < len; i++) {
-      if (cookies[i].name === name) {
-        return cookies[i];
-      }
-    }
-    return null;
-  }
-
-  /**
-   * Adds a cookie to the list of cookies.
-   *
-   * @param name Name of the cookie.
-   * @param value Value of the cookie.
-   * @param opts Other cookie options to set.
-   */
-  set(name: string, value?: string, opts?: CookieOptions): void {
-    const cookie = new Cookie(name, value, opts);
-    const cookies = this.cookies.filter((c) => c.name !== name);
-    cookies.push(cookie);
-    this.cookies = cookies;
-  }
-
-  /**
-   * Returns a string that can be used in a HTTP header value for Cookie.
-   * The structure of the cookie string depends on if you want to send a
-   * cookie from the server to client or other way around.
-   * When you want to send the `Cookie` header to server set
-   * `toServer` argument to true. Then it will produce only `name=value;`
-   * string. Otherwise it will be the `Set-Cookie` header value
-   * containing all other cookies properties.
-   *
-   * @param toServer True if produced string is to be used with the `Cookie` header
-   * @returns HTTP header string value for all cookies.
-   */
-  toString(toServer = false): string {
-    const parts: string[] = [];
-    this.cookies.forEach((cookie) => {
-      parts.push(toServer ? cookie.toString() : cookie.toHeader());
-    });
-    return parts.join('; ');
-  }
-
-  /**
-   * Removes cookies from `this.cookies` that has been set for different
-   * domain and path.
-   * This function has no effect if the URL is not set.
-   *
-   * This function follows an algorithm defined in https://tools.ietf.org/html/rfc6265 for
-   * domain match.
-   *
-   * @returns A list of removed cookies.
-   */
-  filter(): Cookie[] {
-    const { uri, url } = this;
-    if (!uri || !url) {
-      return [];
-    }
-    const domain = uri.hostname.toLowerCase();
-    const path = getPath(url);
-    const removed: Cookie[] = [];
-    this.cookies = this.cookies.filter((cookie) => {
-      if (!cookie.path) {
-        cookie.path = path;
-      }
-      const cDomain = cookie.domain;
-      if (!cDomain) {
-        cookie.domain = domain;
-        // point 6. of https://tools.ietf.org/html/rfc6265#section-5.3
-        cookie.hostOnly = true;
-        return true;
-      }
-      const res =
-        matchesDomain(cDomain, uri) && matchesPath(cookie.path, uri, url);
-      if (!res) {
-        removed.push(cookie);
-      }
-      return res;
-    });
-    return removed;
-  }
-
-  /**
-   * Merges this cookies with another Cookies object.
-   * This cookies will be overwritten by passed cookies according to
-   * the HTTP spec.
-   * This function is useful when you need to override cookies with
-   * the response from the server
-   * as defined in the https://tools.ietf.org/html/rfc6265.
-   *
-   * @param cookies An Cookies object with newest cookies.
-   * @param copyKeys When set, it copies values for given keys from old object to the new one.
-   */
-  merge(cookies: Cookies, copyKeys: (keyof Cookie)[] = []): void {
-    if (!cookies || !cookies.cookies || cookies.cookies.length === 0) {
-      return;
-    }
-    if (!this.cookies || this.cookies.length === 0) {
-      this.cookies = cookies.cookies;
-      return;
-    }
-    const foreignDomain = cookies.uri ? cookies.uri.hostname : null;
-    const foreignPath = cookies.url ? getPath(cookies.url) : null;
-    // delete cookies from this.cookies that has the same name as new ones,
-    // but are domain/path match
-    const newCookies: Cookie[] = cookies.cookies;
-    const nLength: number = newCookies.length;
-
-    const { uri, url } = this;
-    if (!uri || !url) {
-      return;
-    }
-    const copyKeysLength = copyKeys.length;
-    for (let i = this.cookies.length - 1; i >= 0; i--) {
-      const tName = this.cookies[i].name;
-      for (let j = 0; j < nLength; j++) {
-        const targetCookie = newCookies[j];
-        const nName = targetCookie.name;
-        if (nName !== tName) {
-          continue;
-        }
-        if (!foreignDomain || !matchesDomain(foreignDomain, uri)) {
-          // This is cookie for a different domain. Don't override.
-          continue;
-        }
-        if (!foreignPath || !matchesPath(foreignPath, uri, url)) {
-          // This is cookie for a different path. Don't override.
-          continue;
-        }
-        const removed = this.cookies.splice(i, 1);
-        targetCookie.created = removed[0].created;
-        if (copyKeysLength) {
-          for (let k = 0; k < copyKeysLength; k++) {
-            const key = copyKeys[k];
-            if (key in removed[0]) {
-              targetCookie[key] = removed[0][key] as never;
-            }
-          }
-        }
-        break;
-      }
-    }
-    // Do not re-set cookies that values are not set.
-    for (let i = nLength - 1; i >= 0; i--) {
-      const nValue = newCookies[i].value;
-      if (!nValue || !nValue.trim || !nValue.trim()) {
-        newCookies.splice(i, 1);
-      }
-    }
-    this.cookies = this.cookies.concat(newCookies);
-  }
-
-  /**
-   * Clears cookies from `this.cookies` that already expired.
-   *
-   * @returns List of removed (expired) cookies.
-   */
-  clearExpired(): Cookie[] {
-    const now = Date.now();
-    const expired: Cookie[] = [];
-    const cookies = this.cookies.filter((cookie) => {
-      if (!cookie.expires) {
-        return true;
-      }
-      if (now >= cookie.expires) {
-        expired.push(cookie);
-        return false;
-      }
-      return true;
-    });
-    this.cookies = cookies;
-    return expired;
-  }
-}