Fix in signed url and readme.md

Author: Manu Chaudhary

README.md

@@ -98,7 +98,7 @@ The `.url()` method accepts the following parameters
 | transformation   | Optional. An array of objects specifying the transformation to be applied in the URL. The transformation name  and the value should be specified as a key-value pair in the object. Different steps of a [chained transformation](https://docs.imagekit.io/features/image-transformations/chained-transformations) can be specified as different objects of the array. The complete list of supported transformations in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL. |
 | transformationPostion | Optional. Default value is `path` that places the transformation string as a path parameter in the URL. Can also be specified as `query` which adds the transformation string as the query parameter `tr` in the URL. If you use `src` parameter to create the URL, then the transformation string is always added as a query parameter. |
 | queryParameters  | Optional. These are the other query parameters that you want to add to the final URL. These can be any query parameters and not necessarily related to ImageKit. Especially useful, if you want to add some versioning parameter to your URLs. |
-| signed           | Optional. Boolean. Default is `false`. If set to `true`, the SDK generates a signed image URL adding the image signature to the image URL. This can only be used if you are creating the URL with the `urlEndpoint` and `path` parameters, and not with the `src` parameter. |
+| signed           | Optional. Boolean. 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 |
 | expireSeconds    | Optional. Integer. 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. |
 
 #### Examples of generating URLs

libs/url/builder.js

@@ -75,12 +75,20 @@ module.exports.buildURL = function(opts) {
     urlObject.pathname = urlFormatter.addLeadingSlash(urlObject.pathname);
     urlObject.search = queryParameters.toString();
 
-    // Signature String and Timestamp
-    // We can do this only for URLs that are created using urlEndpoint and path parameter
-    // because we need to know the endpoint to be able to remove it from the URL to create a signature
-    // for the remaining. With the src parameter, we would not know the "pattern" in the URL
+    /* 
+        Signature String and Timestamp
+        If the url is constructed using src parameter instead of path then we still replace the urlEndpoint we have
+        But the user is responsible for passing correct urlEndpoint value
+
+        Signature generation logic, let's assume:
+        urlEndpoint value = https://ik.imagekit.io/your_imagekit_id
+        expiryTimestamp 9999999999 
+        1. Let the final URL construct e.g. https://ik.imagekit.io/your_imagekit_id/tr:w-400:rotate-91/sample/testing-file.jpg?param1=123
+        2. Now remove urlEndpoint from it i.e tr:w-400:rotate-91/sample/testing-file.jpg?param1=123
+        3. Append expiryTimestamp to above string and calcualte signature of this string i.e "tr:w-400:rotate-91/sample/testing-file.jpg?param1=1239999999999"
+    */
     var expiryTimestamp;
-    if(opts.signed === true && !isSrcParameterUsedForURL) {
+    if(opts.signed === true) {
         if(opts.expireSeconds) {
             expiryTimestamp = getSignatureTimestamp(opts.expireSeconds);
         } else {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "imagekit",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Offical NodeJS SDK for ImageKit.io integration",
   "main": "index.js",
   "scripts": {

sample/index.js

@@ -44,6 +44,16 @@ const sampleApp = async () => {
             });
         console.log("Url for first image transformed with height: 300, width: 400: ", imageURL, "\n");
 
+        var signedUrl = imagekit.url({
+            path : filesList[0].filePath,
+            signed : true,
+            transformation : [{
+                height: 300,
+                width: 400
+            }]
+        });
+        console.log("Signed Url for first image transformed with height: 300, width: 400: ", signedUrl, "\n");
+
         // Get File Details
         const fileDetails_1 = await getFileDetails(imagekit, filesList[0].fileId);
         console.log("File Details fetched: ", JSON.stringify(fileDetails_1, undefined, 2), "\n");
@@ -58,6 +68,7 @@ const sampleApp = async () => {
         console.log("File Update Response: ", JSON.stringify(fileUpdateResponse, undefined, 2), "\n");
 
         // pHash Distance
+        console.log(fileMetadata_1.pHash, fileMetadata_2.pHash)
         const pHashDistance = imagekit.pHashDistance(fileMetadata_1.pHash, fileMetadata_2.pHash);
         console.log(`pHash distance: ${pHashDistance}`, "\n");