@contentful/field-editor-shared 2.8.0 → 2.9.1

package/dist/cjs/PredefinedValuesError.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "PredefinedValuesError", {
 });
 const _react = /*#__PURE__*/ _interop_require_wildcard(require("react"));
 const _f36note = require("@contentful/f36-note");
+const _core = require("@lingui/core");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
     var cacheBabelInterop = new WeakMap();
@@ -55,5 +56,8 @@ function PredefinedValuesError() {
     return /*#__PURE__*/ _react.createElement(_f36note.Note, {
         variant: "warning",
         testId: "predefined-values-warning"
-    }, "The widget failed to initialize. You can fix the problem by providing predefined values under the validations tab in the field settings.");
+    }, _core.i18n._({
+        id: "FieldEditors.Shared.PredefinedValuesError.ErrorMessage",
+        message: "The widget failed to initialize. You can fix the problem by providing predefined values under the validations tab in the field settings."
+    }));
 }

package/dist/cjs/index.js

@@ -111,13 +111,15 @@ const _PredefinedValuesError = require("./PredefinedValuesError");
 const _typesEntity = require("./typesEntity");
 const _isValidImage = require("./utils/isValidImage");
 const _shortenStorageUnit = require("./utils/shortenStorageUnit");
-_export_star(require("./utils/parseReleaseParameters"), exports);
-_export_star(require("./hooks/useLocalePublishStatus"), exports);
-_export_star(require("./hooks/useActiveLocales"), exports);
 _export_star(require("./types"), exports);
+_export_star(require("./hooks/useActiveLocales"), exports);
 _export_star(require("./hooks/useActiveReleaseLocalesStatuses"), exports);
+_export_star(require("./hooks/useLocalePublishStatus"), exports);
 _export_star(require("./LocalePublishingEntityStatusBadge"), exports);
 _export_star(require("./ReleaseEntityStatusBadge"), exports);
+_export_star(require("./utils/determineReleaseAction"), exports);
+_export_star(require("./utils/getEntryReleaseStatus"), exports);
+_export_star(require("./utils/parseReleaseParameters"), exports);
 const _ModalDialogLauncher = /*#__PURE__*/ _interop_require_wildcard(require("./ModalDialogLauncher"));
 const _constraints = /*#__PURE__*/ _interop_require_wildcard(require("./utils/constraints"));
 const _entityHelpers = /*#__PURE__*/ _interop_require_wildcard(require("./utils/entityHelpers"));

package/dist/cjs/utils/determineReleaseAction.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "determineReleaseAction", {
+    enumerable: true,
+    get: function() {
+        return determineReleaseAction;
+    }
+});
+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
+    };
+}
+function getLocaleBasedAction(addLocales, removeLocales) {
+    const hasPublish = addLocales.length > 0;
+    const hasUnpublish = removeLocales.length > 0;
+    if (hasPublish && !hasUnpublish) {
+        return 'publish';
+    }
+    if (!hasPublish && hasUnpublish) {
+        return 'unpublish';
+    }
+    return 'publish';
+}
+function determineReleaseAction(entryId, release) {
+    if (!release) {
+        return {
+            releaseAction: 'not-in-release'
+        };
+    }
+    const entityItem = release.entities?.items.find((item)=>item.entity.sys.id === entryId);
+    if (!entityItem) {
+        return {
+            releaseAction: 'not-in-release'
+        };
+    }
+    if (isEntryBasedAction(entityItem)) {
+        return {
+            releaseAction: entityItem.action,
+            entityItem
+        };
+    }
+    const { addLocales, removeLocales } = getLocalesFromEntity(entityItem);
+    const releaseAction = getLocaleBasedAction(addLocales, removeLocales);
+    return {
+        releaseAction,
+        entityItem,
+        addLocales,
+        removeLocales
+    };
+}

package/dist/cjs/utils/getEntryReleaseStatus.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "getEntryReleaseStatus", {
+    enumerable: true,
+    get: function() {
+        return getEntryReleaseStatus;
+    }
+});
+const _determineReleaseAction = require("./determineReleaseAction");
+function getEntryReleaseStatus(entryId, locales, release) {
+    const { releaseAction, entityItem, addLocales, removeLocales } = (0, _determineReleaseAction.determineReleaseAction)(entryId, release);
+    if (releaseAction === 'not-in-release' || !entityItem) {
+        return {
+            releaseAction
+        };
+    }
+    if ('action' in entityItem) {
+        return {
+            releaseAction,
+            localesCount: locales.length,
+            entityItem
+        };
+    }
+    const localesCount = addLocales && addLocales.length > 0 ? addLocales.length : locales.length;
+    return {
+        releaseAction,
+        localesCount,
+        entityItem,
+        addLocales,
+        removeLocales
+    };
+}

package/dist/esm/PredefinedValuesError.js

@@ -1,8 +1,12 @@
 import * as React from 'react';
 import { Note } from '@contentful/f36-note';
+import { i18n as $_i18n } from "@lingui/core";
 export function PredefinedValuesError() {
     return /*#__PURE__*/ React.createElement(Note, {
         variant: "warning",
         testId: "predefined-values-warning"
-    }, "The widget failed to initialize. You can fix the problem by providing predefined values under the validations tab in the field settings.");
+    }, $_i18n._({
+        id: "FieldEditors.Shared.PredefinedValuesError.ErrorMessage",
+        message: "The widget failed to initialize. You can fix the problem by providing predefined values under the validations tab in the field settings."
+    }));
 }

package/dist/esm/index.js

@@ -1,21 +1,23 @@
 export { AccessAPI, AppConfigAPI, BaseAppSDK, ContentType, DialogsAPI, EntryAPI, EntryFieldAPI, FieldAPI, FieldAppSDK, IdsAPI, LocalesAPI, LocationAPI, NavigatorAPI, NotifierAPI, OpenCustomWidgetOptions, ParametersAPI, SpaceAPI, WindowAPI } from '@contentful/app-sdk';
 export { CharCounter } from './CharCounter';
 export { CharValidation } from './CharValidation';
+export { ConstraintsUtils };
+export { entityHelpers };
 export { FieldConnector } from './FieldConnector';
+export { ModalDialogLauncher };
 export { PredefinedValuesError } from './PredefinedValuesError';
 export { Asset, Entry, File } from './typesEntity';
 export { isValidImage } from './utils/isValidImage';
 export { shortenStorageUnit, toLocaleString } from './utils/shortenStorageUnit';
-export * from './utils/parseReleaseParameters';
-export * from './hooks/useLocalePublishStatus';
-export * from './hooks/useActiveLocales';
-export { ModalDialogLauncher };
-export { entityHelpers };
-export { ConstraintsUtils };
 export * from './types';
+export * from './hooks/useActiveLocales';
 export * from './hooks/useActiveReleaseLocalesStatuses';
+export * from './hooks/useLocalePublishStatus';
 export * from './LocalePublishingEntityStatusBadge';
 export * from './ReleaseEntityStatusBadge';
+export * from './utils/determineReleaseAction';
+export * from './utils/getEntryReleaseStatus';
+export * from './utils/parseReleaseParameters';
 import * as ModalDialogLauncher from './ModalDialogLauncher';
 import * as ConstraintsUtils from './utils/constraints';
 import * as entityHelpers from './utils/entityHelpers';

package/dist/esm/utils/determineReleaseAction.js

@@ -0,0 +1,49 @@
+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
+    };
+}
+function getLocaleBasedAction(addLocales, removeLocales) {
+    const hasPublish = addLocales.length > 0;
+    const hasUnpublish = removeLocales.length > 0;
+    if (hasPublish && !hasUnpublish) {
+        return 'publish';
+    }
+    if (!hasPublish && hasUnpublish) {
+        return 'unpublish';
+    }
+    return 'publish';
+}
+export function determineReleaseAction(entryId, release) {
+    if (!release) {
+        return {
+            releaseAction: 'not-in-release'
+        };
+    }
+    const entityItem = release.entities?.items.find((item)=>item.entity.sys.id === entryId);
+    if (!entityItem) {
+        return {
+            releaseAction: 'not-in-release'
+        };
+    }
+    if (isEntryBasedAction(entityItem)) {
+        return {
+            releaseAction: entityItem.action,
+            entityItem
+        };
+    }
+    const { addLocales, removeLocales } = getLocalesFromEntity(entityItem);
+    const releaseAction = getLocaleBasedAction(addLocales, removeLocales);
+    return {
+        releaseAction,
+        entityItem,
+        addLocales,
+        removeLocales
+    };
+}

package/dist/esm/utils/getEntryReleaseStatus.js

@@ -0,0 +1,24 @@
+import { determineReleaseAction } from './determineReleaseAction';
+export function getEntryReleaseStatus(entryId, locales, release) {
+    const { releaseAction, entityItem, addLocales, removeLocales } = determineReleaseAction(entryId, release);
+    if (releaseAction === 'not-in-release' || !entityItem) {
+        return {
+            releaseAction
+        };
+    }
+    if ('action' in entityItem) {
+        return {
+            releaseAction,
+            localesCount: locales.length,
+            entityItem
+        };
+    }
+    const localesCount = addLocales && addLocales.length > 0 ? addLocales.length : locales.length;
+    return {
+        releaseAction,
+        localesCount,
+        entityItem,
+        addLocales,
+        removeLocales
+    };
+}

package/dist/types/index.d.ts

@@ -1,22 +1,24 @@
 export { AccessAPI, AppConfigAPI, BaseAppSDK, ContentType, DialogsAPI, EntryAPI, EntryFieldAPI, FieldAPI, FieldAppSDK, IdsAPI, LocalesAPI, LocationAPI, NavigatorAPI, NotifierAPI, OpenCustomWidgetOptions, ParametersAPI, SpaceAPI, WindowAPI, } from '@contentful/app-sdk';
 export { CharCounter } from './CharCounter';
 export { CharValidation } from './CharValidation';
+export { ConstraintsUtils };
+export { entityHelpers };
 export { FieldConnector } from './FieldConnector';
-export type { FieldConnectorChildProps } from './FieldConnector';
+export { ModalDialogLauncher };
 export { PredefinedValuesError } from './PredefinedValuesError';
 export { Asset, Entry, File } from './typesEntity';
 export { isValidImage } from './utils/isValidImage';
 export { shortenStorageUnit, toLocaleString } from './utils/shortenStorageUnit';
-export * from './utils/parseReleaseParameters';
-export * from './hooks/useLocalePublishStatus';
-export * from './hooks/useActiveLocales';
-export { ModalDialogLauncher };
-export { entityHelpers };
-export { ConstraintsUtils };
+export type { FieldConnectorChildProps } from './FieldConnector';
 export * from './types';
+export * from './hooks/useActiveLocales';
 export * from './hooks/useActiveReleaseLocalesStatuses';
+export * from './hooks/useLocalePublishStatus';
 export * from './LocalePublishingEntityStatusBadge';
 export * from './ReleaseEntityStatusBadge';
+export * from './utils/determineReleaseAction';
+export * from './utils/getEntryReleaseStatus';
+export * from './utils/parseReleaseParameters';
 import * as ModalDialogLauncher from './ModalDialogLauncher';
 import * as ConstraintsUtils from './utils/constraints';
 import * as entityHelpers from './utils/entityHelpers';

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

@@ -0,0 +1,9 @@
+import type { ReleaseAction, ReleaseV2Entity, ReleaseV2EntityWithLocales, ReleaseV2Props } from '../types';
+type DetermineActionResult = {
+    releaseAction: ReleaseAction;
+    entityItem?: ReleaseV2Entity | ReleaseV2EntityWithLocales;
+    addLocales?: string[];
+    removeLocales?: string[];
+};
+export declare function determineReleaseAction(entryId: string, release?: ReleaseV2Props): DetermineActionResult;
+export {};

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

@@ -0,0 +1,11 @@
+import type { LocaleProps } from 'contentful-management/types';
+import type { ReleaseAction, ReleaseV2Entity, ReleaseV2EntityWithLocales, ReleaseV2Props } from '../types';
+type GetEntryReleaseStatusResult = {
+    releaseAction: ReleaseAction;
+    localesCount?: number;
+    entityItem?: ReleaseV2Entity | ReleaseV2EntityWithLocales;
+    addLocales?: string[];
+    removeLocales?: string[];
+};
+export declare function getEntryReleaseStatus(entryId: string, locales: LocaleProps[], release?: ReleaseV2Props): GetEntryReleaseStatusResult;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "2.8.0",
+  "version": "2.9.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -57,5 +57,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "a86f67a6d507eb7c8c7a38b4312380361bdbebbb"
+  "gitHead": "4fa62eaa25b40c592cc3671df8626dd18013a206"
 }