Merge branch 'main' into beta

cloudinary-community · Oct 22, 2024 · 5f7ccbe · 5f7ccbe
2 parents d262d80 + 0ecd331
commit 5f7ccbe
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 3 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -114,6 +114,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "Mrinank-Bhowmick",
+      "name": "Mrinank Bhowmick",
+      "avatar_url": "https://avatars.githubusercontent.com/u/77621953?v=4",
+      "profile": "https://www.mrinank.me",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <picture>
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
   <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/62209650/196528621-b68e9e10-7e55-4c7d-9177-904cadbb4296.png" align="center" height=50>
   <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/62209650/196528761-a815025a-271a-4d8e-ac7e-cea833728bf9.png" align="center" height=50>
@@ -86,6 +86,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="http://soumyadipmoni.vercel.app"><img src="https://avatars.githubusercontent.com/u/116944847?v=4?s=100" width="100px;" alt="Soumyadip Moni"/><br /><sub><b>Soumyadip Moni</b></sub></a><br /><a href="https://github.com/cloudinary-community/cloudinary-util/commits?author=AvaterClasher" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://noorasfatima.netlify.app/"><img src="https://avatars.githubusercontent.com/u/30138146?v=4?s=100" width="100px;" alt="NOORAS FATIMA ANSARI"/><br /><sub><b>NOORAS FATIMA ANSARI</b></sub></a><br /><a href="https://github.com/cloudinary-community/cloudinary-util/commits?author=nooras" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ayan-joshi"><img src="https://avatars.githubusercontent.com/u/96243602?v=4?s=100" width="100px;" alt="Ayan Joshi"/><br /><sub><b>Ayan Joshi</b></sub></a><br /><a href="https://github.com/cloudinary-community/cloudinary-util/commits?author=ayan-joshi" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.mrinank.me"><img src="https://avatars.githubusercontent.com/u/77621953?v=4?s=100" width="100px;" alt="Mrinank Bhowmick"/><br /><sub><b>Mrinank Bhowmick</b></sub></a><br /><a href="https://github.com/cloudinary-community/cloudinary-util/commits?author=Mrinank-Bhowmick" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

diff --git a/packages/url-loader/src/constants/parameters.ts b/packages/url-loader/src/constants/parameters.ts
@@ -107,7 +107,36 @@ export type FlagRecord = Partial<Record<Flag, StringifiablePrimative>>;
  * @url https://cloudinary.com/documentation/transformation_reference#f_format
  * @qualifier f
  */
-export type Format = string;
+export type Format =
+  | "auto"
+  | "auto:image"
+  | "auto:animated"
+  | "gif"
+  | "png"
+  | "jpg"
+  | "bmp"
+  | "ico"
+  | "pdf"
+  | "tiff"
+  | "eps"
+  | "jpc"
+  | "jp2"
+  | "psd"
+  | "webp"
+  | "zip"
+  | "svg"
+  | "webm"
+  | "wdp"
+  | "hpx"
+  | "djvu"
+  | "ai"
+  | "flif"
+  | "bpg"
+  | "miff"
+  | "tga"
+  | "heic"
+  | "default" // library specific feature to turn off automatic optimization
+  | (string & {});
 
 /**
  *  @description Determines which part of an asset to focus on. Note: Default of auto is applied for supported crop modes only.

diff --git a/packages/url-loader/src/types/asset.ts b/packages/url-loader/src/types/asset.ts
@@ -13,6 +13,8 @@ import type { UnderlaysPlugin } from "../plugins/underlays.js";
 import type { VersionPlugin } from "../plugins/version.js";
 import type { ZoompanPlugin } from "../plugins/zoompan.js";
 
+import type { Format } from '../constants/parameters.js';
+
 export type SupportedAssetTypeInput = SupportedAssetType | "videos" | "images";
 
 export interface BaseAssetOptions<
@@ -41,7 +43,7 @@ export interface BaseAssetOptions<
    * @description Converts (if necessary) and delivers an asset in the specified format.
    * @url https://cloudinary.com/documentation/transformation_reference#f_format
    */
-  format?: string;
+  format?: Format;
   /**
    * @description Height of the given asset.
    */