@api-client/core 0.5.17 → 0.5.20

package/src/events/models/ModelEventTypes.ts

@@ -10,38 +10,4 @@ export const ModelEventTypes = {
       delete: 'storestateclientcertificatedelete',
     }),
   }),
-  Project: Object.freeze({
-    create: 'storeprojectcreate',
-    read: 'storeprojectread',
-    update: 'storeprojectupdate',
-    delete: 'storeprojectdelete',
-    /** 
-     * Moves objects inside a project between position and/or folders.
-     */
-    move: 'storeprojectmove',
-    /** 
-     * Makes a copy of the project and stores it as new.
-     */
-    clone: 'storeprojectclone',
-    listAll: 'storeprojectlistall', // without pagination
-    Folder: Object.freeze({
-      create: 'storeprojectfoldercreate',
-      delete: 'storeprojectfolderdelete',
-      update: 'storeprojectfolderupdate',
-    }),
-    Request: Object.freeze({
-      create: 'storeprojectrequestcreate',
-      delete: 'storeprojectrequestdelete',
-      update: 'storeprojectrequestupdate',
-    }),
-    Environment: Object.freeze({
-      create: 'storeprojectenvironmentcreate',
-      delete: 'storeprojectenvironmentdelete',
-      update: 'storeprojectenvironmentupdate',
-    }),
-    State: Object.freeze({
-      update: 'storeprojectstateupdate',
-      delete: 'storeprojectstatedelete',
-    })
-  }),
 }

package/src/events/models/ModelEvents.ts

@@ -1,7 +1,5 @@
 import { ClientCertificateEvents } from './ClientCertificateEvents.js';
-import { ProjectEvents } from './ProjectEvents.js';
 
 export const ModelEvents = Object.freeze({
-  Project: ProjectEvents,
   ClientCertificate: ClientCertificateEvents,
 });

package/src/lib/Buffer.ts

@@ -0,0 +1,48 @@
+/**
+ * Converts base64 string to Uint8Array.
+ * 
+ * @returns The restored array view.
+ */
+export function base64ToBuffer(str: string): Uint8Array {
+  const asciiString = atob(str);
+  return new Uint8Array([...asciiString].map((char) => char.charCodeAt(0)));
+}
+
+/**
+ * Converts incoming data to base64 string.
+ * 
+ * @returns Safe to store string.
+ */
+export function bufferToBase64(view: Buffer | Uint8Array): string {
+  const str = view.reduce(
+    (data, byte) => data + String.fromCharCode(byte),
+    ''
+  );
+  return btoa(str);
+}
+
+/**
+ * Reads file as ArrayBuffer
+ */
+export function fileToBuffer(blob: Blob): Promise<Uint8Array> {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onload = (): void => { resolve(new Uint8Array(reader.result as ArrayBuffer)); };
+    /* istanbul ignore next */
+    reader.onerror = (): void => { reject(new Error('Unable to read file')); };
+    reader.readAsArrayBuffer(blob);
+  });
+}
+
+/**
+ * Reads file as string
+ */
+export function fileToString(blob: Blob): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onload = (): void => { resolve(reader.result as string); };
+    /* istanbul ignore next */
+    reader.onerror = (): void => { reject(new Error('Unable to read file')); };
+    reader.readAsText(blob);
+  });
+}

package/src/lib/definitions/HttpDefinitions.ts

@@ -0,0 +1,63 @@
+import { requestHeaders, responseHeaders, statusCodes, IHeaderDefinition, IStatusCodeDefinition } from '../headers/HeadersData.js';
+
+/**
+ * Queries for headers containing a `query`. If query is not set
+ * (value is falsy) then it returns all headers definitions array.
+ *
+ * @param query A query to search for in the `key` field of the headers array.
+ * @param type If this equals `request` then it will look in the request headers array. Is the response headers list otherwise.
+ * @returns Array of the headers of selected `type` matched a `query` in a header's `key` field.
+ */
+export function queryHeaders(type: 'request' | 'response', query?: string): IHeaderDefinition[] {
+  const headers = type === 'request' ? requestHeaders : responseHeaders;
+  if (!query) {
+    return headers;
+  }
+  const lowerQuery = query.trim().toLowerCase();
+  return headers.filter(
+    (item) => item.key.toLowerCase().indexOf(lowerQuery) !== -1
+  );
+}
+
+/**
+ * Queries for request headers that contains a `query`. If query is
+ * not set (value is falsy) then it returns all headers definitions array.
+ *
+ * @param name A header name to look for. It will match a header where the header name contains the `name` param.
+ * @returns Array of the request headers matched `name` in the header's `key` field.
+ */
+export function queryRequestHeaders(name?: string): IHeaderDefinition[] {
+  return queryHeaders('request', name);
+}
+
+/**
+ * Queries for response headers that contains a `query`. If query is
+ * not set (value is falsy) then it returns all headers definitions array.
+ *
+ * @param name A header name to look for. It will match a header where the header name contains the `name` param.
+ * @returns Array of the response headers matched `name` in the header's `key` field.
+ */
+export function queryResponseHeaders(name?: string): IHeaderDefinition[] {
+  return queryHeaders('response', name);
+}
+
+/**
+ * Convenient function to look for a status code in the array.
+ *
+ * @param codeArg The status code to look for.
+ * @returns Status code definition or null if not found.
+ */
+export function getStatusCode(codeArg: number): IStatusCodeDefinition|IStatusCodeDefinition[]|null {
+  if (!codeArg) {
+    return statusCodes;
+  }
+  const code = Number(codeArg);
+  if (Number.isNaN(code)) {
+    return null;
+  }
+  const res = statusCodes.filter((item) => item.key === code);
+  if (!res.length) {
+    return null;
+  }
+  return res[0];
+}

package/src/lib/headers/Headers.ts

@@ -55,8 +55,8 @@ function* headersStringToList(string: string): Generator<string[]> {
     if (sepPosition === -1) {
       yield [line, ''];
     } else {
-      const name = line.substr(0, sepPosition);
-      const value = line.substr(sepPosition + 1).trim();
+      const name = line.substring(0, sepPosition);
+      const value = line.substring(sepPosition + 1).trim();
       yield [name, value];
     }
   }
@@ -70,7 +70,8 @@ export class Headers {
   /**
    * The keys are canonical keys and the values are the input values.
    */
-  map: Record<string, RawValue> = {};
+  _map: Record<string, RawValue> = {};
+
   /**
    * @param headers The headers to parse.
    */
@@ -99,7 +100,7 @@ export class Headers {
     }
     const normalizedName = normalizeName(name);
     value = value ? normalizeValue(value) : '';
-    let item = this.map[normalizedName];
+    let item = this._map[normalizedName];
     if (item) {
       const oldValue = item.value;
       item.value = oldValue ? `${oldValue},${value}` : value;
@@ -109,7 +110,7 @@ export class Headers {
         value,
       };
     }
-    this.map[normalizedName] = item;
+    this._map[normalizedName] = item;
   }
 
   /**
@@ -117,7 +118,7 @@ export class Headers {
    * @param name The header name
    */
   delete(name: string): void {
-    delete this.map[normalizeName(name)];
+    delete this._map[normalizeName(name)];
   }
 
   /**
@@ -126,14 +127,14 @@ export class Headers {
    */
   get(name: string): string | undefined {
     name = normalizeName(name);
-    return this.has(name) ? this.map[name].value : undefined;
+    return this.has(name) ? this._map[name].value : undefined;
   }
 
   /**
    * Checks if the header exists.
    */
   has(name: string): boolean {
-    return Object.prototype.hasOwnProperty.call(this.map, normalizeName(name));
+    return Object.prototype.hasOwnProperty.call(this._map, normalizeName(name));
   }
 
   /**
@@ -141,7 +142,7 @@ export class Headers {
    */
   set(name: string, value: string): void {
     const normalizedName = normalizeName(name);
-    this.map[normalizedName] = {
+    this._map[normalizedName] = {
       value: normalizeValue(value),
       name,
     };
@@ -151,11 +152,28 @@ export class Headers {
    * Iterates over each header.
    */
   forEach(callback: (value: string, name: string, headers: Headers) => void, thisArg?: unknown): void {
-    for (const name in this.map) {
-      if (Object.prototype.hasOwnProperty.call(this.map, name)) {
-        callback.call(thisArg, this.map[name].value, this.map[name].name, this);
-      }
+    const keys = Object.keys(this._map);
+    keys.forEach((key) => {
+      const item = this._map[key];
+      callback.call(thisArg, item.value, item.name, this);
+    });
+  }
+
+  /**
+   * Calls a defined callback function on each element of the headers, and returns an array that contains the results.
+   * 
+   * @param callbackfn A function that accepts up to two arguments. The map method calls the callbackfn function one time for each header.
+   * @param thisArg An object to which the `this` keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+   */
+  map<U>(callbackfn: (name: string, value: string) => U, thisArg?: any): U[] {
+    const keys = Object.keys(this._map);
+    const results: U[] = [];
+    for (const name of keys) {
+      const item = this._map[name];
+      const cbReturn = callbackfn.call(thisArg, item.value, item.name);
+      results.push(cbReturn);
     }
+    return results;
   }
 
   /**
@@ -163,13 +181,15 @@ export class Headers {
    */
   toString(): string {
     const result: string[] = [];
-    this.forEach((value, name) => {
-      let tmp = `${name}: `;
-      if (value) {
-        tmp += value;
+    const keys = Object.keys(this._map);
+    for (const name of keys) {
+      const item = this._map[name];
+      let tmp = `${item.name}: `;
+      if (item.value) {
+        tmp += item.value;
       }
       result.push(tmp);
-    });
+    }
     return result.join('\n');
   }
 
@@ -177,10 +197,9 @@ export class Headers {
    * Iterates over keys.
    */
   *keys(): IterableIterator<string> {
-    for (const name in this.map) {
-      if (Object.prototype.hasOwnProperty.call(this.map, name)) {
-        yield this.map[name].name;
-      }
+    const keys = Object.keys(this._map);
+    for (const name of keys) {
+      yield this._map[name].name;
     }
   }
 
@@ -188,10 +207,9 @@ export class Headers {
    * Iterates over values.
    */
   *values(): IterableIterator<string> {
-    for (const name in this.map) {
-      if (Object.prototype.hasOwnProperty.call(this.map, name)) {
-        yield this.map[name].value;
-      }
+    const keys = Object.keys(this._map);
+    for (const name of keys) {
+      yield this._map[name].value;
     }
   }
 
@@ -199,10 +217,9 @@ export class Headers {
    * Iterates over headers.
    */
   *entries(): IterableIterator<string[]> {
-    for (const name in this.map) {
-      if (Object.prototype.hasOwnProperty.call(this.map, name)) {
-        yield [this.map[name].name, this.map[name].value];
-      }
+    const keys = Object.keys(this._map);
+    for (const name of keys) {
+      yield [this._map[name].name, this._map[name].value];
     }
   }
 
@@ -210,10 +227,9 @@ export class Headers {
    * Iterates over headers.
    */
   *[Symbol.iterator](): IterableIterator<string[]> {
-    for (const name in this.map) {
-      if (Object.prototype.hasOwnProperty.call(this.map, name)) {
-        yield [this.map[name].name, this.map[name].value];
-      }
+    const keys = Object.keys(this._map);
+    for (const name of keys) {
+      yield [this._map[name].name, this._map[name].value];
     }
   }
 }