Add examples to PSDTools (#369)

Author: patrick-tolosa

src/actions/psdTools.ts

@@ -1,13 +1,14 @@
-import ClipAction from "./psdTools/ClipAction";
-import GetLayerAction from "./psdTools/GetLayerAction";
-import SmartObjectAction from "./psdTools/SmartObjectAction";
+import {ClipAction} from "./psdTools/ClipAction";
+import {GetLayerAction} from "./psdTools/GetLayerAction";
+import {SmartObjectAction} from "./psdTools/SmartObjectAction";
 
 /**
+ * @namespace PSDTools
  * @description Represents a layer in a Photoshop document.
- *
- * <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
+ * </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
  * @memberOf Actions
- * @namespace PSDTools
+ * @example
+ * // See examples under each method
  */
 
 
@@ -16,6 +17,19 @@ import SmartObjectAction from "./psdTools/SmartObjectAction";
  * @description Trims the pixels of a PSD image according to a Photoshop clipping path that is stored in the image's metadata.
  * @memberOf Actions.PSDTools
  * @return {Actions.PSDTools.ClipAction}
+ * @example
+ * import {Cloudinary} from '@cloudinary/base/instance/Cloudinary';
+ * import {clip} from '@cloudinary/base/actions/psdTools';
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.psdTools(
+ *  clip()
+ *    .byName('foo') // either name, or number
+ *    .byNumber(2)   // either name, or number
+ *    .evenOdd()     // Use the evenodd clipping rule
+ * );
  */
 function clip(): ClipAction {
   return new ClipAction();
@@ -28,6 +42,19 @@ function clip(): ClipAction {
  * <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
  * @memberOf Actions.PSDTools
  * @return {Actions.PSDTools.GetLayerAction}
+ * @example
+ * import {Cloudinary} from '@cloudinary/base/instance/Cloudinary';
+ * import {getLayer} from '@cloudinary/base/actions/psdTools';
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.psdTools(
+ *  getLayer()
+ *    .byName('foo') // One of the three
+ *    .byIndex(2)    // One of the three
+ *    .byRange(1, 3) // One of the three
+ * );
  */
 function getLayer(): GetLayerAction {
   return new GetLayerAction();
@@ -38,6 +65,18 @@ function getLayer(): GetLayerAction {
  * @description Extracts the original content of an embedded object of a Photoshop image.
  * @memberOf Actions.PSDTools
  * @return {Actions.PSDTools.SmartObjectAction}
+ * @example
+ * import {Cloudinary} from '@cloudinary/base/instance/Cloudinary';
+ * import {smartObject} from '@cloudinary/base/actions/psdTools';
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.psdTools(
+ *  smartObject()
+ *    .byLayerName('foo') // either name, or number
+ *    .byIndex(2)         // either name, or number
+ * );
  */
 function smartObject(): SmartObjectAction {
   return new SmartObjectAction();

src/actions/psdTools/ClipAction.ts

@@ -5,8 +5,9 @@ import {clip, clipEvenOdd} from "../../qualifiers/flag";
 
 /**
  * @description  Defines the clipping path to use when trimming pixels.
- * @memberOf Actions.PSDTools
  * @extends {SDK.Action}
+ * @memberOf Actions.PSDTools
+ * @see Visit {@link Actions.PSDTools| PSDTools} for an example
  */
 class ClipAction extends Action {
   private path: string | number;
@@ -64,4 +65,4 @@ class ClipAction extends Action {
   }
 }
 
-export default ClipAction;
+export {ClipAction};

src/actions/psdTools/GetLayerAction.ts

@@ -4,10 +4,10 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue";
 
 /**
  * @description Represents a layer in a Photoshop document.
- *
- * <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
- * @memberOf Actions.PSDTools
+ * </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
  * @extends {SDK.Action}
+ * @memberOf Actions.PSDTools
+ * @see Visit {@link Actions.PSDTools| PSDTools} for an example
  */
 class GetLayerAction extends Action {
   private name: string;
@@ -20,7 +20,7 @@ class GetLayerAction extends Action {
 
   /**
    * @description deliver an image containing only specified layer of a Photoshop image from The layer index
-   * @param {string|number}  the index of the layer
+   * @param {string|number} from the index of the layer
    */
   byIndex(from: string|number): this{
     this.qualifierValue.addValue(from);
@@ -62,4 +62,4 @@ class GetLayerAction extends Action {
   }
 }
 
-export default GetLayerAction;
+export {GetLayerAction};

src/actions/psdTools/SmartObjectAction.ts

@@ -4,16 +4,16 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue";
 
 /**
  * @description Represents an embedded smart object in a Photoshop document.
- *
- * <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#extract_the_original_content_of_an_embedded_object
-  * | Extract the original content of an embedded Photoshop object}
- * @memberOf Actions.PSDTools
+ * </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#extract_the_original_content_of_an_embedded_object | Extract the original content of an embedded Photoshop object}
  * @extends {SDK.Action}
+ * @memberOf Actions.PSDTools
+ * @see Visit {@link Actions.PSDTools| PSDTools} for an example
  */
-class SmartObjectAction extends Action{
-  private smartObjectValue: string|number;
+class SmartObjectAction extends Action {
+  private smartObjectValue: string | number;
   private qualifierValue = new QualifierValue();
   private useName = false;
+
   constructor() {
     super();
     this.qualifierValue.delimiter = ';';
@@ -23,7 +23,7 @@ class SmartObjectAction extends Action{
    * @description Creates a new instance using the specified number.
    * @param index The number.
    */
-  byIndex(index: string|number): this{
+  byIndex(index: string | number): this {
     this.smartObjectValue = index;
     this.qualifierValue.addValue(index);
     return this;
@@ -33,13 +33,13 @@ class SmartObjectAction extends Action{
    * @description Creates an instance using the name.
    * @param {string} layerName The name of the layer
    */
-  byLayerName(layerName: string): this{
+  byLayerName(layerName: string): this {
     this.useName = true;
     this.qualifierValue.addValue(layerName);
     return this;
   }
 
-  protected prepareQualifiers() : void {
+  protected prepareQualifiers(): void {
     let qualifierValue;
     if (this.useName) {
       qualifierValue = new QualifierValue(['embedded:name', this.qualifierValue]);
@@ -51,4 +51,4 @@ class SmartObjectAction extends Action{
   }
 }
 
-export default SmartObjectAction;
+export {SmartObjectAction};

src/assets/CloudinaryTransformable.ts

@@ -9,10 +9,11 @@ import {Action} from "../internal/Action";
 import RotateAction from "../actions/rotate/RotateAction";
 import {NamedTransformationAction} from "../actions/namedTransformation/NamedTransformationAction";
 import {SystemColors} from "../qualifiers/color";
-import SmartObjectAction from "../actions/psdTools/SmartObjectAction";
-import ClipAction from "../actions/psdTools/ClipAction";
-import GetLayerAction from "../actions/psdTools/GetLayerAction";
 import {ExtractAction} from "../actions/extract";
+import {SmartObjectAction} from "../actions/psdTools/SmartObjectAction";
+import {ClipAction} from "../actions/psdTools/ClipAction";
+import {GetLayerAction} from "../actions/psdTools/GetLayerAction";
+import {Extract} from "../actions/extract";
 import {FlagQualifier} from "../qualifiers/flag/FlagQualifier";
 import CustomFunctionAction from "../actions/customFunction/CustomFunctionAction";
 import {EffectActions} from "../actions/effect";

src/transformation/Transformation.ts

@@ -8,9 +8,9 @@ import ResizeSimpleAction from "../actions/resize/ResizeSimpleAction";
 import RotateAction from "../actions/rotate/RotateAction";
 import {BackgroundColor} from "../actions/background/actions/BackgroundColor";
 import {NamedTransformationAction} from "../actions/namedTransformation/NamedTransformationAction";
-import SmartObjectAction from "../actions/psdTools/SmartObjectAction";
-import ClipAction from "../actions/psdTools/ClipAction";
-import GetLayerAction from "../actions/psdTools/GetLayerAction";
+import {SmartObjectAction} from "../actions/psdTools/SmartObjectAction";
+import {ClipAction} from "../actions/psdTools/ClipAction";
+import {GetLayerAction} from "../actions/psdTools/GetLayerAction";
 import {IReshape} from "../actions/reshape";
 import {SystemColors} from "../qualifiers/color";
 import {prepareColor} from "../internal/utils/prepareColor";