@contentful/field-editor-shared 2.12.3 → 2.13.1

package/dist/types/hooks/useReleaseStatus.d.ts

@@ -0,0 +1,14 @@
+import type { LocalesAPI } from '@contentful/app-sdk';
+import type { AssetProps, EntryProps, LocaleProps, ReleaseProps } from 'contentful-management/types';
+import type { ReleaseAction, ReleaseV2Props, ReleaseStatusMap } from '../types';
+type UseActiveReleaseLocalesStatuses = {
+    entity?: EntryProps | AssetProps;
+    locales: LocaleProps[] | LocalesAPI;
+    release?: ReleaseProps | ReleaseV2Props;
+    previousEntityOnTimeline?: EntryProps | AssetProps;
+};
+export declare function useReleaseStatus({ entity, release, locales, previousEntityOnTimeline, }: UseActiveReleaseLocalesStatuses): {
+    releaseStatusMap: ReleaseStatusMap;
+    releaseAction: ReleaseAction | undefined;
+};
+export {};

package/dist/types/index.d.ts

@@ -15,10 +15,9 @@ export { shortenStorageUnit, toLocaleString } from './utils/shortenStorageUnit';
 export type { FieldConnectorChildProps } from './FieldConnector';
 export * from './types';
 export * from './hooks/useActiveLocales';
-export * from './hooks/useActiveReleaseLocalesStatuses';
+export * from './hooks/useReleaseStatus';
 export * from './hooks/useLocalePublishStatus';
 export * from './LocalePublishingEntityStatusBadge';
 export * from './ReleaseEntityStatusBadge';
 export * from './utils/determineReleaseAction';
 export * from './utils/getEntityReleaseStatus';
-export * from './utils/parseReleaseParameters';

package/dist/types/types.d.ts

@@ -59,11 +59,11 @@ export type ReleaseV2Props = Omit<ReleaseProps, 'entities' | 'sys'> & {
     metadata?: ReleaseMetadataV2;
 };
 export type ReleaseAction = 'publish' | 'unpublish' | 'not-in-release';
-export type ReleaseEntityStatus = 'willPublish' | 'becomesDraft' | 'remainsDraft' | 'notInRelease';
+export type ReleaseEntityStatus = 'willPublish' | 'becomesDraft' | 'remainsDraft' | 'notInRelease' | 'published';
 export type ReleaseLocalesStatus = {
     status: ReleaseEntityStatus;
     variant: BadgeVariant;
     label: string;
-    locale: LocaleProps;
+    locale: Pick<LocaleProps, 'code' | 'default' | 'name'>;
 };
-export type ReleaseLocalesStatusMap = Map<string, ReleaseLocalesStatus>;
+export type ReleaseStatusMap = Map<string, ReleaseLocalesStatus>;

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

@@ -0,0 +1,4 @@
+import type { LocalesAPI } from '@contentful/app-sdk';
+import type { LocaleProps } from 'contentful-management';
+export type SanitizedLocale = Pick<LocaleProps, 'code' | 'default' | 'name'>;
+export declare function sanitizeLocales(locales: Pick<LocalesAPI, 'available' | 'default' | 'names'> | LocaleProps[]): SanitizedLocale[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "2.12.3",
+  "version": "2.13.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -36,7 +36,7 @@
     "tsc": "tsc -p ./ --noEmit"
   },
   "devDependencies": {
-    "@contentful/app-sdk": "^4.29.0",
+    "@contentful/app-sdk": "^4.42.0",
     "@contentful/field-editor-test-utils": "^1.6.2",
     "@lingui/core": "5.3.0",
     "@testing-library/react": "16.3.0"
@@ -58,5 +58,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "72fc78dc2c8b5431b6740852965a1ce3ccb4c997"
+  "gitHead": "5a7e41aa7b9bbd285221f164daa777fb48cbdb01"
 }

package/dist/cjs/hooks/useActiveReleaseLocalesStatuses.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "useActiveReleaseLocalesStatuses", {
-    enumerable: true,
-    get: function() {
-        return useActiveReleaseLocalesStatuses;
-    }
-});
-const _react = require("react");
-const _getPreviousReleaseEntity = require("../utils/getPreviousReleaseEntity");
-const useActiveReleaseLocalesStatuses = ({ currentEntityDraft, entityId, entityType, releaseVersionMap, locales, activeRelease, releases })=>{
-    const previousReleaseEntity = (0, _react.useMemo)(()=>(0, _getPreviousReleaseEntity.getPreviousReleaseEntity)({
-            entityId,
-            entityType,
-            releaseVersionMap,
-            activeRelease,
-            releases
-        }).previousReleaseEntity, [
-        entityId,
-        entityType,
-        releaseVersionMap,
-        activeRelease,
-        releases
-    ]);
-    const activeReleaseReleaseEntity = (0, _react.useMemo)(()=>activeRelease?.entities.items.find((entity)=>entity.entity.sys.id === entityId && entity.entity.sys.linkType === entityType), [
-        activeRelease?.entities.items,
-        entityId,
-        entityType
-    ]);
-    const getLocaleStatus = (0, _react.useCallback)((localeCode)=>{
-        if (!activeReleaseReleaseEntity) {
-            return 'Not in release';
-        }
-        return activeReleaseReleaseEntity?.action === 'publish' || activeReleaseReleaseEntity?.add?.fields['*'].includes(localeCode) ? 'published' : 'draft';
-    }, [
-        activeReleaseReleaseEntity
-    ]);
-    const releaseLocalesStatusMap = (0, _react.useMemo)(()=>{
-        return locales.reduce((acc, locale)=>{
-            acc.set(locale.code, {
-                variant: 'secondary',
-                status: 'remainsDraft',
-                label: 'Remains draft',
-                locale
-            });
-            if (!activeReleaseReleaseEntity) {
-                acc.set(locale.code, {
-                    variant: 'secondary',
-                    status: 'notInRelease',
-                    label: 'Not in release',
-                    locale
-                });
-                return acc;
-            }
-            if (getLocaleStatus(locale.code) === 'draft') {
-                if (currentEntityDraft?.sys.fieldStatus) {
-                    const previousStatus = currentEntityDraft.sys.fieldStatus['*'][locale.code];
-                    if (previousStatus === 'published' || previousStatus === 'changed') {
-                        acc.set(locale.code, {
-                            status: 'becomesDraft',
-                            variant: 'warning',
-                            label: 'Becomes draft',
-                            locale
-                        });
-                    } else {
-                        acc.set(locale.code, {
-                            status: 'remainsDraft',
-                            variant: 'secondary',
-                            label: 'Remains draft',
-                            locale
-                        });
-                    }
-                } else if (previousReleaseEntity) {
-                    if (previousReleaseEntity.action === 'publish' || previousReleaseEntity.add.fields['*'].includes(locale.code)) {
-                        acc.set(locale.code, {
-                            status: 'becomesDraft',
-                            variant: 'warning',
-                            label: 'Becomes draft',
-                            locale
-                        });
-                    } else {
-                        acc.set(locale.code, {
-                            status: 'remainsDraft',
-                            variant: 'secondary',
-                            label: 'Remains draft',
-                            locale
-                        });
-                    }
-                }
-            } else if (getLocaleStatus(locale.code) === 'published') {
-                acc.set(locale.code, {
-                    variant: 'positive',
-                    status: 'willPublish',
-                    label: 'Will publish',
-                    locale
-                });
-            }
-            return acc;
-        }, new Map());
-    }, [
-        locales,
-        activeReleaseReleaseEntity,
-        getLocaleStatus,
-        currentEntityDraft?.sys.fieldStatus,
-        previousReleaseEntity
-    ]);
-    return {
-        releaseLocalesStatusMap
-    };
-};

package/dist/cjs/utils/getPreviousReleaseEntity.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "getPreviousReleaseEntity", {
-    enumerable: true,
-    get: function() {
-        return getPreviousReleaseEntity;
-    }
-});
-const _datefns = require("date-fns");
-function getPreviousReleaseEntity({ entityId, entityType, releaseVersionMap, activeRelease, releases }) {
-    const orderedScheduledReleases = releases?.items.filter((r)=>r.startDate).sort((a, b)=>(0, _datefns.compareAsc)(new Date(a.startDate), new Date(b.startDate)));
-    const indexOfActive = orderedScheduledReleases?.findIndex((r)=>r.sys.id === activeRelease?.sys.id);
-    let previousRelease;
-    let previousReleaseEntity;
-    if (indexOfActive && indexOfActive > 0) {
-        for(let i = indexOfActive - 1; i >= 0; i--){
-            const release = orderedScheduledReleases[i];
-            const action = releaseVersionMap.get(entityId)?.get(release.sys.id);
-            if (action !== 'not-in-release') {
-                previousRelease = release;
-                previousReleaseEntity = release.entities.items.find((e)=>e.entity.sys.id === entityId && e.entity.sys.linkType === entityType);
-                break;
-            }
-        }
-    }
-    return {
-        previousRelease,
-        previousReleaseEntity
-    };
-}

package/dist/cjs/utils/parseReleaseParameters.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "parseReleaseParams", {
-    enumerable: true,
-    get: function() {
-        return parseReleaseParams;
-    }
-});
-function parseReleaseParams(raw) {
-    let parsedRaw;
-    if (!raw) {
-        return {
-            releaseVersionMap: new Map(),
-            locales: [],
-            activeRelease: undefined,
-            isActiveReleaseLoading: false,
-            releases: undefined
-        };
-    }
-    try {
-        parsedRaw = JSON.parse(raw);
-    } catch (e) {
-        throw new Error('Failed to parse release parameters: invalid JSON');
-    }
-    const releaseVersionMap = new Map();
-    for (const [entryId, innerObj] of Object.entries(parsedRaw.releaseVersionMap)){
-        const innerMap = new Map();
-        for (const [localeKey, actionData] of Object.entries(innerObj)){
-            innerMap.set(localeKey, actionData);
-        }
-        releaseVersionMap.set(entryId, innerMap);
-    }
-    return {
-        releaseVersionMap,
-        locales: parsedRaw.locales,
-        activeRelease: parsedRaw.activeRelease,
-        isActiveReleaseLoading: parsedRaw.isActiveReleaseLoading,
-        releases: parsedRaw.releases
-    };
-}

package/dist/esm/hooks/useActiveReleaseLocalesStatuses.js

@@ -1,102 +0,0 @@
-import { useCallback, useMemo } from 'react';
-import { getPreviousReleaseEntity } from '../utils/getPreviousReleaseEntity';
-export const useActiveReleaseLocalesStatuses = ({ currentEntityDraft, entityId, entityType, releaseVersionMap, locales, activeRelease, releases })=>{
-    const previousReleaseEntity = useMemo(()=>getPreviousReleaseEntity({
-            entityId,
-            entityType,
-            releaseVersionMap,
-            activeRelease,
-            releases
-        }).previousReleaseEntity, [
-        entityId,
-        entityType,
-        releaseVersionMap,
-        activeRelease,
-        releases
-    ]);
-    const activeReleaseReleaseEntity = useMemo(()=>activeRelease?.entities.items.find((entity)=>entity.entity.sys.id === entityId && entity.entity.sys.linkType === entityType), [
-        activeRelease?.entities.items,
-        entityId,
-        entityType
-    ]);
-    const getLocaleStatus = useCallback((localeCode)=>{
-        if (!activeReleaseReleaseEntity) {
-            return 'Not in release';
-        }
-        return activeReleaseReleaseEntity?.action === 'publish' || activeReleaseReleaseEntity?.add?.fields['*'].includes(localeCode) ? 'published' : 'draft';
-    }, [
-        activeReleaseReleaseEntity
-    ]);
-    const releaseLocalesStatusMap = useMemo(()=>{
-        return locales.reduce((acc, locale)=>{
-            acc.set(locale.code, {
-                variant: 'secondary',
-                status: 'remainsDraft',
-                label: 'Remains draft',
-                locale
-            });
-            if (!activeReleaseReleaseEntity) {
-                acc.set(locale.code, {
-                    variant: 'secondary',
-                    status: 'notInRelease',
-                    label: 'Not in release',
-                    locale
-                });
-                return acc;
-            }
-            if (getLocaleStatus(locale.code) === 'draft') {
-                if (currentEntityDraft?.sys.fieldStatus) {
-                    const previousStatus = currentEntityDraft.sys.fieldStatus['*'][locale.code];
-                    if (previousStatus === 'published' || previousStatus === 'changed') {
-                        acc.set(locale.code, {
-                            status: 'becomesDraft',
-                            variant: 'warning',
-                            label: 'Becomes draft',
-                            locale
-                        });
-                    } else {
-                        acc.set(locale.code, {
-                            status: 'remainsDraft',
-                            variant: 'secondary',
-                            label: 'Remains draft',
-                            locale
-                        });
-                    }
-                } else if (previousReleaseEntity) {
-                    if (previousReleaseEntity.action === 'publish' || previousReleaseEntity.add.fields['*'].includes(locale.code)) {
-                        acc.set(locale.code, {
-                            status: 'becomesDraft',
-                            variant: 'warning',
-                            label: 'Becomes draft',
-                            locale
-                        });
-                    } else {
-                        acc.set(locale.code, {
-                            status: 'remainsDraft',
-                            variant: 'secondary',
-                            label: 'Remains draft',
-                            locale
-                        });
-                    }
-                }
-            } else if (getLocaleStatus(locale.code) === 'published') {
-                acc.set(locale.code, {
-                    variant: 'positive',
-                    status: 'willPublish',
-                    label: 'Will publish',
-                    locale
-                });
-            }
-            return acc;
-        }, new Map());
-    }, [
-        locales,
-        activeReleaseReleaseEntity,
-        getLocaleStatus,
-        currentEntityDraft?.sys.fieldStatus,
-        previousReleaseEntity
-    ]);
-    return {
-        releaseLocalesStatusMap
-    };
-};

package/dist/esm/utils/getPreviousReleaseEntity.js

@@ -1,22 +0,0 @@
-import { compareAsc } from 'date-fns';
-export function getPreviousReleaseEntity({ entityId, entityType, releaseVersionMap, activeRelease, releases }) {
-    const orderedScheduledReleases = releases?.items.filter((r)=>r.startDate).sort((a, b)=>compareAsc(new Date(a.startDate), new Date(b.startDate)));
-    const indexOfActive = orderedScheduledReleases?.findIndex((r)=>r.sys.id === activeRelease?.sys.id);
-    let previousRelease;
-    let previousReleaseEntity;
-    if (indexOfActive && indexOfActive > 0) {
-        for(let i = indexOfActive - 1; i >= 0; i--){
-            const release = orderedScheduledReleases[i];
-            const action = releaseVersionMap.get(entityId)?.get(release.sys.id);
-            if (action !== 'not-in-release') {
-                previousRelease = release;
-                previousReleaseEntity = release.entities.items.find((e)=>e.entity.sys.id === entityId && e.entity.sys.linkType === entityType);
-                break;
-            }
-        }
-    }
-    return {
-        previousRelease,
-        previousReleaseEntity
-    };
-}

package/dist/esm/utils/parseReleaseParameters.js

@@ -1,32 +0,0 @@
-export function parseReleaseParams(raw) {
-    let parsedRaw;
-    if (!raw) {
-        return {
-            releaseVersionMap: new Map(),
-            locales: [],
-            activeRelease: undefined,
-            isActiveReleaseLoading: false,
-            releases: undefined
-        };
-    }
-    try {
-        parsedRaw = JSON.parse(raw);
-    } catch (e) {
-        throw new Error('Failed to parse release parameters: invalid JSON');
-    }
-    const releaseVersionMap = new Map();
-    for (const [entryId, innerObj] of Object.entries(parsedRaw.releaseVersionMap)){
-        const innerMap = new Map();
-        for (const [localeKey, actionData] of Object.entries(innerObj)){
-            innerMap.set(localeKey, actionData);
-        }
-        releaseVersionMap.set(entryId, innerMap);
-    }
-    return {
-        releaseVersionMap,
-        locales: parsedRaw.locales,
-        activeRelease: parsedRaw.activeRelease,
-        isActiveReleaseLoading: parsedRaw.isActiveReleaseLoading,
-        releases: parsedRaw.releases
-    };
-}

package/dist/types/hooks/useActiveReleaseLocalesStatuses.d.ts

@@ -1,14 +0,0 @@
-import type { ReleaseAction, ReleaseLocalesStatusMap } from '@contentful/field-editor-shared';
-import type { AssetProps, CollectionProp, EntryProps, LocaleProps } from 'contentful-management/types';
-import type { ReleaseV2Props } from '../types';
-export declare const useActiveReleaseLocalesStatuses: ({ currentEntityDraft, entityId, entityType, releaseVersionMap, locales, activeRelease, releases, }: {
-    currentEntityDraft: EntryProps | AssetProps;
-    entityId: string;
-    entityType: 'Entry' | 'Asset';
-    releaseVersionMap: Map<string, Map<string, ReleaseAction>>;
-    locales: LocaleProps[];
-    activeRelease: ReleaseV2Props | undefined;
-    releases: CollectionProp<ReleaseV2Props> | undefined;
-}) => {
-    releaseLocalesStatusMap: ReleaseLocalesStatusMap;
-};

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

@@ -1,12 +0,0 @@
-import type { CollectionProp } from 'contentful-management/types';
-import type { ReleaseAction, ReleaseV2Entity, ReleaseV2EntityWithLocales, ReleaseV2Props } from '../types';
-export declare function getPreviousReleaseEntity({ entityId, entityType, releaseVersionMap, activeRelease, releases, }: {
-    entityId: string;
-    entityType: 'Entry' | 'Asset';
-    releaseVersionMap: Map<string, Map<string, ReleaseAction>>;
-    activeRelease: ReleaseV2Props | undefined;
-    releases: CollectionProp<ReleaseV2Props> | undefined;
-}): {
-    previousReleaseEntity: ReleaseV2Entity | ReleaseV2EntityWithLocales | undefined;
-    previousRelease: ReleaseV2Props | undefined;
-};

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

@@ -1,11 +0,0 @@
-import type { ReleaseV2Props } from '@contentful/field-editor-shared';
-import type { CollectionProp, LocaleProps } from 'contentful-management';
-import type { ReleaseAction } from '../types';
-export type ParsedReleaseParams = {
-    releaseVersionMap: Map<string, Map<string, ReleaseAction>>;
-    locales: LocaleProps[];
-    activeRelease: ReleaseV2Props | undefined;
-    isActiveReleaseLoading: boolean;
-    releases: CollectionProp<ReleaseV2Props> | undefined;
-};
-export declare function parseReleaseParams(raw: string | undefined): ParsedReleaseParams;