feat: convert TypeScript types made more specific

CHANGES.md

@@ -1,3 +1,6 @@
+## 1.7.2
+* Refine convert TypeScript types and add type tests
+
 ## 1.7.0
 * Added convert and transform functions
 * Added function to get the file extension

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tinify",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "Node.js client for the Tinify API. Tinify compresses your images intelligently. Read more at https://tinify.com.",
   "keywords": [
     "tinify",

src/tinify/Source.ts

@@ -5,6 +5,17 @@ import Client from "./Client"
 import Result from "./Result"
 import ResultMeta from "./ResultMeta"
 
+export type SupportedImageTypes = "image/webp"
+  | "image/png"
+  | "image/jpg";
+
+export type WildcardOrSupportedImageTypes = SupportedImageTypes
+  | "*/*"; // The wildcard "*/*" returns the smallest of Tinify's supported image types, currently JPEG, PNG and WebP.
+
+export type ConvertOptions = {
+  type: WildcardOrSupportedImageTypes | SupportedImageTypes[];
+}
+
 export default class Source {
   /** @internal */
   private _url: Promise<string>
@@ -85,7 +96,7 @@ export default class Source {
     return this.result().toBuffer(callback!)
   }
 
-  convert(options: object): Source {
+  convert(options: ConvertOptions): Source {
       return new tinify.Source(
         this._url,
         Object.assign({ convert: options }, this._commands)

test/tinify-typing-test.ts

@@ -11,6 +11,12 @@ async function run() {
     await tinify.fromBuffer(Buffer.from("foobar")).toBuffer()
     await tinify.fromUrl("https://tinypng.com/images/panda-happy.png").toBuffer()
 
+    await tinify.fromFile("/foo/bar").convert({ type: ["image/webp", "image/png", "image/jpg"] })
+    await tinify.fromFile("/foo/bar").convert({ type: "image/webp" })
+    await tinify.fromFile("/foo/bar").convert({ type: "image/png" })
+    await tinify.fromFile("/foo/bar").convert({ type: "image/jpg" })
+    await tinify.fromFile("/foo/bar").convert({ type: "*/*" })
+
     await tinify.fromBuffer("foo")
       .resize({method: "fit", width: 150, height: 100})
       .preserve("copyright", "creation")