changed some properties name

Author: Alqanar

README.md

@@ -30,7 +30,7 @@ npm install @imgproxy/imgproxy-node
 import { generateImageUrl } from '@imgproxy/imgproxy-node';
 
 const url = generateImageUrl(
-  baseUrl: "https://imgproxy.example.com/",
+  endpoint: "https://imgproxy.example.com/",
   url: "https://example.com/image.jpg",
   options: {
     resizing_type: "fit",
@@ -50,35 +50,35 @@ const url = generateImageUrl(
 This method generates an imgproxy URL.
 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`.
+- `endpoint` (`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 displayAs properties. You can specify only url if you agree with default `url.displayAs` = "base64" or you have to specify `url.value` and `url.displayAs`.
   - `value` (`string`) - (required) the plain text URL of the image.
-  - `resultType` (`"base64" | "encrypted" | "plain"`) - (optional) the final type of URL you will receive . Deafult value is `"base64"`.
+  - `displayAs` (`"base64" | "encrypted" | "plain"`) - (optional) how the image URL should be presented in the resulting imgproxy request URL. Deafult value is `"base64"`.
     Can be one of the following:
     - `"base64"` - a base64 encoded URL. Default value.
     - `"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.
-- `encryptKey` (`string | undefined`) - (optional, **PRO feature**) the key used to encrypt the URL. The key should be either 16, 24, or 32 bytes long for AES-128-CBC, AES-192-CBC, or AES-256-CBC, respectively. This option overrides IMGPROXY_SOURCE_URL_ENCRYPTION_KEY environment variable from process.env for this call.
-- `encryptIV` (`string | undefined`) - (optional, **PRO feature**) the IV used to encrypt the URL. The IV should be 16 bytes long. If not specified, the IV will be generated randomly. But we strongly recommend to specify it.
+- `salt` (`string | undefined`) - (optional) hex-encoded 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) hex-encoded 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.
+- `encryptKey` (`string | undefined`) - (optional, **PRO feature**) hex-encoded key used to encrypt the URL. The key should be either 16, 24, or 32 bytes long for AES-128-CBC, AES-192-CBC, or AES-256-CBC, respectively. This option overrides IMGPROXY_SOURCE_URL_ENCRYPTION_KEY environment variable from process.env for this call.
+- `encryptIV` (`string | undefined`) - (optional, **PRO feature**) hex-encoded 16-bytes length IV for encrypting url. If not specified, the IV will be generated randomly. But it's better if you specify it yourself. Read more in [imgproxy docs iv-generation](https://docs.imgproxy.net/usage/encrypting_source_url#iv-generation).
 
 ### generateImageInfoUrl
 
 This method generates an imgproxy URL to get a source image info.
 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`.
+- `endpoint` (`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 displayAs properties. You can specify only url if you agree with default `url.displayAs` = "base64" or you will have to specify `url.value` and `url.displayAs`.
   - `value` (`string`) - (required) the plain text URL of the image.
-  - `resultType` (`"base64" | "encrypted" | "plain"`) - (optional) the final type of URL you will receive. Deafult value is `"base64"`.
+  - `displayAs` (`"base64" | "encrypted" | "plain"`) - (optional) how the image URL should be presented in the resulting imgproxy request URL. Deafult value is `"base64"`.
     Can be one of the following:
     - `"base64"` - a base64 encoded URL. Default value.
     - `"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.
-- `encryptKey` (`string | undefined`) - (optional, **PRO feature**) the key used to encrypt the URL. The key should be either 16, 24, or 32 bytes long for AES-128-CBC, AES-192-CBC, or AES-256-CBC, respectively. This option overrides IMGPROXY_SOURCE_URL_ENCRYPTION_KEY from process.env for one request.
-- `encryptIV` (`string | undefined`) - (optional, **PRO feature**) the IV used to encrypt the URL. The IV should be 16 bytes long. If not specified, the IV will be generated randomly. But we strongly recommend to specify it.
+- `salt` (`string | undefined`) - (optional) hex-encoded 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) hex-encoded 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.
+- `encryptKey` (`string | undefined`) - (optional, **PRO feature**) hex-encoded key used to encrypt the URL. The key should be either 16, 24, or 32 bytes long for AES-128-CBC, AES-192-CBC, or AES-256-CBC, respectively. This option overrides IMGPROXY_SOURCE_URL_ENCRYPTION_KEY from process.env for one request.
+- `encryptIV` (`string | undefined`) - (optional, **PRO feature**) hex-encoded 16-bytes length IV for encrypting url. If not specified, the IV will be generated randomly. But it's better if you specify it yourself. Read more in [imgproxy docs iv-generation](https://docs.imgproxy.net/usage/encrypting_source_url#iv-generation).

src/methods/generateImageInfoUrl.test.ts

@@ -13,10 +13,10 @@ describe("generateImageInfourl", () => {
     };
 
     const result = generateImageInfoUrl({
-      baseUrl: "https://imgproxy.example.com/",
+      endpoint: "https://imgproxy.example.com/",
       url: {
         value: "https://example.com/image.jpg",
-        resultType: "encrypted",
+        displayAs: "encrypted",
       },
       options,
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",
@@ -37,7 +37,7 @@ describe("generateImageInfourl", () => {
     };
 
     const result = generateImageInfoUrl({
-      baseUrl: "https://imgproxy.example.com",
+      endpoint: "https://imgproxy.example.com",
       url: { value: "https://example.com/image.jpg" },
       options,
     });
@@ -49,7 +49,7 @@ describe("generateImageInfourl", () => {
 
   it("should generate a valid encoded URL withouth options", () => {
     const result = generateImageInfoUrl({
-      baseUrl: "https://imgproxy.example.com/",
+      endpoint: "https://imgproxy.example.com/",
       url: "https://example.com/image.jpg",
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",
       key: "943b421c9eb07c830af81030552c86009268de4e532ba2ee2eab8247c6da0881",
@@ -69,8 +69,8 @@ describe("generateImageInfourl", () => {
     };
 
     const result = generateImageInfoUrl({
-      baseUrl: "https://imgproxy.example.com/",
-      url: { value: "https://example.com/image.jpg", resultType: "plain" },
+      endpoint: "https://imgproxy.example.com/",
+      url: { value: "https://example.com/image.jpg", displayAs: "plain" },
       options,
     });
 

src/methods/generateImageInfoUrl.ts

@@ -8,10 +8,10 @@ import type { IGenerateImageInfoUrl } from "../types";
 
 /**
  * Generate image info url. **PRO feature**
- * @param {string} baseUrl - Base url
- * @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} endpoint - Base url
+ * @param {Object | string} url - you can specify only url if you agree with default url.displayAs = "base64" or you have to specify url.value and url.displayAs
  * @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.
+ * @param {string} url.displayAs - (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
@@ -26,7 +26,7 @@ import type { IGenerateImageInfoUrl } from "../types";
  *
  * @example
  * const url = generateImageInfoUrl({
- *  baseUrl: "https://imgproxy.example",
+ *  endpoint: "https://imgproxy.example",
  *  url: "https://example.com/image.jpg",
  *  options: {
  *    average: { average: 1, ignore_transparent: "f" },
@@ -40,7 +40,7 @@ import type { IGenerateImageInfoUrl } from "../types";
  * });
  */
 const generateImageInfoUrl = ({
-  baseUrl: paramsBaseUrl,
+  endpoint: paramsEndpoint,
   url,
   options,
   salt,
@@ -54,14 +54,14 @@ const generateImageInfoUrl = ({
   const optionsString = generateImageInfoUrlCore(changedUrl, options);
 
   //changing base url
-  const baseUrl = paramsBaseUrl.endsWith("/")
-    ? paramsBaseUrl.slice(0, -1)
-    : paramsBaseUrl;
+  const endpoint = paramsEndpoint.endsWith("/")
+    ? paramsEndpoint.slice(0, -1)
+    : paramsEndpoint;
 
   //adding base url and signature if it exists
   const path = finalizePath({ options: optionsString, salt, key });
 
-  return `${baseUrl}${INFO_PREFIX}${path}`;
+  return `${endpoint}${INFO_PREFIX}${path}`;
 };
 
 export default generateImageInfoUrl;

src/methods/generateImageUrl.test.ts

@@ -14,8 +14,8 @@ describe("generateImageUrl", () => {
     };
 
     const result = generateImageUrl({
-      baseUrl: "https://imgproxy.example.com",
-      url: { value: "https://example.com/image.jpg", resultType: "base64" },
+      endpoint: "https://imgproxy.example.com",
+      url: { value: "https://example.com/image.jpg", displayAs: "base64" },
       options,
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",
       key: "943b421c9eb07c830af81030552c86009268de4e532ba2ee2eab8247c6da0881",
@@ -38,7 +38,7 @@ describe("generateImageUrl", () => {
     };
 
     const result = generateImageUrl({
-      baseUrl: "https://imgproxy.example.com/",
+      endpoint: "https://imgproxy.example.com/",
       url: "https://example.com/image.jpg",
       options,
     });
@@ -50,7 +50,7 @@ describe("generateImageUrl", () => {
 
   it("should generate a valid URL withouth options", () => {
     const result = generateImageUrl({
-      baseUrl: "https://imgproxy.example.com/",
+      endpoint: "https://imgproxy.example.com/",
       url: { value: "https://example.com/image.jpg" },
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",
       key: "943b421c9eb07c830af81030552c86009268de4e532ba2ee2eab8247c6da0881",
@@ -70,8 +70,8 @@ describe("generateImageUrl", () => {
     };
 
     const result = generateImageUrl({
-      baseUrl: "https://imgproxy.example.com/",
-      url: { value: "https://example.com/image.jpg", resultType: "encrypted" },
+      endpoint: "https://imgproxy.example.com/",
+      url: { value: "https://example.com/image.jpg", displayAs: "encrypted" },
       options,
       salt: "520f986b998545b4785e0defbc4f3c1203f22de2374a3d53cb7a7fe9fea309c5",
       key: "943b421c9eb07c830af81030552c86009268de4e532ba2ee2eab8247c6da0881",

src/methods/generateImageUrl.ts

@@ -5,10 +5,10 @@ import type { IGenerateImageUrl } from "../types";
 
 /**
  * Generate image url
- * @param {string} baseUrl - Base url
- * @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} endpoint - Base url
+ * @param {Object | string} url - you can specify only url if you agree with default url.displayAs = "base64" or you have to specify url.value and url.displayAs
  * @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.
+ * @param {string} url.displayAs - (optional) how the image URL should be presented in the resulting imgproxy request URL.
  * 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
@@ -23,7 +23,7 @@ import type { IGenerateImageUrl } from "../types";
  *
  * @example
  * const url = generateImageUrl({
- *   baseUrl: "https://imgproxy.example",
+ *   endpoint: "https://imgproxy.example",
  *   url: "https://example.com/image.jpg",
  *   options: {
  *     resize: { width: 100, height: 100, type: "fill", enlarge: 1, extend: { extend: 1 } },
@@ -36,7 +36,7 @@ import type { IGenerateImageUrl } from "../types";
  * });
  */
 const generateImageUrl = ({
-  baseUrl: paramsBaseUrl,
+  endpoint: paramsEndpoint,
   url,
   options,
   salt,
@@ -50,14 +50,14 @@ const generateImageUrl = ({
   const optionsString = generateUrl(changedUrl, options);
 
   //changing base url
-  const baseUrl = paramsBaseUrl.endsWith("/")
-    ? paramsBaseUrl.slice(0, -1)
-    : paramsBaseUrl;
+  const endpoint = paramsEndpoint.endsWith("/")
+    ? paramsEndpoint.slice(0, -1)
+    : paramsEndpoint;
 
   //adding base url and signature if it exists
   const path = finalizePath({ options: optionsString, salt, key });
 
-  return `${baseUrl}${path}`;
+  return `${endpoint}${path}`;
 };
 
 export default generateImageUrl;

src/types.ts

@@ -21,11 +21,11 @@ export interface ICryptPair {
 
 export interface IRawUrl {
   value: string;
-  resultType?: URL["type"];
+  displayAs?: URL["type"];
 }
 
 interface BaseGenerateImageUrl {
-  baseUrl: string;
+  endpoint: string;
   url: string | IRawUrl;
   salt?: string;
   key?: string;

src/utils/normalizeUrl.test.ts

@@ -2,12 +2,12 @@ import { describe, expect, it } from "vitest";
 import normalizeUrl from "./normalizeUrl";
 
 describe("normalizeUrl", () => {
-  it("should return a throw error if resultType is 'encrypted' and encryptKey is not provided", () => {
+  it("should return a throw error if displayAs is 'encrypted' and encryptKey is not provided", () => {
     expect(() =>
       normalizeUrl({
         url: {
           value: "https://example.com/image.jpg",
-          resultType: "encrypted",
+          displayAs: "encrypted",
         },
       })
     ).toThrowError(
@@ -17,7 +17,7 @@ describe("normalizeUrl", () => {
 
   it("should return a changed url type if encryptKey is provided", () => {
     const result = normalizeUrl({
-      url: { value: "https://example.com/image.jpg", resultType: "encrypted" },
+      url: { value: "https://example.com/image.jpg", displayAs: "encrypted" },
       encryptKey:
         "52dd01d54fcbd79ff247fcff1d2f200ce6b95546f960b084faa1d269fb95d600",
     });
@@ -35,7 +35,7 @@ describe("normalizeUrl", () => {
     expect(result.type).toBe("base64");
   });
 
-  it("should return a url type is 'base64' if url is object without url.resultType", () => {
+  it("should return a url type is 'base64' if url is object without url.displayAs", () => {
     const result = normalizeUrl({
       url: {
         value: "https://example.com/image.jpg",
@@ -45,11 +45,11 @@ describe("normalizeUrl", () => {
     expect(result.type).toBe("base64");
   });
 
-  it("should return a url type is 'plain' if url is object with url.resultType === 'plain'", () => {
+  it("should return a url type is 'plain' if url is object with url.displayAs === 'plain'", () => {
     const result = normalizeUrl({
       url: {
         value: "https://example.com/image.jpg",
-        resultType: "plain",
+        displayAs: "plain",
       },
     });
 

src/utils/normalizeUrl.ts

@@ -12,7 +12,7 @@ interface INormalizeUrl {
 const normalizeUrl = ({ url, encryptKey, encryptIV }: INormalizeUrl): URL => {
   const changedUrl = {
     value: typeof url === "string" ? url : url.value,
-    type: (typeof url === "string" ? "base64" : url.resultType) || "base64",
+    type: (typeof url === "string" ? "base64" : url.displayAs) || "base64",
   };
 
   //encoded url to base64