Skip to content

Commit ec58101

Browse files
imagekitioimagekitio
committed
updated documentation, demo and fixed request error handling
1 parent 27380e6 commit ec58101

File tree

3 files changed

+312
-10
lines changed

3 files changed

+312
-10
lines changed

‎README.md‎

Lines changed: 295 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,306 @@ ImageKit is a complete image optimization and transformation solution that comes
1010

1111
## Initialization
1212

13+
```
14+
var ImageKit = require("imagekit");
15+
16+
var imagekit = new ImageKit({
17+
publicKey : "your_public_api_key",
18+
privateKey : "your_private_api_key",
19+
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
20+
});
21+
```
22+
1323
## Usage
24+
You can use this NodeJS SDK for 3 different kinds of functions - URL generation, file uploads and file management. The usage of the SDK has been explained below
25+
26+
### URL Generation
27+
There are two ways of creating a URL with the SDK.
28+
29+
The first method allows you to create a URL using the path where the image exists and the URL endpoint you want to use to access the image. You can refer to the documentation [here](https://docs.imagekit.io/imagekit-docs/url-endpoints) to read more about URL endpoints in ImageKit and the section about [image origins](https://docs.imagekit.io/imagekit-docs/configure-origin) to understand about paths with different kinds of origins.
30+
31+
The second method allows you to add transformation parameters to an existing, complete URL that is already mapped to ImageKit. This method should be used if you have the complete URL mapped to ImageKit stored in your database.
32+
33+
#### Creating Normal URL
34+
35+
**1. Using `path` and `urlEndpoint` parameters**
36+
37+
```
38+
var imageURL = imagekit.url({
39+
path : "/default-image.jpg",
40+
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/endpoint/",
41+
transformation : [{
42+
"HEIGHT" : "300",
43+
"WIDTH" : "400"
44+
}]
45+
});
46+
```
47+
48+
This results in a URL like
49+
50+
```
51+
https://ik.imagekit.io/your_imagekit_id/endpoint/tr:h-300,w-400/default-image.jpg
52+
```
53+
54+
**2. Using the `src` parameter**
55+
56+
```
57+
var imageURL = imagekit.url({
58+
src : "https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg",
59+
transformation : [{
60+
"HEIGHT" : "300",
61+
"WIDTH" : "400"
62+
}]
63+
});
64+
```
65+
66+
This results in a URL like
67+
68+
```
69+
https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=h-300%2Cw-400
70+
```
71+
72+
73+
The `.url()` method accepts the following parameters
74+
| Option | Description |
75+
| :----------------| :----------------------------- |
76+
| urlEndpoint | Optional. The base URL to be appended before the path of the image. If not specified, the URL Endpoint specified at the time of SDK initialization is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ |
77+
| path | Conditional. This is the path at which the image exists. For example, `/path/to/image.jpg`. Either the `path` or `src` parameter need to be specified for URL generation. |
78+
| src | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter need to be specified for URL generation. |
79+
| 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/imagekit-docs/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. |
80+
| 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. |
81+
| 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. |
82+
| 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. |
83+
| 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. |
84+
85+
#### Examples of generating URLs
86+
87+
**1. Chained Transformations as a query parameter**
88+
```
89+
var imageURL = imagekit.url({
90+
path : "/default-image.jpg",
91+
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/endpoint/",
92+
transformation : [{
93+
"HEIGHT" : "300",
94+
"WIDTH" : "400"
95+
}, {
96+
"ROTATION" : 90
97+
}],
98+
transformationPosition : "query"
99+
});
100+
```
101+
```
102+
https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=h-300%2Cw-400%3Art-90
103+
```
104+
105+
**2. Sharpening and contrast transforms and a progressive JPG image**
106+
107+
There are some transforms like [Sharpening](https://docs.imagekit.io/imagekit-docs/image-enhancement---color-manipulation) that can be added to the URL with or without any other value. To use such transforms without specifying a value, specify the value as "-" in the transformation object, otherwise, specify the value that you want to be added to this transformation.
108+
109+
```
110+
var imageURL = imagekit.url({
111+
src : "https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg",
112+
transformation : [{
113+
"FORMAT" : "jpg",
114+
"PROGRESSIVE" : "true",
115+
"EFFECT_SHARPEN" : "-",
116+
"EFFECT_CONTRAST" : "1"
117+
}]
118+
});
119+
```
120+
```
121+
//Note that because `src` parameter was used, the transformation string gets added as a query parameter `tr`
122+
https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=f-jpg%2Cpr-true%2Ce-sharpen%2Ce-contrast-1
123+
```
124+
125+
**3. Signed URL that expires in 300 seconds with the default URL endpoint and other query parameters**
126+
```
127+
var imageURL = imagekit.url({
128+
path : "/default-image.jpg",
129+
queryParameters : {
130+
"v" : "123"
131+
},
132+
transformation : [{
133+
"HEIGHT" : "300",
134+
"WIDTH" : "400"
135+
}],
136+
signed : true,
137+
expireSeconds : 300
138+
});
139+
```
140+
```
141+
https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg?v=123&ik-t=1567358667&ik-s=f2c7cdacbe7707b71a83d49cf1c6110e3d701054
142+
```
143+
144+
#### List of supported transformations
145+
146+
The complete list of transformations supported and their usage in ImageKit can be found [here](https://docs.imagekit.io/imagekit-docs/image-transformations). The SDK gives a name to each transformation parameter, making the code simpler and readable. If a transformation is supported in ImageKit, but a name for it cannot be found in the table below, then use the transformation code from ImageKit docs as the name when using in the `url` function.
147+
148+
| Supported Transformation Name | Translates to parameter |
149+
|-------------------------------|-------------------------|
150+
| HEIGHT | h |
151+
| WIDTH | w |
152+
| ASPECT_RATIO | ar |
153+
| QUALITY | q |
154+
| CROP | c |
155+
| CROP_MODE | cm |
156+
| X | x |
157+
| Y | y |
158+
| FOCUS | fo |
159+
| FORMAT | f |
160+
| RADIUS | r |
161+
| BACKGROUND | bg |
162+
| BORDER | bo |
163+
| ROTATION | rt |
164+
| BLUR | bl |
165+
| NAMED | n |
166+
| OVERLAY_IMAGE | oi |
167+
| OVERLAY_X | ox |
168+
| OVERLAY_Y | oy |
169+
| OVERLAY_FOCUS | ofo |
170+
| OVERLAY_HEIGHT | oh |
171+
| OVERLAY_WIDTH | ow |
172+
| OVERLAY_TEXT | ot |
173+
| OVERLAY_TEXT_FONT_SIZE | ots |
174+
| OVERLAY_TEXT_FONT_FAMILY | otf |
175+
| OVERLAY_TEXT_COLOR | otc |
176+
| OVERLAY_ALPHA | oa |
177+
| OVERLAY_TEXT_TYPOGRAPHY | ott |
178+
| OVERLAY_BACKGROUND | obg |
179+
| OVERLAY_IMAGE_TRIM | oit |
180+
| PROGRESSIVE | pr |
181+
| LOSSLESS | lo |
182+
| TRIM | t |
183+
| METADATA | md |
184+
| COLOR_PROFILE | cp |
185+
| DEFAULT_IMAGE | di |
186+
| DPR | dpr |
187+
| EFFECT_SHARPEN | e-sharpen |
188+
| EFFECT_USM | e-usm |
189+
| EFFECT_CONTRAST | e-contrast |
190+
| EFFECT_GRAY | e-grayscale |
191+
| ORIGINAL | orig |
14192

15-
### Create URL
16193

17-
### Create Signed URL
18194

19195
### File Upload
20196

197+
The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media Library. It accepts all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/imagekit-docs/server-side-file-upload).
198+
199+
The `upload()` method requires at least the `file` and the `fileName` parameter to upload a file and returns a callback with the `error` and `result` as arguments. You can pass other parameters supported by the ImageKit upload API using the same parameter name as specified in the upload API documentation. For example, to specify tags for a file at the time of upload use the `tags` parameter as specified in the [documentation here](https://docs.imagekit.io/imagekit-docs/server-side-file-upload).
200+
201+
Sample usage
202+
```
203+
imagekit.upload({
204+
file : <url|base_64|binary>, //required
205+
fileName : "my_file_name.jpg", //required
206+
}, function(error, result) {
207+
208+
});
209+
```
210+
211+
If the upload succeed, `error` will be `null` and the `result` will be the same as what is received from ImageKit's servers.
212+
If the upload fails, `error` will be the same as what is received from ImageKit's servers and the `result` will be null.
213+
214+
215+
21216
### File Management
22217

218+
The SDK provides a simple interface for all the [media APIs mentioned here](https://docs.imagekit.io/imagekit-docs/media-api) to manage your files. You can use a callback function with all API interfaces. The first argument of the callback function is the error and the second is the result of the API call. Error will be `null` if the API succeeds.
219+
220+
**1. List & Search Files**
221+
222+
Accepts an object specifying the parameters to be used to list and search files. All parameters specified in the [documentation here](https://docs.imagekit.io/imagekit-docs/list-and-search-files-api) can be passed as is with the correct values to get the results.
223+
224+
```
225+
imagekit.listFiles({
226+
skip : 10,
227+
limit : 10
228+
}, function(err, result) {
229+
230+
});
231+
```
232+
233+
**2. Get File Details**
234+
235+
Accepts the file ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/get-file-details-api).
236+
237+
```
238+
imagekit.getFileDetails("file_id", function(err, result) {
239+
240+
});
241+
```
242+
243+
**3. Get File Metadata**
244+
245+
Accepts the file ID and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/get-image-metadata-api).
246+
247+
```
248+
imagekit.getFileMetadata("file_id", function(err, result) {
249+
250+
});
251+
```
252+
253+
**4. Update File Details**
254+
255+
Update parameters associated with the file as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/update-file-details-api). The first argument to the `updateFileDetails` method is the file ID and the second argument is an object with the parameters to be updated.
256+
257+
```
258+
imagekit.updateFileDetails("file_id", {
259+
tags : ['image_tag'],
260+
customCoordinates : "10,10,100,100"
261+
}, function(err, result) {
262+
263+
});
264+
```
265+
266+
**5. Delete File**
267+
268+
Delete a file as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/delete-file-api). The method accepts the file ID of the file that has to be deleted.
269+
270+
```
271+
imagekit.deleteFile("file_id", function(err, result) {
272+
273+
});
274+
```
275+
276+
**6. Purge Cache**
277+
278+
Programmatically issue a cache clear request as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/purge-cache-api). Accepts the full URL of the file for which the cache has to be cleared.
279+
280+
```
281+
imagekit.purgeCache("full_url", function(err, result) {
282+
283+
});
284+
```
285+
286+
**7. Purge Cache Status**
287+
288+
Get the purge cache request status using the request ID returned when a purge cache request gets submitted as per the [API documentation here](https://docs.imagekit.io/imagekit-docs/purge-cache-status-api)
289+
290+
```
291+
imagekit.getPurgeCacheStatus("cache_request_id", function(err, result) {
292+
293+
});
294+
```
295+
296+
### Authentication Parameter Generation
297+
298+
In case you are looking to implement client-side file upload, you are going to need a token, timestamp and a valid signature for that upload. The SDK provides a simple method that you can use in your code to generate these authentication parameters for you.
299+
300+
*Note: The Private API Key should never be exposed in any client-side code. You must always generate these authentication parameters on the server-side*
301+
302+
```
303+
var authenticationParameters = imagekit.getAuthenticationParameters(token, timestamp);
304+
```
305+
306+
Returns
307+
```
308+
{
309+
token : "unique_token",
310+
timestamp : "valid_timestamp",
311+
signature : "generated_signature"
312+
}
313+
```
314+
315+
Both the `token` and `timestamp` parameters are optional. If not specified the SDK uses the [uuid](https://www.npmjs.com/package/uuid) package to generate a random token and also generates a valid timestamp internally. The value of the `token` and `timestamp` used to generate the signature are always returned in the response, no matter if they are provided as an input to this method or not.

‎demo/index.js‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ var imageURL = imagekit.url({
3030

3131
var authenticationParameters = imagekit.getAuthenticationParameters("your_token");
3232

33-
imagekit.purgeCache("full_url", function(err, body) { /*console.log(arguments);*/ });
34-
imagekit.getPurgeCacheStatus("cache_request_id", function(err, body) { /*console.log(arguments);*/ });
35-
imagekit.deleteFile("file_id", function(err, body) { /*console.log(arguments);*/ });
36-
imagekit.getFileDetails("file_id", function(err, body) { /*console.log(arguments);*/ });
37-
imagekit.getFileMetadata("file_id", function(err, body) { /*console.log(arguments);*/ });
38-
imagekit.updateFileDetails("file_id", { tags : ['image_tag'] }, function(err, body) { /*console.log(arguments);*/ });
39-
imagekit.upload({file : "your_file", fileName : "your_file_name.jpg"}, function(err, body) { /*console.log(arguments);*/ });
33+
imagekit.purgeCache("full_url", function(err, result) { /*console.log(arguments);*/ });
34+
imagekit.getPurgeCacheStatus("cache_request_id", function(err, result) { /*console.log(arguments);*/ });
35+
imagekit.deleteFile("file_id", function(err, result) { /*console.log(arguments);*/ });
36+
imagekit.listFiles({}, function(err, result) { /* console.log(arguments) */ });
37+
imagekit.getFileDetails("file_id", function(err, result) { /*console.log(arguments);*/ });
38+
imagekit.getFileMetadata("file_id", function(err, result) { /*console.log(arguments);*/ });
39+
imagekit.updateFileDetails("file_id", { tags : ['image_tag'] }, function(err, result) { /*console.log(arguments);*/ });
40+
imagekit.upload({file : "your_file", fileName : "your_file_name.jpg"}, function(err, result) { /*console.log(arguments);*/ });

‎utils/request.js‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ var authorizationUtils = require("./authorization");
33

44
module.exports = function(requestOptions, defaultOptions, callback) {
55
authorizationUtils.addAuthorization(requestOptions, defaultOptions.privateKey);
6-
request(requestOptions, callback);
6+
request(requestOptions, function(err, response, body) {
7+
if(typeof callback != "function") return;
8+
9+
if(response.statusCode >= 400) {
10+
callback(err || body);
11+
} else {
12+
callback(err, response, body);
13+
}
14+
});
715
}
816

0 commit comments

Comments
 (0)