@artsy/img 0.1.2 → 1.0.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v1.0.0 (Fri Dec 09 2022)
+
+#### 💥  Breaking Change
+
+- refactor: renames functions and types to be less generic [#10](https://github.com/artsy/img/pull/10) ([@dzucconi](https://github.com/dzucconi))
+
+#### Authors: 1
+
+- Damon ([@dzucconi](https://github.com/dzucconi))
+
+---
+
 # v0.1.2 (Fri Dec 09 2022)
 
 #### 🐛  Bug Fix

package/dist/services/gemini.d.ts

@@ -1,5 +1,5 @@
-import { Exec } from "../services";
+import { ResizeExec } from "../services";
 export type Gemini = {
     endpoint: string;
 };
-export declare const gemini: (config: Gemini) => Exec;
+export declare const gemini: (config: Gemini) => ResizeExec;

package/dist/services/gemini.js

@@ -4,8 +4,8 @@ exports.gemini = void 0;
 const services_1 = require("../services");
 const stringify_1 = require("../utils/stringify");
 const gemini = (config) => {
-    return (mode, src, { width, height, quality = services_1.DEFAULT_QUALITY }) => {
-        if (!(0, services_1.validate)(mode, { width, height }))
+    return (mode, src, { width, height, quality = services_1.DEFAULT_IMG_QUALITY }) => {
+        if (!(0, services_1.validateResizeOptions)(mode, { width, height }))
             return src;
         let resizeTo;
         switch (mode) {

package/dist/services/imgix.d.ts

@@ -1,6 +1,6 @@
-import { Exec } from "../services";
+import { ResizeExec } from "../services";
 export type Imgix = {
     endpoint: string;
     token: string;
 };
-export declare const imgix: (config: Imgix) => Exec;
+export declare const imgix: (config: Imgix) => ResizeExec;

package/dist/services/imgix.js

@@ -8,8 +8,8 @@ const md5_1 = __importDefault(require("md5"));
 const services_1 = require("../services");
 const stringify_1 = require("../utils/stringify");
 const imgix = (config) => {
-    return (mode, src, { width, height, quality = services_1.DEFAULT_QUALITY }) => {
-        if (!(0, services_1.validate)(mode, { width, height }))
+    return (mode, src, { width, height, quality = services_1.DEFAULT_IMG_QUALITY }) => {
+        if (!(0, services_1.validateResizeOptions)(mode, { width, height }))
             return src;
         const params = {
             fit: { crop: "crop", resize: "clip" }[mode],

package/dist/services/lambda.d.ts

@@ -1,4 +1,4 @@
-import { Exec } from "../services";
+import { ResizeExec } from "../services";
 export type Lambda = {
     endpoint: string;
     sources: {
@@ -6,4 +6,4 @@ export type Lambda = {
         bucket: string;
     }[];
 };
-export declare const lambda: (config: Lambda) => Exec;
+export declare const lambda: (config: Lambda) => ResizeExec;

package/dist/services/lambda.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.lambda = void 0;
 const services_1 = require("../services");
 const lambda = (config) => {
-    return (mode, src, { width, height, quality = services_1.DEFAULT_QUALITY }) => {
-        if (!(0, services_1.validate)(mode, { width, height }))
+    return (mode, src, { width, height, quality = services_1.DEFAULT_IMG_QUALITY }) => {
+        if (!(0, services_1.validateResizeOptions)(mode, { width, height }))
             return src;
         const source = config.sources.find((source) => {
             return src.startsWith(source.source);

package/dist/services.d.ts

@@ -1,27 +1,26 @@
 import { Gemini } from "./services/gemini";
 import { Imgix } from "./services/imgix";
 import { Lambda } from "./services/lambda";
-export declare const SERVICES: readonly ["gemini", "imgix", "lambda"];
-export declare const MODES: readonly ["resize", "crop"];
-export declare const DEFAULT_QUALITY = 80;
-export type Mode = typeof MODES[number];
-export type Config = {
-    gemini?: Gemini;
-    imgix?: Imgix;
-    lambda?: Lambda;
-};
-export type Options = {
+export declare const RESIZE_MODES: readonly ["resize", "crop"];
+export declare const DEFAULT_IMG_QUALITY = 80;
+export type ResizeMode = typeof RESIZE_MODES[number];
+export type ResizeOptions = {
     width?: number;
     height?: number;
     quality?: number;
 };
-export type Exec = (mode: Mode, src: string, options: Options) => string;
-export type Service = {
-    exec: Exec;
+export type ServiceConfigurations = {
+    gemini?: Gemini;
+    imgix?: Imgix;
+    lambda?: Lambda;
+};
+export type ResizeExec = (mode: ResizeMode, src: string, options: ResizeOptions) => string;
+export type ImageService = {
+    exec: ResizeExec;
 };
-export declare const validate: (mode: Mode, { width, height }: Options) => boolean;
+export declare const validateResizeOptions: (mode: ResizeMode, { width, height }: ResizeOptions) => boolean;
 /**
  * Returns a list of configured services.
  * All endpoints should *not* have trailing slashes.
  */
-export declare const configure: <T extends Config>(config: T) => Record<keyof T, Service>;
+export declare const configureImageServices: <T extends ServiceConfigurations>(config: T) => Record<keyof T, ImageService>;

package/dist/services.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configure = exports.validate = exports.DEFAULT_QUALITY = exports.MODES = exports.SERVICES = void 0;
+exports.configureImageServices = exports.validateResizeOptions = exports.DEFAULT_IMG_QUALITY = exports.RESIZE_MODES = void 0;
 const gemini_1 = require("./services/gemini");
 const imgix_1 = require("./services/imgix");
 const lambda_1 = require("./services/lambda");
-exports.SERVICES = ["gemini", "imgix", "lambda"];
-exports.MODES = ["resize", "crop"];
-exports.DEFAULT_QUALITY = 80;
-const validate = (mode, { width, height }) => {
+exports.RESIZE_MODES = ["resize", "crop"];
+exports.DEFAULT_IMG_QUALITY = 80;
+const validateResizeOptions = (mode, { width, height }) => {
     if (mode === "crop" && (!width || !height)) {
         console.warn("`crop`requires both `width` and `height`");
         return false;
@@ -26,12 +25,12 @@ const validate = (mode, { width, height }) => {
     }
     return true;
 };
-exports.validate = validate;
+exports.validateResizeOptions = validateResizeOptions;
 /**
  * Returns a list of configured services.
  * All endpoints should *not* have trailing slashes.
  */
-const configure = (config) => {
+const configureImageServices = (config) => {
     const services = {};
     if (config.gemini) {
         services.gemini = { exec: (0, gemini_1.gemini)(config.gemini) };
@@ -44,4 +43,4 @@ const configure = (config) => {
     }
     return services;
 };
-exports.configure = configure;
+exports.configureImageServices = configureImageServices;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/img",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "Logic for constructing image proxy URLs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/__tests__/services.test.ts

@@ -1,16 +1,18 @@
-import { configure } from "../services";
+import { configureImageServices } from "../services";
 
 const EXAMPLE_SRC =
   "https://d32dm0rphc51dk.cloudfront.net/MFFPXvpJSoGzggU8zujwBw/normalized.jpg";
 
 describe("strategies", () => {
   it("only returns the services that are configured", () => {
-    const services = configure({ gemini: { endpoint: "https://example.com" } });
+    const services = configureImageServices({
+      gemini: { endpoint: "https://example.com" },
+    });
 
     expect(Object.keys(services)).toEqual(["gemini"]);
   });
 
-  const { gemini, imgix, lambda } = configure({
+  const { gemini, imgix, lambda } = configureImageServices({
     imgix: {
       endpoint: "https://example.imgix.net",
       token: "secret",

package/src/services/gemini.ts

@@ -1,13 +1,17 @@
-import { DEFAULT_QUALITY, Exec, validate } from "../services";
+import {
+  DEFAULT_IMG_QUALITY,
+  ResizeExec,
+  validateResizeOptions,
+} from "../services";
 import { stringify } from "../utils/stringify";
 
 export type Gemini = {
   endpoint: string;
 };
 
-export const gemini = (config: Gemini): Exec => {
-  return (mode, src, { width, height, quality = DEFAULT_QUALITY }) => {
-    if (!validate(mode, { width, height })) return src;
+export const gemini = (config: Gemini): ResizeExec => {
+  return (mode, src, { width, height, quality = DEFAULT_IMG_QUALITY }) => {
+    if (!validateResizeOptions(mode, { width, height })) return src;
 
     let resizeTo: "width" | "height" | "fit" | "fill";
 

package/src/services/imgix.ts

@@ -1,5 +1,9 @@
 import md5 from "md5";
-import { DEFAULT_QUALITY, Exec, validate } from "../services";
+import {
+  DEFAULT_IMG_QUALITY,
+  ResizeExec,
+  validateResizeOptions,
+} from "../services";
 import { stringify } from "../utils/stringify";
 
 export type Imgix = {
@@ -7,9 +11,9 @@ export type Imgix = {
   token: string;
 };
 
-export const imgix = (config: Imgix): Exec => {
-  return (mode, src, { width, height, quality = DEFAULT_QUALITY }) => {
-    if (!validate(mode, { width, height })) return src;
+export const imgix = (config: Imgix): ResizeExec => {
+  return (mode, src, { width, height, quality = DEFAULT_IMG_QUALITY }) => {
+    if (!validateResizeOptions(mode, { width, height })) return src;
 
     const params = {
       fit: { crop: "crop", resize: "clip" }[mode],

package/src/services/lambda.ts

@@ -1,4 +1,8 @@
-import { DEFAULT_QUALITY, Exec, validate } from "../services";
+import {
+  DEFAULT_IMG_QUALITY,
+  ResizeExec,
+  validateResizeOptions,
+} from "../services";
 
 export type Lambda = {
   endpoint: string;
@@ -8,9 +12,9 @@ export type Lambda = {
   }[];
 };
 
-export const lambda = (config: Lambda): Exec => {
-  return (mode, src, { width, height, quality = DEFAULT_QUALITY }) => {
-    if (!validate(mode, { width, height })) return src;
+export const lambda = (config: Lambda): ResizeExec => {
+  return (mode, src, { width, height, quality = DEFAULT_IMG_QUALITY }) => {
+    if (!validateResizeOptions(mode, { width, height })) return src;
 
     const source = config.sources.find((source) => {
       return src.startsWith(source.source);

package/src/services.ts

@@ -2,31 +2,36 @@ import { Gemini, gemini } from "./services/gemini";
 import { imgix, Imgix } from "./services/imgix";
 import { lambda, Lambda } from "./services/lambda";
 
-export const SERVICES = ["gemini", "imgix", "lambda"] as const;
+export const RESIZE_MODES = ["resize", "crop"] as const;
 
-export const MODES = ["resize", "crop"] as const;
+export const DEFAULT_IMG_QUALITY = 80;
 
-export const DEFAULT_QUALITY = 80;
+export type ResizeMode = typeof RESIZE_MODES[number];
 
-export type Mode = typeof MODES[number];
+export type ResizeOptions = {
+  width?: number;
+  height?: number;
+  quality?: number;
+};
 
-export type Config = {
+export type ServiceConfigurations = {
   gemini?: Gemini;
   imgix?: Imgix;
   lambda?: Lambda;
 };
 
-export type Options = {
-  width?: number;
-  height?: number;
-  quality?: number;
-};
-
-export type Exec = (mode: Mode, src: string, options: Options) => string;
+export type ResizeExec = (
+  mode: ResizeMode,
+  src: string,
+  options: ResizeOptions
+) => string;
 
-export type Service = { exec: Exec };
+export type ImageService = { exec: ResizeExec };
 
-export const validate = (mode: Mode, { width, height }: Options) => {
+export const validateResizeOptions = (
+  mode: ResizeMode,
+  { width, height }: ResizeOptions
+) => {
   if (mode === "crop" && (!width || !height)) {
     console.warn("`crop`requires both `width` and `height`");
     return false;
@@ -54,8 +59,10 @@ export const validate = (mode: Mode, { width, height }: Options) => {
  * Returns a list of configured services.
  * All endpoints should *not* have trailing slashes.
  */
-export const configure = <T extends Config>(config: T) => {
-  const services = {} as Record<keyof T, Service>;
+export const configureImageServices = <T extends ServiceConfigurations>(
+  config: T
+) => {
+  const services = {} as Record<keyof T, ImageService>;
 
   if (config.gemini) {
     services.gemini = { exec: gemini(config.gemini) };