imgix-url-builder 0.0.2 → 0.0.4

package/dist/node/index.cjs

@@ -74,42 +74,497 @@ const buildWidthSrcSet = (url, { widths, ...params }) => {
 };
 
 class SecureClient {
+  /**
+   * Creates a new `SecureClient` instance for an Imgix domain.
+   *
+   * @param options - Options to instantiate a new client.
+   *
+   * @returns A `SecureClient` instance for the given Imgix domain.
+   */
   constructor(options) {
     this.baseURL = options.baseURL;
     this.secureURLToken = options.secureURLToken;
   }
+  /**
+   * Builds a Web Proxy URL that proxies a non-Imgix URL to Imgix. The client's
+   * Imgix domain must be configured as a Web Proxy source. All Web Proxy URLs
+   * will be signed automatically.
+   *
+   * **Important**: The given URL must not be URI encoded. If it is, decode it
+   * before passing it to `buildWebProxyURL()`.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const url = client.buildWebProxyURL("https://www.this.com/pic.jpg", {
+   * 	width: 400,
+   * });
+   * // => https://example.imgix.net/https%3A%2F%2Fwww.this.com%2Fpic.jpg?width=400&s=def3e221c3f4c4debda091b8e49420ea
+   * ```
+   *
+   * @param url - Full absolute URL to the source image to proxy.
+   * @param params - An object of Imgix URL API parameters.
+   *
+   * @returns An Imgix url proxying `url` to the client's Imgix domain.
+   */
   buildWebProxyURL(url, params = {}) {
     return this.buildSignedURLForPath(encodeURIComponent(url), params);
   }
+  /**
+   * Builds a URL to an Imgix image with Imgix URL API parameters for the
+   * client's base URL.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const url = client.buildURLForPath("/image.png", { width: 400 });
+   * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net/folder",
+   * 	secureURLToken: "example-token",
+   * });
+   * const url = client.buildURLForPath("./image.png", { width: 400 });
+   * // => https://example.imgix.net/folder/image.png?width=400&s=f12c7c39333410c10c2930b57116a943
+   * ```
+   *
+   * @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.
+   */
   buildSignedURLForPath(path, params = {}) {
     return this.signURL(this.buildURLForPath(path, params));
   }
+  /**
+   * Builds a URL to an Imgix image with Imgix URL API parameters for the
+   * client's base URL.
+   *
+   * Note: The returned URL is not signed. See `buildSignedURL` if a signature
+   * is required.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const url = client.buildURLForPath("/image.png", { width: 400 });
+   * // => https://example.imgix.net/image.png?width=400
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net/folder",
+   * 	secureURLToken: "example-token",
+   * });
+   * 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 a URL to an Imgix image with Imgix URL API parameters. The URL is
+   * signed by appending a signature to the URL parameters. This locks the URL
+   * and its parameters to the signature to prevent URL tampering.
+   *
+   * 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.
+   *
+   * @example
+   *
+   * ```ts
+   * const url = client.buildSignedURL(
+   * 	"https://example.imgix.net/image.png",
+   * 	{ width: 400 },
+   * );
+   * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const url = client.buildSignedURL(
+   * 	"https://example.imgix.net/image.png?width=400",
+   * 	{ height: 300 },
+   * );
+   * // => https://example.imgix.net/image.png?width=400&height=300&s=f12c7c39333410c10c2930b57116a943
+   * ```
+   *
+   * @param url - Full absolute URL to the Imgix image.
+   * @param params - An object of Imgix URL API parameters.
+   *
+   * @returns `url` with the given Imgix URL API parameters applied.
+   *
+   * @see Imgix URL API reference: https://docs.imgix.com/apis/rendering
+   * @see Details on securing Imgix images: https://docs.imgix.com/setup/securing-images
+   */
   buildSignedURL(url, params = {}) {
     return buildSignedURL(url, this.secureURLToken, params);
   }
+  /**
+   * Signs an Imgix image URL by appending a signature to the URL parameters.
+   * This locks the URL and its parameters to the signature to prevent URL
+   * tampering.
+   *
+   * @example
+   *
+   * ```ts
+   * const url = client.signURL(
+   * 	"https://example.imgix.net/image.png?width=400",
+   * );
+   * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea
+   * ```
+   *
+   * @param url - Full absolute URL to the Imgix image to sign.
+   *
+   * @returns `url` with a signature appended via an `s` URL parameter.
+   *
+   * @see Details on securing Imgix images: https://docs.imgix.com/setup/securing-images
+   */
   signURL(url) {
     return signURL(url, this.secureURLToken);
   }
+  /**
+   * Builds an `<img>` `srcset` attribute value for a given set of widths. It
+   * can also optinally apply Imgix URL API parameters to the URLs. The URLs are
+   * signed by appending a signature to their URL parameters. This locks the
+   * URLs and their parameters to the signature to prevent URL tampering.
+   *
+   * 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 srcset = client.buildSignedWidthSrcSet(
+   * 	"https://example.imgix.net/image.png",
+   * 	{ widths: [400, 800, 1600] },
+   * );
+   * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea 400w,
+   * //    https://example.imgix.net/image.png?width=800&s=f12c7c39333410c10c2930b57116a943 800w,
+   * //    https://example.imgix.net/image.png?width=1600&s=3a975b5087ab7ad2ab91fe66072fd628 1600w
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const srcset = client.buildSignedWidthSrcSet(
+   * 	"https://example.imgix.net/image.png",
+   * 	{
+   * 		widths: [400, 800, 1600],
+   * 		sat: -100,
+   * 	},
+   * );
+   * // => https://example.imgix.net/image.png?width=400&sat=-100&s=def3e221c3f4c4debda091b8e49420ea 400w,
+   * //    https://example.imgix.net/image.png?width=800&sat=-100&s=f12c7c39333410c10c2930b57116a943 800w,
+   * //    https://example.imgix.net/image.png?width=1600&sat=-100&s=3a975b5087ab7ad2ab91fe66072fd628 1600w
+   * ```
+   *
+   * @param url - Full absolute URL to the Imgix image.
+   * @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.
+   */
   buildSignedWidthSrcSet(url, params) {
     return buildSignedWidthSrcSet(url, this.secureURLToken, 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.
+   *
+   * Note: The returned URLs are not signed. See `buildSignedWidthSrcSet` if
+   * signatures are required.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * 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 SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * 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 widths for
+   * the client's base URL. It can also optinally apply Imgix URL API parameters
+   * to the URLs. The URLs are signed by appending a signature to their URL
+   * parameters. This locks the URLs and their parameters to the signature to
+   * prevent URL tampering.
+   *
+   * 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 SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const srcset = client.buildSignedWidthSrcSetForPath("/image.png", {
+   * 	widths: [400, 800, 1600],
+   * });
+   * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea 400w,
+   * //    https://example.imgix.net/image.png?width=800&s=f12c7c39333410c10c2930b57116a943 800w,
+   * //    https://example.imgix.net/image.png?width=1600&s=3a975b5087ab7ad2ab91fe66072fd628 1600w
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const srcset = client.buildSignedWidthSrcSetForPath("/image.png", {
+   * 	widths: [400, 800, 1600],
+   * 	sat: -100,
+   * });
+   * // => https://example.imgix.net/image.png?width=400&sat=-100&s=def3e221c3f4c4debda091b8e49420ea 400w,
+   * //    https://example.imgix.net/image.png?width=800&sat=-100&s=f12c7c39333410c10c2930b57116a943 800w,
+   * //    https://example.imgix.net/image.png?width=1600&sat=-100&s=3a975b5087ab7ad2ab91fe66072fd628 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.
+   */
   buildSignedWidthSrcSetForPath(path, params) {
-    return this.buildSignedWidthSrcSet(`${new URL(path, this.baseURL)}`, params);
+    return this.buildSignedWidthSrcSet(
+      `${new URL(path, this.baseURL)}`,
+      params
+    );
   }
+  /**
+   * Builds an `<img>` `srcset` attribute value for a given set of pixel
+   * densities. It can also optinally apply Imgix URL API parameters to the
+   * URLs. The URLs are signed by appending a signature to their URL parameters.
+   * This locks the URLs and their parameters to the signature to prevent URL
+   * tampering.
+   *
+   * 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 srcset = client.buildSignedPixelDensitySrcSet(
+   * 	"https://example.imgix.net/image.png",
+   * 	{ pixelDensities: [1, 2, 3] },
+   * );
+   * // => https://example.imgix.net/image.png?dpr=1&s=def3e221c3f4c4debda091b8e49420ea 1x,
+   * //    https://example.imgix.net/image.png?dpr=2&s=f12c7c39333410c10c2930b57116a943 2x,
+   * //    https://example.imgix.net/image.png?dpr=3&s=3a975b5087ab7ad2ab91fe66072fd628 3x
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const srcset = client.buildSignedPixelDensitySrcSet(
+   * 	"https://example.imgix.net/image.png",
+   * 	{
+   * 		pixelDensities: [1, 2, 3],
+   * 		sat: -100,
+   * 	},
+   * );
+   * // => https://example.imgix.net/image.png?dpr=1&sat=-100&s=def3e221c3f4c4debda091b8e49420ea 1x,
+   * //    https://example.imgix.net/image.png?dpr=2&sat=-100&s=f12c7c39333410c10c2930b57116a943 2x,
+   * //    https://example.imgix.net/image.png?dpr=3&sat=-100&s=3a975b5087ab7ad2ab91fe66072fd628 3x
+   * ```
+   *
+   * @param url - Full absolute URL to the Imgix image.
+   * @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.
+   */
   buildSignedPixelDensitySrcSet(url, params) {
     return buildSignedPixelDensitySrcSet(url, this.secureURLToken, 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.
+   *
+   * Note: The returned URLs are not signed. See `buildSignedPixelDensitySrcSet`
+   * if signatures are required.
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * 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 SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * 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);
   }
+  /**
+   * 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 URLs are signed by appending a signature to
+   * their URL parameters. This locks the URLs and their parameters to the
+   * signature to prevent URL tampering.
+   *
+   * 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 SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const srcset = client.buildSignedPixelDensitySrcSetForPath(
+   * 	"/image.png",
+   * 	{ pixelDensities: [1, 2, 3] },
+   * );
+   * // => https://example.imgix.net/image.png?dpr=1&s=def3e221c3f4c4debda091b8e49420ea 1x,
+   * //    https://example.imgix.net/image.png?dpr=2&s=f12c7c39333410c10c2930b57116a943 2x,
+   * //    https://example.imgix.net/image.png?dpr=3&s=3a975b5087ab7ad2ab91fe66072fd628 3x
+   * ```
+   *
+   * @example
+   *
+   * ```ts
+   * const client = new SecureClient({
+   * 	baseURL: "https://example.imgix.net",
+   * 	secureURLToken: "example-token",
+   * });
+   * const srcset = client.buildSignedPixelDensitySrcSetForPath(
+   * 	"/image.png",
+   * 	{
+   * 		pixelDensities: [1, 2, 3],
+   * 		sat: -100,
+   * 	},
+   * );
+   * // => https://example.imgix.net/image.png?dpr=1&sat=-100&s=def3e221c3f4c4debda091b8e49420ea 1x,
+   * //    https://example.imgix.net/image.png?dpr=2&sat=-100&s=f12c7c39333410c10c2930b57116a943 2x,
+   * //    https://example.imgix.net/image.png?dpr=3&sat=-100&s=3a975b5087ab7ad2ab91fe66072fd628 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.
+   */
   buildSignedPixelDensitySrcSetForPath(path, params) {
-    return buildSignedPixelDensitySrcSet(`${new URL(path, this.baseURL)}`, this.secureURLToken, params);
+    return buildSignedPixelDensitySrcSet(
+      `${new URL(path, this.baseURL)}`,
+      this.secureURLToken,
+      params
+    );
   }
 }