@contentful/field-editor-shared 1.5.1 → 1.5.3

package/dist/cjs/utils/entityHelpers.js

@@ -15,6 +15,9 @@ _export(exports, {
     getEntityDescription: function() {
         return getEntityDescription;
     },
+    getEntityStatus: function() {
+        return getEntityStatus;
+    },
     getEntryImage: function() {
         return getEntryImage;
     },
@@ -160,24 +163,26 @@ function getEntryTitle({ entry, contentType, localeCode, defaultLocaleCode, defa
     }
     return titleOrDefault(title, defaultTitle);
 }
-function getEntryStatus(sys, localeCodes) {
+function getEntityStatus(sys, localeCodes) {
     if (!sys || sys.type !== 'Entry' && sys.type !== 'Asset') {
         throw new TypeError('Invalid entity metadata object');
     }
     if (sys.deletedVersion) {
         return 'deleted';
-    } else if (sys.archivedVersion) {
+    }
+    if (sys.archivedVersion) {
         return 'archived';
-    } else if (sys.fieldStatus) {
+    }
+    if (sys.fieldStatus && localeCodes) {
         let status = 'draft';
-        const condition = (locale)=>{
+        const isMatchingLocale = (locale)=>{
             if (Array.isArray(localeCodes)) {
                 return localeCodes.includes(locale);
             }
             return localeCodes ? localeCodes === locale : true;
         };
         Object.entries(sys.fieldStatus['*']).forEach(([localeCode, fieldStatus])=>{
-            if (condition(localeCode)) {
+            if (isMatchingLocale(localeCode)) {
                 if (fieldStatus === 'changed') {
                     status = fieldStatus;
                     return;
@@ -188,15 +193,18 @@ function getEntryStatus(sys, localeCodes) {
             }
         });
         return status;
-    } else if (sys.publishedVersion) {
+    }
+    if (sys.publishedVersion) {
         if (sys.version > sys.publishedVersion + 1) {
             return 'changed';
         } else {
             return 'published';
         }
-    } else {
-        return 'draft';
     }
+    return 'draft';
+}
+function getEntryStatus(sys, localeCodes) {
+    return getEntityStatus(sys, localeCodes);
 }
 const getEntryImage = async ({ entry, contentType, localeCode }, getAsset)=>{
     if (!contentType) {

package/dist/esm/utils/entityHelpers.js

@@ -116,24 +116,26 @@ export function getEntryTitle({ entry, contentType, localeCode, defaultLocaleCod
     }
     return titleOrDefault(title, defaultTitle);
 }
-export function getEntryStatus(sys, localeCodes) {
+export function getEntityStatus(sys, localeCodes) {
     if (!sys || sys.type !== 'Entry' && sys.type !== 'Asset') {
         throw new TypeError('Invalid entity metadata object');
     }
     if (sys.deletedVersion) {
         return 'deleted';
-    } else if (sys.archivedVersion) {
+    }
+    if (sys.archivedVersion) {
         return 'archived';
-    } else if (sys.fieldStatus) {
+    }
+    if (sys.fieldStatus && localeCodes) {
         let status = 'draft';
-        const condition = (locale)=>{
+        const isMatchingLocale = (locale)=>{
             if (Array.isArray(localeCodes)) {
                 return localeCodes.includes(locale);
             }
             return localeCodes ? localeCodes === locale : true;
         };
         Object.entries(sys.fieldStatus['*']).forEach(([localeCode, fieldStatus])=>{
-            if (condition(localeCode)) {
+            if (isMatchingLocale(localeCode)) {
                 if (fieldStatus === 'changed') {
                     status = fieldStatus;
                     return;
@@ -144,15 +146,18 @@ export function getEntryStatus(sys, localeCodes) {
             }
         });
         return status;
-    } else if (sys.publishedVersion) {
+    }
+    if (sys.publishedVersion) {
         if (sys.version > sys.publishedVersion + 1) {
             return 'changed';
         } else {
             return 'published';
         }
-    } else {
-        return 'draft';
     }
+    return 'draft';
+}
+export function getEntryStatus(sys, localeCodes) {
+    return getEntityStatus(sys, localeCodes);
 }
 export const getEntryImage = async ({ entry, contentType, localeCode }, getAsset)=>{
     if (!contentType) {

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

@@ -59,6 +59,19 @@ type AsyncPublishStatus = 'draft' | 'published' | 'changed';
 type FieldStatus = {
     '*': Record<string, AsyncPublishStatus>;
 };
+/**
+ * Returns the status of the entry/asset
+ * If a locale code(s) is provided it will pick up the most advanced state for these locale(s)
+ * - deleted
+ * - archived
+ * - changed
+ * - published
+ * - draft
+ */
+export declare function getEntityStatus(sys: (Entry['sys'] | Asset['sys']) & {
+    fieldStatus?: FieldStatus;
+}, localeCodes?: string | string[]): "draft" | "published" | "changed" | "deleted" | "archived";
+/**@deprecated use `getEntityStatus` */
 export declare function getEntryStatus(sys: Entry['sys'] & {
     fieldStatus?: FieldStatus;
 }, localeCodes?: string | string[]): "draft" | "published" | "changed" | "deleted" | "archived";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -51,5 +51,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "60fd3c2f5a58f4d42886b5f952ce3cc1aec71833"
+  "gitHead": "6287e6c00cd65f5f3625526707551c213d58d3e3"
 }