carbon-react 91.2.1 → 93.0.2

package/lib/utils/helpers/poller/poller.js

@@ -1,181 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _superagent = _interopRequireDefault(require("superagent"));
-
-var _logger = _interopRequireDefault(require("../../logger"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * A helper to make poll an endpoint with a GET request
- *
- * The helper takes the following params
- *
- * - queryOptions:
- * -- url - the url to make the GET request to
- * -- data - any data you wish to pass with the request
- * -- headers - any header you wish to pass with the request
- *
- * - functions: An object containing the custom functions
- * -- conditionMet: Use this to test a desired condition in the response and return a boolean.
- *                  If the condition is true, the callback will be executed.
- * -- conditionNotMetCallback: Called when condition not met and poller will retry
- * -- callback: A callback function to call when the conditionMet returns true
- * -- handleError: a callback function that takes an error and handles it
- * -- terminate: Use this to test a desired condition in the response and return a boolean.
- *               If the condition is true, the polling will end.
- * -- onMaxRetries: Use this to do something when the max retries are met
- * options:
- * -- interval - the interval after which the request is re-submitted
- * -- retries - number of times to re-submit the request before giving up
- * -- endTime - a time period after which to end the polling
- *
- * ===Example Usage===
- *
- * import Poller from 'carbon-react/lib/utils/helpers/poller';
- *
- * let queryOptions = {  url: '/foo/bar/1' }
- * let options = { interval: 5000 };
- * let functions = {
- *   conditionMet: function(response) => { return response.body.status === 'complete' };
- *   conditionNotMetCallback: function(response) => { notYetFunction(response) };
- *   callback: function(response) => { doSomethingFancy(reponse) };
- *   handleError: function(err) => { FlashMessage("Failed", err) };
- * }
- *
- * Poller(queryOptions, functions);
- */
-var _default = (queryOptions, functions, options) => {
-  if (!setupValid(queryOptions, functions)) {
-    return;
-  } // set default options for unprovided options
-
-
-  const queryOpts = getQueryOptions(queryOptions);
-  const funcs = getFunctions(functions);
-  const opts = getOptions(options); // pollCount for use if retries option passed
-
-  let pollCount = 1;
-
-  (function poll() {
-    const now = Date.now();
-
-    if (pollCount > opts.retries || now > opts.endTime) {
-      funcs.onMaxRetries();
-      return;
-    }
-
-    _superagent.default.get(queryOpts.url).query(queryOpts.data).set(queryOpts.headers).end((err, response) => {
-      let result;
-
-      if (err) {
-        if (funcs.handleError) {
-          result = funcs.handleError(err);
-        } else {
-          result = _logger.default.error(err.message); // eslint-disable-line no-console
-        }
-      } else if (funcs.terminate(response)) {
-        result = response;
-      } else if (funcs.conditionMet(response)) {
-        result = funcs.callback(response);
-      } else {
-        funcs.conditionNotMetCallback(response);
-        pollCount += 1;
-        setTimeout(poll, opts.interval);
-      }
-
-      return result;
-    });
-  })();
-};
-/**
- * Sets default queryOptions
- *
- * @method getQueryOptions
- * @return {Object} queryOptions
- */
-
-
-exports.default = _default;
-
-function getQueryOptions(queryOptions) {
-  return {
-    url: queryOptions.url,
-    data: queryOptions.data || {},
-    headers: queryOptions.headers || {}
-  };
-}
-/**
- * Sets default Options for poller
- *
- * @method getOptions
- * @return {Object} options
- */
-
-
-function getOptions(options) {
-  return {
-    interval: options.interval || 3000,
-    endTime: Date.now() + options.endTime || Infinity,
-    retries: options.retries || Infinity
-  };
-}
-/**
- * Sets default functions for poller
- *
- * @method getFunctions
- * @return {Object} functions
- */
-
-
-function getFunctions(functions) {
-  return {
-    callback: functions.callback || null,
-    handleError: functions.handleError || null,
-    conditionMet: functions.conditionMet || (() => {
-      return false;
-    }),
-    conditionNotMetCallback: functions.conditionNotMetCallback || (() => {
-      return false;
-    }),
-    terminate: functions.terminate || (() => {
-      return false;
-    }),
-    onMaxRetries: functions.onMaxRetries || (() => {
-      _logger.default.warn("The poller has made too many requests - terminating poll"); // eslint-disable-line no-console
-
-    })
-  };
-}
-/**
- * Checks that required params are present
- *
- * @method setupValid
- * @return {Boolean}
- */
-
-
-function setupValid(queryOptions, functions) {
-  if (queryOptions === null || typeof queryOptions.url === "undefined") {
-    _logger.default.error("You must provide a url to the poller"); // eslint-disable-line no-console
-
-
-    return false;
-  }
-
-  if (typeof functions.conditionMet !== "undefined" && typeof functions.callback === "undefined") {
-    const msg = "You must provide a callback function if you are testing a condition with conditionMet";
-
-    _logger.default.error(msg); // eslint-disable-line no-console
-
-
-    return false;
-  }
-
-  return true;
-}

package/lib/utils/helpers/prop-types/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./prop-types.js"
-}

package/lib/utils/helpers/prop-types/prop-types.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-const valueInRange = (value, min, max) => {
-  return value >= min && value <= max;
-};
-
-const buildErrorString = (propName, componentName, error) => {
-  return `${propName} in ${componentName} ${error}`;
-};
-
-const throwError = (propName, componentName, error) => {
-  return new Error(buildErrorString(propName, componentName, error));
-};
-
-const isTypeOfNumberOrString = value => {
-  return typeof value === "string" || typeof value === "number";
-};
-
-const PropTypesHelper = {
-  inValidRange: (props, propName, componentName, min, max) => {
-    if (props[propName]) {
-      const value = props[propName];
-
-      if (isTypeOfNumberOrString(value)) {
-        if (!valueInRange(value, min, max)) {
-          return throwError(propName, componentName, `must be between ${min} and ${max}`);
-        }
-      } else {
-        return throwError(propName, componentName, "must be a String or Integer");
-      }
-    }
-
-    return null;
-  }
-};
-var _default = PropTypesHelper;
-exports.default = _default;

package/lib/utils/helpers/scrollable-parent/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./scrollable-parent.js"
-}

package/lib/utils/helpers/should-component-update/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./should-component-update.js"
-}

package/lib/utils/helpers/should-component-update/should-component-update.js

@@ -1,56 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = _default;
-
-var _immutable = _interopRequireDefault(require("immutable"));
-
-var _lodash = require("lodash");
-
-var _logger = _interopRequireDefault(require("../../logger/logger"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * A shouldComponentUpdate helper. Run this method with your instance, nextProps and nextState
- * and it will perform a deep comparison of the properties - handling immutable objects.
- *
- * @method
- * @param {Object} scope
- * @param {Object} nextProps
- * @param {Object} nextState
- * @return {Boolean}
- */
-let deprecatedWarnTriggered = false;
-
-function _default(scope, nextProps, nextState) {
-  if (!deprecatedWarnTriggered) {
-    deprecatedWarnTriggered = true; // eslint-disable-next-line max-len
-
-    _logger.default.deprecate("`ShouldComponentUpdate` helper is deprecated and will soon be removed");
-  }
-
-  return !(0, _lodash.isEqualWith)(scope.props, nextProps, customCheck) || !(0, _lodash.isEqualWith)(scope.state, nextState, customCheck);
-}
-/**
- * Performs a custom check of parameters from the isEqual method.
- *
- * @method customCheck
- * @param current - could be any type
- * @param next - could be any type
- * @param {String} key
- * @private
- */
-
-
-function customCheck(current, next) {
-  // if immutable object, do custom comparison. otherwise return undefined to
-  // allow isEqual to continue as normal
-  if (_immutable.default.Iterable.isIterable(current)) {
-    return _immutable.default.is(current, next);
-  }
-
-  return undefined;
-}

package/lib/utils/helpers/tags/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./tags"
-}

package/lib/utils/helpers/tags/tags-specs/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./tags-specs.js"
-}

package/lib/utils/helpers/text/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./text"
-}

package/lib/utils/helpers/text/text.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _browser = _interopRequireDefault(require("../browser"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Text utility methods
- *
- */
-const Text = {
-  /**
-   * Clears any selected text from the current page
-   */
-  clearSelection() {
-    const document = _browser.default.getDocument();
-
-    const window = _browser.default.getWindow();
-
-    if (document.body.createTextRange) {
-      // IE
-      const range = document.body.createTextRange();
-      range.collapse();
-      range.select();
-    } else {
-      // Chrome, Firefox, Safari, Edge
-      window.getSelection().removeAllRanges();
-    }
-  },
-
-  /**
-   * Capitalises the first letter of string paramater
-   */
-  titleCase(str) {
-    return str.replace(/\w\S*/g, txt => {
-      return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
-    });
-  }
-
-};
-var _default = Text;
-exports.default = _default;

package/lib/utils/helpers/to-array/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./to-array.js"
-}

package/lib/utils/helpers/to-array/to-array.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = _default;
-
-/**
- * Converts a string of a given format into an array.
- *
- * For example:
- *
- *  "foo[bar][baz]"
- *
- * Will be converted to:
- *
- *  ["foo", "bar", "baz"]
- *
- * @method toArray
- * @param {String}
- * @return {Array}
- */
-function _default(str) {
-  let result = [];
-  const index = str.indexOf("[");
-
-  if (index === -1) {
-    // if there are no square brackets
-    result.push(str);
-  } else {
-    if (index > 0) {
-      // if the square bracket is not the first character, add the name at the
-      // start of the string (not in brackets)
-      const name = str.slice(0, index);
-      result.push(name);
-    } // pull out the names in brackets and add to the array
-
-
-    const nestedNames = str.match(/[^[\]]+(?=])/g);
-    result = result.concat(nestedNames);
-  }
-
-  return result;
-}

package/lib/utils/helpers/validations/package.json

@@ -1,4 +0,0 @@
-{
-  "name": "validations",
-  "main": "./validations.js"
-}

package/lib/utils/helpers/validations/validations.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-const ValidationsHelper = {
-  /**
-   * Return the comparison type depending on params
-   *
-   * @method comparisonType
-   * @param {Object} params
-   * @return {String} function type to call
-   */
-  comparisonType: params => {
-    const is = typeof params.is !== "undefined",
-          max = typeof params.max !== "undefined",
-          min = typeof params.min !== "undefined";
-    if (is && !max && !min) return "Exact";
-    if (!is && max && !min) return "Less";
-    if (!is && min && !max) return "Greater";
-    if (!is && min && max) return "Range";
-    return null;
-  }
-};
-var _default = ValidationsHelper;
-exports.default = _default;

package/lib/utils/helpers/warn-as-deprecated/warn-as-deprecated.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _logger = _interopRequireDefault(require("../../logger"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * A function to display a warning in the console when a deprecated component is being used in developpment
- */
-var _default = (oldName, newName) => {
-  if (process.env.NODE_ENV === "development" && oldName.length && newName.length) {
-    const warnMessage = `${oldName} is marked as deprecated, it will soon be moved to "carbon-graveyard" and be replaced by ${newName}`;
-
-    _logger.default.deprecate(warnMessage);
-  }
-};
-
-exports.default = _default;

package/lib/utils/logger/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./logger.js"
-}

package/lib/utils/service/package.json

@@ -1,3 +0,0 @@
-{
-  "main": "./service.js"
-}