Merge pull request #57 from imagekit-developer/dev

imagekitio · web-flow · commit d1cf79d3484b · 2022-07-06T12:28:22.000+05:30
Dev
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -22,6 +22,7 @@ jobs:
         npm i -g yarn
         yarn install
         yarn test
+        yarn test-e2e
         yarn report-coverage
       env:
         CI: true
diff --git a/.github/workflows/npmpublish.yml b/.github/workflows/npmpublish.yml
@@ -25,6 +25,7 @@ jobs:
         npm i -g yarn
         yarn install
         yarn test
+        yarn test-e2e
       env:
         CI: true
   
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,12 @@ node_modules
 coverage.lcov
 coverage
 .DS_Store 
-dist*
+dist*
+tests/e2e/node-js/package.json
+tests/e2e/node-js/yarn.lock
+tests/e2e/typescript/package.json
+tests/e2e/typescript/yarn.lock
+tests/e2e/typescript/index.js
+.cache
+yarn-error.log
+*.tgz
diff --git a/.npmignore b/.npmignore
@@ -9,4 +9,11 @@ babel-register.js
 .vscode
 .DS_Store
 .mocharc.json
-.nycrc
+.nycrc
+libs/*
+utils/*
+tsconfig*
+fixup.sh
+index.ts
+*.tgz
+test-e2e.sh
diff --git a/README.md b/README.md
@@ -13,7 +13,6 @@ Node.js SDK for [ImageKit](https://imagekit.io/) implements the new APIs and int
 
 ImageKit is complete media storage, optimization, and transformation solution that comes with an [image and video CDN](https://imagekit.io/features/imagekit-infrastructure). It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
 
-This SDK supports both CommonJS and ESM.
 ##### Table of contents
 * [Installation](#installation)
 * [Initialization](#initialization)
diff --git a/index.ts b/index.ts
@@ -99,8 +99,7 @@ class ImageKit {
   }
 
   /**
-   * 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.
+   * This method allows you to create an URL to access a file using the relative or absolute path and the ImageKit URL endpoint (urlEndpoint). The file can be an image, video or any other static file supported by ImageKit.
    *
    * @see {@link https://github.com/imagekit-developer/imagekit-nodejs#url-generation}
    * @see {@link https://docs.imagekit.io/integration/url-endpoints}
@@ -113,10 +112,7 @@ class ImageKit {
   }
 
   /**
-   * 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.
+   * You can upload file to ImageKit.io media library from your server-side using private API key authentication.
    *
    * @see {@link https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload}
    *
@@ -133,7 +129,7 @@ class ImageKit {
 
   /**
    * This API can list all the uploaded files in your ImageKit.io media library.
-   * For searching and filtering, you can use query parameters as described below.
+   * For searching and filtering, you can use query parameters as described in docs.
    *
    * @see {@link https://docs.imagekit.io/api-reference/media-api/list-and-search-files}
    *
@@ -165,7 +161,7 @@ class ImageKit {
   }
 
   /**
-   * Get all versions of an assset API
+   * Get all versions of an assset.
    *
    * @see {@link https://docs.imagekit.io/api-reference/media-api/get-file-versions}
    *
@@ -181,7 +177,7 @@ class ImageKit {
   }
 
   /**
-   * Get file version details API
+   * Get file details of a specific version.
    *
    * @see {@link https://docs.imagekit.io/api-reference/media-api/get-file-version-details}
    *
@@ -673,4 +669,4 @@ class ImageKit {
   }
 }
 
-export default ImageKit;
+export = ImageKit;
diff --git a/libs/constants/supportedTransforms.ts b/libs/constants/supportedTransforms.ts
@@ -1,7 +1,7 @@
 /**
  * @see {@link https://docs.imagekit.io/features/image-transformations}
  */
-const supportedTransforms: { [key: string]: string } = {
+const supportedTransforms = {
   /**
    * @see {@link https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#width-w}
    */
@@ -286,4 +286,5 @@ const supportedTransforms: { [key: string]: string } = {
   original: "orig",
 };
 
-export default supportedTransforms;
+export default supportedTransforms as { [key: string]: string };
+export type SupportedTransformsParam = keyof typeof supportedTransforms;
diff --git a/libs/interfaces/Transformation.ts b/libs/interfaces/Transformation.ts
@@ -1,5 +1,10 @@
-import supportedTransforms from "../constants/supportedTransforms";
+import { SupportedTransformsParam } from "../constants/supportedTransforms";
 
 export type TransformationPosition = "path" | "query";
 
-export type Transformation = Partial<typeof supportedTransforms>;
+export type Transformation = Partial<
+  | {
+      [key in SupportedTransformsParam]: string | boolean | number;
+    }
+  | { [key: string]: string | boolean | number }
+>;
diff --git a/libs/url/builder.ts b/libs/url/builder.ts
@@ -113,7 +113,9 @@ const buildURL = function (opts: FinalUrlOptions): string {
   return url.format(urlObject);
 };
 
-function constructTransformationString(transformation: Array<Transformation> | undefined) {
+function constructTransformationString(inputTransformation: Array<Transformation> | undefined) {
+
+  const transformation = inputTransformation as Array<{ [key: string]: string | boolean | number }> | undefined;
   if (!Array.isArray(transformation)) {
     return "";
   }
diff --git a/package.json b/package.json
@@ -1,16 +1,13 @@
 {
   "name": "imagekit",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Offical NodeJS SDK for ImageKit.io integration",
-  "main": "./dist/cjs/index.js",
-  "types": "./dist/types/index.d.ts",
-  "module": "./dist/esm/index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "compile": "concurrently 'yarn:compile:cjs' 'yarn:compile:esm' 'yarn:compile:types'",
-    "compile:cjs": "rm -rf dist/cjs & tsc -p tsconfig.cjs.json",
-    "compile:esm": "rm -rf dist/esm & tsc -p tsconfig.esm.json",
-    "compile:types": "rm -rf dist/types & tsc -p tsconfig.types.json",
+    "compile": "rm -rf dist/ & tsc -p tsconfig.json",
     "test": "export NODE_ENV=test; nyc ./node_modules/mocha/bin/mocha --exit -t 40000 tests/*.js;ex=$?;unset NODE_ENV; exit $ex;",
+    "test-e2e": "sh test-e2e.sh; exit $?;",
     "report-coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
     "prepack": "npm run compile"
   },
@@ -56,9 +53,12 @@
     "@babel/preset-env": "^7.14.5",
     "@babel/preset-typescript": "^7.14.5",
     "@babel/register": "^7.14.5",
+    "@types/chai": "^4.3.1",
     "@types/lodash": "^4.14.170",
+    "@types/mocha": "^9.1.1",
     "@types/node": "^15.12.2",
     "@types/request": "^2.48.5",
+    "@types/sinon": "^10.0.12",
     "@types/uuid": "^8.3.4",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "chai": "^4.2.0",
diff --git a/test-e2e.sh b/test-e2e.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+npm pack
+cd tests/e2e
+export YARN_CACHE_FOLDER=.cache
+cd node-js
+rm -rf .cache
+yarn init --yes
+echo "Installing local bundle from TAR in NodeJS project"
+yarn add ../../../imagekit*.tgz
+node index.js;test_result=$?
+echo $test_result
+if [ "$test_result" != "0" ]; then
+  printf '%s\n' "Final bundle not working in NodeJS project" >&2
+  exit 1                                
+fi
+echo "Final bundle working in NodeJS project"
+
+cd ../typescript
+rm -rf .cache
+yarn init --yes
+yarn add typescript --dev
+echo "Installing local bundle from TAR in Typescript project"
+yarn add ../../../imagekit*.tgz
+npx tsc && node index.js;test_result=$?
+echo $test_result
+if [ "$test_result" != "0" ]; then
+  printf '%s\n' "Final bundle not working in Typescript project" >&2
+  exit 1                                
+fi
+echo "Final bundle working in Typescript project"
+
+rm -rf ../../../imagekit*.tgz
diff --git a/tests/e2e/node-js/index.js b/tests/e2e/node-js/index.js
@@ -0,0 +1,31 @@
+const ImageKit = require("imagekit");
+
+try {
+    var imagekit = new ImageKit({
+        publicKey: "public",
+        privateKey: "private",
+        urlEndpoint: "https://ik.imagekit.io/xyz"
+    });
+
+    var url = imagekit.url({
+        path: "Screenshot_2022-07-05_at_1.06.47_PM_2558irHgF.png",
+        transformation: [{
+            width: 100,
+            raw: "sdfdsf"
+        }],
+        transformationPosition: "path"
+    })
+
+    if (url === "https://ik.imagekit.io/xyz/tr:w-100,sdfdsf/Screenshot_2022-07-05_at_1.06.47_PM_2558irHgF.png") {
+        process.exit(0);
+    } else {
+        console.log("Invalid URL", url);
+        process.exit(1);
+    }
+
+
+} catch (ex) {
+    console.log(ex)
+    process.exit(1);
+}
+
diff --git a/tests/e2e/typescript/index.ts b/tests/e2e/typescript/index.ts
@@ -0,0 +1,30 @@
+import ImageKit from "imagekit";
+
+try {
+    var imagekit = new ImageKit({
+        publicKey: "public",
+        privateKey: "private",
+        urlEndpoint: "https://ik.imagekit.io/xyz"
+    });
+
+    var url = imagekit.url({
+        path: "Screenshot_2022-07-05_at_1.06.47_PM_2558irHgF.png",
+        transformation: [{
+            width: 100,
+            raw: "sdfdsf"
+        }],
+        transformationPosition: "path"
+    })
+
+    if (url === "https://ik.imagekit.io/xyz/tr:w-100,sdfdsf/Screenshot_2022-07-05_at_1.06.47_PM_2558irHgF.png") {
+        process.exit(0);
+    } else {
+        console.log("Invalid URL", url);
+        process.exit(1);
+    }
+
+
+} catch (ex) {
+    console.log(ex)
+    process.exit(1);
+}
diff --git a/tests/e2e/typescript/tsconfig.json b/tests/e2e/typescript/tsconfig.json
diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json
diff --git a/tsconfig.esm.json b/tsconfig.esm.json
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tsconfig.types.json b/tsconfig.types.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,7 @@ class ImageKit {`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`/**`
`102`		`- * You can add multiple origins in the same ImageKit.io account.`
`103`		`- * URL endpoints allow you to configure which origins are accessible through your account and set their preference order as well.`
	`102`	`+ * This method allows you to create an URL to access a file using the relative or absolute path and the ImageKit URL endpoint (urlEndpoint). The file can be an image, video or any other static file supported by ImageKit.`
`104`	`103`	`*`
`105`	`104`	`* @see {@link https://github.com/imagekit-developer/imagekit-nodejs#url-generation}`
`106`	`105`	`* @see {@link https://docs.imagekit.io/integration/url-endpoints}`
`@@ -113,10 +112,7 @@ class ImageKit {`
`113`	`112`	`}`
`114`	`113`
`115`	`114`	`/**`
`116`		`- * You can upload files to ImageKit.io media library from your server-side using private API key authentication.`
`117`		`- *`
`118`		`- * File size limit`
`119`		`- * The maximum upload file size is limited to 25MB.`
	`115`	`+ * You can upload file to ImageKit.io media library from your server-side using private API key authentication.`
`120`	`116`	`*`
`121`	`117`	`* @see {@link https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload}`
`122`	`118`	`*`
`@@ -133,7 +129,7 @@ class ImageKit {`
`133`	`129`
`134`	`130`	`/**`
`135`	`131`	`* This API can list all the uploaded files in your ImageKit.io media library.`
`136`		`- * For searching and filtering, you can use query parameters as described below.`
	`132`	`+ * For searching and filtering, you can use query parameters as described in docs.`
`137`	`133`	`*`
`138`	`134`	`* @see {@link https://docs.imagekit.io/api-reference/media-api/list-and-search-files}`
`139`	`135`	`*`
`@@ -165,7 +161,7 @@ class ImageKit {`
`165`	`161`	`}`
`166`	`162`
`167`	`163`	`/**`
`168`		`- * Get all versions of an assset API`
	`164`	`+ * Get all versions of an assset.`
`169`	`165`	`*`
`170`	`166`	`* @see {@link https://docs.imagekit.io/api-reference/media-api/get-file-versions}`
`171`	`167`	`*`
`@@ -181,7 +177,7 @@ class ImageKit {`
`181`	`177`	`}`
`182`	`178`
`183`	`179`	`/**`
`184`		`- * Get file version details API`
	`180`	`+ * Get file details of a specific version.`
`185`	`181`	`*`
`186`	`182`	`* @see {@link https://docs.imagekit.io/api-reference/media-api/get-file-version-details}`
`187`	`183`	`*`
`@@ -673,4 +669,4 @@ class ImageKit {`
`673`	`669`	`}`
`674`	`670`	`}`
`675`	`671`
`676`		`-export default ImageKit;`
	`672`	`+export = ImageKit;`