imgix-url-builder 0.0.4 → 0.0.6

package/dist/node/signURL.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const crypto = require("crypto");
+const signURL = (url, secureURLToken) => {
+  const instance = new URL(url);
+  instance.searchParams.delete("s");
+  const signature = crypto.createHash("md5").update(secureURLToken + instance.pathname + instance.search).digest("hex");
+  instance.searchParams.append("s", signature);
+  return instance.toString();
+};
+exports.signURL = signURL;
+//# sourceMappingURL=signURL.cjs.map

package/dist/node/signURL.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"signURL.cjs","sources":["../../../src/node/signURL.ts"],"sourcesContent":["import { createHash } from \"crypto\";\n\n/**\n * Signs an Imgix image URL by appending a signature to the URL parameters. This\n * locks the URL and its parameters to the signature to prevent URL tampering.\n *\n * **Important**: This function should only be used in a trusted environment and\n * never in a browser. The `secureURLToken` parameter is a secret and should not\n * be exposed to the public.\n *\n * @example\n *\n * ```ts\n * const url = signURL(\n * \t\"https://example.imgix.net/image.png?width=400\",\n * \t\"example-token\",\n * );\n * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea\n * ```\n *\n * @param url - Full absolute URL to the Imgix image to sign.\n * @param secureURLToken - The secret Imgix secure URL token used to generate\n *   the signature.\n *\n * @returns `url` with a signature appended via an `s` URL parameter.\n *\n * @see Details on securing Imgix images: https://docs.imgix.com/setup/securing-images\n */\nexport const signURL = (url: string, secureURLToken: string): string => {\n\tconst instance = new URL(url);\n\n\t// If an `s` param is passed explicitly, it will be overridden. It must\n\t// also not be used when generating the signature.\n\tinstance.searchParams.delete(\"s\");\n\n\t// @see https://github.com/imgix/imgix-blueprint#securing-urls\n\tconst signature = createHash(\"md5\")\n\t\t.update(secureURLToken + instance.pathname + instance.search)\n\t\t.digest(\"hex\");\n\n\tinstance.searchParams.append(\"s\", signature);\n\n\treturn instance.toString();\n};\n"],"names":["createHash"],"mappings":";;;AA4Ba,MAAA,UAAU,CAAC,KAAa,mBAAkC;AAChE,QAAA,WAAW,IAAI,IAAI,GAAG;AAInB,WAAA,aAAa,OAAO,GAAG;AAGhC,QAAM,YAAYA,OAAA,WAAW,KAAK,EAChC,OAAO,iBAAiB,SAAS,WAAW,SAAS,MAAM,EAC3D,OAAO,KAAK;AAEL,WAAA,aAAa,OAAO,KAAK,SAAS;AAE3C,SAAO,SAAS;AACjB;;"}

package/dist/node/signURL.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ *
+ * **Important**: This function should only be used in a trusted environment and
+ * never in a browser. The `secureURLToken` parameter is a secret and should not
+ * be exposed to the public.
+ *
+ * @example
+ *
+ * ```ts
+ * const url = signURL(
+ * 	"https://example.imgix.net/image.png?width=400",
+ * 	"example-token",
+ * );
+ * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea
+ * ```
+ *
+ * @param url - Full absolute URL to the Imgix image to sign.
+ * @param secureURLToken - The secret Imgix secure URL token used to generate
+ *   the signature.
+ *
+ * @returns `url` with a signature appended via an `s` URL parameter.
+ *
+ * @see Details on securing Imgix images: https://docs.imgix.com/setup/securing-images
+ */
+export declare const signURL: (url: string, secureURLToken: string) => string;

package/dist/node/signURL.js

@@ -0,0 +1,12 @@
+import { createHash } from "crypto";
+const signURL = (url, secureURLToken) => {
+  const instance = new URL(url);
+  instance.searchParams.delete("s");
+  const signature = createHash("md5").update(secureURLToken + instance.pathname + instance.search).digest("hex");
+  instance.searchParams.append("s", signature);
+  return instance.toString();
+};
+export {
+  signURL
+};
+//# sourceMappingURL=signURL.js.map

package/dist/node/signURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signURL.js","sources":["../../../src/node/signURL.ts"],"sourcesContent":["import { createHash } from \"crypto\";\n\n/**\n * Signs an Imgix image URL by appending a signature to the URL parameters. This\n * locks the URL and its parameters to the signature to prevent URL tampering.\n *\n * **Important**: This function should only be used in a trusted environment and\n * never in a browser. The `secureURLToken` parameter is a secret and should not\n * be exposed to the public.\n *\n * @example\n *\n * ```ts\n * const url = signURL(\n * \t\"https://example.imgix.net/image.png?width=400\",\n * \t\"example-token\",\n * );\n * // => https://example.imgix.net/image.png?width=400&s=def3e221c3f4c4debda091b8e49420ea\n * ```\n *\n * @param url - Full absolute URL to the Imgix image to sign.\n * @param secureURLToken - The secret Imgix secure URL token used to generate\n *   the signature.\n *\n * @returns `url` with a signature appended via an `s` URL parameter.\n *\n * @see Details on securing Imgix images: https://docs.imgix.com/setup/securing-images\n */\nexport const signURL = (url: string, secureURLToken: string): string => {\n\tconst instance = new URL(url);\n\n\t// If an `s` param is passed explicitly, it will be overridden. It must\n\t// also not be used when generating the signature.\n\tinstance.searchParams.delete(\"s\");\n\n\t// @see https://github.com/imgix/imgix-blueprint#securing-urls\n\tconst signature = createHash(\"md5\")\n\t\t.update(secureURLToken + instance.pathname + instance.search)\n\t\t.digest(\"hex\");\n\n\tinstance.searchParams.append(\"s\", signature);\n\n\treturn instance.toString();\n};\n"],"names":[],"mappings":";AA4Ba,MAAA,UAAU,CAAC,KAAa,mBAAkC;AAChE,QAAA,WAAW,IAAI,IAAI,GAAG;AAInB,WAAA,aAAa,OAAO,GAAG;AAGhC,QAAM,YAAY,WAAW,KAAK,EAChC,OAAO,iBAAiB,SAAS,WAAW,SAAS,MAAM,EAC3D,OAAO,KAAK;AAEL,WAAA,aAAa,OAAO,KAAK,SAAS;AAE3C,SAAO,SAAS;AACjB;"}

package/dist/node.cjs

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const buildURL = require("./buildURL.cjs");
+const SecureClient = require("./node/SecureClient.cjs");
+const buildSignedURL = require("./node/buildSignedURL.cjs");
+const buildSignedWidthSrcSet = require("./node/buildSignedWidthSrcSet.cjs");
+const buildSignedPixelDensitySrcSet = require("./node/buildSignedPixelDensitySrcSet.cjs");
+const signURL = require("./node/signURL.cjs");
+exports.buildURL = buildURL.buildURL;
+exports.SecureClient = SecureClient.SecureClient;
+exports.buildSignedURL = buildSignedURL.buildSignedURL;
+exports.buildSignedWidthSrcSet = buildSignedWidthSrcSet.buildSignedWidthSrcSet;
+exports.buildSignedPixelDensitySrcSet = buildSignedPixelDensitySrcSet.buildSignedPixelDensitySrcSet;
+exports.signURL = signURL.signURL;
+//# sourceMappingURL=node.cjs.map

package/dist/node.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;"}

package/dist/node.js

@@ -0,0 +1,15 @@
+import { buildURL } from "./buildURL.js";
+import { SecureClient } from "./node/SecureClient.js";
+import { buildSignedURL } from "./node/buildSignedURL.js";
+import { buildSignedWidthSrcSet } from "./node/buildSignedWidthSrcSet.js";
+import { buildSignedPixelDensitySrcSet } from "./node/buildSignedPixelDensitySrcSet.js";
+import { signURL } from "./node/signURL.js";
+export {
+  SecureClient,
+  buildSignedPixelDensitySrcSet,
+  buildSignedURL,
+  buildSignedWidthSrcSet,
+  buildURL,
+  signURL
+};
+//# sourceMappingURL=node.js.map

package/dist/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}