@lambdaimg/core 0.1.0

package/README.md

@@ -0,0 +1,17 @@
+# @lambdaimg/core
+
+Core URL and responsive image helpers for LambdaImg.
+
+```ts
+import { buildOriginalUrl, buildResizedUrl, buildSrcSet } from "@lambdaimg/core";
+
+buildOriginalUrl("products/chair.jpeg");
+buildResizedUrl("products/chair.jpeg", 640);
+buildSrcSet("products/chair.jpeg", { baseUrl: "https://images.example.com" });
+```
+
+LambdaImg derivative URLs are canonicalized as:
+
+```txt
+/_/w{width}/{originalKey}/{filename}.webp
+```

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const ALLOWED_IMAGE_WIDTHS: readonly [160, 320, 480, 640, 828, 1080, 1440, 1920];
+export type ImageWidth = (typeof ALLOWED_IMAGE_WIDTHS)[number];
+export declare const DERIVED_PREFIX = "_";
+export declare const WEBP_CONTENT_TYPE = "image/webp";
+export declare const RESIZED_CACHE_CONTROL = "public, max-age=31536000, immutable";
+export declare const NOT_FOUND_CACHE_CONTROL = "public, max-age=60";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,YAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAEzF,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC,eAAO,MAAM,iBAAiB,eAAe,CAAC;AAE9C,eAAO,MAAM,qBAAqB,wCAAwC,CAAC;AAE3E,eAAO,MAAM,uBAAuB,uBAAuB,CAAC"}

package/dist/constants.js

@@ -0,0 +1,6 @@
+export const ALLOWED_IMAGE_WIDTHS = [160, 320, 480, 640, 828, 1080, 1440, 1920];
+export const DERIVED_PREFIX = "_";
+export const WEBP_CONTENT_TYPE = "image/webp";
+export const RESIZED_CACHE_CONTROL = "public, max-age=31536000, immutable";
+export const NOT_FOUND_CACHE_CONTROL = "public, max-age=60";
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAIzF,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAC;AAElC,MAAM,CAAC,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAE9C,MAAM,CAAC,MAAM,qBAAqB,GAAG,qCAAqC,CAAC;AAE3E,MAAM,CAAC,MAAM,uBAAuB,GAAG,oBAAoB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { ALLOWED_IMAGE_WIDTHS, DERIVED_PREFIX, NOT_FOUND_CACHE_CONTROL, RESIZED_CACHE_CONTROL, WEBP_CONTENT_TYPE, type ImageWidth, } from "./constants.js";
+export { buildOriginalUrl, buildResizedUrl, buildSrcSet, canonicalFilename, isAllowedImageWidth, normalizeBaseUrl, normalizeImageKey, parseResizedPath, resizedS3Key, type BuildImageUrlOptions, type BuildSrcSetOptions, type ParsedResizedPath, } from "./url.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,EACjB,KAAK,UAAU,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,GACvB,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { ALLOWED_IMAGE_WIDTHS, DERIVED_PREFIX, NOT_FOUND_CACHE_CONTROL, RESIZED_CACHE_CONTROL, WEBP_CONTENT_TYPE, } from "./constants.js";
+export { buildOriginalUrl, buildResizedUrl, buildSrcSet, canonicalFilename, isAllowedImageWidth, normalizeBaseUrl, normalizeImageKey, parseResizedPath, resizedS3Key, } from "./url.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GAElB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,GAIb,MAAM,UAAU,CAAC"}

package/dist/url.d.ts

@@ -0,0 +1,22 @@
+import { type ImageWidth } from "./constants.js";
+export interface ParsedResizedPath {
+    width: ImageWidth;
+    originalKey: string;
+    resizedKey: string;
+}
+export interface BuildImageUrlOptions {
+    baseUrl?: string;
+}
+export interface BuildSrcSetOptions extends BuildImageUrlOptions {
+    widths?: readonly ImageWidth[];
+}
+export declare function canonicalFilename(s3Key: string): string;
+export declare function isAllowedImageWidth(width: number): width is ImageWidth;
+export declare function normalizeImageKey(imageKey: string): string;
+export declare function normalizeBaseUrl(baseUrl?: string): string;
+export declare function buildOriginalUrl(s3Key: string, options?: BuildImageUrlOptions): string;
+export declare function buildResizedUrl(s3Key: string, width: ImageWidth, options?: BuildImageUrlOptions): string;
+export declare function buildSrcSet(s3Key: string, options?: BuildSrcSetOptions): string;
+export declare function resizedS3Key(s3Key: string, width: ImageWidth): string;
+export declare function parseResizedPath(pathname: string): ParsedResizedPath | null;
+//# sourceMappingURL=url.d.ts.map

package/dist/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEvF,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,MAAM,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CAChC;AAID,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAOvD;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,UAAU,CAEtE;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,gBAAgB,CAAC,OAAO,SAAK,GAAG,MAAM,CAErD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,MAAM,CAE1F;AAED,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,oBAAyB,GACjC,MAAM,CAIR;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,MAAM,CAGnF;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,CAErE;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI,CAqC3E"}

package/dist/url.js

@@ -0,0 +1,73 @@
+import { ALLOWED_IMAGE_WIDTHS, DERIVED_PREFIX } from "./constants.js";
+const RESIZED_PATH_RE = /^\/_\/w(\d+)\/(.+)\.webp$/;
+export function canonicalFilename(s3Key) {
+    const lastSegment = s3Key.split("/").pop() ?? s3Key;
+    const dotIndex = lastSegment.lastIndexOf(".");
+    if (dotIndex <= 0) {
+        return lastSegment;
+    }
+    return lastSegment.slice(0, dotIndex);
+}
+export function isAllowedImageWidth(width) {
+    return ALLOWED_IMAGE_WIDTHS.includes(width);
+}
+export function normalizeImageKey(imageKey) {
+    return imageKey.replace(/^\/+/, "");
+}
+export function normalizeBaseUrl(baseUrl = "") {
+    return baseUrl.replace(/\/+$/, "");
+}
+export function buildOriginalUrl(s3Key, options = {}) {
+    return withBaseUrl(options.baseUrl, `/${normalizeImageKey(s3Key)}`);
+}
+export function buildResizedUrl(s3Key, width, options = {}) {
+    const normalizedKey = normalizeImageKey(s3Key);
+    const filename = canonicalFilename(normalizedKey);
+    return withBaseUrl(options.baseUrl, `/_/${`w${width}`}/${normalizedKey}/${filename}.webp`);
+}
+export function buildSrcSet(s3Key, options = {}) {
+    const widths = options.widths ?? ALLOWED_IMAGE_WIDTHS;
+    return widths.map((width) => `${buildResizedUrl(s3Key, width, options)} ${width}w`).join(", ");
+}
+export function resizedS3Key(s3Key, width) {
+    return buildResizedUrl(s3Key, width).slice(1);
+}
+export function parseResizedPath(pathname) {
+    const match = RESIZED_PATH_RE.exec(pathname);
+    if (!match?.[1] || !match[2]) {
+        return null;
+    }
+    const width = Number.parseInt(match[1], 10);
+    if (!isAllowedImageWidth(width)) {
+        return null;
+    }
+    const middle = match[2];
+    const lastSlash = middle.lastIndexOf("/");
+    if (lastSlash === -1) {
+        return null;
+    }
+    const originalKey = middle.slice(0, lastSlash);
+    const filename = middle.slice(lastSlash + 1);
+    if (originalKey.length === 0 || filename.length === 0) {
+        return null;
+    }
+    if (originalKey.startsWith(`${DERIVED_PREFIX}/`)) {
+        return null;
+    }
+    if (canonicalFilename(originalKey) !== filename) {
+        return null;
+    }
+    return {
+        width,
+        originalKey,
+        resizedKey: pathname.slice(1),
+    };
+}
+function withBaseUrl(baseUrl, pathname) {
+    const normalizedBaseUrl = normalizeBaseUrl(baseUrl);
+    if (!normalizedBaseUrl) {
+        return pathname;
+    }
+    return `${normalizedBaseUrl}${pathname}`;
+}
+//# sourceMappingURL=url.js.map

package/dist/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAmB,MAAM,gBAAgB,CAAC;AAgBvF,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAEpD,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,KAAK,CAAC;IACpD,MAAM,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;QAClB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,OAAQ,oBAA0C,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAgB;IAChD,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAO,GAAG,EAAE;IAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAa,EAAE,OAAO,GAAyB,EAAE;IAChF,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,KAAa,EACb,KAAiB,EACjB,OAAO,GAAyB,EAAE;IAElC,MAAM,aAAa,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAClD,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE,IAAI,aAAa,IAAI,QAAQ,OAAO,CAAC,CAAC;AAC7F,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,OAAO,GAAuB,EAAE;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,oBAAoB,CAAC;IACtD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjG,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAa,EAAE,KAAiB;IAC3D,OAAO,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IAE7C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,cAAc,GAAG,CAAC,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,KAAK;QACL,WAAW;QACX,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,OAA2B,EAAE,QAAgB;IAChE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,OAAO,GAAG,iBAAiB,GAAG,QAAQ,EAAE,CAAC;AAC3C,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@lambdaimg/core",
+  "version": "0.1.0",
+  "description": "Core URL and srcset primitives for LambdaImg.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jperezrealini/lambdaimg.git",
+    "directory": "packages/core"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "check": "oxlint && oxfmt --check && tsc --noEmit -p tsconfig.json",
+    "fix": "oxlint --fix && oxfmt",
+    "test": "bun test"
+  },
+  "devDependencies": {
+    "@types/bun": "catalog:",
+    "@types/node": "catalog:"
+  }
+}