changed url type from 'encoded' to 'encrypted', fixed build

Author: Alqanar

README.md

@@ -55,11 +55,11 @@ It takes the following arguments:
 - `baseUrl` (`string`) - (required) the base URL of your imgproxy instance
 - `url` (`Object | string`) - (required) a string with url value or an object that contains the value and resultType properties. You can specify only url if you agree with default `url.resultType` = "base64" or you have to specify `url.value` and `url.resultType`.
   - `value` (`string`) - (required) the plain text URL of the image.
-  - `resultType` (`"base64" | "encoded" | "plain"`) - (optional) the type of the URL. Deafult value is `"base64"`.
+  - `resultType` (`"base64" | "encrypted" | "plain"`) - (optional) the type of the URL. Deafult value is `"base64"`.
     Can be one of the following:
     - `"base64"` - a base64 encoded URL. Default value.
-    - `"encoded"` - (**PRO feature**) an AES-CBC encrypted URL.
-    - `"plain"` - a plain text URL. We strongly recommend using `base64` or `encoded` type.
+    - `"encrypted"` - (**PRO feature**) an AES-CBC encrypted URL.
+    - `"plain"` - a plain text URL. We strongly recommend using `base64` or `encrypted` type.
 - `options` (`Object | undefined`) - (optional) an object that contains the resizing options. You can see all options in [imgproxy docs](https://docs.imgproxy.net/generating_the_url?id=processing-options) or in [Options types in imgproxy-js-core library](https://github.com/imgproxy/imgproxy-js-core/blob/main/src/types/index.ts).
 - `salt` (`string | undefined`) - (optional) the salt used to encode the URL. It must be a hex-encoded 16-byte string. This option overrides IMGPROXY_SALT environment variable from process.env for this call.
 - `key` (`string | undefined`) - (optional) the key used to encode the URL. It must be a hex-encoded 16-byte string. This option overrides IMGPROXY_KEY environment variable from process.env for this call.
@@ -74,11 +74,11 @@ It takes the following arguments:
 - `baseUrl` (`string`) - (required) the base URL of your imgproxy instance
 - `url` (`Object | string`) - (required) a string with url value or an object that contains the value and resultType properties. You can specify only url if you agree with default `url.resultType` = "base64" or you will have to specify `url.value` and `url.resultType`.
   - `value` (`string`) - (required) the plain text URL of the image.
-  - `resultType` (`"base64" | "encoded" | "plain"`) - (optional) the type of the URL. Deafult value is `"base64"`.
+  - `resultType` (`"base64" | "encrypted" | "plain"`) - (optional) the type of the URL. Deafult value is `"base64"`.
     Can be one of the following:
     - `"base64"` - a base64 encoded URL. Default value.
-    - `"encoded"` - (**PRO feature**) an AES-CBC encrypted URL.
-    - `"plain"` - a plain text URL. We strongly recommend using `base64` or `encoded` type.
+    - `"encrypted"` - (**PRO feature**) an AES-CBC encrypted URL.
+    - `"plain"` - a plain text URL. We strongly recommend using `base64` or `encrypted` type.
 - `options` (`Object | undefined`) - (optional) an object that contains the resizing options. You can see all options in [imgproxy docs](https://docs.imgproxy.net/getting_the_image_info?id=info-options) or in [OptionsImageInfo types in imgproxy-js-core library](https://github.com/imgproxy/imgproxy-js-core/blob/main/src/types/index.ts).
 - `salt` (`string | undefined`) - (optional) the salt used to encode the URL. It must be a hex-encoded 16-byte string. This option overrides IMGPROXY_SALT from process.env for one request.
 - `key` (`string | undefined`) - (optional) the key used to encode the URL. It must be a hex-encoded 16-byte string. This option overrides IMGPROXY_KEY from process.env for one request.

package-lock.json

@@ -41,6 +41,6 @@
     "vitest": "^0.34.1"
   },
   "dependencies": {
-    "@imgproxy/imgproxy-js-core": "^1.0.3"
+    "@imgproxy/imgproxy-js-core": "^1.0.5"
   }
 }

package.json

@@ -16,7 +16,7 @@ describe("generateImageInfourl", () => {
       baseUrl: "https://imgproxy.example.com/",
       url: {
         value: "https://example.com/image.jpg",
-        resultType: "encoded",
+        resultType: "encrypted",
       },
       options,
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",

src/methods/generateImageInfoUrl.test.ts

@@ -9,9 +9,10 @@ import type { IGenerateImageInfoUrl } from "../types";
 /**
  * Generate image info url. **PRO feature**
  * @param {string} baseUrl - Base url
- * @param {Object} url - url and type
+ * @param {Object | string} url - you can specify only url if you agree with default url.resultType = "base64" or you have to specify url.value and url.resultType
  * @param {string} url.value - url value
- * @param {string} url.type - url type (plain, base64 or encoded)
+ * @param {string} url.resultType - (optional) here you specify in what type of image URL is required in the generated.
+ * Imgproxy request URL: "plain", "base64" or "encrypted" (encrypted is PRO feature). We strongly recommend to use "base64" or "encrypted" kind of url. default: `"base64"`.
  * @param {Object} [options] - (optional) options. You can see all options in [imgproxy docs](https://docs.imgproxy.net/getting_the_image_info?id=info-options)
  * or in OptionsImageInfo types in imgproxy-js-core.d.ts
  * @param {string} [salt] - (optional) hex-encoded salt. This option overrides IMGPROXY_SALT from process.env for this request
@@ -26,7 +27,7 @@ import type { IGenerateImageInfoUrl } from "../types";
  * @example
  * const url = generateImageInfoUrl({
  *  baseUrl: "https://imgproxy.example",
- *  url: { value: "hLhDnxN9acjq3LDooARQ3t6OU1UwAG1IeXsM2b7qxOyMP4DF+GsbBdnG1K9B0+bz", type: "encoded"},
+ *  url: "https://example.com/image.jpg",
  *  options: {
  *    average: { average: 1, ignore_transparent: "f" },
  *    detect_objects: true,

src/methods/generateImageInfoUrl.ts

@@ -61,7 +61,7 @@ describe("generateImageUrl", () => {
     );
   });
 
-  it("should generate a valid encoded URL with encryption", () => {
+  it("should generate a valid encrypted URL with encryption", () => {
     const options: Options = {
       resizing_type: "fit",
       width: 300,
@@ -71,7 +71,7 @@ describe("generateImageUrl", () => {
 
     const result = generateImageUrl({
       baseUrl: "https://imgproxy.example.com/",
-      url: { value: "https://example.com/image.jpg", resultType: "encoded" },
+      url: { value: "https://example.com/image.jpg", resultType: "encrypted" },
       options,
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",
       key: "943b421c9eb07c830af81030552c86009268de4e532ba2ee2eab8247c6da0881",

src/methods/generateImageUrl.test.ts

@@ -6,10 +6,10 @@ import type { IGenerateImageUrl } from "../types";
 /**
  * Generate image url
  * @param {string} baseUrl - Base url
- * @param {Object | string} url - you should specify only url if you agree with default url.resultType = "base64" or you should specify url.value and url.resultType
+ * @param {Object | string} url - you can specify only url if you agree with default url.resultType = "base64" or you have to specify url.value and url.resultType
  * @param {string} url.value - url value
- * @param {string} url.resultType - (optional) here you specify in what type of image URL is required in the generated
- * Imgproxy request URL: "plain", "base64" or "encoded" (encoded is PRO feature). We strongly recommend to use "base64" or "encoded" kind of url. default: "base64"
+ * @param {string} url.resultType - (optional) here you specify in what type of image URL is required in the generated.
+ * Imgproxy request URL: "plain", "base64" or "encrypted" (encrypted is PRO feature). We strongly recommend to use "base64" or "encrypted" kind of url. default: `"base64"`
  * @param {Object} [options] - (optional) options. You can see all options in [imgproxy docs](https://docs.imgproxy.net/generating_the_url?id=processing-options)
  * or in Options types in imgproxy-js-core.d.ts
  * @param {string} [salt] - (optional) hex-encoded salt. This option overrides IMGPROXY_SALT from process.env for this request

src/methods/generateImageUrl.ts

@@ -1,4 +1,8 @@
-import type { Options, OptionsImageInfo } from "@imgproxy/imgproxy-js-core";
+import type {
+  Options,
+  OptionsImageInfo,
+  URL,
+} from "@imgproxy/imgproxy-js-core";
 
 export interface IMaybePair {
   salt: string | undefined;
@@ -12,7 +16,7 @@ export interface IPair {
 
 export interface IRawUrl {
   value: string;
-  resultType?: "plain" | "base64" | "encoded";
+  resultType?: URL["type"];
 }
 
 interface BaseGenerateImageUrl {

src/types.ts

@@ -1,11 +1,11 @@
-import { createHmac } from "crypto";
+import crypto from "crypto";
 import type { IPair } from "../types";
 import withCache from "./withCache";
 
 const hexDecode = (hex: string): Buffer => Buffer.from(hex, "hex");
 
 const sign = (target: string, signPair: IPair): string => {
-  const hmac = createHmac("sha256", hexDecode(signPair.key));
+  const hmac = crypto.createHmac("sha256", hexDecode(signPair.key));
   hmac.update(hexDecode(signPair.salt));
   hmac.update(target);
 

src/utils/getSignedUrl.ts

@@ -2,24 +2,27 @@ import { describe, expect, it } from "vitest";
 import normalizeUrl from "./normalizeUrl";
 
 describe("normalizeUrl", () => {
-  it("should return a throw error if resultType is 'encoded' and encryptKey is not provided", () => {
+  it("should return a throw error if resultType is 'encrypted' and encryptKey is not provided", () => {
     expect(() =>
       normalizeUrl({
-        url: { value: "https://example.com/image.jpg", resultType: "encoded" },
+        url: {
+          value: "https://example.com/image.jpg",
+          resultType: "encrypted",
+        },
       })
     ).toThrowError(
-      "You should provide encryptKey if you want to use encoded url type"
+      "You should provide encryptKey if you want to use encrypted url type"
     );
   });
 
   it("should return a changed url type if encryptKey is provided", () => {
     const result = normalizeUrl({
-      url: { value: "https://example.com/image.jpg", resultType: "encoded" },
+      url: { value: "https://example.com/image.jpg", resultType: "encrypted" },
       encryptKey:
         "52dd01d54fcbd79ff247fcff1d2f200ce6b95546f960b084faa1d269fb95d600",
     });
 
-    expect(result.type).toBe("encoded");
+    expect(result.type).toBe("encrypted");
   });
 
   it("should return a url type without changes if encryptKey and noEcroption are provided", () => {