imgix-url-builder 0.0.2 → 0.0.4

package/dist/index.cjs

@@ -41,15 +41,133 @@ const buildWidthSrcSet = (url, { widths, ...params }) => {
 };
 
 class Client {
+  /**
+   * Creates a new `Client` instance for an Imgix domain.
+   *
+   * @param options - Options to instantiate a new client.
+   *
+   * @returns A `Client` instance for the given Imgix domain.
+   */
   constructor(options) {
     this.baseURL = options.baseURL;
   }
+  /**
+   * Builds a URL to an Imgix image with Imgix URL API parameters for the
+   * client's base URL.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new Client({ baseURL: "https://example.imgix.net" });
+   * const url = client.buildURLForPath("/image.png", { width: 400 });
+   * // => https://example.imgix.net/image.png?width=400
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new Client({
+   * 	baseURL: "https://example.imgix.net/folder",
+   * });
+   * const url = client.buildURLForPath("./image.png", { width: 400 });
+   * // => https://example.imgix.net/folder/image.png?width=400
+   * ```
+   *
+   * @param path - Path to the image relative to the client's base URL.
+   * @param params - An object of Imgix URL API parameters.
+   *
+   * @returns The full absolute URL to the image with the given Imgix URL API
+   *   parameters applied.
+   */
   buildURLForPath(path, params = {}) {
     return buildURL(`${new URL(path, this.baseURL)}`, params);
   }
+  /**
+   * Builds an `<img>` `srcset` attribute value for a given set of widths for
+   * the client's base URL. It can also optinally apply Imgix URL API parameters
+   * to the URLs.
+   *
+   * The `width` URL parameter will be applied for each `srcset` entry. If a
+   * `width` or `w` parameter is provided to the `params` parameter, it will be
+   * ignored.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new Client({ baseURL: "https://example.imgix.net" });
+   * const srcset = client.buildWidthSrcSetForPath("/image.png", {
+   * 	widths: [400, 800, 1600],
+   * });
+   * // => https://example.imgix.net/image.png?width=400 400w,
+   * //    https://example.imgix.net/image.png?width=800 800w,
+   * //    https://example.imgix.net/image.png?width=1600 1600w
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new Client({
+   * 	baseURL: "https://example.imgix.net",
+   * });
+   * const srcset = client.buildWidthSrcSetForPath("/image.png", {
+   * 	widths: [400, 800, 1600],
+   * 	sat: -100,
+   * });
+   * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,
+   * //    https://example.imgix.net/image.png?width=800&sat=-100 800w,
+   * //    https://example.imgix.net/image.png?width=1600&sat=-100 1600w
+   * ```
+   *
+   * @param path - Path to the image relative to the client's base URL.
+   * @param params - An object of Imgix URL API parameters. The `widths`
+   *   parameter defines the resulting `srcset` widths.
+   *
+   * @returns A `srcset` attribute value for `url` with the given Imgix URL API
+   *   parameters applied.
+   */
   buildWidthSrcSetForPath(path, params) {
     return buildWidthSrcSet(`${new URL(path, this.baseURL)}`, params);
   }
+  /**
+   * Builds an `<img>` `srcset` attribute value for a given set of pixel
+   * densities for the client's base URL. It can also optinally apply Imgix URL
+   * API parameters to the URLs.
+   *
+   * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`
+   * parameter is provided to the `params` parameter, it will be ignored.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new Client({ baseURL: "https://example.imgix.net" });
+   * const srcset = client.buildPixelDensitySrcSetForPath("/image.png", {
+   * 	pixelDensities: [1, 2, 3],
+   * });
+   * // => https://example.imgix.net/image.png?dpr=1 1x,
+   * //    https://example.imgix.net/image.png?dpr=2 2x,
+   * //    https://example.imgix.net/image.png?dpr=3 3x
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new Client({ baseURL: "https://example.imgix.net" });
+   * const srcset = client.buildPixelDensitySrcSetForPath("/image.png", {
+   * 	pixelDensities: [1, 2, 3],
+   * 	sat: -100,
+   * });
+   * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,
+   * //    https://example.imgix.net/image.png?dpr=2&sat=-100 2x,
+   * //    https://example.imgix.net/image.png?dpr=3&sat=-100 3x
+   * ```
+   *
+   * @param path - Path to the image relative to the client's base URL.
+   * @param params - An object of Imgix URL API parameters. The `pixelDensities`
+   *   parameter defines the resulting `srcset` widths.
+   *
+   * @returns A `srcset` attribute value for `url` with the given Imgix URL API
+   *   parameters applied.
+   */
   buildPixelDensitySrcSetForPath(path, params) {
     return buildPixelDensitySrcSet(`${new URL(path, this.baseURL)}`, params);
   }

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/buildURL.ts","../src/buildPixelDensitySrcSet.ts","../src/buildWidthSrcSet.ts","../src/Client.ts"],"sourcesContent":["import type { ImgixURLParams } from \"./types.generated\";\n\n/**\n * Converts a camel case string to a param case string.\n *\n * @example\n *\n * ```ts\n * camelCaseToParamCase(\"fooBar\");\n * // => 'foo-bar'\n * ```\n *\n * @param input - Camel case string to convert.\n *\n * @returns Param case version of `input`.\n */\nconst camelCaseToParamCase = (input: string): string => {\n\treturn input.replace(/[A-Z]/g, (match) => {\n\t\treturn `-${match.toLowerCase()}`;\n\t});\n};\n\n/**\n * Builds a URL to an Imgix image with Imgix URL API parameters.\n *\n * The given URL must be a full absolute URL containing the protocol and domain.\n *\n * URL parameters already applied to the image will be retained. To remove\n * existing parameters, set the parameter to `undefined` in the `params` argument.\n *\n * @example\n *\n * ```ts\n * const url = buildURL(\"https://example.imgix.net/image.png\", {\n * \twidth: 400,\n * });\n * // => https://example.imgix.net/image.png?width=400\n * ```\n *\n * @example\n *\n * ```ts\n * const url = buildURL(\"https://example.imgix.net/image.png?width=400\", {\n * \theight: 300,\n * });\n * // => https://example.imgix.net/image.png?width=400&height=300\n * ```\n *\n * @param url - Full absolute URL to the Imgix image.\n * @param params - An object of Imgix URL API parameters.\n *\n * @returns `url` with the given Imgix URL API parameters applied.\n *\n * @see Imgix URL API reference: https://docs.imgix.com/apis/rendering\n */\nexport const buildURL = (url: string, params: ImgixURLParams): string => {\n\tconst instance = new URL(url);\n\n\tfor (const camelCasedParamKey in params) {\n\t\tconst paramKey = camelCaseToParamCase(camelCasedParamKey);\n\t\tconst paramValue = params[camelCasedParamKey as keyof typeof params];\n\n\t\tif (paramValue === undefined) {\n\t\t\tinstance.searchParams.delete(paramKey);\n\t\t} else if (Array.isArray(paramValue)) {\n\t\t\tinstance.searchParams.set(paramKey, paramValue.join(\",\"));\n\t\t} else {\n\t\t\tinstance.searchParams.set(paramKey, `${paramValue}`);\n\t\t}\n\t}\n\n\t// Ensure the `s` parameter is the last parameter, if it exists.\n\t// @see https://github.com/imgix/imgix-blueprint#securing-urls\n\tconst s = instance.searchParams.get(\"s\");\n\tif (s) {\n\t\tinstance.searchParams.delete(\"s\");\n\t\tinstance.searchParams.append(\"s\", s);\n\t}\n\n\treturn instance.toString();\n};\n","import type { ImgixURLParams } from \"./types.generated\";\nimport { buildURL } from \"./buildURL\";\n\n/**\n * Parameters for `buildPixelDensitySrcSet`.\n */\nexport type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, \"dpr\"> & {\n\t/**\n\t * The pixel densities to include in the resulting `srcset` value.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * [1, 2, 3];\n\t * ```\n\t */\n\tpixelDensities: number[];\n};\n\n/**\n * Builds an `<img>` `srcset` attribute value for a given set of pixel\n * densities. It can also optinally apply Imgix URL API parameters to the URLs.\n *\n * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`\n * parameter is provided to the `params` parameter, it will be ignored.\n *\n * @example\n *\n * ```ts\n * const srcset = buildPixelDensitySrcSet(\n * \t\"https://example.imgix.net/image.png\",\n * \t{ pixelDensities: [1, 2, 3] },\n * );\n * // => https://example.imgix.net/image.png?dpr=1 1x,\n * //    https://example.imgix.net/image.png?dpr=2 2x,\n * //    https://example.imgix.net/image.png?dpr=3 3x\n * ```\n *\n * @example\n *\n * ```ts\n * const srcset = buildPixelDensitySrcSet(\n * \t\"https://example.imgix.net/image.png\",\n * \t{\n * \t\tpixelDensities: [1, 2, 3],\n * \t\tsat: -100,\n * \t},\n * );\n * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,\n * //    https://example.imgix.net/image.png?dpr=2&sat=-100 2x,\n * //    https://example.imgix.net/image.png?dpr=3&sat=-100 3x\n * ```\n *\n * @param url - Full absolute URL to the Imgix image.\n * @param params - An object of Imgix URL API parameters. The `pixelDensities`\n *   parameter defines the resulting `srcset` widths.\n *\n * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n *   parameters applied.\n */\nexport const buildPixelDensitySrcSet = (\n\turl: string,\n\t{ pixelDensities, ...params }: BuildPixelDensitySrcSetParams,\n): string => {\n\treturn pixelDensities\n\t\t.map((dpr) => {\n\t\t\treturn `${buildURL(url, { ...params, dpr })} ${dpr}x`;\n\t\t})\n\t\t.join(\", \");\n};\n","import type { ImgixURLParams } from \"./types.generated\";\nimport { buildURL } from \"./buildURL\";\n\n/**\n * Parameters for `buildWidthSrcSet`.\n */\nexport type BuildWidthSrcSetParams = Omit<ImgixURLParams, \"width\" | \"w\"> & {\n\t/**\n\t * The pixel widths to include in the resulting `srcset` value.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * [400, 800, 1600];\n\t * ```\n\t */\n\twidths: number[];\n};\n\n/**\n * Builds an `<img>` `srcset` attribute value for a given set of widths. It can\n * also optinally apply Imgix URL API parameters to the URLs.\n *\n * The `width` URL parameter will be applied for each `srcset` entry. If a\n * `width` or `w` parameter is provided to the `params` parameter, it will be ignored.\n *\n * @example\n *\n * ```ts\n * const srcset = buildWidthSrcSet(\"https://example.imgix.net/image.png\", {\n * \twidths: [400, 800, 1600],\n * });\n * // => https://example.imgix.net/image.png?width=400 400w,\n * //    https://example.imgix.net/image.png?width=800 800w,\n * //    https://example.imgix.net/image.png?width=1600 1600w\n * ```\n *\n * @example\n *\n * ```ts\n * const srcset = buildWidthSrcSet(\"https://example.imgix.net/image.png\", {\n * \twidths: [400, 800, 1600],\n * \tsat: -100,\n * });\n * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,\n * //    https://example.imgix.net/image.png?width=800&sat=-100 800w,\n * //    https://example.imgix.net/image.png?width=1600&sat=-100 1600w\n * ```\n *\n * @param url - Full absolute URL to the Imgix image.\n * @param params - An object of Imgix URL API parameters. The `widths` parameter\n *   defines the resulting `srcset` widths.\n *\n * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n *   parameters applied.\n */\nexport const buildWidthSrcSet = (\n\turl: string,\n\t{ widths, ...params }: BuildWidthSrcSetParams,\n): string => {\n\treturn widths\n\t\t.map((width) => {\n\t\t\treturn `${buildURL(url, { ...params, w: undefined, width })} ${width}w`;\n\t\t})\n\t\t.join(\", \");\n};\n","import type { BuildPixelDensitySrcSetParams } from \"./buildPixelDensitySrcSet\";\nimport type { BuildWidthSrcSetParams } from \"./buildWidthSrcSet\";\nimport type { ImgixURLParams } from \"./types.generated\";\nimport { buildPixelDensitySrcSet } from \"./buildPixelDensitySrcSet\";\nimport { buildURL } from \"./buildURL\";\nimport { buildWidthSrcSet } from \"./buildWidthSrcSet\";\n\n/**\n * Options to instantiate a new client.\n */\nexport type ClientOptions = {\n\t/**\n\t * The base URL used to construct image URLs from a path. The base URL must\n\t * include the protocol, domain, and optionally a path.\n\t *\n\t * @example `https://example.imgix.net`\n\t *\n\t * @example `https://example.imgix.net/folder`\n\t */\n\tbaseURL: string;\n};\n\n/**\n * An Imgix Rendering API client. A client is paired to a single Imgix domain.\n */\nexport class Client {\n\tbaseURL: string;\n\n\t/**\n\t * Creates a new `Client` instance for an Imgix domain.\n\t *\n\t * @param options - Options to instantiate a new client.\n\t *\n\t * @returns A `Client` instance for the given Imgix domain.\n\t */\n\tconstructor(options: ClientOptions) {\n\t\tthis.baseURL = options.baseURL;\n\t}\n\n\t/**\n\t * Builds a URL to an Imgix image with Imgix URL API parameters for the\n\t * client's base URL.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const url = client.buildURLForPath(\"/image.png\", { width: 400 });\n\t * // => https://example.imgix.net/image.png?width=400\n\t * ```\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({\n\t * \tbaseURL: \"https://example.imgix.net/folder\",\n\t * });\n\t * const url = client.buildURLForPath(\"./image.png\", { width: 400 });\n\t * // => https://example.imgix.net/folder/image.png?width=400\n\t * ```\n\t *\n\t * @param path - Path to the image relative to the client's base URL.\n\t * @param params - An object of Imgix URL API parameters.\n\t *\n\t * @returns The full absolute URL to the image with the given Imgix URL API\n\t *   parameters applied.\n\t */\n\tbuildURLForPath(path: string, params: ImgixURLParams = {}) {\n\t\treturn buildURL(`${new URL(path, this.baseURL)}`, params);\n\t}\n\n\t/**\n\t * Builds an `<img>` `srcset` attribute value for a given set of widths for\n\t * the client's base URL. It can also optinally apply Imgix URL API parameters\n\t * to the URLs.\n\t *\n\t * The `width` URL parameter will be applied for each `srcset` entry. If a\n\t * `width` or `w` parameter is provided to the `params` parameter, it will be ignored.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const srcset = client.buildWidthSrcSetForPath(\"/image.png\", {\n\t * \twidths: [400, 800, 1600],\n\t * });\n\t * // => https://example.imgix.net/image.png?width=400 400w,\n\t * //    https://example.imgix.net/image.png?width=800 800w,\n\t * //    https://example.imgix.net/image.png?width=1600 1600w\n\t * ```\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({\n\t * \tbaseURL: \"https://example.imgix.net\",\n\t * });\n\t * const srcset = client.buildWidthSrcSetForPath(\"/image.png\", {\n\t * \twidths: [400, 800, 1600],\n\t * \tsat: -100,\n\t * });\n\t * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,\n\t * //    https://example.imgix.net/image.png?width=800&sat=-100 800w,\n\t * //    https://example.imgix.net/image.png?width=1600&sat=-100 1600w\n\t * ```\n\t *\n\t * @param path - Path to the image relative to the client's base URL.\n\t * @param params - An object of Imgix URL API parameters. The `widths`\n\t *   parameter defines the resulting `srcset` widths.\n\t *\n\t * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n\t *   parameters applied.\n\t */\n\tbuildWidthSrcSetForPath(path: string, params: BuildWidthSrcSetParams) {\n\t\treturn buildWidthSrcSet(`${new URL(path, this.baseURL)}`, params);\n\t}\n\n\t/**\n\t * Builds an `<img>` `srcset` attribute value for a given set of pixel\n\t * densities for the client's base URL. It can also optinally apply Imgix URL\n\t * API parameters to the URLs.\n\t *\n\t * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`\n\t * parameter is provided to the `params` parameter, it will be ignored.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const srcset = client.buildPixelDensitySrcSetForPath(\"/image.png\", {\n\t * \tpixelDensities: [1, 2, 3],\n\t * });\n\t * // => https://example.imgix.net/image.png?dpr=1 1x,\n\t * //    https://example.imgix.net/image.png?dpr=2 2x,\n\t * //    https://example.imgix.net/image.png?dpr=3 3x\n\t * ```\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const srcset = client.buildPixelDensitySrcSetForPath(\"/image.png\", {\n\t * \tpixelDensities: [1, 2, 3],\n\t * \tsat: -100,\n\t * });\n\t * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,\n\t * //    https://example.imgix.net/image.png?dpr=2&sat=-100 2x,\n\t * //    https://example.imgix.net/image.png?dpr=3&sat=-100 3x\n\t * ```\n\t *\n\t * @param path - Path to the image relative to the client's base URL.\n\t * @param params - An object of Imgix URL API parameters. The `pixelDensities`\n\t *   parameter defines the resulting `srcset` widths.\n\t *\n\t * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n\t *   parameters applied.\n\t */\n\tbuildPixelDensitySrcSetForPath(\n\t\tpath: string,\n\t\tparams: BuildPixelDensitySrcSetParams,\n\t) {\n\t\treturn buildPixelDensitySrcSet(`${new URL(path, this.baseURL)}`, params);\n\t}\n}\n"],"names":[],"mappings":";;;;AAgBA,MAAM,uBAAuB,CAAC,UAA0B;AACvD,SAAO,MAAM,QAAQ,UAAU,CAAC,UAAU;AACzC,WAAO,IAAI,MAAM;AAAA;AAAA;MAqCN,WAAW,CAAC,KAAa,WAAmC;AACxE,QAAM,WAAW,IAAI,IAAI;AAEzB,aAAW,sBAAsB,QAAQ;AACxC,UAAM,WAAW,qBAAqB;AACtC,UAAM,aAAa,OAAO;AAE1B,QAAI,eAAe,QAAW;AAC7B,eAAS,aAAa,OAAO;AAAA,eACnB,MAAM,QAAQ,aAAa;AACrC,eAAS,aAAa,IAAI,UAAU,WAAW,KAAK;AAAA,WAC9C;AACN,eAAS,aAAa,IAAI,UAAU,GAAG;AAAA;AAAA;AAMzC,QAAM,IAAI,SAAS,aAAa,IAAI;AACpC,MAAI,GAAG;AACN,aAAS,aAAa,OAAO;AAC7B,aAAS,aAAa,OAAO,KAAK;AAAA;AAGnC,SAAO,SAAS;AAAA;;MCnBJ,0BAA0B,CACtC,KACA,EAAE,mBAAmB,aACT;AACZ,SAAO,eACL,IAAI,CAAC,QAAQ;AACb,WAAO,GAAG,SAAS,KAAK,KAAK,QAAQ,UAAU;AAAA,KAE/C,KAAK;AAAA;;MCZK,mBAAmB,CAC/B,KACA,EAAE,WAAW,aACD;AACZ,SAAO,OACL,IAAI,CAAC,UAAU;AACf,WAAO,GAAG,SAAS,KAAK,KAAK,QAAQ,GAAG,QAAW,YAAY;AAAA,KAE/D,KAAK;AAAA;;aCvCY;AAAA,EAUnB,YAAY,SAAwB;AACnC,SAAK,UAAU,QAAQ;AAAA;AAAA,EA+BxB,gBAAgB,MAAc,SAAyB,IAAI;AAC1D,WAAO,SAAS,GAAG,IAAI,IAAI,MAAM,KAAK,YAAY;AAAA;AAAA,EA6CnD,wBAAwB,MAAc,QAAgC;AACrE,WAAO,iBAAiB,GAAG,IAAI,IAAI,MAAM,KAAK,YAAY;AAAA;AAAA,EA2C3D,+BACC,MACA,QACC;AACD,WAAO,wBAAwB,GAAG,IAAI,IAAI,MAAM,KAAK,YAAY;AAAA;AAAA;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/buildURL.ts","../src/buildPixelDensitySrcSet.ts","../src/buildWidthSrcSet.ts","../src/Client.ts"],"sourcesContent":["import type { ImgixURLParams } from \"./types.generated\";\n\n/**\n * Converts a camel case string to a param case string.\n *\n * @example\n *\n * ```ts\n * camelCaseToParamCase(\"fooBar\");\n * // => 'foo-bar'\n * ```\n *\n * @param input - Camel case string to convert.\n *\n * @returns Param case version of `input`.\n */\nconst camelCaseToParamCase = (input: string): string => {\n\treturn input.replace(/[A-Z]/g, (match) => {\n\t\treturn `-${match.toLowerCase()}`;\n\t});\n};\n\n/**\n * Builds a URL to an Imgix image with Imgix URL API parameters.\n *\n * The given URL must be a full absolute URL containing the protocol and domain.\n *\n * URL parameters already applied to the image will be retained. To remove\n * existing parameters, set the parameter to `undefined` in the `params`\n * argument.\n *\n * @example\n *\n * ```ts\n * const url = buildURL(\"https://example.imgix.net/image.png\", {\n * \twidth: 400,\n * });\n * // => https://example.imgix.net/image.png?width=400\n * ```\n *\n * @example\n *\n * ```ts\n * const url = buildURL(\"https://example.imgix.net/image.png?width=400\", {\n * \theight: 300,\n * });\n * // => https://example.imgix.net/image.png?width=400&height=300\n * ```\n *\n * @param url - Full absolute URL to the Imgix image.\n * @param params - An object of Imgix URL API parameters.\n *\n * @returns `url` with the given Imgix URL API parameters applied.\n *\n * @see Imgix URL API reference: https://docs.imgix.com/apis/rendering\n */\nexport const buildURL = (url: string, params: ImgixURLParams): string => {\n\tconst instance = new URL(url);\n\n\tfor (const camelCasedParamKey in params) {\n\t\tconst paramKey = camelCaseToParamCase(camelCasedParamKey);\n\t\tconst paramValue = params[camelCasedParamKey as keyof typeof params];\n\n\t\tif (paramValue === undefined) {\n\t\t\tinstance.searchParams.delete(paramKey);\n\t\t} else if (Array.isArray(paramValue)) {\n\t\t\tinstance.searchParams.set(paramKey, paramValue.join(\",\"));\n\t\t} else {\n\t\t\tinstance.searchParams.set(paramKey, `${paramValue}`);\n\t\t}\n\t}\n\n\t// Ensure the `s` parameter is the last parameter, if it exists.\n\t// @see https://github.com/imgix/imgix-blueprint#securing-urls\n\tconst s = instance.searchParams.get(\"s\");\n\tif (s) {\n\t\tinstance.searchParams.delete(\"s\");\n\t\tinstance.searchParams.append(\"s\", s);\n\t}\n\n\treturn instance.toString();\n};\n","import type { ImgixURLParams } from \"./types.generated\";\nimport { buildURL } from \"./buildURL\";\n\n/**\n * Parameters for `buildPixelDensitySrcSet`.\n */\nexport type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, \"dpr\"> & {\n\t/**\n\t * The pixel densities to include in the resulting `srcset` value.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * [1, 2, 3];\n\t * ```\n\t */\n\tpixelDensities: number[];\n};\n\n/**\n * Builds an `<img>` `srcset` attribute value for a given set of pixel\n * densities. It can also optinally apply Imgix URL API parameters to the URLs.\n *\n * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`\n * parameter is provided to the `params` parameter, it will be ignored.\n *\n * @example\n *\n * ```ts\n * const srcset = buildPixelDensitySrcSet(\n * \t\"https://example.imgix.net/image.png\",\n * \t{ pixelDensities: [1, 2, 3] },\n * );\n * // => https://example.imgix.net/image.png?dpr=1 1x,\n * //    https://example.imgix.net/image.png?dpr=2 2x,\n * //    https://example.imgix.net/image.png?dpr=3 3x\n * ```\n *\n * @example\n *\n * ```ts\n * const srcset = buildPixelDensitySrcSet(\n * \t\"https://example.imgix.net/image.png\",\n * \t{\n * \t\tpixelDensities: [1, 2, 3],\n * \t\tsat: -100,\n * \t},\n * );\n * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,\n * //    https://example.imgix.net/image.png?dpr=2&sat=-100 2x,\n * //    https://example.imgix.net/image.png?dpr=3&sat=-100 3x\n * ```\n *\n * @param url - Full absolute URL to the Imgix image.\n * @param params - An object of Imgix URL API parameters. The `pixelDensities`\n *   parameter defines the resulting `srcset` widths.\n *\n * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n *   parameters applied.\n */\nexport const buildPixelDensitySrcSet = (\n\turl: string,\n\t{ pixelDensities, ...params }: BuildPixelDensitySrcSetParams,\n): string => {\n\treturn pixelDensities\n\t\t.map((dpr) => {\n\t\t\treturn `${buildURL(url, { ...params, dpr })} ${dpr}x`;\n\t\t})\n\t\t.join(\", \");\n};\n","import type { ImgixURLParams } from \"./types.generated\";\nimport { buildURL } from \"./buildURL\";\n\n/**\n * Parameters for `buildWidthSrcSet`.\n */\nexport type BuildWidthSrcSetParams = Omit<ImgixURLParams, \"width\" | \"w\"> & {\n\t/**\n\t * The pixel widths to include in the resulting `srcset` value.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * [400, 800, 1600];\n\t * ```\n\t */\n\twidths: number[];\n};\n\n/**\n * Builds an `<img>` `srcset` attribute value for a given set of widths. It can\n * also optinally apply Imgix URL API parameters to the URLs.\n *\n * The `width` URL parameter will be applied for each `srcset` entry. If a\n * `width` or `w` parameter is provided to the `params` parameter, it will be\n * ignored.\n *\n * @example\n *\n * ```ts\n * const srcset = buildWidthSrcSet(\"https://example.imgix.net/image.png\", {\n * \twidths: [400, 800, 1600],\n * });\n * // => https://example.imgix.net/image.png?width=400 400w,\n * //    https://example.imgix.net/image.png?width=800 800w,\n * //    https://example.imgix.net/image.png?width=1600 1600w\n * ```\n *\n * @example\n *\n * ```ts\n * const srcset = buildWidthSrcSet(\"https://example.imgix.net/image.png\", {\n * \twidths: [400, 800, 1600],\n * \tsat: -100,\n * });\n * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,\n * //    https://example.imgix.net/image.png?width=800&sat=-100 800w,\n * //    https://example.imgix.net/image.png?width=1600&sat=-100 1600w\n * ```\n *\n * @param url - Full absolute URL to the Imgix image.\n * @param params - An object of Imgix URL API parameters. The `widths` parameter\n *   defines the resulting `srcset` widths.\n *\n * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n *   parameters applied.\n */\nexport const buildWidthSrcSet = (\n\turl: string,\n\t{ widths, ...params }: BuildWidthSrcSetParams,\n): string => {\n\treturn widths\n\t\t.map((width) => {\n\t\t\treturn `${buildURL(url, { ...params, w: undefined, width })} ${width}w`;\n\t\t})\n\t\t.join(\", \");\n};\n","import type { BuildPixelDensitySrcSetParams } from \"./buildPixelDensitySrcSet\";\nimport type { BuildWidthSrcSetParams } from \"./buildWidthSrcSet\";\nimport type { ImgixURLParams } from \"./types.generated\";\nimport { buildPixelDensitySrcSet } from \"./buildPixelDensitySrcSet\";\nimport { buildURL } from \"./buildURL\";\nimport { buildWidthSrcSet } from \"./buildWidthSrcSet\";\n\n/**\n * Options to instantiate a new client.\n */\nexport type ClientOptions = {\n\t/**\n\t * The base URL used to construct image URLs from a path. The base URL must\n\t * include the protocol, domain, and optionally a path.\n\t *\n\t * @example `https://example.imgix.net`\n\t *\n\t * @example `https://example.imgix.net/folder`\n\t */\n\tbaseURL: string;\n};\n\n/**\n * An Imgix Rendering API client. A client is paired to a single Imgix domain.\n */\nexport class Client {\n\tbaseURL: string;\n\n\t/**\n\t * Creates a new `Client` instance for an Imgix domain.\n\t *\n\t * @param options - Options to instantiate a new client.\n\t *\n\t * @returns A `Client` instance for the given Imgix domain.\n\t */\n\tconstructor(options: ClientOptions) {\n\t\tthis.baseURL = options.baseURL;\n\t}\n\n\t/**\n\t * Builds a URL to an Imgix image with Imgix URL API parameters for the\n\t * client's base URL.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const url = client.buildURLForPath(\"/image.png\", { width: 400 });\n\t * // => https://example.imgix.net/image.png?width=400\n\t * ```\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({\n\t * \tbaseURL: \"https://example.imgix.net/folder\",\n\t * });\n\t * const url = client.buildURLForPath(\"./image.png\", { width: 400 });\n\t * // => https://example.imgix.net/folder/image.png?width=400\n\t * ```\n\t *\n\t * @param path - Path to the image relative to the client's base URL.\n\t * @param params - An object of Imgix URL API parameters.\n\t *\n\t * @returns The full absolute URL to the image with the given Imgix URL API\n\t *   parameters applied.\n\t */\n\tbuildURLForPath(path: string, params: ImgixURLParams = {}) {\n\t\treturn buildURL(`${new URL(path, this.baseURL)}`, params);\n\t}\n\n\t/**\n\t * Builds an `<img>` `srcset` attribute value for a given set of widths for\n\t * the client's base URL. It can also optinally apply Imgix URL API parameters\n\t * to the URLs.\n\t *\n\t * The `width` URL parameter will be applied for each `srcset` entry. If a\n\t * `width` or `w` parameter is provided to the `params` parameter, it will be\n\t * ignored.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const srcset = client.buildWidthSrcSetForPath(\"/image.png\", {\n\t * \twidths: [400, 800, 1600],\n\t * });\n\t * // => https://example.imgix.net/image.png?width=400 400w,\n\t * //    https://example.imgix.net/image.png?width=800 800w,\n\t * //    https://example.imgix.net/image.png?width=1600 1600w\n\t * ```\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({\n\t * \tbaseURL: \"https://example.imgix.net\",\n\t * });\n\t * const srcset = client.buildWidthSrcSetForPath(\"/image.png\", {\n\t * \twidths: [400, 800, 1600],\n\t * \tsat: -100,\n\t * });\n\t * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,\n\t * //    https://example.imgix.net/image.png?width=800&sat=-100 800w,\n\t * //    https://example.imgix.net/image.png?width=1600&sat=-100 1600w\n\t * ```\n\t *\n\t * @param path - Path to the image relative to the client's base URL.\n\t * @param params - An object of Imgix URL API parameters. The `widths`\n\t *   parameter defines the resulting `srcset` widths.\n\t *\n\t * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n\t *   parameters applied.\n\t */\n\tbuildWidthSrcSetForPath(path: string, params: BuildWidthSrcSetParams) {\n\t\treturn buildWidthSrcSet(`${new URL(path, this.baseURL)}`, params);\n\t}\n\n\t/**\n\t * Builds an `<img>` `srcset` attribute value for a given set of pixel\n\t * densities for the client's base URL. It can also optinally apply Imgix URL\n\t * API parameters to the URLs.\n\t *\n\t * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`\n\t * parameter is provided to the `params` parameter, it will be ignored.\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const srcset = client.buildPixelDensitySrcSetForPath(\"/image.png\", {\n\t * \tpixelDensities: [1, 2, 3],\n\t * });\n\t * // => https://example.imgix.net/image.png?dpr=1 1x,\n\t * //    https://example.imgix.net/image.png?dpr=2 2x,\n\t * //    https://example.imgix.net/image.png?dpr=3 3x\n\t * ```\n\t *\n\t * @example\n\t *\n\t * ```ts\n\t * const client = new Client({ baseURL: \"https://example.imgix.net\" });\n\t * const srcset = client.buildPixelDensitySrcSetForPath(\"/image.png\", {\n\t * \tpixelDensities: [1, 2, 3],\n\t * \tsat: -100,\n\t * });\n\t * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,\n\t * //    https://example.imgix.net/image.png?dpr=2&sat=-100 2x,\n\t * //    https://example.imgix.net/image.png?dpr=3&sat=-100 3x\n\t * ```\n\t *\n\t * @param path - Path to the image relative to the client's base URL.\n\t * @param params - An object of Imgix URL API parameters. The `pixelDensities`\n\t *   parameter defines the resulting `srcset` widths.\n\t *\n\t * @returns A `srcset` attribute value for `url` with the given Imgix URL API\n\t *   parameters applied.\n\t */\n\tbuildPixelDensitySrcSetForPath(\n\t\tpath: string,\n\t\tparams: BuildPixelDensitySrcSetParams,\n\t) {\n\t\treturn buildPixelDensitySrcSet(`${new URL(path, this.baseURL)}`, params);\n\t}\n}\n"],"names":[],"mappings":";;;;AAgBA,MAAM,uBAAuB,CAAC,UAA0B;AACvD,SAAO,MAAM,QAAQ,UAAU,CAAC,UAAU;AACzC,WAAO,IAAI,MAAM;AAAY,GAC7B;AACF;MAoCa,WAAW,CAAC,KAAa,WAAmC;AACxE,QAAM,WAAW,IAAI,IAAI,GAAG;AAE5B,aAAW,sBAAsB,QAAQ;AACxC,UAAM,WAAW,qBAAqB,kBAAkB;AACxD,UAAM,aAAa,OAAO,kBAAyC;AAEnE,QAAI,eAAe,QAAW;AAC7B,eAAS,aAAa,OAAO,QAAQ;AAAA,eAC3B,MAAM,QAAQ,UAAU,GAAG;AACrC,eAAS,aAAa,IAAI,UAAU,WAAW,KAAK,GAAG,CAAC;AAAA,WAClD;AACN,eAAS,aAAa,IAAI,UAAU,GAAG,YAAY;AAAA;AACpD;AAKD,QAAM,IAAI,SAAS,aAAa,IAAI,GAAG;AACvC,MAAI,GAAG;AACN,aAAS,aAAa,OAAO,GAAG;AAChC,aAAS,aAAa,OAAO,KAAK,CAAC;AAAA;AAGpC,SAAO,SAAS;AACjB;;MCrBa,0BAA0B,CACtC,KACA,EAAE,gBAAgB,GAAG,aACT;AACZ,SAAO,eACL,IAAI,CAAC,QAAQ;AACb,WAAO,GAAG,SAAS,KAAK,EAAE,GAAG,QAAQ,KAAK,KAAK;AAAA,GAC/C,EACA,KAAK,IAAI;AACZ;;MCZa,mBAAmB,CAC/B,KACA,EAAE,QAAQ,GAAG,aACD;AACZ,SAAO,OACL,IAAI,CAAC,UAAU;AACf,WAAO,GAAG,SAAS,KAAK,EAAE,GAAG,QAAQ,GAAG,QAAW,OAAO,KAAK;AAAA,GAC/D,EACA,KAAK,IAAI;AACZ;;MCzCa,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUnB,YAAY,SAAwB;AACnC,SAAK,UAAU,QAAQ;AAAA;AACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA8BA,gBAAgB,MAAc,SAAyB,IAAI;AAC1D,WAAO,SAAS,GAAG,IAAI,IAAI,MAAM,KAAK,OAAO,KAAK,MAAM;AAAA;AACzD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6CA,wBAAwB,MAAc,QAAgC;AACrE,WAAO,iBAAiB,GAAG,IAAI,IAAI,MAAM,KAAK,OAAO,KAAK,MAAM;AAAA;AACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0CA,+BACC,MACA,QACC;AACD,WAAO,wBAAwB,GAAG,IAAI,IAAI,MAAM,KAAK,OAAO,KAAK,MAAM;AAAA;AAEzE;;;;;;;"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-declare type Ratio = `${number}:${number}`;
-declare type ColorKeyword = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "imgixorange" | "imgixblue" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orange" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "rebeccapurple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
-declare type Font = "serif" | "sans-serif" | "monospace" | "cursive" | "fantasy" | "serif,bold" | "sans-serif,bold" | "monospace,bold" | "fantasy,bold" | "serif,italic" | "sans-serif,italic" | "monospace,italic" | "serif,bold,italic" | "sans-serif,bold,italic" | "monospace,bold,italic" | "American Typewriter" | "American Typewriter Condensed" | "American Typewriter Condensed Light" | "American Typewriter Condensed,Bold" | "American Typewriter Light" | "American Typewriter,Bold" | "AndaleMono" | "Arial Narrow" | "Arial Narrow,Bold" | "Arial Narrow,BoldItalic" | "Arial Narrow,Italic" | "Arial Rounded MT,Bold" | "Arial UnicodeMS" | "Arial,BoldItalicMT" | "Arial,BoldMT" | "Arial,ItalicMT" | "Arial-Black" | "ArialMT" | "Athelas,Bold" | "Athelas,BoldItalic" | "Athelas,Italic" | "Athelas-Regular" | "Avenir Next Condensed Demi,Bold" | "Avenir Next Condensed Demi,BoldItalic" | "Avenir Next Condensed Heavy" | "Avenir Next Condensed Heavy,Italic" | "Avenir Next Condensed Medium" | "Avenir Next Condensed Medium,Italic" | "Avenir Next Condensed Regular" | "Avenir Next Condensed Ultra Light" | "Avenir Next Condensed Ultra Light,Italic" | "Avenir Next Condensed,Bold" | "Avenir Next Condensed,BoldItalic" | "Avenir Next Condensed,Italic" | "Avenir Next Demi,Bold" | "Avenir Next Demi,BoldItalic" | "Avenir Next Heavy" | "Avenir Next Heavy,Italic" | "Avenir Next Medium" | "Avenir Next Medium,Italic" | "Avenir Next Regular" | "Avenir Next Ultra Light" | "Avenir Next Ultra Light,Italic" | "Avenir Next,Bold" | "Avenir Next,BoldItalic" | "Avenir Next,Italic" | "Avenir-Black" | "Avenir-BlackOblique" | "Avenir-Book" | "Avenir-BookOblique" | "Avenir-Heavy" | "Avenir-HeavyOblique" | "Avenir-Light" | "Avenir-LightOblique" | "Avenir-Medium" | "Avenir-MediumOblique" | "Avenir-Oblique" | "Avenir-Roman" | "Baskerville" | "Baskerville,Bold" | "Baskerville,BoldItalic" | "Baskerville,Italic" | "BigCaslon-Medium" | "BrushScriptMT" | "Chalkboard" | "Chalkboard SE Light" | "Chalkboard SE Regular" | "Chalkboard SE,Bold" | "Chalkboard,Bold" | "Chalkduster" | "CharcoalCY" | "Charter Black,Italic" | "Charter,Bold" | "Charter,BoldItalic" | "Charter,Italic" | "Charter-Black" | "Charter-Roman" | "Cochin" | "Cochin,Bold" | "Cochin,BoldItalic" | "Cochin,Italic" | "Comic Sans MS,Bold" | "ComicSansMS" | "Copperplate" | "Copperplate,Bold" | "Copperplate-Light" | "Courier" | "Courier New,Bold" | "Courier New,BoldItalic" | "Courier New,Italic" | "Courier,Bold" | "Courier-Oblique" | "CourierNewPSMT" | "DIN Alternate,Bold" | "DIN Condensed,Bold" | "Didot" | "Didot,Bold" | "Didot,Italic" | "Futura Medium,Italic" | "Futura-CondensedMedium" | "Futura-Medium" | "Geneva" | "GenevaCyr" | "Georgia" | "Georgia,Bold" | "Georgia,BoldItalic" | "Georgia,Italic" | "Gill Sans" | "Gill Sans Light,Italic" | "Gill Sans,Bold" | "Gill Sans,BoldItalic" | "Gill Sans,UltraBold" | "GillSans,Italic" | "GillSans-Light" | "Helvetica" | "Helvetica CY,Bold" | "Helvetica Neue" | "Helvetica Neue Condensed Black" | "Helvetica Neue Condensed,Bold" | "Helvetica Neue Light" | "Helvetica Neue Light,Italic" | "Helvetica Neue Medium" | "Helvetica Neue Medium,Italic" | "Helvetica Neue Thin" | "Helvetica Neue Thin,Italic" | "Helvetica Neue UltraLight" | "Helvetica Neue UltraLight,Italic" | "Helvetica Neue,Bold" | "Helvetica Neue,BoldItalic" | "Helvetica Neue,Italic" | "Helvetica,Bold" | "Helvetica-Light" | "Helvetica-LightOblique" | "Helvetica-Oblique" | "HelveticaCY-Oblique" | "HelveticaCY-Plain" | "Herculanum" | "Hoefler Text Black,Italic" | "Hoefler Text,Italic" | "HoeflerText-Black" | "HoeflerText-Ornaments" | "HoeflerText-Regular" | "Impact" | "Iowan Old Style Black,Italic" | "Iowan Old Style,Bold" | "Iowan Old Style,BoldItalic" | "Iowan Old Style,Italic" | "IowanOldStyle-Black" | "IowanOldStyle-Roman" | "IowanOldStyle-Titling" | "Lucida Grande" | "Lucida Grande,Bold" | "Marion,Bold" | "Marion,Italic" | "Marion-Regular" | "Marker Felt Thin" | "Marker Felt Wide" | "Menlo,Bold" | "Menlo,BoldItalic" | "Menlo,Italic" | "Menlo-Regular" | "Monaco" | "Noteworthy,Bold" | "Noteworthy-Light" | "Optima,Bold" | "Optima,BoldItalic" | "Optima,Italic" | "Optima-ExtraBlack" | "Optima-Regular" | "PT Mono,Bold" | "PT Sans Caption,Bold" | "PT Sans Narrow,Bold" | "PT Sans,Bold" | "PT Sans,BoldItalic" | "PT Sans,Italic" | "PT Serif Caption,Italic" | "PT Serif,Bold" | "PT Serif,BoldItalic" | "PT Serif,Italic" | "PTMono-Regular" | "PTSans-Caption" | "PTSans-Narrow" | "PTSans-Regular" | "PTSerif-Caption" | "PTSerif-Regular" | "Palatino,Bold" | "Palatino,BoldItalic" | "Palatino,Italic" | "Palatino-Roman" | "Papyrus" | "Papyrus-Condensed" | "PlantagenetCherokee" | "STBaoli-SC-Regular" | "STYuanti-SC-Light" | "STYuanti-SC-Regular" | "SavoyeLetPlain" | "Seravek" | "Seravek ExtraLight, Italic" | "Seravek Light,Italic" | "Seravek Medium,Italic" | "Seravek,Bold" | "Seravek,BoldItalic" | "Seravek,Italic" | "Seravek-ExtraLight" | "Seravek-Light" | "Seravek-Medium" | "Skia-Regular" | "Skia-Regular_Black" | "Skia-Regular_Black-Condensed" | "Skia-Regular_Black-Extended" | "Skia-Regular_Condensed" | "Skia-Regular_Extended" | "Skia-Regular_Light" | "Skia-Regular_Light-Condensed" | "Skia-Regular_Light-Extended" | "Snell Roundhand,Bold" | "SnellRoundhand" | "SnellRoundhand-Black" | "Superclarendon Black,Italic" | "Superclarendon Light,Italic" | "Superclarendon,Bold" | "Superclarendon,BoldItalic" | "Superclarendon,Italic" | "Superclarendon-Black" | "Superclarendon-Light" | "Superclarendon-Regular" | "Tahoma" | "Tahoma,Bold" | "Times New Roman,Bold" | "Times New Roman,BoldItalic" | "Times New Roman,Italic" | "Times,Bold" | "Times,BoldItalic" | "Times,Italic" | "Times-Roman" | "TimesNewRomanPSMT" | "Trebuchet MS,Bold" | "Trebuchet MS,BoldItalic" | "Trebuchet MS,Italic" | "TrebuchetMS" | "Verdana" | "Verdana,Bold" | "Verdana,BoldItalic" | "Verdana,Italic" | "Waseem" | "WaseemLight" | "Webdings" | "Wingdings-Regular" | "Wingdings2" | "Wingdings3" | "Yuanti SC,Bold" | "YuppySC-Regular" | "Zapf Dingbats" | "Zapfino";
+type Ratio = `${number}:${number}`;
+type ColorKeyword = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "imgixorange" | "imgixblue" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orange" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "rebeccapurple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
+type Font = ".Aqua Kana" | ".Arabic UI Display Black" | ".Arabic UI Text Regular" | ".HeitiUI TC Thin" | ".HeitiUI TC Ultra Light" | ".Helvetica Neue DeskInterface Regular" | ".New York" | ".New York Italic" | ".SF Compact Display" | ".SF Compact Rounded" | ".SF Compact Text" | ".SF Compact Text Italic" | ".SF NS Display Condensed Black" | ".SF NS Display Condensed Bold" | ".SF NS Display Condensed Heavy" | ".SF NS Display Condensed Light" | ".SF NS Display Condensed Medium" | ".SF NS Display Condensed Regular" | ".SF NS Display Condensed Semibold" | ".SF NS Display Condensed Thin" | ".SF NS Display Condensed Ultralight" | ".SF NS Mono Light" | ".SF NS Mono Light Italic" | ".SF NS Rounded" | ".SF NS Text Condensed Bold" | ".SF NS Text Condensed Heavy" | ".SF NS Text Condensed Light" | ".SF NS Text Condensed Medium" | ".SF NS Text Condensed Regular" | ".SF NS Text Condensed Semibold" | "Al Nile" | "Al Tarikh" | "AlBayan" | "AmericanTypewriter" | "Andale Mono" | "Apple Braille" | "Apple Braille Outline 6 Dot" | "Apple Braille Outline 8 Dot" | "Apple Braille Pinpoint 6 Dot" | "Apple Braille Pinpoint 8 Dot" | "Apple Chancery" | "Apple Color Emoji" | "Apple Symbols" | "AppleGothic" | "AppleMyungjo Regular" | "AppleSDGothicNeo" | "Arial" | "Arial Black" | "Arial Bold" | "Arial Bold Italic" | "Arial Italic" | "Arial Narrow" | "Arial Narrow Bold" | "Arial Narrow Bold Italic" | "Arial Narrow Italic" | "Arial Rounded MT Bold" | "Arial Unicode MS" | "ArialHB" | "Athelas Regular" | "Avenir Book" | "Avenir Next Bold" | "Avenir Next Condensed Bold" | "Ayuthaya" | "BIZ UDGothic" | "BIZ UDGothic Bold" | "BIZ UDMincho" | "BIZ UDPGothic" | "BIZ UDPGothic Bold" | "BIZ UDPMincho" | "Baghdad" | "Bangla MN" | "Bangla Sangam MN" | "Baoli SC Regular" | "Baskerville" | "Beirut" | "BigCaslon" | "Bodoni 72 Book" | "Bodoni 72 Oldstyle Book" | "Bodoni 72 Smallcaps Book" | "Bodoni Ornaments" | "Bradley Hand Bold" | "Brush Script MT Italic" | "Chalkboard" | "ChalkboardSE" | "Chalkduster" | "Charter Roman" | "Cochin" | "Comic Sans MS" | "Comic Sans MS Bold" | "Copperplate" | "Corsiva" | "Courier" | "Courier New" | "Courier New Bold" | "Courier New Bold Italic" | "Courier New Italic" | "DIN Alternate Bold" | "DIN Condensed Bold" | "Damascus" | "DecoTypeNaskh" | "Dela Gothic One Regular" | "Devanagari MT" | "Devanagari Sangam MN" | "Didot" | "Diwan Kufi" | "Diwan Thuluth" | "DotGothic16 Regular" | "EuphemiaCAS" | "Farah" | "Farisi" | "Futura" | "GB18030 Bitmap" | "Galvji" | "GeezaPro" | "Geneva" | "Georgia" | "Georgia Bold" | "Georgia Bold Italic" | "Georgia Italic" | "GillSans" | "Gujarati Sangam MN" | "GujaratiMT" | "Gungseouche" | "Gurmukhi" | "Gurmukhi MN" | "Gurmukhi Sangam MN" | "Hachi Maru Pop Regular" | "Hannotate SC Regular" | "HanziPen SC Regular" | "Headline Alternate" | "Heiti TC Light" | "Heiti TC Medium" | "Helvetica" | "HelveticaNeue" | "Herculanum" | "Hina Mincho Regular" | "HiraMaruPro-W4" | "HiraMinProN-W3" | "HiraMinProN-W6" | "Hiragino Sans GB W3" | "Hiragino Sans GB W6" | "Hiragino Sans W0" | "Hiragino Sans W1" | "Hiragino Sans W2" | "Hiragino Sans W3" | "Hiragino Sans W4" | "Hiragino Sans W5" | "Hiragino Sans W6" | "Hiragino Sans W7" | "Hiragino Sans W8" | "Hiragino Sans W9" | "Hoefler Text" | "Hoefler Text Ornaments" | "IBM Plex Sans JP Bold" | "IBM Plex Sans JP ExtraLight" | "IBM Plex Sans JP Light" | "IBM Plex Sans JP Medium" | "IBM Plex Sans JP Regular" | "IBM Plex Sans JP SemiBold" | "IBM Plex Sans JP Thin" | "ITFDevanagari-Book" | "Impact" | "InaiMathi" | "InaiMathi-MN" | "Iowan Old Style Roman" | "Kailasa" | "Kaisei Decol Bold" | "Kaisei Decol Medium" | "Kaisei Decol Regular" | "Kaisei HarunoUmi Bold" | "Kaisei HarunoUmi Medium" | "Kaisei HarunoUmi Regular" | "Kaisei Opti Bold" | "Kaisei Opti Medium" | "Kaisei Opti Regular" | "Kaisei Tokumin Bold" | "Kaisei Tokumin ExtraBold" | "Kaisei Tokumin Medium" | "Kaisei Tokumin Regular" | "Kaiti SC Black" | "Kannada MN" | "Kannada Sangam MN" | "Kefa Regular" | "Keyboard" | "Khmer MN" | "Khmer Sangam MN" | "Kiwi Maru Light" | "Kiwi Maru Medium" | "Kiwi Maru Regular" | "Klee Demibold" | "Klee One Regular" | "Klee One SemiBold" | "Kohinoor Bangla" | "Kohinoor Devanagari Regular" | "Kohinoor Gujarati Bold" | "Kohinoor Telugu" | "Kokonor" | "Kosugi Maru Regular" | "Kosugi Regular" | "Krungthep" | "KufiStandardGK Regular" | "Lantinghei SC Demibold" | "Lao MN" | "Lao Sangam MN" | "LastResort" | "Libian SC Regular" | "LucidaGrande" | "Luminari" | "M PLUS 1 Black" | "M PLUS 1 Bold" | "M PLUS 1 Code Bold" | "M PLUS 1 Code ExtraLight" | "M PLUS 1 Code Light" | "M PLUS 1 Code Medium" | "M PLUS 1 Code Regular" | "M PLUS 1 Code SemiBold" | "M PLUS 1 Code Thin" | "M PLUS 1 ExtraBold" | "M PLUS 1 ExtraLight" | "M PLUS 1 Light" | "M PLUS 1 Medium" | "M PLUS 1 Regular" | "M PLUS 1 SemiBold" | "M PLUS 1 Thin" | "M PLUS 1p Black" | "M PLUS 1p Bold" | "M PLUS 1p ExtraBold" | "M PLUS 1p Light" | "M PLUS 1p Medium" | "M PLUS 1p Regular" | "M PLUS 1p Thin" | "M PLUS 2 Black" | "M PLUS 2 Bold" | "M PLUS 2 ExtraBold" | "M PLUS 2 ExtraLight" | "M PLUS 2 Light" | "M PLUS 2 Medium" | "M PLUS 2 Regular" | "M PLUS 2 SemiBold" | "M PLUS 2 Thin" | "Malayalam MN" | "Malayalam Sangam MN" | "Marion Regular" | "MarkerFelt" | "Menlo" | "Microsoft Sans Serif" | "Mishafi" | "Mishafi Gold" | "Mochiy Pop One Regular" | "Mochiy Pop P One Regular" | "Monaco" | "Mshtakan" | "MuktaMahee Regular" | "Muna" | "Murecho Black" | "Murecho Bold" | "Murecho ExtraBold" | "Murecho ExtraLight" | "Murecho Light" | "Murecho Medium" | "Murecho Regular" | "Murecho SemiBold" | "Murecho Thin" | "Myanmar MN" | "Myanmar Sangam MN" | "Nadeem" | "Nanum Brush Script" | "NanumGothic" | "NanumMyeongjo" | "New Tegomin Regular" | "NewPeninimMT" | "Noteworthy Light" | "Noto Nastaliq Urdu" | "Noto Sans Armenian Black" | "Noto Sans Avestan Regular" | "Noto Sans Bamum Regular" | "Noto Sans Batak Regular" | "Noto Sans Brahmi Regular" | "Noto Sans Buginese Regular" | "Noto Sans Buhid Regular" | "Noto Sans Carian Regular" | "Noto Sans Chakma Regular" | "Noto Sans Cham Regular" | "Noto Sans Coptic Regular" | "Noto Sans Cuneiform Regular" | "Noto Sans Cypriot Regular" | "Noto Sans Egyptian Hieroglyphs Regular" | "Noto Sans Glagolitic Regular" | "Noto Sans Gothic Regular" | "Noto Sans Hanunoo Regular" | "Noto Sans Imperial Aramaic Regular" | "Noto Sans Inscriptional Pahlavi Regular" | "Noto Sans Inscriptional Parthian Regular" | "Noto Sans JP" | "Noto Sans JP Black" | "Noto Sans JP Bold" | "Noto Sans JP Light" | "Noto Sans JP Medium" | "Noto Sans JP Thin" | "Noto Sans Javanese Regular" | "Noto Sans Kaithi Regular" | "Noto Sans Kannada Black" | "Noto Sans Kayah Li Regular" | "Noto Sans Kharoshthi Regular" | "Noto Sans Lepcha Regular" | "Noto Sans Limbu Regular" | "Noto Sans Linear B Regular" | "Noto Sans Lisu Regular" | "Noto Sans Lycian Regular" | "Noto Sans Lydian Regular" | "Noto Sans Mandaic Regular" | "Noto Sans Meetei Mayek Regular" | "Noto Sans Mongolian" | "Noto Sans Myanmar Black" | "Noto Sans NKo Regular" | "Noto Sans New Tai Lue Regular" | "Noto Sans Ogham Regular" | "Noto Sans Ol Chiki Regular" | "Noto Sans Old Italic Regular" | "Noto Sans Old Persian Regular" | "Noto Sans Old South Arabian Regular" | "Noto Sans Old Turkic Regular" | "Noto Sans Oriya" | "Noto Sans Osmanya Regular" | "Noto Sans PhagsPa Regular" | "Noto Sans Phoenician Regular" | "Noto Sans Rejang Regular" | "Noto Sans Runic Regular" | "Noto Sans Samaritan Regular" | "Noto Sans Saurashtra Regular" | "Noto Sans Shavian Regular" | "Noto Sans Sundanese Regular" | "Noto Sans Syloti Nagri Regular" | "Noto Sans Syriac Regular" | "Noto Sans Tagalog Regular" | "Noto Sans Tagbanwa Regular" | "Noto Sans Tai Le Regular" | "Noto Sans Tai Tham" | "Noto Sans Tai Viet Regular" | "Noto Sans Thaana Regular" | "Noto Sans Tifinagh Regular" | "Noto Sans Ugaritic Regular" | "Noto Sans Vai Regular" | "Noto Sans Yi Regular" | "Noto Serif Balinese Regular" | "Noto Serif JP" | "Noto Serif JP Black" | "Noto Serif JP Bold" | "Noto Serif JP ExtraLight" | "Noto Serif JP Light" | "Noto Serif JP Medium" | "Noto Serif JP SemiBold" | "Noto Serif Myanmar Black" | "Optima" | "Oriya MN" | "Oriya Sangam MN" | "Osaka" | "OsakaMono" | "PCmyoungjo" | "PT Mono Bold" | "PT Sans" | "PT Serif Caption" | "PT Serif" | "Palatino" | "Papyrus" | "Phosphate" | "Pilgiche" | "PingFang HK Regular" | "PlantagenetCherokee" | "Potta One Regular" | "Raanana" | "Rampart One Regular" | "Reggae One Regular" | "RocknRoll One Regular" | "Rockwell" | "Rounded Mplus 1c" | "Rounded Mplus 1c Black" | "Rounded Mplus 1c Bold" | "Rounded Mplus 1c ExtraBold" | "Rounded Mplus 1c Light" | "Rounded Mplus 1c Medium" | "Rounded Mplus 1c Thin" | "STIXGeneral-Bold" | "STIXGeneral-BoldItalic" | "STIXGeneral-Italic" | "STIXGeneral-Regular" | "STIXIntegralsD-Bold" | "STIXIntegralsD-Regular" | "STIXIntegralsSm-Bold" | "STIXIntegralsSm-Regular" | "STIXIntegralsUp-Bold" | "STIXIntegralsUp-Regular" | "STIXIntegralsUpD-Bold" | "STIXIntegralsUpD-Regular" | "STIXIntegralsUpSm-Bold" | "STIXIntegralsUpSm-Regular" | "STIXNonUnicode-Bold" | "STIXNonUnicode-BoldItalic" | "STIXNonUnicode-Italic" | "STIXNonUnicode-Regular" | "STIXSizeFiveSym-Regular" | "STIXSizeFourSym-Bold" | "STIXSizeFourSym-Regular" | "STIXSizeOneSym-Bold" | "STIXSizeOneSym-Regular" | "STIXSizeThreeSym-Bold" | "STIXSizeThreeSym-Regular" | "STIXSizeTwoSym-Bold" | "STIXSizeTwoSym-Regular" | "STIXVariants-Bold" | "STIXVariants-Regular" | "Sana" | "Sathu" | "Savoye LET" | "Sawarabi Gothic" | "Sawarabi Mincho" | "Seravek" | "Shippori Antique B1 Regular" | "Shippori Antique Regular" | "Shippori Mincho B1 Bold" | "Shippori Mincho B1 ExtraBold" | "Shippori Mincho B1 Medium" | "Shippori Mincho B1 Regular" | "Shippori Mincho B1 SemiBold" | "Shippori Mincho Bold" | "Shippori Mincho ExtraBold" | "Shippori Mincho Medium" | "Shippori Mincho Regular" | "Shippori Mincho SemiBold" | "Shree Devanagari 714" | "SignPainter-HouseScript" | "Silom" | "Sinhala MN" | "Sinhala Sangam MN" | "Skia" | "Snell Roundhand" | "Songti SC Black" | "Stick Regular" | "SukhumvitSet-Thin" | "Superclarendon Regular" | "Symbol" | "System Font" | "System Font Black" | "System Font Bold" | "System Font Bold G1" | "System Font Bold G2" | "System Font Bold G3" | "System Font Bold Italic" | "System Font Bold Italic G1" | "System Font Bold Italic G2" | "System Font Bold Italic G3" | "System Font Heavy" | "System Font Heavy Italic" | "System Font Italic" | "System Font Italic G1" | "System Font Italic G2" | "System Font Italic G3" | "System Font Light" | "System Font Light Italic" | "System Font Medium" | "System Font Medium Italic" | "System Font Regular" | "System Font Regular G1" | "System Font Regular G2" | "System Font Regular G3" | "System Font Regular Italic" | "System Font SemiBold" | "System Font SemiBold Italic" | "System Font Thin" | "System Font UltraLight" | "Tahoma" | "Tahoma Bold" | "Tamil MN" | "Tamil Sangam MN" | "Telugu MN" | "Telugu Sangam MN" | "Thonburi" | "Times" | "Times New Roman" | "Times New Roman Bold" | "Times New Roman Bold Italic" | "Times New Roman Italic" | "Train One Regular" | "Trattatello" | "Trebuchet MS" | "Trebuchet MS Bold" | "Trebuchet MS Bold Italic" | "Trebuchet MS Italic" | "Tsukushi A Round Gothic Regular" | "Tsukushi B Round Gothic Regula" | "Verdana" | "Verdana Bold" | "Verdana Bold Italic" | "Verdana Italic" | "Waseem" | "Wawati SC Regular" | "Wawati TC Regular" | "Webdings" | "Weibei SC Bold" | "Weibei TC Bold" | "Wingdings" | "Wingdings 2" | "Wingdings 3" | "Xingkai SC Bold" | "Yomogi Regular" | "YuGothic Bold" | "YuGothic Medium" | "YuMincho Medium" | "Yuanti SC Bold" | "Yuji Boku Regular" | "Yuji Mai Regular" | "Yuji Syuku Regular" | "Yuppy SC Regular" | "Yuppy TC Regular" | "Yusei Magic Regular" | "ZapfDingbats" | "Zapfino" | "Zen Antique Regular" | "Zen Antique Soft Regular" | "Zen Kaku Gothic Antique Black" | "Zen Kaku Gothic Antique Bold" | "Zen Kaku Gothic Antique Light" | "Zen Kaku Gothic Antique Medium" | "Zen Kaku Gothic Antique Regular" | "Zen Kaku Gothic New Black" | "Zen Kaku Gothic New Bold" | "Zen Kaku Gothic New Light" | "Zen Kaku Gothic New Medium" | "Zen Kaku Gothic New Regular" | "Zen Kurenaido Regular" | "Zen Maru Gothic Black" | "Zen Maru Gothic Bold" | "Zen Maru Gothic Light" | "Zen Maru Gothic Medium" | "Zen Maru Gothic Regular" | "Zen Old Mincho Black" | "Zen Old Mincho Bold" | "Zen Old Mincho Medium" | "Zen Old Mincho Regular" | "Zen Old Mincho SemiBold" | "儷宋 Pro" | "儷黑 Pro" | "华文仿宋" | "华文细黑" | "华文黑体";
+type Range = `${number}-${number}` | `${number}-` | `-${number}`;
 interface ImgixURLParams {
     /**
      * Aspect ratio
@@ -18,6 +19,26 @@ interface ImgixURLParams {
      * @see https://docs.imgix.com/apis/url/auto
      */
     auto?: ("enhance" | "format" | "redeye" | "compress" | "true")[];
+    /**
+     * Background removal
+     *
+     * Removes background from image.
+     *
+     * @defaultValue `false`
+     *
+     * @see https://docs.imgix.com/apis/rendering/background-removal/bg-remove
+     */
+    bgRemove?: boolean;
+    /**
+     * Background removal fallback
+     *
+     * Overrides default fallback behavior for bg-remove failures.
+     *
+     * @defaultValue `true`
+     *
+     * @see https://docs.imgix.com/apis/rendering/background-removal/bg-remove
+     */
+    bgRemoveFallback?: boolean;
     /**
      * Background color
      *
@@ -684,7 +705,8 @@ interface ImgixURLParams {
     /**
      * Json face data
      *
-     * Specifies that face data should be included in output when combined with `fm=json`.
+     * Specifies that face data should be included in output when combined with
+     * `fm=json`.
      *
      * @see https://docs.imgix.com/apis/url/face-detection/faces
      */
@@ -692,7 +714,8 @@ interface ImgixURLParams {
     /**
      * Fill color
      *
-     * Sets the fill color for images with additional space created by the fit setting
+     * Sets the fill color for images with additional space created by the fit
+     * setting
      *
      * Aliases: `fillcolor`
      *
@@ -704,7 +727,8 @@ interface ImgixURLParams {
     /**
      * Fill color
      *
-     * Sets the fill color for images with additional space created by the fit setting
+     * Sets the fill color for images with additional space created by the fit
+     * setting
      *
      * Alias for: `fillColor`
      *
@@ -795,6 +819,18 @@ interface ImgixURLParams {
      * @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-z
      */
     fpZ?: number;
+    /**
+     * Frames per second
+     *
+     * Specifies the framerate of the generated image.
+     */
+    fps?: number;
+    /**
+     * Frame selection
+     *
+     * Specifies the frame of an animated image to use.
+     */
+    frame?: number | Range;
     /**
      * Gamma
      *
@@ -805,6 +841,18 @@ interface ImgixURLParams {
      * @see https://docs.imgix.com/apis/url/adjustment/gam
      */
     gam?: number;
+    /**
+     * Animated gif quality
+     *
+     * Aliases: `gifq`
+     */
+    gifQ?: number;
+    /**
+     * Animated gif quality
+     *
+     * Alias for: `gifQ`
+     */
+    gifq?: number;
     /**
      * Grid colors
      *
@@ -867,6 +915,12 @@ interface ImgixURLParams {
      * @see https://docs.imgix.com/apis/url/adjustment/hue
      */
     hue?: number;
+    /**
+     * Frame interval
+     *
+     * Displays every Nth frame starting with the first frame.
+     */
+    interval?: number;
     /**
      * Invert
      *
@@ -897,6 +951,15 @@ interface ImgixURLParams {
      * Determine if IPTC data should be passed for JPEG images.
      */
     iptc?: "allow" | "block";
+    /**
+     * Animation loop count
+     *
+     * Specifies the number of times an animated image should repeat. A value of 0
+     * means infinite looping.
+     *
+     * @defaultValue `0`
+     */
+    loop?: number;
     /**
      * Lossless compression
      *
@@ -1584,6 +1647,14 @@ interface ImgixURLParams {
         number,
         number
     ];
+    /**
+     * Reverse
+     *
+     * Reverses the frame order on the source animation.
+     *
+     * @defaultValue `false`
+     */
+    reverse?: boolean;
     /**
      * Rotation
      *
@@ -1634,6 +1705,12 @@ interface ImgixURLParams {
      * @see https://docs.imgix.com/apis/url/adjustment/sharp
      */
     sharp?: number;
+    /**
+     * Frame skip
+     *
+     * Skips every Nth frame starting with the first frame.
+     */
+    skip?: number;
     /**
      * Transparency
      *
@@ -2229,6 +2306,58 @@ interface ImgixURLParams {
      * @see https://docs.imgix.com/apis/url/text/txt-width
      */
     txtwidth?: number;
+    /**
+     * Text x position
+     *
+     * Sets the horizontal (x) position of the text in pixels relative to the left
+     * edge of the base image.
+     *
+     * Aliases: `txtx`
+     *
+     * @defaultValue `0`
+     *
+     * @see https://docs.imgix.com/apis/url/text/txt-x
+     */
+    txtX?: number;
+    /**
+     * Text x position
+     *
+     * Sets the horizontal (x) position of the text in pixels relative to the left
+     * edge of the base image.
+     *
+     * Alias for: `txtX`
+     *
+     * @defaultValue `0`
+     *
+     * @see https://docs.imgix.com/apis/url/text/txt-x
+     */
+    txtx?: number;
+    /**
+     * Text y position
+     *
+     * Sets the vertical (y) position of the text in pixels relative to the top
+     * edge of the base image.
+     *
+     * Aliases: `txty`
+     *
+     * @defaultValue `0`
+     *
+     * @see https://docs.imgix.com/apis/url/text/txt-y
+     */
+    txtY?: number;
+    /**
+     * Text y position
+     *
+     * Sets the vertical (y) position of the text in pixels relative to the top
+     * edge of the base image.
+     *
+     * Alias for: `txtY`
+     *
+     * @defaultValue `0`
+     *
+     * @see https://docs.imgix.com/apis/url/text/txt-y
+     */
+    txty?: number;
     /**
      * Text string
      *
@@ -2313,7 +2442,7 @@ interface ImgixURLParams {
 /**
  * Parameters for `buildPixelDensitySrcSet`.
  */
-declare type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, "dpr"> & {
+type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, "dpr"> & {
     /**
      * The pixel densities to include in the resulting `srcset` value.
      *
@@ -2371,7 +2500,7 @@ declare const buildPixelDensitySrcSet: (url: string, { pixelDensities, ...params
 /**
  * Parameters for `buildWidthSrcSet`.
  */
-declare type BuildWidthSrcSetParams = Omit<ImgixURLParams, "width" | "w"> & {
+type BuildWidthSrcSetParams = Omit<ImgixURLParams, "width" | "w"> & {
     /**
      * The pixel widths to include in the resulting `srcset` value.
      *
@@ -2388,7 +2517,8 @@ declare type BuildWidthSrcSetParams = Omit<ImgixURLParams, "width" | "w"> & {
  * also optinally apply Imgix URL API parameters to the URLs.
  *
  * The `width` URL parameter will be applied for each `srcset` entry. If a
- * `width` or `w` parameter is provided to the `params` parameter, it will be ignored.
+ * `width` or `w` parameter is provided to the `params` parameter, it will be
+ * ignored.
  *
  * @example
  *
@@ -2425,7 +2555,7 @@ declare const buildWidthSrcSet: (url: string, { widths, ...params }: BuildWidthS
 /**
  * Options to instantiate a new client.
  */
-declare type ClientOptions = {
+type ClientOptions = {
     /**
      * The base URL used to construct image URLs from a path. The base URL must
      * include the protocol, domain, and optionally a path.
@@ -2484,7 +2614,8 @@ declare class Client {
      * to the URLs.
      *
      * The `width` URL parameter will be applied for each `srcset` entry. If a
-     * `width` or `w` parameter is provided to the `params` parameter, it will be ignored.
+     * `width` or `w` parameter is provided to the `params` parameter, it will be
+     * ignored.
      *
      * @example
      *
@@ -2570,7 +2701,8 @@ declare class Client {
  * The given URL must be a full absolute URL containing the protocol and domain.
  *
  * URL parameters already applied to the image will be retained. To remove
- * existing parameters, set the parameter to `undefined` in the `params` argument.
+ * existing parameters, set the parameter to `undefined` in the `params`
+ * argument.
  *
  * @example
  *