@contentful/field-editor-shared 4.0.0 → 4.0.1-canary.15

package/dist/cjs/hooks/useReleaseStatus.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "useReleaseStatus", {
     }
 });
 const _react = require("react");
+const _determineReleaseAction = require("../utils/determineReleaseAction");
 const _entityHelpers = require("../utils/entityHelpers");
 const _getReleaseStatusBadgeConfig = require("../utils/getReleaseStatusBadgeConfig");
 const _sanitizeLocales = require("../utils/sanitizeLocales");
@@ -34,8 +35,8 @@ function getReleaseItemLocaleStatus(releaseItem, locale, previousEntityOnTimelin
             ].includes(status) ? 'becomesDraft' : 'remainsDraft';
         }
     }
-    const addedLocales = releaseItem.add?.fields['*'] || [];
-    const removedLocales = releaseItem.remove?.fields['*'] || [];
+    const addedLocales = (0, _determineReleaseAction.normalizeReleaseLocaleFields)(releaseItem.add);
+    const removedLocales = (0, _determineReleaseAction.normalizeReleaseLocaleFields)(releaseItem.remove);
     if (addedLocales.includes(locale.code)) {
         return 'willPublish';
     }

package/dist/cjs/hooks/useReleaseStatus.spec.js

@@ -30,6 +30,8 @@ const createEntityBuilder = (entityType, defaultId)=>{
 };
 const entryBuilder = ()=>createEntityBuilder('Entry', 'entry-1');
 const assetBuilder = ()=>createEntityBuilder('Asset', 'asset-1');
+const fragmentBuilder = ()=>createEntityBuilder('Fragment', 'fragment-1');
+const experienceBuilder = ()=>createEntityBuilder('Experience', 'experience-1');
 const createEntryBasedReleaseEntity = ({ entityId, action = 'publish', entityType })=>({
         entity: {
             sys: {
@@ -103,8 +105,34 @@ const expectEntityStatus = (result, expectedStatus)=>{
 };
 const ENTITY_TYPES = [
     'Entry',
-    'Asset'
+    'Asset',
+    'Fragment',
+    'Experience'
 ];
+const ENTITY_ID_BY_TYPE = {
+    Entry: {
+        default: 'entry-1',
+        different: 'entry-2'
+    },
+    Asset: {
+        default: 'asset-1',
+        different: 'asset-2'
+    },
+    Fragment: {
+        default: 'fragment-1',
+        different: 'fragment-2'
+    },
+    Experience: {
+        default: 'experience-1',
+        different: 'experience-2'
+    }
+};
+const BUILDER_BY_TYPE = {
+    Entry: entryBuilder,
+    Asset: assetBuilder,
+    Fragment: fragmentBuilder,
+    Experience: experienceBuilder
+};
 describe('useReleaseStatus', ()=>{
     const locales = createDefaultLocales();
     describe('Guard clauses and invalid inputs', ()=>{
@@ -389,16 +417,86 @@ describe('useReleaseStatus', ()=>{
             });
         });
     });
+    describe('Flat array payload shape', ()=>{
+        const buildFlatShapeRelease = (verb, localeCodes)=>({
+                title: 'Release 1',
+                sys: {
+                    id: 'release-1',
+                    type: 'Release',
+                    schemaVersion: 'Release.v2'
+                },
+                entities: {
+                    items: [
+                        {
+                            entity: {
+                                sys: {
+                                    type: 'Link',
+                                    linkType: 'Entry',
+                                    id: 'entry-1'
+                                }
+                            },
+                            [verb]: localeCodes
+                        }
+                    ]
+                }
+            });
+        it('treats flat-array add as willPublish', ()=>{
+            const { result } = (0, _react.renderHook)(()=>(0, _useReleaseStatus.useReleaseStatus)({
+                    locales,
+                    release: buildFlatShapeRelease('add', [
+                        'en-US'
+                    ]),
+                    entity: entryBuilder().withStatus('draft')
+                }));
+            expectLocaleStatus(result.current, 'en-US', {
+                variant: 'positive',
+                status: 'willPublish',
+                label: 'Will publish',
+                locale: {
+                    code: 'en-US'
+                }
+            });
+        });
+        it('treats flat-array remove as becomesDraft', ()=>{
+            const { result } = (0, _react.renderHook)(()=>(0, _useReleaseStatus.useReleaseStatus)({
+                    locales,
+                    previousEntityOnTimeline: entryBuilder().withStatus('published'),
+                    release: buildFlatShapeRelease('remove', [
+                        'en-US'
+                    ]),
+                    entity: entryBuilder().withStatus('draft')
+                }));
+            expectLocaleStatus(result.current, 'en-US', {
+                variant: 'warning',
+                status: 'becomesDraft',
+                label: 'Becomes draft',
+                locale: {
+                    code: 'en-US'
+                }
+            });
+        });
+        it('treats empty flat-array remove as remainsDraft', ()=>{
+            const { result } = (0, _react.renderHook)(()=>(0, _useReleaseStatus.useReleaseStatus)({
+                    locales,
+                    release: buildFlatShapeRelease('remove', []),
+                    entity: entryBuilder().withStatus('draft')
+                }));
+            expectLocaleStatus(result.current, 'en-US', {
+                variant: 'warning',
+                status: 'remainsDraft',
+                label: 'Remains draft',
+                locale: {
+                    code: 'en-US'
+                }
+            });
+        });
+    });
     const testPublishingScenarios = (config)=>{
         const { isReference, publishingModel } = config;
         const locales = createDefaultLocales();
         ENTITY_TYPES.forEach((entityType)=>{
-            const defaultEntityId = entityType === 'Entry' ? 'entry-1' : 'asset-1';
-            const differentEntityId = entityType === 'Entry' ? 'entry-2' : 'asset-2';
-            const buildEntity = (status)=>{
-                const builder = entityType === 'Entry' ? entryBuilder() : assetBuilder();
-                return builder.withStatus(status);
-            };
+            const { default: defaultEntityId, different: differentEntityId } = ENTITY_ID_BY_TYPE[entityType];
+            const buildEntity = (status)=>BUILDER_BY_TYPE[entityType]().withStatus(status);
             const createRelease = (options)=>{
                 return publishingModel === 'entry-based' ? createEntryBasedRelease({
                     entityId: options.entityId,

package/dist/cjs/utils/determineReleaseAction.js

@@ -2,21 +2,36 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "determineReleaseAction", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    determineReleaseAction: function() {
         return determineReleaseAction;
+    },
+    normalizeReleaseLocaleFields: function() {
+        return normalizeReleaseLocaleFields;
     }
 });
+function normalizeReleaseLocaleFields(value) {
+    if (!value) {
+        return [];
+    }
+    if (Array.isArray(value)) {
+        return value;
+    }
+    return value.fields?.['*'] ?? [];
+}
 function isEntryBasedAction(entityItem) {
     return 'action' in entityItem && (entityItem.action === 'publish' || entityItem.action === 'unpublish');
 }
 function getLocalesFromEntity(entityItem) {
-    const addLocales = entityItem?.add?.fields?.['*'] ?? [];
-    const removeLocales = entityItem?.remove?.fields?.['*'] ?? [];
     return {
-        addLocales,
-        removeLocales
+        addLocales: normalizeReleaseLocaleFields(entityItem?.add),
+        removeLocales: normalizeReleaseLocaleFields(entityItem?.remove)
     };
 }
 function getLocaleBasedAction(addLocales, removeLocales) {

package/dist/esm/hooks/useReleaseStatus.js

@@ -1,4 +1,5 @@
 import { useMemo } from 'react';
+import { normalizeReleaseLocaleFields } from '../utils/determineReleaseAction';
 import { getEntityStatus } from '../utils/entityHelpers';
 import { getReleaseStatusBadgeConfig } from '../utils/getReleaseStatusBadgeConfig';
 import { sanitizeLocales } from '../utils/sanitizeLocales';
@@ -24,8 +25,8 @@ function getReleaseItemLocaleStatus(releaseItem, locale, previousEntityOnTimelin
             ].includes(status) ? 'becomesDraft' : 'remainsDraft';
         }
     }
-    const addedLocales = releaseItem.add?.fields['*'] || [];
-    const removedLocales = releaseItem.remove?.fields['*'] || [];
+    const addedLocales = normalizeReleaseLocaleFields(releaseItem.add);
+    const removedLocales = normalizeReleaseLocaleFields(releaseItem.remove);
     if (addedLocales.includes(locale.code)) {
         return 'willPublish';
     }

package/dist/esm/hooks/useReleaseStatus.spec.js

@@ -26,6 +26,8 @@ const createEntityBuilder = (entityType, defaultId)=>{
 };
 const entryBuilder = ()=>createEntityBuilder('Entry', 'entry-1');
 const assetBuilder = ()=>createEntityBuilder('Asset', 'asset-1');
+const fragmentBuilder = ()=>createEntityBuilder('Fragment', 'fragment-1');
+const experienceBuilder = ()=>createEntityBuilder('Experience', 'experience-1');
 const createEntryBasedReleaseEntity = ({ entityId, action = 'publish', entityType })=>({
         entity: {
             sys: {
@@ -99,8 +101,34 @@ const expectEntityStatus = (result, expectedStatus)=>{
 };
 const ENTITY_TYPES = [
     'Entry',
-    'Asset'
+    'Asset',
+    'Fragment',
+    'Experience'
 ];
+const ENTITY_ID_BY_TYPE = {
+    Entry: {
+        default: 'entry-1',
+        different: 'entry-2'
+    },
+    Asset: {
+        default: 'asset-1',
+        different: 'asset-2'
+    },
+    Fragment: {
+        default: 'fragment-1',
+        different: 'fragment-2'
+    },
+    Experience: {
+        default: 'experience-1',
+        different: 'experience-2'
+    }
+};
+const BUILDER_BY_TYPE = {
+    Entry: entryBuilder,
+    Asset: assetBuilder,
+    Fragment: fragmentBuilder,
+    Experience: experienceBuilder
+};
 describe('useReleaseStatus', ()=>{
     const locales = createDefaultLocales();
     describe('Guard clauses and invalid inputs', ()=>{
@@ -385,16 +413,86 @@ describe('useReleaseStatus', ()=>{
             });
         });
     });
+    describe('Flat array payload shape', ()=>{
+        const buildFlatShapeRelease = (verb, localeCodes)=>({
+                title: 'Release 1',
+                sys: {
+                    id: 'release-1',
+                    type: 'Release',
+                    schemaVersion: 'Release.v2'
+                },
+                entities: {
+                    items: [
+                        {
+                            entity: {
+                                sys: {
+                                    type: 'Link',
+                                    linkType: 'Entry',
+                                    id: 'entry-1'
+                                }
+                            },
+                            [verb]: localeCodes
+                        }
+                    ]
+                }
+            });
+        it('treats flat-array add as willPublish', ()=>{
+            const { result } = renderHook(()=>useReleaseStatus({
+                    locales,
+                    release: buildFlatShapeRelease('add', [
+                        'en-US'
+                    ]),
+                    entity: entryBuilder().withStatus('draft')
+                }));
+            expectLocaleStatus(result.current, 'en-US', {
+                variant: 'positive',
+                status: 'willPublish',
+                label: 'Will publish',
+                locale: {
+                    code: 'en-US'
+                }
+            });
+        });
+        it('treats flat-array remove as becomesDraft', ()=>{
+            const { result } = renderHook(()=>useReleaseStatus({
+                    locales,
+                    previousEntityOnTimeline: entryBuilder().withStatus('published'),
+                    release: buildFlatShapeRelease('remove', [
+                        'en-US'
+                    ]),
+                    entity: entryBuilder().withStatus('draft')
+                }));
+            expectLocaleStatus(result.current, 'en-US', {
+                variant: 'warning',
+                status: 'becomesDraft',
+                label: 'Becomes draft',
+                locale: {
+                    code: 'en-US'
+                }
+            });
+        });
+        it('treats empty flat-array remove as remainsDraft', ()=>{
+            const { result } = renderHook(()=>useReleaseStatus({
+                    locales,
+                    release: buildFlatShapeRelease('remove', []),
+                    entity: entryBuilder().withStatus('draft')
+                }));
+            expectLocaleStatus(result.current, 'en-US', {
+                variant: 'warning',
+                status: 'remainsDraft',
+                label: 'Remains draft',
+                locale: {
+                    code: 'en-US'
+                }
+            });
+        });
+    });
     const testPublishingScenarios = (config)=>{
         const { isReference, publishingModel } = config;
         const locales = createDefaultLocales();
         ENTITY_TYPES.forEach((entityType)=>{
-            const defaultEntityId = entityType === 'Entry' ? 'entry-1' : 'asset-1';
-            const differentEntityId = entityType === 'Entry' ? 'entry-2' : 'asset-2';
-            const buildEntity = (status)=>{
-                const builder = entityType === 'Entry' ? entryBuilder() : assetBuilder();
-                return builder.withStatus(status);
-            };
+            const { default: defaultEntityId, different: differentEntityId } = ENTITY_ID_BY_TYPE[entityType];
+            const buildEntity = (status)=>BUILDER_BY_TYPE[entityType]().withStatus(status);
             const createRelease = (options)=>{
                 return publishingModel === 'entry-based' ? createEntryBasedRelease({
                     entityId: options.entityId,

package/dist/esm/utils/determineReleaseAction.js

@@ -1,12 +1,19 @@
+export function normalizeReleaseLocaleFields(value) {
+    if (!value) {
+        return [];
+    }
+    if (Array.isArray(value)) {
+        return value;
+    }
+    return value.fields?.['*'] ?? [];
+}
 function isEntryBasedAction(entityItem) {
     return 'action' in entityItem && (entityItem.action === 'publish' || entityItem.action === 'unpublish');
 }
 function getLocalesFromEntity(entityItem) {
-    const addLocales = entityItem?.add?.fields?.['*'] ?? [];
-    const removeLocales = entityItem?.remove?.fields?.['*'] ?? [];
     return {
-        addLocales,
-        removeLocales
+        addLocales: normalizeReleaseLocaleFields(entityItem?.add),
+        removeLocales: normalizeReleaseLocaleFields(entityItem?.remove)
     };
 }
 function getLocaleBasedAction(addLocales, removeLocales) {

package/dist/types/types.d.ts

@@ -12,34 +12,32 @@ export type ValidationType = {
     min: number;
     max: number;
 };
+export type ReleaseV2EntityLinkType = 'Entry' | 'Asset' | 'Fragment' | 'Experience';
 export type ReleaseV2Entity = {
     entity: {
         sys: {
             type: 'Link';
-            linkType: 'Entry' | 'Asset';
+            linkType: ReleaseV2EntityLinkType;
             id: string;
         };
     };
     action: 'publish' | 'unpublish';
 };
+export type ReleaseV2LocaleFields = string[] | {
+    fields: {
+        '*': string[];
+    };
+};
 export type ReleaseV2EntityWithLocales = {
     entity: {
         sys: {
             type: 'Link';
-            linkType: 'Entry' | 'Asset';
+            linkType: ReleaseV2EntityLinkType;
             id: string;
         };
     };
-    add: {
-        fields: {
-            '*': string[];
-        };
-    };
-    remove: {
-        fields: {
-            '*': string[];
-        };
-    };
+    add: ReleaseV2LocaleFields;
+    remove: ReleaseV2LocaleFields;
 };
 export type ReleaseV2AnnotationType = 'Hidden' | 'Ideation';
 export type ReleaseV2Annotations = {

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

@@ -1,4 +1,5 @@
-import type { ReleaseAction, ReleaseV2Entity, ReleaseV2EntityWithLocales, ReleaseV2Props } from '../types';
+import type { ReleaseAction, ReleaseV2Entity, ReleaseV2EntityWithLocales, ReleaseV2LocaleFields, ReleaseV2Props } from '../types';
+export declare function normalizeReleaseLocaleFields(value?: ReleaseV2LocaleFields): string[];
 type DetermineActionResult = {
     releaseAction: ReleaseAction;
     entityItem?: ReleaseV2Entity | ReleaseV2EntityWithLocales;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "4.0.0",
+  "version": "4.0.1-canary.15+17e1a003",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -73,5 +73,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "267c2c3194103479b3fa0ba2c61001ef993f4cfd"
+  "gitHead": "17e1a003b6e3cccd22251c65b3c496b6ff1111a0"
 }