@webex/http-core 3.0.0-beta.8 → 3.0.0-bnr.0

package/dist/types/interceptors/http-status.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @class
+ */
+export default class HttpStatusInterceptor extends Interceptor {
+    /**
+     * @param {Object} options
+     * @returns {HttpStatusInterceptor}
+     */
+    static create(options: any): HttpStatusInterceptor;
+    /**
+     * @param {Object} webex
+     * @param {Object} options
+     * @returns {HttpStatusInterceptor}
+     */
+    constructor(webex: any, options: any);
+}
+import Interceptor from "../lib/interceptor";

package/dist/types/lib/detect.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Determine mimeType for the specified buffer;
+ * @param {Buffer|Uint8Array|ArrayBuffer} buffer
+ * @returns {Promise<string>}
+ */
+export default function detect(buffer: Buffer | Uint8Array | ArrayBuffer): Promise<string>;

package/dist/types/lib/interceptor.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @class
+ */
+export default class Interceptor {
+    /**
+     * @abstract
+     * @returns {Interceptor}
+     */
+    static create(): Interceptor;
+    /**
+     * @constructor
+     * @param {Object} attrs
+     * @returns {UrlInterceptor}
+     */
+    constructor(attrs: any);
+    /**
+     * Logs the options of a request. This should be utilized
+     * during the intercepting process, but can be used at any
+     * time otherwise.
+     * @param {object} options
+     * @returns {void}
+     */
+    logOptions(options?: object): void;
+    /**
+     * Transform request options before sending them
+     * @param {Object} options
+     * @returns {Promise<Object>}
+     */
+    onRequest(options: any): Promise<any>;
+    /**
+     * Handle request failures
+     * @param {Object} options
+     * @param {Error} reason
+     * @returns {RejectedPromise<Error>}
+     */
+    onRequestError(options: any, reason: Error): RejectedPromise<Error>;
+    /**
+     * Transform response before returning it
+     * @param {Object} options
+     * @param {HttpResponse} response
+     * @returns {Promise<HttpResponse>}
+     */
+    onResponse(options: any, response: HttpResponse): Promise<HttpResponse>;
+    /**
+     * Handle response errors
+     * @param {Object} options
+     * @param {WebexHttpError} reason
+     * @returns {Promise<WebexHttpError>}
+     */
+    onResponseError(options: any, reason: WebexHttpError): Promise<WebexHttpError>;
+}

package/dist/types/lib/xhr.d.ts

@@ -0,0 +1,6 @@
+export default createXHR;
+declare function createXHR(uri: any, options: any, callback: any): any;
+declare namespace createXHR {
+    const XMLHttpRequest: any;
+    const XDomainRequest: any;
+}

package/dist/types/progress-event.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Object of the same shape as web browser ProgressEvents
+ * @class ProgressEvent
+ * @param {integer} loaded
+ * @param {integer} total
+ * @returns {ProgressEvent}
+ */
+export default function ProgressEvent(loaded: integer, total: integer): ProgressEvent;
+export default class ProgressEvent {
+    /**
+     * Object of the same shape as web browser ProgressEvents
+     * @class ProgressEvent
+     * @param {integer} loaded
+     * @param {integer} total
+     * @returns {ProgressEvent}
+     */
+    constructor(loaded: integer, total: integer);
+}

package/dist/types/request/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {Object} options
+ * @returns {Promise}
+ */
+export default function request(options: any): Promise<any>;

package/dist/types/request/request.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @name request
+ * @param {Object} options
+ * @returns {Promise}
+ */
+export default function _request(options: any): Promise<any>;

package/dist/types/request/request.shim.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @name request
+ * @param {Object} options
+ * @returns {Promise}
+ */
+export default function _request(options: any): Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/http-core",
-  "version": "3.0.0-beta.8",
+  "version": "3.0.0-bnr.0",
   "description": "Core HTTP library for the Cisco Webex",
   "license": "MIT",
   "main": "dist/index.js",
@@ -24,18 +24,18 @@
     ]
   },
   "devDependencies": {
-    "@webex/test-helper-chai": "3.0.0-beta.8",
-    "@webex/test-helper-file": "3.0.0-beta.8",
-    "@webex/test-helper-make-local-url": "3.0.0-beta.8",
-    "@webex/test-helper-mocha": "3.0.0-beta.8",
+    "@webex/test-helper-chai": "3.0.0-bnr.0",
+    "@webex/test-helper-file": "3.0.0-bnr.0",
+    "@webex/test-helper-make-local-url": "3.0.0-bnr.0",
+    "@webex/test-helper-mocha": "3.0.0-bnr.0",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.8",
-    "@webex/http-core": "3.0.0-beta.8",
-    "@webex/internal-plugin-device": "3.0.0-beta.8",
-    "@webex/test-helper-test-users": "3.0.0-beta.8",
-    "@webex/webex-core": "3.0.0-beta.8",
+    "@webex/common": "3.0.0-bnr.0",
+    "@webex/http-core": "3.0.0-bnr.0",
+    "@webex/internal-plugin-device": "3.0.0-bnr.0",
+    "@webex/test-helper-test-users": "3.0.0-bnr.0",
+    "@webex/webex-core": "3.0.0-bnr.0",
     "file-type": "^16.0.1",
     "global": "^4.4.0",
     "is-function": "^1.0.1",

package/src/http-error-subtypes.js

@@ -182,6 +182,6 @@ export default function makeSubTypes(Base) {
       statusCode = parseInt(statusCode, 10);
 
       return Base[statusCode] || Base;
-    }
+    },
   });
 }

package/src/http-error.js

@@ -23,14 +23,7 @@ export default class HttpError extends Exception {
    *
    * @type {Array}
    */
-  static errorKeys = [
-    'error',
-    'errorString',
-    'response',
-    'errorResponse',
-    'message',
-    'msg'
-  ];
+  static errorKeys = ['error', 'errorString', 'response', 'errorResponse', 'message', 'msg'];
 
   /**
    * Default error string if no error can be extracted from the http response
@@ -55,8 +48,7 @@ export default class HttpError extends Exception {
         try {
           body = JSON.parse(body);
           message = this.parseObject(body);
-        }
-        catch (err) {
+        } catch (err) {
           message = body;
         }
         break;
@@ -73,52 +65,52 @@ export default class HttpError extends Exception {
     Object.defineProperties(this, {
       body: {
         enumerable: false,
-        value: body
+        value: body,
       },
       httpVersion: {
         enumerable: false,
-        value: res.httpVersion
+        value: res.httpVersion,
       },
       headers: {
         enumerable: false,
-        value: res.headers || {}
+        value: res.headers || {},
       },
       rawHeaders: {
         enumerable: false,
-        value: res.rawHeaders || []
+        value: res.rawHeaders || [],
       },
       trailers: {
         enumerable: false,
-        value: res.trailers || {}
+        value: res.trailers || {},
       },
       rawTrailers: {
         enumerable: false,
-        value: res.rawTrailers || []
+        value: res.rawTrailers || [],
       },
       method: {
         enumerable: false,
-        value: res.method
+        value: res.method,
       },
       url: {
         enumerable: false,
-        value: res.url
+        value: res.url,
       },
       statusCode: {
         enumerable: false,
-        value: res.statusCode
+        value: res.statusCode,
       },
       statusMessage: {
         enumerable: false,
-        value: res.statusMessage
+        value: res.statusMessage,
       },
       socket: {
         enumerable: false,
-        value: res.socket
+        value: res.socket,
       },
       _res: {
         enumerable: false,
-        value: res
-      }
+        value: res,
+      },
     });
 
     return message;

package/src/index.js

@@ -20,17 +20,12 @@ const protorequest = curry(function protorequest(defaultOptions, options) {
   }
 
   // Hide useless elements from logs
-  [
-    'download',
-    'interceptors',
-    'logger',
-    'upload'
-  ].forEach((prop) => {
+  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {
     let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);
 
     descriptor = assign({}, descriptor, {
       enumerable: false,
-      writable: true
+      writable: true,
     });
     Reflect.defineProperty(options, prop, descriptor);
   });
@@ -50,8 +45,8 @@ const defaultOptions = {
   json: true,
   interceptors: [
     // Reminder: this is supposed to be an instantiated interceptor.
-    HttpStatusInterceptor.create()
-  ]
+    HttpStatusInterceptor.create(),
+  ],
 };
 
 export const defaults = protorequest;

package/src/interceptors/http-status.js

@@ -18,12 +18,12 @@ export default class HttpStatusInterceptor extends Interceptor {
    */
   constructor(webex, options) {
     super(webex);
-    const ErrorConstructor = options && (options.error || options.ErrorConstructor) || HttpError;
+    const ErrorConstructor = (options && (options.error || options.ErrorConstructor)) || HttpError;
 
     Object.defineProperties(this, {
       ErrorConstructor: {
-        value: ErrorConstructor
-      }
+        value: ErrorConstructor,
+      },
     });
   }
 
@@ -46,9 +46,11 @@ export default class HttpStatusInterceptor extends Interceptor {
         return Promise.resolve(response);
       }
       // to handle locus redirects
-      if (response.statusCode === 404 &&
+      if (
+        response.statusCode === 404 &&
         response.body &&
-        response.body.errorCode === LOCUS_REDIRECT_ERROR) {
+        response.body.errorCode === LOCUS_REDIRECT_ERROR
+      ) {
         return Promise.resolve(response);
       }
     }

package/src/lib/detect.js

@@ -10,7 +10,6 @@ import {fromBuffer} from 'file-type';
  * @returns {Promise<string>}
  */
 export default async function detect(buffer) {
-  /* global Blob */
   if (
     !(buffer instanceof Blob) &&
     !(buffer instanceof ArrayBuffer) &&

package/src/lib/interceptor.js

@@ -20,7 +20,7 @@ export default class Interceptor {
 
         Reflect.defineProperty(this, key, {
           enumerable: true,
-          value
+          value,
         });
       });
     }
@@ -43,9 +43,7 @@ export default class Interceptor {
     // prepend a header for the interceptor
     logger.info('/***** Interceptor ****************************************************\\');
 
-    logger.info(
-      `${this.constructor.name} - ${JSON.stringify(options, null, 2)}`
-    );
+    logger.info(`${this.constructor.name} - ${JSON.stringify(options, null, 2)}`);
   }
 
   /**