optional params and its related fixes

Author: eco-line

src/constants/errorMessages.ts

@@ -6,6 +6,7 @@ export default {
   MISSING_UPLOAD_FILE_PARAMETER: { message: "Missing file parameter for upload", help: "" },
   MISSING_UPLOAD_FILENAME_PARAMETER: { message: "Missing fileName parameter for upload", help: "" },
   MISSING_AUTHENTICATION_ENDPOINT: { message: "Missing authentication endpoint for upload", help: "" },
+  MISSING_PUBLIC_KEY : { message: "Missing public key for upload", help: "" },
   AUTH_ENDPOINT_TIMEOUT: { message: "The authenticationEndpoint you provided timed out in 60 seconds", help: "" },
   AUTH_ENDPOINT_NETWORK_ERROR: { message: "Request to authenticationEndpoint failed due to network error", help: "" },
   UPLOAD_ENDPOINT_NETWORK_ERROR: {

src/index.ts

@@ -3,7 +3,7 @@ import { upload } from "./upload/index";
 import { version } from "../package.json";
 import transformationUtils from "./utils/transformation";
 import errorMessages from "./constants/errorMessages";
-import { IImageKit, ImageKitOptions, TransformationPosition, UploadOptions, UploadResponse, UrlOptions } from "./interfaces";
+import { IImageKit, ImageKitOptions, UploadOptions, UploadResponse, UrlOptions } from "./interfaces";
 
 function mandatoryParametersAvailable(options: ImageKitOptions) {
   return options.urlEndpoint;
@@ -15,12 +15,7 @@ function privateKeyPassed(options: ImageKitOptions) {
 
 const ImageKit = function (
   this: IImageKit,
-  opts: {
-    publicKey: string;
-    urlEndpoint: string;
-    authenticationEndpoint?: string;
-    transformationPosition?: TransformationPosition;
-  },
+  opts: ImageKitOptions,
 ) {
   opts = opts || {};
   this.options = {

src/interfaces/ImageKitOptions.ts

@@ -1,9 +1,9 @@
 import { TransformationPosition } from ".";
 
 export interface ImageKitOptions {
-  sdkVersion: string;
-  publicKey: string;
   urlEndpoint: string;
+  sdkVersion?: string;
+  publicKey?: string;
   authenticationEndpoint?: string;
-  transformationPosition: TransformationPosition;
+  transformationPosition?: TransformationPosition;
 }

src/interfaces/UrlOptions.ts

@@ -25,17 +25,6 @@ export interface UrlOptionsBase {
    * If not specified, the URL Endpoint specified at the time of SDK initialization is used.
    */
   urlEndpoint?: string;
-  /**
-   * Default is false. If set to true, the SDK generates a signed image URL adding the image signature to the image URL.
-   * If you are creating URL using src parameter instead of path then do correct urlEndpoint for this to work.
-   * Otherwise returned URL will have wrong signature.
-   */
-  signed?: boolean;
-  /**
-   * Meant to be used along with the signed parameter to specify the time in seconds from now when the URL should expire.
-   * If specified, the URL contains the expiry timestamp in the URL and the image signature is modified accordingly.
-   */
-  expireSeconds?: number;
 }
 
 export interface UrlOptionsSrc extends UrlOptionsBase {

src/upload/index.ts

@@ -28,6 +28,11 @@ export const upload = (
     return;
   }
 
+  if (!options.publicKey) {
+    respond(true, errorMessages.MISSING_PUBLIC_KEY, callback);
+    return;
+  }
+
   var formData = new FormData();
   let i: keyof typeof uploadOptions;
   for (i in uploadOptions) {

src/utils/request.ts

@@ -78,7 +78,7 @@ export const uploadFile = (formData: FormData, callback: (err: Error | null, res
         else if (uploadFileXHR.status !== 200) {
             try {
               callback(JSON.parse(uploadFileXHR.responseText), null);
-            } catch (ex) {
+            } catch (ex : any) {
               callback(ex, null);
             }
         }

src/utils/transformation.ts

@@ -1,12 +1,12 @@
 import supportedTransforms from "../constants/supportedTransforms";
 import { ImageKitOptions, TransformationPosition } from "../interfaces";
 
-const DEFAULT_TRANSFORMATION_POSITION = "path";
-const QUERY_TRANSFORMATION_POSITION = "query";
+const DEFAULT_TRANSFORMATION_POSITION : TransformationPosition = "path";
+const QUERY_TRANSFORMATION_POSITION : TransformationPosition = "query";
 const VALID_TRANSFORMATION_POSITIONS = [DEFAULT_TRANSFORMATION_POSITION, QUERY_TRANSFORMATION_POSITION];
-const CHAIN_TRANSFORM_DELIMITER = ":";
-const TRANSFORM_DELIMITER = ",";
-const TRANSFORM_KEY_VALUE_DELIMITER = "-";
+const CHAIN_TRANSFORM_DELIMITER : string = ":";
+const TRANSFORM_DELIMITER : string = ",";
+const TRANSFORM_KEY_VALUE_DELIMITER : string = "-";
 
 export default {
     getDefault: (): TransformationPosition => {
@@ -16,6 +16,7 @@ export default {
         return options.transformationPosition === QUERY_TRANSFORMATION_POSITION;
     },
     validParameters: (options: ImageKitOptions) =>  {
+		if(typeof options.transformationPosition == "undefined") return false;
         return VALID_TRANSFORMATION_POSITIONS.indexOf(options.transformationPosition) != -1;
     },
     getTransformKey: function (transform: string) {