Removed IImageKit and Changed ImageKit to class

Author: ahnv

.babelrc

@@ -1,11 +1,12 @@
 {
-    "presets": [
-        "@babel/preset-typescript",
-        [
-            "@babel/env",
-            {
-                "targets": "> 0.25%, not dead"
-            }
-        ]
+  "plugins": ["@babel/plugin-proposal-class-properties"],
+  "presets": [
+    "@babel/preset-typescript",
+    [
+      "@babel/env",
+      {
+        "targets": "> 0.25%, not dead"
+      }
     ]
-}
+  ]
+}

package-lock.json

@@ -21,6 +21,7 @@
         "@rollup/plugin-node-resolve": "^8.4.0",
         "@rollup/plugin-typescript": "^8.2.1",
         "@types/node": "^15.6.1",
+        "babel-plugin-transform-class-properties": "^6.24.1",
         "chai": "^4.2.0",
         "codecov": "^3.8.0",
         "esm": "^3.2.25",

package.json

@@ -1,9 +1,9 @@
-import { url } from "./url/index";
-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 { ImageKitOptions, UploadOptions, UploadResponse, UrlOptions } from "./interfaces";
+import { upload } from "./upload/index";
+import { url } from "./url/index";
+import transformationUtils from "./utils/transformation";
 
 function mandatoryParametersAvailable(options: ImageKitOptions) {
   return options.urlEndpoint;
@@ -13,46 +13,52 @@ function privateKeyPassed(options: ImageKitOptions) {
   return typeof (options as any).privateKey != "undefined";
 }
 
-const ImageKit = function (
-  this: IImageKit,
-  opts: {
-    publicKey: string;
-    urlEndpoint: string;
-    authenticationEndpoint?: string;
-    transformationPosition?: TransformationPosition;
-  },
-) {
-  opts = opts || {};
-  this.options = {
+class ImageKit {
+  options: ImageKitOptions = {
     sdkVersion: `javascript-${version}`,
     publicKey: "",
     urlEndpoint: "",
     transformationPosition: transformationUtils.getDefault(),
   };
 
-  this.options = {
-    ...this.options,
-    ...opts,
-  };
+  constructor(opts: Omit<ImageKitOptions, "sdkVersion">) {
+    this.options = { ...this.options, ...(opts || {}) };
+    if (!mandatoryParametersAvailable(this.options)) {
+      throw errorMessages.MANDATORY_INITIALIZATION_MISSING;
+    }
+    if (privateKeyPassed(this.options)) {
+      throw errorMessages.PRIVATE_KEY_CLIENT_SIDE;
+    }
 
-  if (!mandatoryParametersAvailable(this.options)) {
-    throw errorMessages.MANDATORY_INITIALIZATION_MISSING;
-  }
-  if (privateKeyPassed(this.options)) {
-    throw errorMessages.PRIVATE_KEY_CLIENT_SIDE;
+    if (!transformationUtils.validParameters(this.options)) {
+      throw errorMessages.INVALID_TRANSFORMATION_POSITION;
+    }
   }
 
-  if (!transformationUtils.validParameters(this.options)) {
-    throw errorMessages.INVALID_TRANSFORMATION_POSITION;
-  }
-
-  /* URL Builder */
-  this.url = function (urlOptions: UrlOptions): string {
+  /**
+   * You can add multiple origins in the same ImageKit.io account.
+   * URL endpoints allow you to configure which origins are accessible through your account and set their preference order as well.
+   *
+   * @see {@link https://github.com/imagekit-developer/imagekit-nodejs#url-generation}
+   * @see {@link https://docs.imagekit.io/integration/url-endpoints}
+   *
+   * @param urlOptions
+   */
+  url(urlOptions: UrlOptions): string {
     return url(urlOptions, this.options);
-  };
+  }
 
-  /* Upload API */
-  this.upload = function (
+  /**
+   * You can upload files to ImageKit.io media library from your server-side using private API key authentication.
+   *
+   * File size limit
+   * The maximum upload file size is limited to 25MB.
+   *
+   * @see {@link https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload}
+   *
+   * @param uploadOptions
+   */
+  upload(
     uploadOptions: UploadOptions,
     callback?: (err: Error | null, response: UploadResponse | null) => void,
     options?: Partial<ImageKitOptions>,
@@ -62,7 +68,7 @@ const ImageKit = function (
       ...options,
     };
     return upload(uploadOptions, mergedOptions, callback);
-  };
-};
+  }
+}
 
 export default ImageKit;

src/index.ts

@@ -3,14 +3,5 @@ import { TransformationPosition } from "./Transformation";
 import { UploadOptions } from "./UploadOptions";
 import { UploadResponse, FileType } from "./UploadResponse";
 import { UrlOptions } from "./UrlOptions";
-export interface IImageKit {
-  options: ImageKitOptions;
-  url: (urlOptions: UrlOptions) => string;
-  upload: (
-    uploadOptions: UploadOptions,
-    callback?: (err: Error | null, response: UploadResponse | null) => void,
-    options?: Partial<ImageKitOptions>,
-  ) => void;
-}
 
 export { ImageKitOptions, TransformationPosition, UploadOptions, UploadResponse, FileType, UrlOptions };