CHANGELOG.md

4.29.3 (2024-11-05)

Bug Fixes

• remove .npmrc at root to fix publish registry [EXT-5905] (#2064) (b3174ec)

4.29.2 (2024-10-30)

Bug Fixes

• release dependabot updates [] (#2058) (8ef81a9)

4.29.1 (2024-08-15)

Bug Fixes

• upgrade contentful-management to include axios vuln fix (#2002) (a9d2831)

4.29.0 (2024-07-22)

Bug Fixes

• husky pre-commit [] (#1981) (4d81c5a)

Features

• add type for cursor-based collection responses (#1975) (e912b7d)

4.28.0 (2024-07-08)

Features

• export allowed resources error types (#1962) (d9feb5b)

4.27.0 (2024-07-08)

Features

• add allowed resources error types (#1957) (d946440)

4.26.3 (2024-07-02)

Bug Fixes

• [] add NPM token to .npmrc in CI (#1952) (a16d1c7)

4.26.2 (2024-06-28)

Bug Fixes

• whitespace [] (#1949) (e682d5b)

4.26.1 (2024-06-28)

Bug Fixes

• non-compatible test deps [NONE] (#1947) (81546a1)

4.26.0 (2024-03-07)

Features

• github migration [EXT-5010] (#1852) (36d924c)

4.25.0 (2024-03-06)

Features

• github migration [EXT-5010] (#1851) (aa29074)

4.24.0 (2024-01-19)

Features

• add nodeType to SizeValidationError [DANTE-1114] (#1807) (735e915)

4.23.1 (2023-09-26)

Bug Fixes

• node 18.18 for semantic release to work (#1676) (4336a35)

4.23.0 (2023-08-25)

Features

• hostnames API (#1633) (e776ce4)

4.22.1 (2023-07-10)

Bug Fixes

• [EXT-3666] Remove duplicating event dispatch (#1565) (c51f998)

4.22.0 (2023-06-29)

Features

• [EXT-3599] Bundle contentful-management with app-sdk. (Third attempt) (#1560) (78780b7), closes #1548

4.22.0-alpha.1 (2023-06-29)

Features

• [EXT-3599] Bundle contentful-management with app-sdk. (Third attempt) (#1560) (78780b7), closes #1548

4.21.1 (2023-06-23)

Bug Fixes

• revert expose cma in the sdk [EXT-3599] (#1549) (7b58c94)

Reverts

• expose cma in the sdk [EXT-3599] (#1548) (9b8684f)

4.21.0 (2023-06-22)

Features

• adds optional types for parameters [EXT-4381] (#1538) (7cbad71)

4.20.0 (2023-06-22)

Features

• expose cma in the sdk [EXT-3599] (#1536) (942c5e0)

4.19.1 (2023-06-15)

Bug Fixes

• [] Add boolean field type (#1541) (ba52bdf)

4.19.0 (2023-06-14)

Features

• [EXT-3648][EXT-4380] Improve sdk.field types (#1529) (ec0da5a)

4.18.0 (2023-06-14)

Features

• [EXT-3265] Add field name prop (#1527) (4477e90)

4.17.2 (2023-05-17)

Bug Fixes

• exposed createWithResponse function[] (#1522) (2255541)

4.17.1 (2023-04-05)

Bug Fixes

• [] Deprecate XXXExtensionSDK types in favour of XXXAppSDK (#1505) (a8ee8e7)

4.17.0 (2023-03-29)

Features

• Entities: add more supported entities to app sdk's cma [EXT-4359] (#1501) (43e6c96)

4.16.0 (2023-02-10)

Features

• initial values & getters for field/editor API (#1444) (fa98f30)

4.15.0 (2023-02-06)

Features

• expose automation tags on entry.sys [] (#1468) (a5cde02)

4.14.1 (2022-12-29)

Bug Fixes

• types of sdk.editor & sdk.navigator (#1441) (b514498)

4.14.0 (2022-12-22)

Features

• add type for CMA client (#1430) (8eb1847)

4.13.0 (2022-10-24)

Features

• add home location [EXT-3684] (#1388) (9193e43)

4.12.1 (2022-09-12)

Bug Fixes

• make ContentEntityType more specific (#1328) (99bda6e)

4.12.0 (2022-08-15)

Features

• ui-config updates [EXT-3738] (#1344) (524a701)

4.11.1 (2022-08-02)

Bug Fixes

• add missing properties to new init method (#1338) (4370508)

4.11.0 (2022-08-01)

Features

• init can be called at any time (#1319) (d95d441)

4.10.0 (2022-07-26)

Features

• add query param to getTasks (#1335) (8e79721)

4.9.0 (2022-07-12)

Features

• [] add option to entry publish method (#1306) (e6aaab1)

4.8.1 (2022-06-28)

Bug Fixes

• make init a noop for non-browser environments (#1308) (253c5c8)
• use App SDK instead of UI Extensions in error message (#1307) (06ec441)

4.8.0 (2022-06-15)

Features

• exported workflow definition type (#1295) (490e5db)

4.7.0 (2022-06-15)

Features

• added worflowdefinition type to exported entities and to api.types (#1294) (b2d917f)

4.6.0 (2022-06-01)

Features

• add option to include absolute elements in auto resizer (#901) (0269b00)

4.5.0 (2022-05-18)

Features

• add organization to sdk.ids (#1271) (b3eca1c)

4.4.1 (2022-05-16)

Bug Fixes

• Use ResizeObserver to track iframe body size changes [EXT-3733] (#1263) (391b282)

4.4.0 (2022-05-09)

Features

• add warning notification support [SHE-785] (#1232) (be30251)

4.3.7 (2022-04-13)

Bug Fixes

• make openNewAsset options param optional (#1239) (bdf3336)

4.3.6 (2022-04-12)

Bug Fixes

• [] improved types for ParametersAPI (#1236) (abf53c0)

4.3.5 (2022-02-23)

Bug Fixes

• explicitly state 5.0.0 deprecation plan (#1194) (6a73271)

4.3.4 (2022-02-21)

Bug Fixes

• support contentful-management v8 and later (#1190) (45fdefe)

4.3.3 (2022-02-14)

Bug Fixes

• [EXT-3363] use correct IDS api for fields (#1184) (84daaa2)

4.3.2 (2022-02-09)

Bug Fixes

• return same SDK instance when calling init multiple times (#1173) (8acc077)

4.3.1 (2021-11-10)

Bug Fixes

• export team type (#1072) (2845c96)

4.3.0 (2021-10-26)

Features

• [EXT-2755] add save and (un)publish command (#1040) (f1a4de4)

4.2.1 (2021-10-07)

Bug Fixes

• LinkContentTypeValidationError contains a list of content types (#1021) (64a8c05)

4.2.0 (2021-10-06)

Features

• export Action and ValidationError types (#1018) (dcff361)

4.1.1 (2021-10-06)

Bug Fixes

• [3161] use correct type for conflicting errors (#1017) (621a1d0)

4.1.0 (2021-10-05)

Features

• [] export validation error type (#1011) (983407e)

4.0.1 (2021-10-05)

Bug Fixes

• measure old css file usage (#1010) (7dcd079)

4.0.0 (2021-10-05)

This major release of the Contentful App SDK provides two great features to make app development for Contentful even easier.

Contentful Management API Adapter

You can now use the contentful-management library within apps. This gives you access to a huge load of APIs that were previously not available. Also, you can reuse existing code utilising the contentful-management library which makes it easier to convert your custom Contentful scripts to convenient apps.

After installing the library, a new client can be created using the cmaAdapter which is exposed by the App SDK. There is no need to deal with authentication and tokens.

import { createClient } from 'contentful-management'

const nestedClient = createClient({ apiAdapter: sdk.cmaAdapter })

const cma = createClient(
  { apiAdapter: sdk.cmaAdapter },
  {
    type: 'plain',
    defaults: {
      environmentId: sdk.ids.environment,
      spaceId: sdk.ids.space,
    },
  },
)

Please note that not all methods are available. You can only use methods that access entities within the app’s space environment.

Deprecation of Space API

The Space API (sdk.space) is deprecated and will be removed in a future major update of the App SDK. We recommend using the new CMA Adapters to replace existing Space API functionality.

Typings revamp

In the previous version of the App SDK app developers sometimes struggled with our provided types. For version 4 we took the opportunity to revamp and significantly improve the types of the whole library. These changes are likely to break existing TypeScript apps as we are more specific about each property and also changed the usage of generics on API methods. The new types of the App SDK now align with the types of the contentful-management library. To get the best development experience, you need to install contentful-management as a separate dependency.

npm install contentful-management

We do not include this dependency by default to keep your dependency tree clean and ensure small bundle sizes and short build times.

3.42.0 (2021-10-01)

Features

• show better warning for DATA_CLONE_ERR [EXT-2761] (#989) (fb82d86)

3.41.0 (2021-09-29)

Features

• Include patch in message (#997) (0a97537)

3.40.1 (2021-09-23)

Bug Fixes

• AccessSDK: patch action isn't supported (#987) (7aff0ae)

3.40.0 (2021-09-17)

Features

• AccessAPI: add support for JSON patches in access sdk [EXT-3041] (#974) (a720fc2)

3.39.1 (2021-09-10)

Bug Fixes

• create upload types (#961) (a65b320)

3.39.0 (2021-07-20)

Features

• Add typings and expose metadata methods (#865) (b0bbaad)

3.38.0 (2021-06-30)

Features

• add resolved info to tasks sys (#822) (e0be824)

3.37.0 (2021-06-23)

Features

• add type parameter to create task input data (#809) (e0fe688)

3.36.0 (2021-06-17)

Features

• add interface for space.getTeams [HOMER-75] (#789) (a5b8dac)

3.35.0 (2021-06-11)

Features

• add due date as a task field type (#776) (ed0bf60)

3.34.3 (2021-05-18)

Reverts

• "chore: test that SDK respects alias (#710)" (#717) (4ab6e48)

3.34.2 (2021-05-11)

Reverts

• bump cypress from 7.2.0 to 7.3.0 (#706) (ebcdf01)

3.34.1 (2021-05-06)

Bug Fixes

• make options of dialogs.openExtension optional (#681) (ca6d15b)

3.34.0 (2021-04-30)

Features

• add navigate to lists methods (ef5ee41)

3.33.0 (2021-04-06)

Features

• expose tags api (3ae6b4b)

3.32.2 (2021-03-23)

Bug Fixes

• [EXT-2508] use husky v4 (#611) (85e1d4f)

3.32.1 (2021-02-16)

Bug Fixes

• link to App SDK reference (#550) (be47635)

3.32.0 (2021-01-29)

Features

• add Task API to sdk.entry (#516) (334097c)

3.31.1 (2021-01-28)

Documentation

• rename UIE SDK to App SDK in readme (#508) (d565d3d)
• add repository and homepage to package.json (#509) (d301d46)

3.31.0 (2021-01-13)

Features

• export module as contentfulApp (#490) (0eb5aaa)

3.30.0 (2021-01-13)

Features

• generate typings (#473) (1c9a69b)

3.29.2 (2021-01-11)

Bug Fixes

• emit build errors (#484) (5a0f20d)

3.29.1 (2021-01-08)

Bug Fixes

• correct type for canEditAppConfig (#481) (808521f)

3.29.0 (2021-01-08)

Features

• add canEditAppConfig method (#480) (594d37d)

3.28.1 (2021-01-08)

Bug Fixes

• make signRequest non optional (#479) (0f932f1)

3.28.0 (2021-01-07)

Features

• add openAppConfig method (#476) (80a808d)

3.27.0 (2021-01-05)

Features

• [EXT-2360] add test for onvaluechanged (#431) (229d930)

3.26.1 (2021-11-24)

Features

• Add env alias to IdsApi type

3.25.1 (2021-11-24)

Features

• Bump dependencies

3.25.0 (2020-11-09)

Bug Fixes

• only expose signRequest in apps (169ff70)
• request signing endpoint can be undefined (2eb0d76)

Features

• [EXT-2360] add test for onvaluechanged (#431) (229d930)

3.24.0 (2020-11-02)

Features

• log error if it appears app is running outside of iframe (#390) (c46be9d)