@managesome/eposmatic-toolkit 0.2.515 → 0.2.517
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/helpers/utils/image-url-helpers.d.ts +16 -0
- package/lib/helpers/utils/image-url-helpers.js +85 -0
- package/lib/helpers/utils/index.d.ts +1 -0
- package/lib/helpers/utils/index.js +1 -0
- package/lib/tests/image-url-helpers.test.d.ts +1 -0
- package/lib/tests/image-url-helpers.test.js +63 -0
- package/package.json +1 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/** Available variant sizes generated for each source image. */
|
|
2
|
+
export type VariantSize = '64x64' | '128x128' | '256x256' | '512x512';
|
|
3
|
+
/**
|
|
4
|
+
* Transforms a Firebase Storage download URL for an original image into the
|
|
5
|
+
* URL of a resized WebP variant stored in the `{project}-variants` bucket.
|
|
6
|
+
*
|
|
7
|
+
* Returns the input unchanged if it is not a parseable firebasestorage URL,
|
|
8
|
+
* so consumers degrade gracefully to the original when no variant exists.
|
|
9
|
+
*
|
|
10
|
+
* Naming parity with the backfill + Cloud Function:
|
|
11
|
+
* - variants bucket = source bucket minus `.appspot.com` plus `-variants`
|
|
12
|
+
* - variant path = original path minus extension + `_{size}`
|
|
13
|
+
* - `.webp` is appended only when the original had an extension
|
|
14
|
+
* (extensionless originals produce extensionless variants)
|
|
15
|
+
*/
|
|
16
|
+
export declare function getImageVariantUrl(downloadUrl: string, size: VariantSize): string;
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getImageVariantUrl = getImageVariantUrl;
|
|
4
|
+
const VARIANTS_HOST = 'firebasestorage.googleapis.com';
|
|
5
|
+
/**
|
|
6
|
+
* Transforms a Firebase Storage download URL for an original image into the
|
|
7
|
+
* URL of a resized WebP variant stored in the `{project}-variants` bucket.
|
|
8
|
+
*
|
|
9
|
+
* Returns the input unchanged if it is not a parseable firebasestorage URL,
|
|
10
|
+
* so consumers degrade gracefully to the original when no variant exists.
|
|
11
|
+
*
|
|
12
|
+
* Naming parity with the backfill + Cloud Function:
|
|
13
|
+
* - variants bucket = source bucket minus `.appspot.com` plus `-variants`
|
|
14
|
+
* - variant path = original path minus extension + `_{size}`
|
|
15
|
+
* - `.webp` is appended only when the original had an extension
|
|
16
|
+
* (extensionless originals produce extensionless variants)
|
|
17
|
+
*/
|
|
18
|
+
function getImageVariantUrl(downloadUrl, size) {
|
|
19
|
+
let url;
|
|
20
|
+
try {
|
|
21
|
+
url = new URL(downloadUrl);
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
return downloadUrl;
|
|
25
|
+
}
|
|
26
|
+
if (url.hostname !== VARIANTS_HOST) {
|
|
27
|
+
return downloadUrl;
|
|
28
|
+
}
|
|
29
|
+
// Path shape: /v0/b/{bucket}/o/{encodedPath}
|
|
30
|
+
const segments = url.pathname.split('/');
|
|
31
|
+
if (segments[1] !== 'v0' || segments[2] !== 'b' || segments[4] !== 'o') {
|
|
32
|
+
return downloadUrl;
|
|
33
|
+
}
|
|
34
|
+
const bucket = segments[3];
|
|
35
|
+
if (!bucket) {
|
|
36
|
+
return downloadUrl;
|
|
37
|
+
}
|
|
38
|
+
const encodedPath = segments.slice(5).join('/');
|
|
39
|
+
if (!encodedPath) {
|
|
40
|
+
return downloadUrl;
|
|
41
|
+
}
|
|
42
|
+
// Guard: malformed percent-encoding (e.g. "%zz") throws URIError —
|
|
43
|
+
// degrade to the original URL rather than crash.
|
|
44
|
+
let sourcePath;
|
|
45
|
+
try {
|
|
46
|
+
sourcePath = decodeURIComponent(encodedPath);
|
|
47
|
+
}
|
|
48
|
+
catch {
|
|
49
|
+
return downloadUrl;
|
|
50
|
+
}
|
|
51
|
+
const variantsBucket = bucket.replace(/\.appspot\.com$/, '') + '-variants';
|
|
52
|
+
const variantPath = buildVariantPath(sourcePath, size);
|
|
53
|
+
const result = new URL(`https://${VARIANTS_HOST}/v0/b/${variantsBucket}/o/`);
|
|
54
|
+
result.pathname += encodeURIComponent(variantPath);
|
|
55
|
+
result.searchParams.set('alt', 'media');
|
|
56
|
+
// Preserve a cache-busting timestamp from the original URL (if present) so
|
|
57
|
+
// variant URLs refresh in sync with the source image.
|
|
58
|
+
const originalTimestamp = url.searchParams.get('timestamp');
|
|
59
|
+
if (originalTimestamp !== null) {
|
|
60
|
+
result.searchParams.set('timestamp', originalTimestamp);
|
|
61
|
+
}
|
|
62
|
+
return result.toString();
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Derive the variant object path from the source path and size.
|
|
66
|
+
* e.g. "images/common/logo.png" -> "images/common/logo_128x128.webp"
|
|
67
|
+
* "images/brands/x/image_url" -> "images/brands/x/image_url_128x128"
|
|
68
|
+
*/
|
|
69
|
+
function buildVariantPath(sourcePath, size) {
|
|
70
|
+
const hasExtension = hasFileExtension(sourcePath);
|
|
71
|
+
if (!hasExtension) {
|
|
72
|
+
return `${sourcePath}_${size}`;
|
|
73
|
+
}
|
|
74
|
+
const basePath = sourcePath.replace(/\.[^.]+$/, '');
|
|
75
|
+
return `${basePath}_${size}.webp`;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Determine whether the final path segment carries a file extension.
|
|
79
|
+
* A leading dot (e.g. ".webp" as a bare name) is treated as extensionless.
|
|
80
|
+
*/
|
|
81
|
+
function hasFileExtension(sourcePath) {
|
|
82
|
+
const lastSegment = sourcePath.slice(sourcePath.lastIndexOf('/') + 1);
|
|
83
|
+
const dotIndex = lastSegment.lastIndexOf('.');
|
|
84
|
+
return dotIndex > 0;
|
|
85
|
+
}
|
|
@@ -19,6 +19,7 @@ export * from './halfhalf-setup-helpers';
|
|
|
19
19
|
export * from './hourly-comparison-report-helpers';
|
|
20
20
|
export * from './hubrise-utils';
|
|
21
21
|
export * from './image-helpers';
|
|
22
|
+
export * from './image-url-helpers';
|
|
22
23
|
export * from './ingredients';
|
|
23
24
|
export * from './internal-amount-helpers';
|
|
24
25
|
export * from './inventory';
|
|
@@ -35,6 +35,7 @@ __exportStar(require("./halfhalf-setup-helpers"), exports);
|
|
|
35
35
|
__exportStar(require("./hourly-comparison-report-helpers"), exports);
|
|
36
36
|
__exportStar(require("./hubrise-utils"), exports);
|
|
37
37
|
__exportStar(require("./image-helpers"), exports);
|
|
38
|
+
__exportStar(require("./image-url-helpers"), exports);
|
|
38
39
|
__exportStar(require("./ingredients"), exports);
|
|
39
40
|
__exportStar(require("./internal-amount-helpers"), exports);
|
|
40
41
|
__exportStar(require("./inventory"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const image_url_helpers_1 = require("../helpers/utils/image-url-helpers");
|
|
4
|
+
describe('getImageVariantUrl', () => {
|
|
5
|
+
it('maps a prod bucket original to the prod variants bucket', () => {
|
|
6
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fcommon%2Flogo.png?alt=media&token=abc';
|
|
7
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome-variants/o/images%2Fcommon%2Flogo_128x128.webp?alt=media';
|
|
8
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(expected);
|
|
9
|
+
});
|
|
10
|
+
it('maps a dev bucket original to the dev variants bucket', () => {
|
|
11
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/dev-managesome.appspot.com/o/images%2Fcommon%2Flogo.png?alt=media&token=abc';
|
|
12
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/dev-managesome-variants/o/images%2Fcommon%2Flogo_128x128.webp?alt=media';
|
|
13
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(expected);
|
|
14
|
+
});
|
|
15
|
+
it('handles nested paths with multiple segments', () => {
|
|
16
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fbrands%2Fali-refreshments%2Fitem.jpg?alt=media&token=abc';
|
|
17
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome-variants/o/images%2Fbrands%2Fali-refreshments%2Fitem_256x256.webp?alt=media';
|
|
18
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '256x256')).toBe(expected);
|
|
19
|
+
});
|
|
20
|
+
it('keeps extensionless variants extensionless (warehouse uploads)', () => {
|
|
21
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fbrands%2Fali-refreshments%2Fimage_url?alt=media&token=abc';
|
|
22
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome-variants/o/images%2Fbrands%2Fali-refreshments%2Fimage_url_64x64?alt=media';
|
|
23
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '64x64')).toBe(expected);
|
|
24
|
+
});
|
|
25
|
+
it('supports all four variant sizes', () => {
|
|
26
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fcommon%2Flogo.png?alt=media&token=abc';
|
|
27
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '64x64')).toContain('logo_64x64.webp');
|
|
28
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toContain('logo_128x128.webp');
|
|
29
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '256x256')).toContain('logo_256x256.webp');
|
|
30
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '512x512')).toContain('logo_512x512.webp');
|
|
31
|
+
});
|
|
32
|
+
it('preserves the timestamp query from the original URL', () => {
|
|
33
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fcommon%2Flogo.png?alt=media&token=abc×tamp=1710000000000';
|
|
34
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome-variants/o/images%2Fcommon%2Flogo_128x128.webp?alt=media×tamp=1710000000000';
|
|
35
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(expected);
|
|
36
|
+
});
|
|
37
|
+
it('treats a leading-dot filename as extensionless', () => {
|
|
38
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fcommon%2F.webp?alt=media&token=abc';
|
|
39
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome-variants/o/images%2Fcommon%2F.webp_128x128?alt=media';
|
|
40
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(expected);
|
|
41
|
+
});
|
|
42
|
+
it('returns non-firebasestorage URLs unchanged', () => {
|
|
43
|
+
const input = 'https://example.com/some/image.png';
|
|
44
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(input);
|
|
45
|
+
});
|
|
46
|
+
it('returns malformed URLs unchanged', () => {
|
|
47
|
+
const input = 'not a url';
|
|
48
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(input);
|
|
49
|
+
});
|
|
50
|
+
it('returns URLs with malformed percent-encoding unchanged', () => {
|
|
51
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2Fbad%zz.png?alt=media&token=abc';
|
|
52
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(input);
|
|
53
|
+
});
|
|
54
|
+
it('handles percent-encoded characters in the filename', () => {
|
|
55
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/o/images%2F100%25_off.png?alt=media&token=abc';
|
|
56
|
+
const expected = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome-variants/o/images%2F100%25_off_128x128.webp?alt=media';
|
|
57
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(expected);
|
|
58
|
+
});
|
|
59
|
+
it('returns a firebasestorage URL without the /o/ segment unchanged', () => {
|
|
60
|
+
const input = 'https://firebasestorage.googleapis.com/v0/b/prod-managesome.appspot.com/';
|
|
61
|
+
expect((0, image_url_helpers_1.getImageVariantUrl)(input, '128x128')).toBe(input);
|
|
62
|
+
});
|
|
63
|
+
});
|