Separate class definition and export statements. Updated documentation comments.

Author: Amir Tocker

src/Util/closestAbove.js

@@ -3,6 +3,7 @@
  * @param {Array} list a sorted array of items
  * @param {*} value
  * @returns {*}
+ * @protected
  */
 export default function closestAbove(list, value) {
   return list.reduce((last, next) => value <= last ? last : next, undefined);

src/Util/debounce.js

@@ -4,6 +4,7 @@
  * @param {number} wait waiting time in milliseconds
  * @param {boolean=false} immediate if true execute func at the beginning of the wait period
  * @returns {function()} debounced function
+ * @protected
  */
 export default function debounce(func, wait, immediate) {
   let timeout = null;

src/Util/firstDefined.js

@@ -2,6 +2,7 @@
  * Returns the first argument that is not undefined
  * @param {...*} values a list of arguments of any type
  * @returns {*}
+ * @protected
  */
 export default function firstDefined(...values){
   for(let i = 0; i < values.length; i++) {

src/Util/isElement.js

@@ -8,6 +8,7 @@
  * @category Lang
  * @param {*} value The value to check.
  * @returns {boolean} Returns `true` if `value` is a DOM element, else `false`.
+ * @protected
  * @example
  *
  * _.isElement(document.body);

src/components/CloudinaryComponent/CloudinaryComponent.js

@@ -5,7 +5,11 @@ import {mapKeys} from '../../Util'
 const camelCase = Util.camelCase;
 const snakeCase = Util.snakeCase;
 
-export default class CloudinaryComponent extends Component {
+/**
+ * A base component for Cloudinary components.
+ * @protected
+ */
+class CloudinaryComponent extends Component {
   constructor(props, context) {
     super(props, context);
   }
@@ -41,6 +45,7 @@ export default class CloudinaryComponent extends Component {
    * and any children.
    * @param options
    * @returns {object} a hash of transformation and configuration parameters
+   * @protected
    */
   getTransformation(options) {
     var transformation;
@@ -56,7 +61,8 @@ export default class CloudinaryComponent extends Component {
 
   /**
    * Combine properties of all options to create an option Object that can be passed to Cloudinary methods.<br>
-   *   All names are converted to snake_case. undefined and null values are filtered out.
+   *   `undefined` and `null` values are filtered out.
+   * @protected
    * @returns {Object}
    * @param options one or more options objects
    */
@@ -77,6 +83,7 @@ export default class CloudinaryComponent extends Component {
    * Generate a Cloudinary resource URL based on the options provided and child Transformation elements
    * @param options
    * @returns {string} a cloudinary URL
+   * @protected
    */
   getUrl(options) {
     let transformation = this.getTransformation(options);
@@ -98,6 +105,7 @@ CloudinaryComponent.childContextTypes = {};
  * Create a React type definition object. All items are PropTypes.string or [string] or object or [object].
  * @param {Array} configParams a list of parameter names
  * @returns {Object}
+ * @private
  */
 function typesFrom(configParams) {
   configParams = configParams || [];
@@ -109,3 +117,4 @@ function typesFrom(configParams) {
   return types;
 }
 
+export default CloudinaryComponent;

src/components/CloudinaryContext/CloudinaryContext.js

@@ -4,13 +4,13 @@ import CloudinaryComponent from '../CloudinaryComponent';
 /**
  * Provides a container for Cloudinary components. Any option set in CloudinaryContext will be passed to the children.
  * @example
- *    <CloudinaryContext cloudName="mycloud" dpr="auto">
- *      <!-- other tags -->
- *      <Image publicId={id}/>
- *    </CloudinaryContext>
+ *<CloudinaryContext cloudName="mycloud" dpr="auto">
+ *    <!-- other tags -->
+ *    <Image publicId={id}/>
+ *</CloudinaryContext>
  *
  */
-export default class CloudinaryContext extends CloudinaryComponent {
+class CloudinaryContext extends CloudinaryComponent {
   constructor(props, context) {
     super(props, context);
     this.state = {};
@@ -37,4 +37,6 @@ export default class CloudinaryContext extends CloudinaryComponent {
 
 CloudinaryContext.propTypes = CloudinaryComponent.propTypes;
 CloudinaryContext.defaultProps = {};
-CloudinaryContext.childContextTypes = CloudinaryComponent.contextTypes;
+CloudinaryContext.childContextTypes = CloudinaryComponent.contextTypes;
+
+export default CloudinaryContext;

src/components/Image/Image.js

@@ -4,9 +4,9 @@ import CloudinaryComponent from '../CloudinaryComponent';
 import {debounce, firstDefined, closestAbove, requestAnimationFrame, equals, isElement} from '../../Util';
 
 /**
- * An element representing a Cloudinary served image
+ * A component representing a Cloudinary served image
  */
-export default class Image extends CloudinaryComponent {
+class Image extends CloudinaryComponent {
   constructor(props, context) {
     function defaultBreakpoints(width, steps = 100) {
       return steps * Math.ceil(width / steps);
@@ -22,6 +22,7 @@ export default class Image extends CloudinaryComponent {
   /**
    * Retrieve the window or default view of the current element
    * @returns {DocumentView|*}
+   * @private
    */
   get window() {
     let windowRef = null;
@@ -45,6 +46,7 @@ export default class Image extends CloudinaryComponent {
    * @param {Object} [props=this.props]
    * @param {Object} [context=this.context]
    * @returns {Object} state updates
+   * @private
    */
   prepareState(props = this.props, context = this.context) {
     let options = CloudinaryComponent.normalizeOptions(context, props);
@@ -217,3 +219,5 @@ export default class Image extends CloudinaryComponent {
 Image.defaultProps = {};
 Image.contextTypes = CloudinaryComponent.contextTypes;
 Image.propTypes = CloudinaryComponent.propTypes;
+
+export default Image;

src/components/Transformation/Transformation.js

@@ -1,7 +1,10 @@
 import React, {Component} from 'react';
 import CloudinaryComponent from '../CloudinaryComponent';
 
-export default class Transformation extends CloudinaryComponent {
+/**
+ * Define a transformation that is applied to the parent tag.
+ */
+class Transformation extends CloudinaryComponent {
   constructor(props) {
     super(props);
   }
@@ -12,4 +15,6 @@ export default class Transformation extends CloudinaryComponent {
 }
 Transformation.propTypes = CloudinaryComponent.propTypes;
 Transformation.defaultProps = {};
-Transformation.contextTypes = {};
+Transformation.contextTypes = {};
+
+export default Transformation;

src/components/Video/Video.js

@@ -7,7 +7,10 @@ const DEFAULT_POSTER_OPTIONS = {
   resource_type: 'video'
 };
 
-export default class Video extends CloudinaryComponent {
+/**
+ * A component representing a Cloudinary served video
+ */
+class Video extends CloudinaryComponent {
   constructor(props) {
     super(props);
     this.state = {};
@@ -56,4 +59,6 @@ export default class Video extends CloudinaryComponent {
 }
 Video.propTypes = {publicId: PropTypes.string};
 Video.defaultProps = {};
-Video.contextTypes = CloudinaryComponent.contextTypes;
+Video.contextTypes = CloudinaryComponent.contextTypes;
+
+export default Video;