@contentful/field-editor-shared 1.2.0 → 1.3.0

package/dist/{utils → types/utils}/entityHelpers.d.ts

@@ -1,68 +1,68 @@
-import { Asset, ContentType, ContentTypeField, Entry, File } from '../typesEntity';
-export declare function getFieldValue({ 
-/**
- * Expects an entity fetched with a flag Skip-Transformation: true
- */
-entity, fieldId, localeCode, defaultLocaleCode, }: {
-    entity: {
-        fields: {
-            [key: string]: {
-                [valueKey: string]: string | undefined;
-            };
-        };
-    };
-    fieldId: string;
-    localeCode: string;
-    defaultLocaleCode: string;
-}): string | undefined;
-export declare function getAssetTitle({ asset, localeCode, defaultLocaleCode, defaultTitle, }: {
-    asset: Asset;
-    localeCode: string;
-    defaultLocaleCode: string;
-    defaultTitle: string;
-}): string;
-/**
- * Returns true if field is an Asset
- *
- * @param field
- * @returns {boolean}
- */
-export declare const isAssetField: (field: ContentTypeField) => boolean;
-/**
- * Returns true if field is a Title
- */
-export declare function isDisplayField({ field, contentType, }: {
-    field: ContentTypeField;
-    contentType: ContentType;
-}): boolean;
-/**
- * Returns true if field is a short Description
- */
-export declare function isDescriptionField({ field, contentType, }: {
-    field: ContentTypeField;
-    contentType: ContentType;
-}): boolean;
-export declare function getEntityDescription({ entity, contentType, localeCode, defaultLocaleCode, }: {
-    entity: Entry;
-    contentType?: ContentType;
-    localeCode: string;
-    defaultLocaleCode: string;
-}): string;
-export declare function getEntryTitle({ entry, contentType, localeCode, defaultLocaleCode, defaultTitle, }: {
-    entry: Entry;
-    contentType?: ContentType;
-    localeCode: string;
-    defaultLocaleCode: string;
-    defaultTitle: string;
-}): string;
-export declare function getEntryStatus(sys: Entry['sys']): "deleted" | "archived" | "changed" | "published" | "draft";
-/**
- * Gets a promise resolving with a localized asset image field representing a
- * given entities file. The promise may resolve with null.
- */
-export declare const getEntryImage: ({ entry, contentType, localeCode, }: {
-    entry: Entry;
-    contentType?: ContentType | undefined;
-    localeCode: string;
-    defaultLocaleCode: string;
-}, getAsset: (assetId: string) => Promise<unknown>) => Promise<null | File>;
+import { Asset, ContentType, ContentTypeField, Entry, File } from '../typesEntity';
+export declare function getFieldValue({ 
+/**
+ * Expects an entity fetched with a flag Skip-Transformation: true
+ */
+entity, fieldId, localeCode, defaultLocaleCode, }: {
+    entity: {
+        fields: {
+            [key: string]: {
+                [valueKey: string]: string | undefined;
+            };
+        };
+    };
+    fieldId: string;
+    localeCode: string;
+    defaultLocaleCode: string;
+}): string | undefined;
+export declare function getAssetTitle({ asset, localeCode, defaultLocaleCode, defaultTitle, }: {
+    asset: Asset;
+    localeCode: string;
+    defaultLocaleCode: string;
+    defaultTitle: string;
+}): string;
+/**
+ * Returns true if field is an Asset
+ *
+ * @param field
+ * @returns {boolean}
+ */
+export declare const isAssetField: (field: ContentTypeField) => boolean;
+/**
+ * Returns true if field is a Title
+ */
+export declare function isDisplayField({ field, contentType, }: {
+    field: ContentTypeField;
+    contentType: ContentType;
+}): boolean;
+/**
+ * Returns true if field is a short Description
+ */
+export declare function isDescriptionField({ field, contentType, }: {
+    field: ContentTypeField;
+    contentType: ContentType;
+}): boolean;
+export declare function getEntityDescription({ entity, contentType, localeCode, defaultLocaleCode, }: {
+    entity: Entry;
+    contentType?: ContentType;
+    localeCode: string;
+    defaultLocaleCode: string;
+}): string;
+export declare function getEntryTitle({ entry, contentType, localeCode, defaultLocaleCode, defaultTitle, }: {
+    entry: Entry;
+    contentType?: ContentType;
+    localeCode: string;
+    defaultLocaleCode: string;
+    defaultTitle: string;
+}): string;
+export declare function getEntryStatus(sys: Entry['sys']): "deleted" | "archived" | "changed" | "published" | "draft";
+/**
+ * Gets a promise resolving with a localized asset image field representing a
+ * given entities file. The promise may resolve with null.
+ */
+export declare const getEntryImage: ({ entry, contentType, localeCode, }: {
+    entry: Entry;
+    contentType?: ContentType | undefined;
+    localeCode: string;
+    defaultLocaleCode: string;
+}, getAsset: (assetId: string) => Promise<unknown>) => Promise<null | File>;

package/dist/{utils → types/utils}/isValidImage.d.ts

@@ -1,5 +1,5 @@
-import { File } from '../typesEntity';
-/**
- * Checks whether the passed content type matches one of our valid MIME types
- */
-export declare function isValidImage(file: File): boolean;
+import { File } from '../typesEntity';
+/**
+ * Checks whether the passed content type matches one of our valid MIME types
+ */
+export declare function isValidImage(file: File): boolean;

package/dist/{utils → types/utils}/shortenStorageUnit.d.ts

@@ -1,17 +1,17 @@
-/**
- * Transforms a number into a localized string (en-US)
- * toLocaleString(1000); // "1,000"
- * @param {Number} number
- */
-export declare function toLocaleString(number: number): string;
-declare type UnitOfMeasure = 'PB' | 'TB' | 'GB' | 'MB' | 'KB' | 'B';
-/**
- * Make a storage unit number more readable by making them smaller
- * shortenStorageUnit(1000, 'GB'); // "1 TB"
- * shortenStorageUnit(0.001, 'TB'); // "1 GB"
- * @param value
- * @param uom Unit of measure
- * @returns
- */
-export declare function shortenStorageUnit(value: number, uom: UnitOfMeasure): string;
-export {};
+/**
+ * Transforms a number into a localized string (en-US)
+ * toLocaleString(1000); // "1,000"
+ * @param {Number} number
+ */
+export declare function toLocaleString(number: number): string;
+type UnitOfMeasure = 'PB' | 'TB' | 'GB' | 'MB' | 'KB' | 'B';
+/**
+ * Make a storage unit number more readable by making them smaller
+ * shortenStorageUnit(1000, 'GB'); // "1 TB"
+ * shortenStorageUnit(0.001, 'TB'); // "1 GB"
+ * @param value
+ * @param uom Unit of measure
+ * @returns
+ */
+export declare function shortenStorageUnit(value: number, uom: UnitOfMeasure): string;
+export {};

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "1.2.0",
-  "main": "dist/index.js",
-  "module": "dist/field-editor-shared.esm.js",
-  "typings": "dist/index.d.ts",
+  "version": "1.3.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "dist"
   ],
@@ -14,25 +22,32 @@
     "url": "https://github.com/contentful/field-editors"
   },
   "scripts": {
-    "watch": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test --env=jsdom --watch",
-    "test:ci": "tsdx test --env=jsdom --ci",
+    "watch": "yarn concurrently \"yarn:watch:*\"",
+    "watch:cjs": "yarn build:cjs -w",
+    "watch:esm": "yarn build:esm -w",
+    "watch:types": "yarn build:types --watch",
+    "build": "yarn build:types && yarn build:cjs && yarn build:esm",
+    "build:types": "tsc --outDir dist/types --emitDeclarationOnly",
+    "build:cjs": "swc src --config-file ../../.swcrc -d dist/cjs -C module.type=commonjs",
+    "build:esm": "swc src --config-file ../../.swcrc -d dist/esm",
+    "test": "jest --watch",
+    "test:ci": "jest --ci",
     "tsc": "tsc -p ./ --noEmit"
   },
   "devDependencies": {
-    "@contentful/app-sdk": "^4.2.0"
+    "@contentful/app-sdk": "^4.2.0",
+    "@contentful/field-editor-test-utils": "^1.4.0"
   },
   "dependencies": {
     "@contentful/f36-note": "^4.2.8",
     "@contentful/f36-tokens": "^4.0.0",
     "emotion": "^10.0.17",
     "lodash": "^4.17.15",
-    "lodash-es": "^4.17.15"
+    "lodash-es": "^4.17.21"
   },
   "peerDependencies": {
     "@contentful/app-sdk": "^4.2.0",
     "react": ">=16.8.0"
   },
-  "gitHead": "de7e74e3485dd69c240cfe9c545e6e50e41fb295"
+  "gitHead": "543e02672a8dd4edc810f9f3568d6b69c454e1f9"
 }

package/CHANGELOG.md

@@ -1,196 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [1.2.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.8...@contentful/field-editor-shared@1.2.0) (2023-04-19)
-
-### Features
-
-- upgrade cypress [TOL-1036] ([#1391](https://github.com/contentful/field-editors/issues/1391)) ([9c1aec9](https://github.com/contentful/field-editors/commit/9c1aec98aabbe464cdc3f1236c3bb1cc29b8208d))
-
-## [1.1.8](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.7...@contentful/field-editor-shared@1.1.8) (2023-03-14)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-## [1.1.7](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.6...@contentful/field-editor-shared@1.1.7) (2023-03-10)
-
-### Bug Fixes
-
-- support disabling single line editor ([#1367](https://github.com/contentful/field-editors/issues/1367)) ([f8314ff](https://github.com/contentful/field-editors/commit/f8314fff446a3dcb482835424c7fca66c4f87f20))
-
-## [1.1.6](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.5...@contentful/field-editor-shared@1.1.6) (2023-02-21)
-
-### Bug Fixes
-
-- [] adds configurations to support image/avif mime type with web application previews ([#1347](https://github.com/contentful/field-editors/issues/1347)) ([616e6ad](https://github.com/contentful/field-editors/commit/616e6adc70d6d9ae6ad606c677fa9658d6e78006))
-
-## [1.1.5](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.4...@contentful/field-editor-shared@1.1.5) (2023-02-07)
-
-### Bug Fixes
-
-- improve types ([#1338](https://github.com/contentful/field-editors/issues/1338)) ([3197fa9](https://github.com/contentful/field-editors/commit/3197fa9e806f32c90cda454681cb48b604072529))
-
-## [1.1.4](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.3...@contentful/field-editor-shared@1.1.4) (2022-12-08)
-
-### Bug Fixes
-
-- handle unavailable marks ([#1288](https://github.com/contentful/field-editors/issues/1288)) ([c672c51](https://github.com/contentful/field-editors/commit/c672c516332407ec0691bffc764912b5c6b18795))
-
-## [1.1.3](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.2...@contentful/field-editor-shared@1.1.3) (2022-06-22)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-## [1.1.2](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.1...@contentful/field-editor-shared@1.1.2) (2022-02-15)
-
-### Bug Fixes
-
-- bump f36 packages ([#1025](https://github.com/contentful/field-editors/issues/1025)) ([ec37a40](https://github.com/contentful/field-editors/commit/ec37a4000db7cd75c66dd9621136b2272c9feeea))
-
-## [1.1.1](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.1.0...@contentful/field-editor-shared@1.1.1) (2022-02-14)
-
-### Bug Fixes
-
-- **number-editor:** use "text" input that syncs numeric value when valid ([#1020](https://github.com/contentful/field-editors/issues/1020)) ([0f38462](https://github.com/contentful/field-editors/commit/0f384623f969284d122255191397402bbb3e7763))
-
-# [1.1.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.0.3...@contentful/field-editor-shared@1.1.0) (2022-01-11)
-
-### Features
-
-- bump f36 packages to stable v4 [BAU-521] ([#988](https://github.com/contentful/field-editors/issues/988)) ([419cf56](https://github.com/contentful/field-editors/commit/419cf56692179b074fcfa2743469d5265ed98429))
-
-## [1.0.3](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.0.2...@contentful/field-editor-shared@1.0.3) (2021-12-23)
-
-### Bug Fixes
-
-- markdown buttons ([#968](https://github.com/contentful/field-editors/issues/968)) ([9803b98](https://github.com/contentful/field-editors/commit/9803b98c25d92df6148686ffe2749a77f7efdbb9))
-
-## [1.0.2](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.0.1...@contentful/field-editor-shared@1.0.2) (2021-12-20)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-## [1.0.1](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@1.0.0...@contentful/field-editor-shared@1.0.1) (2021-11-17)
-
-### Bug Fixes
-
-- **card-actions:** update forma 36 to fix card actions click issue ([#927](https://github.com/contentful/field-editors/issues/927)) ([3dfdef2](https://github.com/contentful/field-editors/commit/3dfdef2c2b0045f12ea94ddafca89a8e9f25e7d0))
-
-# [1.0.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.26.0...@contentful/field-editor-shared@1.0.0) (2021-11-04)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-# [0.26.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.25.1...@contentful/field-editor-shared@0.26.0) (2021-11-04)
-
-### Features
-
-- Forma v4 components adoption ([#805](https://github.com/contentful/field-editors/issues/805)) ([526bde6](https://github.com/contentful/field-editors/commit/526bde6e10e0ee3789705ec10fb31489af7ca59e))
-
-### BREAKING CHANGES
-
-- adopts a new Forma v4 beta
-
-## [0.25.1](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.25.0...@contentful/field-editor-shared@0.25.1) (2021-10-14)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-# [0.25.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.24.0...@contentful/field-editor-shared@0.25.0) (2021-10-06)
-
-### Features
-
-- [EXT-3161] bump app sdk to v4 ([#881](https://github.com/contentful/field-editors/issues/881)) ([9c4a2af](https://github.com/contentful/field-editors/commit/9c4a2af07da203d59fb5f15c3a5188ecc64b1d44))
-
-# [0.24.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.23.0...@contentful/field-editor-shared@0.24.0) (2021-09-17)
-
-### Features
-
-- add shortenStorageUnit util to shared ([#852](https://github.com/contentful/field-editors/issues/852)) ([142472b](https://github.com/contentful/field-editors/commit/142472b57fc1ca2843dd414c5320fdb5b5b11e62))
-
-# [0.23.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.22.1...@contentful/field-editor-shared@0.23.0) (2021-09-16)
-
-### Features
-
-- export shared util to validate images ([#846](https://github.com/contentful/field-editors/issues/846)) ([f26c481](https://github.com/contentful/field-editors/commit/f26c481cc5abf275acb4e4a65b462be487708117))
-
-## [0.22.1](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.22.0...@contentful/field-editor-shared@0.22.1) (2021-08-19)
-
-### Bug Fixes
-
-- FieldConnector setValue race conditions ([#803](https://github.com/contentful/field-editors/issues/803)) ([15a5aa6](https://github.com/contentful/field-editors/commit/15a5aa68a6f3f6c7183444c8fd11de1e70208aa7))
-
-# [0.22.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.21.0...@contentful/field-editor-shared@0.22.0) (2021-07-23)
-
-### Features
-
-- 💡 new color tokens ([#778](https://github.com/contentful/field-editors/issues/778)) ([fba548d](https://github.com/contentful/field-editors/commit/fba548de32305016df7f2685634eefb14294828f))
-
-# [0.21.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.18.0...@contentful/field-editor-shared@0.21.0) (2021-07-06)
-
-### Features
-
-- [] bump forma tokens ([#756](https://github.com/contentful/field-editors/issues/756)) ([befc60f](https://github.com/contentful/field-editors/commit/befc60f9f495b0d1e072e9cba969d139da8f674a))
-
-# [0.20.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.18.0...@contentful/field-editor-shared@0.20.0) (2021-07-06)
-
-### Features
-
-- [] bump forma tokens ([#756](https://github.com/contentful/field-editors/issues/756)) ([befc60f](https://github.com/contentful/field-editors/commit/befc60f9f495b0d1e072e9cba969d139da8f674a))
-
-# [0.19.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.18.0...@contentful/field-editor-shared@0.19.0) (2021-06-23)
-
-### Features
-
-- [] bump forma tokens ([#756](https://github.com/contentful/field-editors/issues/756)) ([befc60f](https://github.com/contentful/field-editors/commit/befc60f9f495b0d1e072e9cba969d139da8f674a))
-
-# [0.18.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.17.0...@contentful/field-editor-shared@0.18.0) (2021-06-23)
-
-### Features
-
-- [] bump app sdk ([#755](https://github.com/contentful/field-editors/issues/755)) ([aa0c217](https://github.com/contentful/field-editors/commit/aa0c2179d4edbb1a37453e1e3bdf0ae11991166f))
-
-# [0.17.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.16.0...@contentful/field-editor-shared@0.17.0) (2021-06-22)
-
-### Features
-
-- [EXT-2826] make app-sdk a peer depedency ([#748](https://github.com/contentful/field-editors/issues/748)) ([f1d1d01](https://github.com/contentful/field-editors/commit/f1d1d01d89d59d70ab2c831a513ab2580ea64d7e))
-
-# [0.16.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.15.1...@contentful/field-editor-shared@0.16.0) (2021-02-19)
-
-### Features
-
-- bump min version of forma-36 ([#606](https://github.com/contentful/field-editors/issues/606)) ([fd57c7a](https://github.com/contentful/field-editors/commit/fd57c7a4312766af38c01507f17706ab22992617))
-
-## [0.15.1](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.15.0...@contentful/field-editor-shared@0.15.1) (2021-02-09)
-
-### Bug Fixes
-
-- **tags:** Editor permissions handles entities with metadata ([#584](https://github.com/contentful/field-editors/issues/584)) ([32636da](https://github.com/contentful/field-editors/commit/32636daf05e0ba9abb47eafe9893850db2c6601f))
-
-# [0.15.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.14.0...@contentful/field-editor-shared@0.15.0) (2021-02-01)
-
-### Features
-
-- swap ui-extension-sdk to app-sdk ([#576](https://github.com/contentful/field-editors/issues/576)) ([ac88b4b](https://github.com/contentful/field-editors/commit/ac88b4bd4573a72f521246fc8fcc873520ca90d4))
-
-# [0.14.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.13.3...@contentful/field-editor-shared@0.14.0) (2021-01-20)
-
-### Features
-
-- update minimal forma-36 versions to use updated design ([#565](https://github.com/contentful/field-editors/issues/565)) ([332c734](https://github.com/contentful/field-editors/commit/332c734bfaf54f0e9773fcbb460d743b1f5459ec))
-
-## [0.13.3](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.13.2...@contentful/field-editor-shared@0.13.3) (2021-01-12)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-## [0.13.2](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.13.1...@contentful/field-editor-shared@0.13.2) (2020-12-16)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-## [0.13.1](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.13.0...@contentful/field-editor-shared@0.13.1) (2020-11-06)
-
-**Note:** Version bump only for package @contentful/field-editor-shared
-
-# [0.13.0](https://github.com/contentful/field-editors/compare/@contentful/field-editor-shared@0.12.0...@contentful/field-editor-shared@0.13.0) (2020-08-24)
-
-### Features
-
-- extract field component to default-field-editors package ([#365](https://github.com/contentful/field-editors/issues/365)) ([eb78219](https://github.com/contentful/field-editors/commit/eb78219d52c3dcfb91824f3106f44312aaaf1f8e))

package/dist/CharCounter.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-interface CharCounterProps {
-    value?: string;
-    checkConstraint: (n: number) => boolean;
-}
-export declare function CharCounter(props: CharCounterProps): JSX.Element;
-export {};

package/dist/PredefinedValuesError.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare function PredefinedValuesError(): JSX.Element;