Merge pull request #161 from imagekit-developer/add-checks-parm

Add checks parm

Author: imagekitio

README.md

@@ -205,6 +205,7 @@ import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react'
         }
       ]
     }}
+    checks={`"file.size" < "1mb"`} // To run server side checks before uploading files. Notice the quotes around file.size and 1mb.
   />
 </IKContext>
 ```
@@ -620,12 +621,13 @@ The SDK provides the `IKUpload` component to upload files to the [ImageKit Media
 | onUploadStart           | Function callback                                          | Optional. Called before the upload is started. The first and only argument is the HTML input's change event                                                                                                                                                                                                                                                                                                             |
 | onUploadProgress        | Function callback                                          | Optional. Called while an upload is in progress. The first and only argument is the ProgressEvent                                                                                                                                                                                                                                                                                                                       |
 | validateFile            | Function callback                                          | Optional. This function accepts the `File` object as an argument and exoects a Boolean return value. This is called before the upload is started to run custom validation. The first and only argument is the file selected for upload. If the callback returns `true`, the upload is allowed to continue. But, if it returns `false`, the upload is not done                                                           |
-| overrideParameters      | Function callback                                          | Optional. This function accepts the `File` object as an argument and should return a JSON value, e.g., `{fileName: "new-file-name.jpg"}.` Use this to programmatically override `fileName`, `useUniqueFileName`, `tags`, `folder`, `isPrivateFile`, `customCoordinates`, `extensions`, `webhookUrl`, `overwriteFile`, `overwriteAITags`, `overwriteTags`, `overwriteCustomMetadata`, `customMetadata`, and `transformation` parameters. |
+| overrideParameters      | Function callback                                          | Optional. This function accepts the `File` object as an argument and should return a JSON value, e.g., `{fileName: "new-file-name.jpg"}.` Use this to programmatically override `fileName`, `useUniqueFileName`, `tags`, `folder`, `isPrivateFile`, `customCoordinates`, `extensions`, `webhookUrl`, `overwriteFile`, `overwriteAITags`, `overwriteTags`, `overwriteCustomMetadata`, `customMetadata`, `transformation`, and `checks` parameters. |
 | onSuccess               | Function callback                                          | Optional. Called if the upload is successful. The first and only argument is the response JSON from the upload API. The request-id, response headers, and HTTP status code are also accessible using the $ResponseMetadata key that is exposed from the [javascript sdk](https://github.com/imagekit-developer/imagekit-javascript#access-request-id-other-response-headers-and-http-status-code)                       |
 | onError                 | Function callback                                          | Optional. Called if upload results in an error. The first and only argument is the error received from the upload API                                                                                                                                                                                                                                                                                                   |
 | urlEndpoint             | String                                                     | Optional. If not specified, the URL-endpoint specified in the parent `IKContext` component is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/                                                                                                                                                                                                                                                      |
 | publicKey               | String                                                     | Optional. If not specified, the `publicKey` specified in the parent `IKContext` component is used.                                                                                                                                                                                                                                                                                                                      |
 | authenticator           | ()=>Promise<{signature:string,token:string,expiry:number}> | Optional. If not specified, the `authenticator` specified in the parent `IKContext` component is used.                                                                                                                                                                                                                                                                                                                  |
+| checks | String | Optional. Run server-side checks before uploading files. For example, `"file.size" < "1mb"` will check if the file size is less than 1 MB. Check [Upload API docs](https://imagekit.io/docs/api-reference/upload-file/upload-file#upload-api-checks) to learn more. Notice the quotes around `file.size` and `1mb`; otherwise, you will get an error `Your request contains invalid syntax for the checks parameter.` |
 
 
 > Make sure that you have specified `authenticator` and `publicKey` in `IKUpload` or in the parent `IKContext` component as a prop. The authenticator expects an asynchronous function that resolves with an object containing the necessary security parameters i.e `signature`, `token`, and `expire`.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "imagekitio-react",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "React SDK for ImageKit.io which implements client-side upload and URL generation for use inside a react application.",
   "scripts": {
     "build:js": "rollup -c",
@@ -80,7 +80,7 @@
     "typescript": "^4.8.2"
   },
   "dependencies": {
-    "imagekit-javascript": "^3.0.0",
+    "imagekit-javascript": "^3.0.2",
     "prop-types": "^15.7.2"
   },
   "peerDependencies": {

package.json

@@ -50,6 +50,7 @@ const IKUpload = forwardRef<HTMLInputElement, IKUploadProps & IKContextBaseProps
     extensions,
     customMetadata,
     transformation,
+    checks,
     overrideParameters,
     ...restProps
   } = props;
@@ -151,6 +152,7 @@ const IKUpload = forwardRef<HTMLInputElement, IKUploadProps & IKContextBaseProps
       token: '',
       xhr,
       transformation: overrideValues.transformation || transformation,
+      checks: overrideValues.checks || checks
     };
 
     const authPromise = authenticator();

src/components/IKUpload/index.tsx

@@ -71,6 +71,7 @@ const Props = {
     ref: PropTypes.any,
     transformation: PropTypes.object,
     overrideParameters: PropTypes.func,
+    checks: PropTypes.string
 }
 
 export type OverrideValues = {
@@ -88,6 +89,7 @@ export type OverrideValues = {
   overwriteCustomMetadata?: IKUploadProps['overwriteCustomMetadata'];
   customMetadata?: IKUploadProps['customMetadata'];
   transformation?: IKUploadProps['transformation'];
+  checks?: IKUploadProps['checks'];
 };
 
 export type IKUploadProps = Omit<InferProps<typeof Props>, "customMetadata" | "transformation"> & {
@@ -111,6 +113,7 @@ export type IKUploadProps = Omit<InferProps<typeof Props>, "customMetadata" | "t
     validateFile?: (file: File) => boolean;
     transformation?: TransformationType;
     overrideParameters?: (file: File) => OverrideValues;
+    checks?: string
 } & React.InputHTMLAttributes<HTMLInputElement>;
 
 export default Props;