@contentful/field-editor-shared 2.16.0 → 2.17.0

package/dist/cjs/utils/entityHelpers.js

@@ -30,6 +30,9 @@ _export(exports, {
     getFieldValue: function() {
         return getFieldValue;
     },
+    getResolvedImageUrl: function() {
+        return getResolvedImageUrl;
+    },
     isAssetField: function() {
         return isAssetField;
     },
@@ -236,3 +239,31 @@ const getEntryImage = async ({ entry, contentType, localeCode }, getAsset)=>{
         return null;
     }
 };
+const getResolvedImageUrl = (url, params)=>{
+    try {
+        const urlToParse = url.startsWith('//') ? `https:${url}` : url;
+        const parsedUrl = new URL(urlToParse);
+        if (parsedUrl.hostname.startsWith('downloads.')) {
+            parsedUrl.hostname = parsedUrl.hostname.replace(/^downloads\./, 'images.');
+        }
+        if (params) {
+            Object.entries(params).forEach(([key, value])=>{
+                if (value !== undefined) {
+                    parsedUrl.searchParams.set(key, value.toString());
+                }
+            });
+        }
+        const result = parsedUrl.toString();
+        return url.startsWith('//') ? result.replace(/^https:/, '') : result;
+    } catch  {
+        if (!params) return url;
+        const searchParams = new URLSearchParams();
+        Object.entries(params).forEach(([key, value])=>{
+            if (value !== undefined) {
+                searchParams.set(key, value.toString());
+            }
+        });
+        const queryString = searchParams.toString();
+        return queryString ? `${url}?${queryString}` : url;
+    }
+};

package/dist/cjs/utils/entityHelpers.test.js

@@ -149,3 +149,139 @@ describe('getEntityStatus', ()=>{
         });
     });
 });
+describe('getResolvedImageUrl', ()=>{
+    describe('URL parsing and domain replacement', ()=>{
+        test('replaces downloads.* with images.*', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+        test('handles protocol-relative URLs', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('//downloads.example.com/space/asset.jpg');
+            expect(result).toBe('//images.example.com/space/asset.jpg');
+        });
+        test('does not modify URLs that do not start with downloads.', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://example.com/image.jpg');
+            expect(result).toBe('https://example.com/image.jpg');
+        });
+        test('does not modify images.* URLs', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://images.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+    });
+    describe('query parameters', ()=>{
+        test('adds width parameter', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg', {
+                w: 100
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?w=100');
+        });
+        test('adds height parameter', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg', {
+                h: 200
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?h=200');
+        });
+        test('adds fit parameter', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg', {
+                fit: 'thumb'
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?fit=thumb');
+        });
+        test('adds multiple parameters', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg', {
+                w: 100,
+                h: 200,
+                fit: 'thumb'
+            });
+            expect(result).toContain('w=100');
+            expect(result).toContain('h=200');
+            expect(result).toContain('fit=thumb');
+            expect(result).toContain('images.example.com');
+        });
+        test('skips undefined parameters', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg', {
+                w: 100,
+                h: undefined,
+                fit: 'thumb'
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?w=100&fit=thumb');
+        });
+        test('returns URL without query string when no params provided', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+        test('returns URL without query string when all params are undefined', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg', {
+                w: undefined,
+                h: undefined,
+                fit: undefined
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+    });
+    describe('relative URL fallback', ()=>{
+        test('returns relative URL unchanged when no params provided', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('/assets/image.jpg');
+            expect(result).toBe('/assets/image.jpg');
+        });
+        test('appends query params to relative URLs', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('/assets/image.jpg', {
+                w: 100,
+                h: 200
+            });
+            expect(result).toBe('/assets/image.jpg?w=100&h=200');
+        });
+        test('handles relative URLs with undefined params', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('/assets/image.jpg', {
+                w: 100,
+                h: undefined
+            });
+            expect(result).toBe('/assets/image.jpg?w=100');
+        });
+        test('returns relative URL unchanged when all params are undefined', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('/assets/image.jpg', {
+                w: undefined,
+                h: undefined
+            });
+            expect(result).toBe('/assets/image.jpg');
+        });
+    });
+    describe('edge cases', ()=>{
+        test('preserves existing query parameters', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg?foo=bar', {
+                w: 100
+            });
+            expect(result).toContain('foo=bar');
+            expect(result).toContain('w=100');
+        });
+        test('handles URLs with fragments', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg#section', {
+                w: 100
+            });
+            expect(result).toContain('images.example.com');
+            expect(result).toContain('w=100');
+            expect(result).toContain('#section');
+        });
+    });
+    describe('pattern-based domain replacement', ()=>{
+        test('replaces any downloads.* domain with images.*', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+        test('handles protocol-relative downloads URLs', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('//downloads.example.com/space/asset.jpg');
+            expect(result).toBe('//images.example.com/space/asset.jpg');
+        });
+        test('adds query params to any downloads.* domain', ()=>{
+            const result = (0, _entityHelpers.getResolvedImageUrl)('https://downloads.another-example.com/space/asset.jpg', {
+                w: 150,
+                h: 150,
+                fit: 'thumb'
+            });
+            expect(result).toContain('images.another-example.com');
+            expect(result).toContain('w=150');
+            expect(result).toContain('h=150');
+            expect(result).toContain('fit=thumb');
+        });
+    });
+});

package/dist/esm/utils/entityHelpers.js

@@ -189,3 +189,31 @@ export const getEntryImage = async ({ entry, contentType, localeCode }, getAsset
         return null;
     }
 };
+export const getResolvedImageUrl = (url, params)=>{
+    try {
+        const urlToParse = url.startsWith('//') ? `https:${url}` : url;
+        const parsedUrl = new URL(urlToParse);
+        if (parsedUrl.hostname.startsWith('downloads.')) {
+            parsedUrl.hostname = parsedUrl.hostname.replace(/^downloads\./, 'images.');
+        }
+        if (params) {
+            Object.entries(params).forEach(([key, value])=>{
+                if (value !== undefined) {
+                    parsedUrl.searchParams.set(key, value.toString());
+                }
+            });
+        }
+        const result = parsedUrl.toString();
+        return url.startsWith('//') ? result.replace(/^https:/, '') : result;
+    } catch  {
+        if (!params) return url;
+        const searchParams = new URLSearchParams();
+        Object.entries(params).forEach(([key, value])=>{
+            if (value !== undefined) {
+                searchParams.set(key, value.toString());
+            }
+        });
+        const queryString = searchParams.toString();
+        return queryString ? `${url}?${queryString}` : url;
+    }
+};

package/dist/esm/utils/entityHelpers.test.js

@@ -1,4 +1,4 @@
-import { getEntityStatus } from './entityHelpers';
+import { getEntityStatus, getResolvedImageUrl } from './entityHelpers';
 describe('getEntityStatus', ()=>{
     function createEntity(props) {
         return props;
@@ -145,3 +145,139 @@ describe('getEntityStatus', ()=>{
         });
     });
 });
+describe('getResolvedImageUrl', ()=>{
+    describe('URL parsing and domain replacement', ()=>{
+        test('replaces downloads.* with images.*', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+        test('handles protocol-relative URLs', ()=>{
+            const result = getResolvedImageUrl('//downloads.example.com/space/asset.jpg');
+            expect(result).toBe('//images.example.com/space/asset.jpg');
+        });
+        test('does not modify URLs that do not start with downloads.', ()=>{
+            const result = getResolvedImageUrl('https://example.com/image.jpg');
+            expect(result).toBe('https://example.com/image.jpg');
+        });
+        test('does not modify images.* URLs', ()=>{
+            const result = getResolvedImageUrl('https://images.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+    });
+    describe('query parameters', ()=>{
+        test('adds width parameter', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg', {
+                w: 100
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?w=100');
+        });
+        test('adds height parameter', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg', {
+                h: 200
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?h=200');
+        });
+        test('adds fit parameter', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg', {
+                fit: 'thumb'
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?fit=thumb');
+        });
+        test('adds multiple parameters', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg', {
+                w: 100,
+                h: 200,
+                fit: 'thumb'
+            });
+            expect(result).toContain('w=100');
+            expect(result).toContain('h=200');
+            expect(result).toContain('fit=thumb');
+            expect(result).toContain('images.example.com');
+        });
+        test('skips undefined parameters', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg', {
+                w: 100,
+                h: undefined,
+                fit: 'thumb'
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg?w=100&fit=thumb');
+        });
+        test('returns URL without query string when no params provided', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+        test('returns URL without query string when all params are undefined', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg', {
+                w: undefined,
+                h: undefined,
+                fit: undefined
+            });
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+    });
+    describe('relative URL fallback', ()=>{
+        test('returns relative URL unchanged when no params provided', ()=>{
+            const result = getResolvedImageUrl('/assets/image.jpg');
+            expect(result).toBe('/assets/image.jpg');
+        });
+        test('appends query params to relative URLs', ()=>{
+            const result = getResolvedImageUrl('/assets/image.jpg', {
+                w: 100,
+                h: 200
+            });
+            expect(result).toBe('/assets/image.jpg?w=100&h=200');
+        });
+        test('handles relative URLs with undefined params', ()=>{
+            const result = getResolvedImageUrl('/assets/image.jpg', {
+                w: 100,
+                h: undefined
+            });
+            expect(result).toBe('/assets/image.jpg?w=100');
+        });
+        test('returns relative URL unchanged when all params are undefined', ()=>{
+            const result = getResolvedImageUrl('/assets/image.jpg', {
+                w: undefined,
+                h: undefined
+            });
+            expect(result).toBe('/assets/image.jpg');
+        });
+    });
+    describe('edge cases', ()=>{
+        test('preserves existing query parameters', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg?foo=bar', {
+                w: 100
+            });
+            expect(result).toContain('foo=bar');
+            expect(result).toContain('w=100');
+        });
+        test('handles URLs with fragments', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg#section', {
+                w: 100
+            });
+            expect(result).toContain('images.example.com');
+            expect(result).toContain('w=100');
+            expect(result).toContain('#section');
+        });
+    });
+    describe('pattern-based domain replacement', ()=>{
+        test('replaces any downloads.* domain with images.*', ()=>{
+            const result = getResolvedImageUrl('https://downloads.example.com/space/asset.jpg');
+            expect(result).toBe('https://images.example.com/space/asset.jpg');
+        });
+        test('handles protocol-relative downloads URLs', ()=>{
+            const result = getResolvedImageUrl('//downloads.example.com/space/asset.jpg');
+            expect(result).toBe('//images.example.com/space/asset.jpg');
+        });
+        test('adds query params to any downloads.* domain', ()=>{
+            const result = getResolvedImageUrl('https://downloads.another-example.com/space/asset.jpg', {
+                w: 150,
+                h: 150,
+                fit: 'thumb'
+            });
+            expect(result).toContain('images.another-example.com');
+            expect(result).toContain('w=150');
+            expect(result).toContain('h=150');
+            expect(result).toContain('fit=thumb');
+        });
+    });
+});

package/dist/types/utils/entityHelpers.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="jest" />
 import { Asset, ContentType, ContentTypeField, Entry, File } from '../typesEntity';
 export declare function getFieldValue({ 
 /**
@@ -80,4 +81,9 @@ export declare const getEntryImage: ({ entry, contentType, localeCode, }: {
     localeCode: string;
     defaultLocaleCode: string;
 }, getAsset: (assetId: string) => Promise<unknown>) => Promise<null | File>;
+export declare const getResolvedImageUrl: (url: string, params?: {
+    w?: number;
+    h?: number;
+    fit?: string;
+}) => string;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "2.16.0",
+  "version": "2.17.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -60,5 +60,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "e685baec786ae9c9a6e0660bdb17005304646593"
+  "gitHead": "c85b1e8cd6772eb796ed2b22ebb778c717f4a7f4"
 }