refactor: remove IKResponse interface and update related imports; introduce SrcOptions interface for upload functionality

Author: manu4543

src/index.ts

@@ -1,11 +1,13 @@
-import { UploadOptions, UploadResponse, UrlOptions } from "./interfaces";
-import { upload } from "./upload";
-import { buildURL, generateTransformationString } from "./url";
-
-export { buildURL, generateTransformationString, upload };
+import { SrcOptions, Transformation, UploadOptions, UploadResponse } from "./interfaces";
+import { ImageKitAbortError, ImageKitInvalidRequestError, ImageKitServerError, ImageKitUploadNetworkError, upload } from "./upload";
+import { buildSrc, buildTransformationString } from "./url";
 
+export { buildSrc, buildTransformationString, upload, ImageKitInvalidRequestError, ImageKitAbortError, ImageKitServerError, ImageKitUploadNetworkError };
 export type {
-  UrlOptions,
+  Transformation,
+  SrcOptions,
   UploadOptions,
   UploadResponse
 };
+
+

src/interfaces/IKResponse.ts

@@ -1,7 +1,7 @@
 import { Transformation } from "./Transformation";
 import { TransformationPosition } from ".";
 
-export interface UrlOptions {
+export interface SrcOptions {
   /**
    * Accepts relative or absolute path of the resource. If relative path is provided, it is appended to the `urlEndpoint`. If absolute path is provided, `urlEndpoint` is ignored.
    */

src/interfaces/UrlOptions.ts src/interfaces/SrcOptions.tssrc/interfaces/UrlOptions.ts renamed to src/interfaces/SrcOptions.ts

@@ -21,9 +21,7 @@ interface Transformation {
   post?: PostTransformation[]
 }
 /**
- * Options used when uploading a file
- *
- * {@link https://imagekit.io/docs/api-reference/upload-file/upload-file#Request}
+ * Options used when uploading a file. Checkout [upload docs](https://imagekit.io/docs/api-reference/upload-file/upload-file#Request) for more details.
  */
 export interface UploadOptions {
   /**

src/interfaces/UploadOptions.ts

@@ -6,7 +6,7 @@
  *
  * {@link https://imagekit.io/docs/api-reference/digital-asset-management-dam/list-and-search-assets}
  */
-export type FileType = "all" | "image" | "non-image";
+type FileType = "all" | "image" | "non-image";
 
 /**
  * Metadata object structure
@@ -23,7 +23,7 @@ export type FileType = "all" | "image" | "non-image";
  * 
  * Perceptual hashing allows you to construct a hash value that uniquely identifies an input image based on the image's contents. It is different from cryptographic hash functions like MD5 and SHA1. pHash provides similar hash value after minor distortions, like small rotations, blurring, and compression in the image.
  */
-export interface Metadata {
+interface Metadata {
   height: number;
   width: number;
   size: number;

src/interfaces/UploadResponse.ts

@@ -1,7 +1,7 @@
-import { TransformationPosition } from "./Transformation";
+import { Transformation, TransformationPosition } from "./Transformation";
 import { UploadOptions } from "./UploadOptions";
-import { FileType, UploadResponse } from "./UploadResponse";
-import { UrlOptions } from "./UrlOptions";
+import { ResponseMetadata, UploadResponse } from "./UploadResponse";
+import { SrcOptions } from "./SrcOptions";
 
-export type { FileType, TransformationPosition, UploadOptions, UploadResponse, UrlOptions };
+export type { ResponseMetadata, Transformation, TransformationPosition, UploadOptions, UploadResponse, SrcOptions };
 

src/interfaces/index.ts

@@ -1,7 +1,5 @@
 import errorMessages from "./constants/errorMessages";
-import { UploadOptions } from "./interfaces/UploadOptions";
-import { ResponseMetadata, UploadResponse } from "./interfaces/UploadResponse";
-
+import { ResponseMetadata, UploadOptions, UploadResponse } from "./interfaces";
 
 export class ImageKitInvalidRequestError extends Error {
   /**
@@ -47,12 +45,12 @@ export class ImageKitServerError extends Error {
 }
 
 /**
- * Uploads a file with the given upload options.
+ * Uploads a file to ImageKit with the given upload options.
  * 
- * @throws {ImageKitInvalidRequestError} If the request is invalid.
- * @throws {ImageKitAbortError} If the request is aborted.
- * @throws {ImageKitUploadNetworkError} If there is a network error.
- * @throws {ImageKitServerError} If there is a server error.
+ * @throws {@link ImageKitInvalidRequestError} If the request is invalid.
+ * @throws {@link ImageKitAbortError} If the request is aborted.
+ * @throws {@link ImageKitUploadNetworkError} If there is a network error.
+ * @throws {@link ImageKitServerError} If there is a server error.
  * 
  * @param {UploadOptions} uploadOptions - The options for uploading the file.
  * @returns A Promise resolving to a successful {@link UploadResponse}

src/upload.ts

@@ -1,4 +1,4 @@
-import { UrlOptions } from "./interfaces";
+import { SrcOptions } from "./interfaces";
 import { ImageOverlay, SolidColorOverlay, SubtitleOverlay, TextOverlay, Transformation, VideoOverlay } from "./interfaces/Transformation";
 import transformationUtils, { safeBtoa } from "./utils/transformation";
 const TRANSFORMATION_PARAMETER = "tr";
@@ -25,7 +25,7 @@ function pathJoin(parts: string[], sep?: string) {
   return parts.join(separator).replace(replace, separator);
 }
 
-export const buildURL = (opts: UrlOptions) => {
+export const buildSrc = (opts: SrcOptions) => {
   opts.urlEndpoint = opts.urlEndpoint || "";
   opts.src = opts.src || "";
   opts.transformationPosition = opts.transformationPosition || "query";
@@ -55,7 +55,7 @@ export const buildURL = (opts: UrlOptions) => {
     urlObj.searchParams.append(i, String(opts.queryParameters[i]));
   }
 
-  var transformationString = generateTransformationString(opts.transformation);
+  var transformationString = buildTransformationString(opts.transformation);
 
   if (transformationString && transformationString.length) {
     if (!transformationUtils.addAsQueryParameter(opts) && !isSrcParameterUsedForURL) {
@@ -209,7 +209,7 @@ function processOverlay(overlay: Transformation["overlay"]): string | undefined
     entries.push(`ldu-${duration}`);
   }
 
-  const transformationString = generateTransformationString(transformation);
+  const transformationString = buildTransformationString(transformation);
 
   if (transformationString && transformationString.trim() !== "") entries.push(transformationString);
 
@@ -218,7 +218,7 @@ function processOverlay(overlay: Transformation["overlay"]): string | undefined
   return entries.join(transformationUtils.getTransformDelimiter());
 }
 
-export const generateTransformationString = function (transformation: Transformation[] | undefined) {
+export const buildTransformationString = function (transformation: Transformation[] | undefined) {
   if (!Array.isArray(transformation)) {
     return "";
   }

src/url.ts

@@ -1,5 +1,5 @@
 import supportedTransforms from "../constants/supportedTransforms";
-import { TransformationPosition, UrlOptions } from "../interfaces";
+import { TransformationPosition, SrcOptions } from "../interfaces";
 
 const QUERY_TRANSFORMATION_POSITION: TransformationPosition = "query";
 const PATH_TRANSFORMATION_POSITION: TransformationPosition = "path";
@@ -10,7 +10,7 @@ const TRANSFORM_DELIMITER: string = ",";
 const TRANSFORM_KEY_VALUE_DELIMITER: string = "-";
 
 export default {
-    addAsQueryParameter: (options: UrlOptions) => {
+    addAsQueryParameter: (options: SrcOptions) => {
         return options.transformationPosition === QUERY_TRANSFORMATION_POSITION;
     },
     getTransformKey: function (transform: string) {

src/utils/transformation.ts

@@ -2,13 +2,12 @@ const chai = require("chai");
 const sinon = require("sinon");
 const expect = chai.expect;
 import 'regenerator-runtime/runtime';
-import { upload } from "../src/index";
 import {
     ImageKitAbortError,
     ImageKitInvalidRequestError,
     ImageKitServerError,
-    ImageKitUploadNetworkError
-} from '../src/upload';
+    ImageKitUploadNetworkError, upload
+} from "../src/index";
 
 var requests, server;