@contentful/app-sdk 4.0.0-alpha.7 → 4.0.1

package/CHANGELOG.md

@@ -1,63 +1,119 @@
-# [4.0.0-alpha.7](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.6...v4.0.0-alpha.7) (2021-05-26)
+## [4.0.1](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0...v4.0.1) (2021-10-05)
 
 
-### Features
+### Bug Fixes
 
-* better typings for user API ([#744](https://github.com/contentful/ui-extensions-sdk/issues/744)) ([29a6359](https://github.com/contentful/ui-extensions-sdk/commit/29a63594933f1063ac8734a9877fec6fa25928b9))
+* measure old css file usage ([#1010](https://github.com/contentful/ui-extensions-sdk/issues/1010)) ([7dcd079](https://github.com/contentful/ui-extensions-sdk/commit/7dcd079c5f17f0a4e01e48e8184f0285dd0e9e1b))
 
-# [4.0.0-alpha.6](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.5...v4.0.0-alpha.6) (2021-05-20)
+# [4.0.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.42.0...v4.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.
 
-### Bug Fixes
+## Contentful Management API Adapter
+
+You can now use the [`contentful-management` library](https://github.com/contentful/contentful-management.js) 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.
+
+```javascript
+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.
 
-* navigator api types ([#725](https://github.com/contentful/ui-extensions-sdk/issues/725)) ([7cac2eb](https://github.com/contentful/ui-extensions-sdk/commit/7cac2eb08200bba51d95d5461f00011a3add771b)), closes [#718](https://github.com/contentful/ui-extensions-sdk/issues/718) [#719](https://github.com/contentful/ui-extensions-sdk/issues/719) [#715](https://github.com/contentful/ui-extensions-sdk/issues/715) [#720](https://github.com/contentful/ui-extensions-sdk/issues/720) [#723](https://github.com/contentful/ui-extensions-sdk/issues/723) [#721](https://github.com/contentful/ui-extensions-sdk/issues/721)
+## Deprecation of Space API
 
-# [4.0.0-alpha.5](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.4...v4.0.0-alpha.5) (2021-05-18)
+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.
+
+```bash
+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](https://github.com/contentful/ui-extensions-sdk/compare/v3.41.0...v3.42.0) (2021-10-01)
 
 ### Features
 
-* expose WithId ([#722](https://github.com/contentful/ui-extensions-sdk/issues/722)) ([80189db](https://github.com/contentful/ui-extensions-sdk/commit/80189dbdf5b7592a73e1ed4ec4fef40b0c85a1c8))
+- show better warning for DATA_CLONE_ERR [EXT-2761] ([#989](https://github.com/contentful/ui-extensions-sdk/issues/989)) ([fb82d86](https://github.com/contentful/ui-extensions-sdk/commit/fb82d866c4ffc97554673ea8e32bc8b81fa5f33c))
 
-# [4.0.0-alpha.4](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.3...v4.0.0-alpha.4) (2021-05-18)
+# [3.41.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.40.1...v3.41.0) (2021-09-29)
 
+### Features
+
+- Include patch in message ([#997](https://github.com/contentful/ui-extensions-sdk/issues/997)) ([0a97537](https://github.com/contentful/ui-extensions-sdk/commit/0a97537e3426dfb9a2c95365ae4c96eeb848d8b4))
+
+## [3.40.1](https://github.com/contentful/ui-extensions-sdk/compare/v3.40.0...v3.40.1) (2021-09-23)
 
 ### Bug Fixes
 
-* more explicit space api types ([#711](https://github.com/contentful/ui-extensions-sdk/issues/711)) ([42d63de](https://github.com/contentful/ui-extensions-sdk/commit/42d63dea5fd9a313918a9591311d716c3374ac60))
+- **AccessSDK:** patch action isn't supported ([#987](https://github.com/contentful/ui-extensions-sdk/issues/987)) ([7aff0ae](https://github.com/contentful/ui-extensions-sdk/commit/7aff0aeb4d3680e33a2ab7173a78982c55fa3677))
 
+# [3.40.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.39.2...v3.40.0) (2021-09-17)
 
-### Reverts
+### Features
 
-* "chore: test that SDK respects alias ([#710](https://github.com/contentful/ui-extensions-sdk/issues/710))" ([#717](https://github.com/contentful/ui-extensions-sdk/issues/717)) ([4ab6e48](https://github.com/contentful/ui-extensions-sdk/commit/4ab6e48237ef6d4cdd75c7721cd994539ced0ce2))
+- **AccessAPI:** add support for JSON patches in access sdk [EXT-3041] ([#974](https://github.com/contentful/ui-extensions-sdk/issues/974)) ([a720fc2](https://github.com/contentful/ui-extensions-sdk/commit/a720fc223b19419f61fb5df917540834966dbd83))
 
-# [4.0.0-alpha.3](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.2...v4.0.0-alpha.3) (2021-05-11)
+## [3.39.1](https://github.com/contentful/ui-extensions-sdk/compare/v3.39.0...v3.39.1) (2021-09-10)
 
 ### Bug Fixes
 
-- add missing types also in files ([#707](https://github.com/contentful/ui-extensions-sdk/issues/707)) ([957c858](https://github.com/contentful/ui-extensions-sdk/commit/957c85805a683832ca7f856fe525d17195a910d2))
+- create upload types ([#961](https://github.com/contentful/ui-extensions-sdk/issues/961)) ([a65b320](https://github.com/contentful/ui-extensions-sdk/commit/a65b32046087763708f521b5b2dbb92ac22c6579))
 
-## [3.34.3](https://github.com/contentful/ui-extensions-sdk/compare/v3.34.2...v3.34.3) (2021-05-18)
+# [3.39.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.38.0...v3.39.0) (2021-07-20)
 
-### Reverts
+### Features
 
-- bump cypress from 7.2.0 to 7.3.0 ([#706](https://github.com/contentful/ui-extensions-sdk/issues/706)) ([ebcdf01](https://github.com/contentful/ui-extensions-sdk/commit/ebcdf01c26c59707e5733f34d8897a9de9bfa462))
+- Add typings and expose metadata methods ([#865](https://github.com/contentful/ui-extensions-sdk/issues/865)) ([b0bbaad](https://github.com/contentful/ui-extensions-sdk/commit/b0bbaad477114f7929d974b8bce8c3c03f05f4bf))
 
-# [4.0.0-alpha.2](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.1...v4.0.0-alpha.2) (2021-05-11)
+# [3.38.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.37.0...v3.38.0) (2021-06-30)
 
-### Bug Fixes
+### Features
 
-- include typings in the release ([#699](https://github.com/contentful/ui-extensions-sdk/issues/699)) ([16b15e2](https://github.com/contentful/ui-extensions-sdk/commit/16b15e25ddcfd8a34a6f4c9732fc5e67929ac62b))
+- add resolved info to tasks sys ([#822](https://github.com/contentful/ui-extensions-sdk/issues/822)) ([e0be824](https://github.com/contentful/ui-extensions-sdk/commit/e0be824956082aaa8fe00bd073f7354fb7dea51b))
 
-# [4.0.0-alpha.1](https://github.com/contentful/ui-extensions-sdk/compare/v3.34.1...v4.0.0-alpha.1) (2021-05-10)
+# [3.37.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.36.0...v3.37.0) (2021-06-23)
 
 ### Features
 
-- improve space API typings ([#684](https://github.com/contentful/ui-extensions-sdk/issues/684)) ([a57354c](https://github.com/contentful/ui-extensions-sdk/commit/a57354c32b78204d285aba897d213f201fec208c))
+- add type parameter to create task input data ([#809](https://github.com/contentful/ui-extensions-sdk/issues/809)) ([e0fe688](https://github.com/contentful/ui-extensions-sdk/commit/e0fe688b3e07cf58abd20a0b1f9d82c7ea1e48e7))
+
+# [3.36.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.35.0...v3.36.0) (2021-06-17)
+
+### Features
 
-### BREAKING CHANGES
+- add interface for space.getTeams [HOMER-75] ([#789](https://github.com/contentful/ui-extensions-sdk/issues/789)) ([a5b8dac](https://github.com/contentful/ui-extensions-sdk/commit/a5b8dac92293d2e58ba7625ca4a310d182f3cabf))
+
+# [3.35.0](https://github.com/contentful/ui-extensions-sdk/compare/v3.34.3...v3.35.0) (2021-06-11)
+
+### Features
+
+- add due date as a task field type ([#776](https://github.com/contentful/ui-extensions-sdk/issues/776)) ([ed0bf60](https://github.com/contentful/ui-extensions-sdk/commit/ed0bf60ce877665a3558555346c6bf0c9274bb49))
+
+## [3.34.3](https://github.com/contentful/ui-extensions-sdk/compare/v3.34.2...v3.34.3) (2021-05-18)
+
+### Reverts
 
-- old typings were too loose.
 - "chore: test that SDK respects alias ([#710](https://github.com/contentful/ui-extensions-sdk/issues/710))" ([#717](https://github.com/contentful/ui-extensions-sdk/issues/717)) ([4ab6e48](https://github.com/contentful/ui-extensions-sdk/commit/4ab6e48237ef6d4cdd75c7721cd994539ced0ce2))
 
 ## [3.34.2](https://github.com/contentful/ui-extensions-sdk/compare/v3.34.1...v3.34.2) (2021-05-11)

package/dist/README.md

@@ -6,6 +6,4 @@ Contentful UI Extension styles.
 It is here for backwards compatibility only: it will be packaged and published on npm
 so it's available under its legacy URL:
 
-https://unpkg.com/contentful-ui-extensions-sdk@3/dist/cf-extension.css
-
-We can remove it as soon as we reach 4.0.
+https://unpkg.com/contentful-ui-extensions-sdk/dist/cf-extension.css

package/dist/cf-extension-api.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).contentfulExtension={})}(this,(function(e){"use strict";var t=function(e,n){return(t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n])})(e,n)};var n,r=function(){return(r=Object.assign||function(e){for(var t,n=1,r=arguments.length;n<r;n++)for(var o in t=arguments[n])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};var o=function(){function e(){this._id=0,this._listeners={}}return e.prototype.dispatch=function(){for(var e,t=[],n=0;n<arguments.length;n++)t[n]=arguments[n];for(var r in this._listeners)(e=this._listeners)[r].apply(e,t)},e.prototype.attach=function(e){var t=this;if("function"!=typeof e)throw new Error("listener function expected");var n=this._id++;return this._listeners[n]=e,function(){return delete t._listeners[n]}},e}(),i="__private__memoized__arguments__",a=function(e){function r(){for(var t=[],r=0;r<arguments.length;r++)t[r]=arguments[r];var o=e.call(this)||this;if(o[n]=[],!t.length)throw new Error("Initial value to be memoized expected");return o[i]=t,o}return function(e,n){if("function"!=typeof n&&null!==n)throw new TypeError("Class extends value "+String(n)+" is not a constructor or null");function r(){this.constructor=e}t(e,n),e.prototype=null===n?Object.create(n):(r.prototype=n.prototype,new r)}(r,e),r.prototype.dispatch=function(){for(var t=[],n=0;n<arguments.length;n++)t[n]=arguments[n];this[i]=t,e.prototype.dispatch.apply(this,t)},r.prototype.attach=function(t){var n=e.prototype.attach.call(this,t);return t.apply(void 0,this[i]),n},r}(o);n=i;var s=function(){function e(e,t){var n=this;this._messageHandlers={},this._responseHandlers={},this._send=function(e,t){var n=0;return function(r,o){var i=n++;return t.postMessage({source:e,id:i,method:r,params:o},"*"),i}}(e,t.parent),t.addEventListener("message",(function(e){n._handleMessage(e.data)}))}return e.prototype.call=function(e){for(var t=this,n=[],r=1;r<arguments.length;r++)n[r-1]=arguments[r];var o=this._send(e,n);return new Promise((function(e,n){t._responseHandlers[o]={resolve:e,reject:n}}))},e.prototype.send=function(e){for(var t=[],n=1;n<arguments.length;n++)t[n-1]=arguments[n];this._send(e,t)},e.prototype.addHandler=function(e,t){return e in this._messageHandlers||(this._messageHandlers[e]=new o),this._messageHandlers[e].attach(t)},e.prototype._handleMessage=function(e){if(e.method){var t=e.method,n=e.params,r=this._messageHandlers[t];r&&r.dispatch.apply(r,n)}else{var o=e.id,i=this._responseHandlers[o];if(!i)return;"result"in e?i.resolve(e.result):"error"in e&&i.reject(e.error),delete this._responseHandlers[o]}},e}();var l=function(){function e(e,t){var n=this;this.id=t.id,this.locale=t.locale,this.type=t.type,this.required=t.required,this.validations=t.validations,this.items=t.items,this._value=t.value,this._valueSignal=new a(this._value),this._isDisabledSignal=new a(void 0),this._schemaErrorsChangedSignal=new a(void 0),this._channel=e,e.addHandler("valueChanged",(function(e,t,r){e!==n.id||t&&t!==n.locale||(n._value=r,n._valueSignal.dispatch(r))})),e.addHandler("isDisabledChangedForFieldLocale",(function(e,t,r){e===n.id&&t===n.locale&&n._isDisabledSignal.dispatch(r)})),e.addHandler("schemaErrorsChangedForFieldLocale",(function(e,t,r){e===n.id&&t===n.locale&&n._schemaErrorsChangedSignal.dispatch(r)}))}return e.prototype.getValue=function(){return this._value},e.prototype.setValue=function(e){return this._value=e,this._valueSignal.dispatch(e),this._channel.call("setValue",this.id,this.locale,e)},e.prototype.removeValue=function(){return this._value=void 0,this._channel.call("removeValue",this.id,this.locale)},e.prototype.setInvalid=function(e){return this._channel.call("setInvalid",e,this.locale)},e.prototype.onValueChanged=function(e){return this._valueSignal.attach(e)},e.prototype.onIsDisabledChanged=function(e){return this._isDisabledSignal.attach(e)},e.prototype.onSchemaErrorsChanged=function(e){return this._schemaErrorsChangedSignal.attach(e)},e}(),u=function(){function e(e,t,n){this.id=t.id,this.locales=t.locales,this.type=t.type,this.required=t.required,this.validations=t.validations,this.items=t.items,this._defaultLocale=n,this._fieldLocales=t.locales.reduce((function(n,o){var i,a=new l(e,{id:t.id,type:t.type,required:t.required,validations:t.validations,items:t.items,locale:o,value:t.values[o]});return r(r({},n),((i={})[o]=a,i))}),{}),this.assertHasLocale(n)}return e.prototype.getValue=function(e){return this._getFieldLocale(e).getValue()},e.prototype.setValue=function(e,t){return this._getFieldLocale(t).setValue(e)},e.prototype.removeValue=function(e){return this.setValue(void 0,e)},e.prototype.onValueChanged=function(e,t){var n=t||e;return t||(e=""),this._getFieldLocale(e).onValueChanged(n)},e.prototype.onIsDisabledChanged=function(e,t){var n=t||e;return t||(e=""),this._getFieldLocale(e).onIsDisabledChanged(n)},e.prototype._getFieldLocale=function(e){return e=e||this._defaultLocale,this.assertHasLocale(e),this._fieldLocales[e]},e.prototype.getForLocale=function(e){if(!e)throw new Error("getForLocale must be passed a locale");return this._getFieldLocale(e)},e.prototype.assertHasLocale=function(e){if(!this._fieldLocales[e])throw new Error('Unknown locale "'+e+'" for field "'+this.id+'"')},e}();function c(e,t){var n,r=e,o=r.document,i=r.MutationObserver,a=function(){u.updateHeight()},s=new i(a),l=!1,u={startAutoResizer:function(){if(u.updateHeight(),l)return;l=!0,s.observe(o.body,{attributes:!0,childList:!0,subtree:!0,characterData:!0}),e.addEventListener("resize",a)},stopAutoResizer:function(){if(!l)return;l=!1,s.disconnect(),e.removeEventListener("resize",a)},updateHeight:function(e){void 0===e&&(e=null);null===e&&(e=Math.ceil(o.documentElement.getBoundingClientRect().height));e!==n&&(t.send("setHeight",e),n=e)}};return u}var d=["getTask","getTasks","createTask","updateTask","deleteTask"];function p(e,t,n,o){var i=t.sys,s=new a(i),l=t.metadata;e.addHandler("sysChanged",(function(e){i=e,s.dispatch(i)}));var u={};return d.forEach((function(t){u[t]=function(){for(var n=[],r=0;r<arguments.length;r++)n[r]=arguments[r];return e.call("callEntryMethod",t,n)}})),r(r({getSys:function(){return i},onSysChanged:function(e){return s.attach(e)},fields:n.reduce((function(e,t){return e[t.id]=o(t),e}),{})},l?{metadata:l}:{}),u)}var f=["getContentType","getEntry","getEntrySnapshots","getAsset","getEditorInterface","getPublishedEntries","getPublishedAssets","getContentTypes","getEntries","getEditorInterfaces","getAssets","createContentType","createEntry","createAsset","updateContentType","updateEntry","updateAsset","deleteContentType","deleteEntry","deleteAsset","publishEntry","publishAsset","unpublishEntry","unpublishAsset","archiveEntry","archiveAsset","unarchiveEntry","unarchiveAsset","createUpload","processAsset","waitUntilAssetProcessed","getUsers","getAllScheduledActions","getEntityScheduledActions","signRequest","createTag","readTags","updateTag","deleteTag"];function h(e,t){var n={};return f.forEach((function(t){n[t]=function(){for(var n=[],r=0;r<arguments.length;r++)n[r]=arguments[r];return e.call("callSpaceMethod",t,n)}})),n.getCachedContentTypes=function(){return function(){for(var e=0,t=0,n=arguments.length;t<n;t++)e+=arguments[t].length;var r=Array(e),o=0;for(t=0;t<n;t++)for(var i=arguments[t],a=0,s=i.length;a<s;a++,o++)r[o]=i[a];return r}(t)},n}var v=function(e){return"object"!=typeof(t=e)||null===t||Array.isArray(t)?{}:e;var t};function g(e,t){return{openAlert:n.bind(null,"alert"),openConfirm:n.bind(null,"confirm"),openPrompt:n.bind(null,"prompt"),openExtension:o,openCurrentApp:i,openCurrent:function(e){return t.app?i(e):o(r(r({},e),{id:t.extension}))},selectSingleEntry:a.bind(null,"Entry",!1),selectSingleAsset:a.bind(null,"Asset",!1),selectMultipleEntries:a.bind(null,"Entry",!0),selectMultipleAssets:a.bind(null,"Asset",!0)};function n(t,n){return e.call("openDialog",t,v(n))}function o(n){var o=v(n);if((o=r(r({},o),{id:o.id||t.extension})).id)return e.call("openDialog","extension",o);throw new Error("Extension ID not provided.")}function i(n){if(n=v(n),t.app){var o=r(r({},n),{id:t.app});return e.call("openDialog","app",o)}throw new Error("Not in the app context.")}function a(t,n,r){return(r=v(r)).entityType=t,r.multiple=n,e.call("openDialog","entitySelector",r)}}function y(e,t){var n=new a(void 0),r=new a(void 0);return e.addHandler("localeSettingsChanged",(function(e){n.dispatch(e)})),e.addHandler("showDisabledFieldsChanged",(function(e){r.dispatch(e)})),{editorInterface:t,onLocaleSettingsChanged:function(e){return n.attach(e)},onShowDisabledFieldsChanged:function(e){return r.attach(e)}}}function _(e,t){var n=new o;return e.addHandler("navigateSlideIn",(function(e){n.dispatch(e)})),{openEntry:function(t,n){return e.call("navigateToContentEntity",r(r({},n),{entityType:"Entry",id:t}))},openNewEntry:function(t,n){return e.call("navigateToContentEntity",r(r({},n),{entityType:"Entry",id:null,contentTypeId:t}))},openBulkEditor:function(t,n){return e.call("navigateToBulkEditor",r({entryId:t},n))},openAsset:function(t,n){return e.call("navigateToContentEntity",r(r({},n),{entityType:"Asset",id:t}))},openNewAsset:function(t){return e.call("navigateToContentEntity",r(r({},t),{entityType:"Asset",id:null}))},openPageExtension:function(n){return e.call("navigateToPage",r({type:"extension",id:t.extension},n))},openCurrentAppPage:function(n){return e.call("navigateToPage",r({type:"app",id:t.app},n))},openAppConfig:function(){return e.call("navigateToAppConfig")},openEntriesList:function(){return e.call("navigateToSpaceEnvRoute",{route:"entries"})},openAssetsList:function(){return e.call("navigateToSpaceEnvRoute",{route:"assets"})},onSlideInNavigation:function(e){return n.attach(e)}}}var E="preInstall",m="postInstall",A=function(e){return"object"==typeof e&&null!==e&&!Array.isArray(e)},C=function(e){return"function"==typeof e},T=function(e){return console.error(e),Promise.resolve(!1)},I=function(e,t,n){if(!C(e))return Promise.resolve(t);var r;try{r=void 0===n?e():e(n)}catch(e){return T(e)}var o,i=r;return A(o=i)&&C(o.then)||(i=Promise.resolve(i)),i.then((function(e){return e instanceof Error?Promise.reject(e):!1!==e&&(A(e)?e:t)}),T).catch(T)};function w(e){var t,n=((t={}).preInstall=null,t.postInstall=null,t),r=function(e,t){if(!C(t))throw new Error("Handler must be a function.");n[e]=t};return e.addHandler("appHook",(function(t){var r=t.stage,o=t.installationRequestId,i=t.err;return r===E?I(n[r],{}).then((function(t){return e.send("appHookResult",{stage:r,installationRequestId:o,result:t})})):r===m?I(n[r],void 0,i||null).then((function(){return e.send("appHookResult",{stage:r,installationRequestId:o})})):Promise.resolve()})),{setReady:function(){return e.call("callAppMethod","setReady")},isInstalled:function(){return e.call("callAppMethod","isInstalled")},getParameters:function(){return e.call("callAppMethod","getParameters")},getCurrentState:function(){return e.call("callAppMethod","getCurrentState")},onConfigure:function(e){r(E,e)},onConfigurationCompleted:function(e){r(m,e)}}}var b,L={LOCATION_ENTRY_FIELD:"entry-field",LOCATION_ENTRY_FIELD_SIDEBAR:"entry-field-sidebar",LOCATION_ENTRY_SIDEBAR:"entry-sidebar",LOCATION_DIALOG:"dialog",LOCATION_ENTRY_EDITOR:"entry-editor",LOCATION_PAGE:"page",LOCATION_APP_CONFIG:"app-config"},O=[N,P,function(e,t){var n=t.field;if(!n)throw new Error('FieldAPI called for location without "field" property defined.');return{field:new l(e,n)}},H,D],S=((b={})[L.LOCATION_ENTRY_FIELD]=O,b[L.LOCATION_ENTRY_FIELD_SIDEBAR]=O,b[L.LOCATION_ENTRY_SIDEBAR]=[N,P,H,D],b[L.LOCATION_ENTRY_EDITOR]=[N,P,H],b[L.LOCATION_DIALOG]=[N,function(e){return{close:function(t){return e.send("closeDialog",t)}}},D],b[L.LOCATION_PAGE]=[N],b[L.LOCATION_APP_CONFIG]=[N,function(e){return{app:w(e)}}],b);function N(e,t){var n=t.user,r=t.parameters,o=t.locales,i=t.ids,a=t.initialContentTypes,s=t.location||L.LOCATION_ENTRY_FIELD;return{location:{is:function(e){return s===e}},user:n,parameters:r,locales:{available:o.available,default:o.default,names:o.names,fallbacks:o.fallbacks,optional:o.optional,direction:o.direction},space:h(e,a),dialogs:g(e,i),navigator:_(e,i),notifier:{success:function(t){return e.send("notify",{type:"success",message:t})},error:function(t){return e.send("notify",{type:"error",message:t})}},ids:i,access:{can:function(t,n){return e.call("checkAccess",t,n)},canEditAppConfig:function(){return e.call("checkAppConfigAccess")}}}}function D(e,t,n){return{window:c(n,e)}}function H(e,t){return{editor:y(e,t.editorInterface)}}function P(e,t){var n=t.locales,r=t.contentType,o=t.entry,i=t.fieldInfo;return{contentType:r,entry:p(e,o,i,(function(t){return new u(e,t,n.default)}))}}var R,x,F,k,M=(R=window,x=function(e,t,n){return(S[t.location]||O).reduce((function(o,i){return r(r({},o),i(e,t,n))}),{})},(F={promise:null,resolve:null}).promise=new Promise((function(e){F.resolve=e})),(k=F).promise.then((function(e){var t=e[0],n=R.document;n.addEventListener("focus",(function(){return t.send("setActive",!0)}),!0),n.addEventListener("blur",(function(){return t.send("setActive",!1)}),!0)})),function(e,t){!function(e,t){function n(r){var o=r.data;"connect"===o.method&&(e.removeEventListener("message",n),t.apply(void 0,o.params))}e.addEventListener("message",n)}(e,(function(n,r){var o=new s(n.id,e);t(o,n,r)}))}(R,(function(){for(var e=[],t=0;t<arguments.length;t++)e[t]=arguments[t];return k.resolve(e)})),function(e,t){var n=void 0===t?{supressIframeWarning:!1}:t,r=n.makeCustomApi;n.supressIframeWarning||R.self!==R.top||console.error("Cannot use ui-extension-sdk outside of Contenful:\n\nIn order for the ui-extension-sdk to function correctly, your app needs to be run in an iframe in the Contentful Web App.\n\nLearn more about local development with the ui-extension-sdk here:\n  https://www.contentful.com/developers/docs/extensibility/ui-extensions/faq/#how-can-i-use-the-ui-extension-sdk-locally"),k.promise.then((function(t){var n,o=t[0],i=t[1],a=t[2],s=x(o,i,R);"function"==typeof r&&(n=r(o,i)),a.forEach((function(e){o._handleMessage(e)})),e(s,n)}))});e.init=M,e.locations=L,Object.defineProperty(e,"__esModule",{value:!0})})),window.contentfulApp=window.contentfulExtension;
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).contentfulExtension={})}(this,(function(e){"use strict";var t=function(e,n){return(t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n])})(e,n)};var n,r=function(){return(r=Object.assign||function(e){for(var t,n=1,r=arguments.length;n<r;n++)for(var o in t=arguments[n])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};var o=function(){function e(){this._id=0,this._listeners={}}return e.prototype.dispatch=function(){for(var e,t=[],n=0;n<arguments.length;n++)t[n]=arguments[n];for(var r in this._listeners)(e=this._listeners)[r].apply(e,t)},e.prototype.attach=function(e){var t=this;if("function"!=typeof e)throw new Error("listener function expected");var n=this._id++;return this._listeners[n]=e,function(){return delete t._listeners[n]}},e}(),i="__private__memoized__arguments__",a=function(e){function r(){for(var t=[],r=0;r<arguments.length;r++)t[r]=arguments[r];var o=e.call(this)||this;if(o[n]=[],!t.length)throw new Error("Initial value to be memoized expected");return o[i]=t,o}return function(e,n){if("function"!=typeof n&&null!==n)throw new TypeError("Class extends value "+String(n)+" is not a constructor or null");function r(){this.constructor=e}t(e,n),e.prototype=null===n?Object.create(n):(r.prototype=n.prototype,new r)}(r,e),r.prototype.dispatch=function(){for(var t=[],n=0;n<arguments.length;n++)t[n]=arguments[n];this[i]=t,e.prototype.dispatch.apply(this,t)},r.prototype.attach=function(t){var n=e.prototype.attach.call(this,t);return t.apply(void 0,this[i]),n},r}(o);n=i;var s=function(){function e(e,t){var n=this;this._messageHandlers={},this._responseHandlers={},this._send=function(e,t){var n=0;return function(r,o){var i=n++;try{t.postMessage({source:e,id:i,method:r,params:o},"*")}catch(e){throw e instanceof DOMException&&"DataCloneError"===e.name&&"openDialog"===r&&console.error("Error: openCurrent[App] parameters could not be parsed. You likely tried to pass functions or DOM elements as a parameter. Tip: Use the App SDK directly within the dialog location.\n\nLearn more about the dialog location: https://ctfl.io/app-sdk-dialog"),e}return i}}(e,t.parent),t.addEventListener("message",(function(e){n._handleMessage(e.data)}))}return e.prototype.call=function(e){for(var t=this,n=[],r=1;r<arguments.length;r++)n[r-1]=arguments[r];var o=this._send(e,n);return new Promise((function(e,n){t._responseHandlers[o]={resolve:e,reject:n}}))},e.prototype.send=function(e){for(var t=[],n=1;n<arguments.length;n++)t[n-1]=arguments[n];this._send(e,t)},e.prototype.addHandler=function(e,t){return e in this._messageHandlers||(this._messageHandlers[e]=new o),this._messageHandlers[e].attach(t)},e.prototype._handleMessage=function(e){if(e.method){var t=e.method,n=e.params,r=this._messageHandlers[t];r&&r.dispatch.apply(r,n)}else{var o=e.id,i=this._responseHandlers[o];if(!i)return;"result"in e?i.resolve(e.result):"error"in e&&i.reject(e.error),delete this._responseHandlers[o]}},e}();var l=function(){function e(e,t){var n=this;this.id=t.id,this.locale=t.locale,this.type=t.type,this.required=t.required,this.validations=t.validations,this.items=t.items,this._value=t.value,this._valueSignal=new a(this._value),this._isDisabledSignal=new a(void 0),this._schemaErrorsChangedSignal=new a(void 0),this._channel=e,e.addHandler("valueChanged",(function(e,t,r){e!==n.id||t&&t!==n.locale||(n._value=r,n._valueSignal.dispatch(r))})),e.addHandler("isDisabledChangedForFieldLocale",(function(e,t,r){e===n.id&&t===n.locale&&n._isDisabledSignal.dispatch(r)})),e.addHandler("schemaErrorsChangedForFieldLocale",(function(e,t,r){e===n.id&&t===n.locale&&n._schemaErrorsChangedSignal.dispatch(r)}))}return e.prototype.getValue=function(){return this._value},e.prototype.setValue=function(e){return this._value=e,this._valueSignal.dispatch(e),this._channel.call("setValue",this.id,this.locale,e)},e.prototype.removeValue=function(){return this._value=void 0,this._channel.call("removeValue",this.id,this.locale)},e.prototype.setInvalid=function(e){return this._channel.call("setInvalid",e,this.locale)},e.prototype.onValueChanged=function(e){return this._valueSignal.attach(e)},e.prototype.onIsDisabledChanged=function(e){return this._isDisabledSignal.attach(e)},e.prototype.onSchemaErrorsChanged=function(e){return this._schemaErrorsChangedSignal.attach(e)},e}(),u=function(){function e(e,t,n){this.id=t.id,this.locales=t.locales,this.type=t.type,this.required=t.required,this.validations=t.validations,this.items=t.items,this._defaultLocale=n,this._fieldLocales=t.locales.reduce((function(n,o){var i,a=new l(e,{id:t.id,type:t.type,required:t.required,validations:t.validations,items:t.items,locale:o,value:t.values[o]});return r(r({},n),((i={})[o]=a,i))}),{}),this.assertHasLocale(n)}return e.prototype.getValue=function(e){return this._getFieldLocale(e).getValue()},e.prototype.setValue=function(e,t){return this._getFieldLocale(t).setValue(e)},e.prototype.removeValue=function(e){return this.setValue(void 0,e)},e.prototype.onValueChanged=function(e,t){var n=t||e;return t||(e=""),this._getFieldLocale(e).onValueChanged(n)},e.prototype.onIsDisabledChanged=function(e,t){var n=t||e;return t||(e=""),this._getFieldLocale(e).onIsDisabledChanged(n)},e.prototype._getFieldLocale=function(e){return e=e||this._defaultLocale,this.assertHasLocale(e),this._fieldLocales[e]},e.prototype.getForLocale=function(e){if(!e)throw new Error("getForLocale must be passed a locale");return this._getFieldLocale(e)},e.prototype.assertHasLocale=function(e){if(!this._fieldLocales[e])throw new Error('Unknown locale "'+e+'" for field "'+this.id+'"')},e}();function c(e,t){var n,r=e,o=r.document,i=r.MutationObserver,a=function(){u.updateHeight()},s=new i(a),l=!1,u={startAutoResizer:function(){if(u.updateHeight(),l)return;l=!0,s.observe(o.body,{attributes:!0,childList:!0,subtree:!0,characterData:!0}),e.addEventListener("resize",a)},stopAutoResizer:function(){if(!l)return;l=!1,s.disconnect(),e.removeEventListener("resize",a)},updateHeight:function(e){void 0===e&&(e=null);null===e&&(e=Math.ceil(o.documentElement.getBoundingClientRect().height));e!==n&&(t.send("setHeight",e),n=e)}};return u}var d=["getTask","getTasks","createTask","updateTask","deleteTask"];function p(e,t,n,o){var i=t.sys,s=new a(i),l=t.metadata,u=new a(l);e.addHandler("sysChanged",(function(e){i=e,s.dispatch(i)})),e.addHandler("metadataChanged",(function(e){l=e,u.dispatch(l)}));var c={};return d.forEach((function(t){c[t]=function(){for(var n=[],r=0;r<arguments.length;r++)n[r]=arguments[r];return e.call("callEntryMethod",t,n)}})),r(r(r({getSys:function(){return i},onSysChanged:function(e){return s.attach(e)},fields:n.reduce((function(e,t){return e[t.id]=o(t),e}),{})},l?{metadata:l}:{}),{getMetadata:function(){return l},onMetadataChanged:function(e){return u.attach(e)}}),c)}var f=["getContentType","getEntry","getEntrySnapshots","getAsset","getEditorInterface","getPublishedEntries","getPublishedAssets","getContentTypes","getEntries","getEditorInterfaces","getAssets","createContentType","createEntry","createAsset","updateContentType","updateEntry","updateAsset","deleteContentType","deleteEntry","deleteAsset","publishEntry","publishAsset","unpublishEntry","unpublishAsset","archiveEntry","archiveAsset","unarchiveEntry","unarchiveAsset","createUpload","processAsset","waitUntilAssetProcessed","getUsers","getAllScheduledActions","getEntityScheduledActions","signRequest","createTag","readTags","updateTag","deleteTag","getTeams"];function h(e,t){var n={};return f.forEach((function(t){n[t]=function(){for(var n=[],r=0;r<arguments.length;r++)n[r]=arguments[r];return console.warn("You called "+String(t)+" on the Space API. Since version 4.0.0 the Space API and its methods are deprecated. We recommend that you use the CMA client instead. See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details."),e.call("callSpaceMethod",t,n)}})),n.getCachedContentTypes=function(){return function(e,t){for(var n=0,r=t.length,o=e.length;n<r;n++,o++)e[o]=t[n];return e}([],t)},n}var g=function(e){return"object"!=typeof(t=e)||null===t||Array.isArray(t)?{}:e;var t};function v(e,t){return{openAlert:n.bind(null,"alert"),openConfirm:n.bind(null,"confirm"),openPrompt:n.bind(null,"prompt"),openExtension:o,openCurrentApp:i,openCurrent:function(e){return t.app?i(e):o(r(r({},e),{id:t.extension}))},selectSingleEntry:a.bind(null,"Entry",!1),selectSingleAsset:a.bind(null,"Asset",!1),selectMultipleEntries:a.bind(null,"Entry",!0),selectMultipleAssets:a.bind(null,"Asset",!0)};function n(t,n){return e.call("openDialog",t,g(n))}function o(n){var o=g(n);if((o=r(r({},o),{id:o.id||t.extension})).id)return e.call("openDialog","extension",o);throw new Error("Extension ID not provided.")}function i(n){if(n=g(n),t.app){var o=r(r({},n),{id:t.app});return e.call("openDialog","app",o)}throw new Error("Not in the app context.")}function a(t,n,r){return(r=g(r)).entityType=t,r.multiple=n,e.call("openDialog","entitySelector",r)}}function y(e,t){var n=new a(void 0),r=new a(void 0);return e.addHandler("localeSettingsChanged",(function(e){n.dispatch(e)})),e.addHandler("showDisabledFieldsChanged",(function(e){r.dispatch(e)})),{editorInterface:t,onLocaleSettingsChanged:function(e){return n.attach(e)},onShowDisabledFieldsChanged:function(e){return r.attach(e)}}}function _(e,t){var n=new o;return e.addHandler("navigateSlideIn",(function(e){n.dispatch(e)})),{openEntry:function(t,n){return e.call("navigateToContentEntity",r(r({},n),{entityType:"Entry",id:t}))},openNewEntry:function(t,n){return e.call("navigateToContentEntity",r(r({},n),{entityType:"Entry",id:null,contentTypeId:t}))},openBulkEditor:function(t,n){return e.call("navigateToBulkEditor",r({entryId:t},n))},openAsset:function(t,n){return e.call("navigateToContentEntity",r(r({},n),{entityType:"Asset",id:t}))},openNewAsset:function(t){return e.call("navigateToContentEntity",r(r({},t),{entityType:"Asset",id:null}))},openPageExtension:function(n){return e.call("navigateToPage",r({type:"extension",id:t.extension},n))},openCurrentAppPage:function(n){return e.call("navigateToPage",r({type:"app",id:t.app},n))},openAppConfig:function(){return e.call("navigateToAppConfig")},openEntriesList:function(){return e.call("navigateToSpaceEnvRoute",{route:"entries"})},openAssetsList:function(){return e.call("navigateToSpaceEnvRoute",{route:"assets"})},onSlideInNavigation:function(e){return n.attach(e)}}}var m="preInstall",E="postInstall",A=function(e){return"object"==typeof e&&null!==e&&!Array.isArray(e)},C=function(e){return"function"==typeof e},T=function(e){return console.error(e),Promise.resolve(!1)},w=function(e,t,n){if(!C(e))return Promise.resolve(t);var r;try{r=void 0===n?e():e(n)}catch(e){return T(e)}var o,i=r;return A(o=i)&&C(o.then)||(i=Promise.resolve(i)),i.then((function(e){return e instanceof Error?Promise.reject(e):!1!==e&&(A(e)?e:t)}),T).catch(T)};function I(e){var t,n=((t={}).preInstall=null,t.postInstall=null,t),r=function(e,t){if(!C(t))throw new Error("Handler must be a function.");n[e]=t};return e.addHandler("appHook",(function(t){var r=t.stage,o=t.installationRequestId,i=t.err;return r===m?w(n[r],{}).then((function(t){return e.send("appHookResult",{stage:r,installationRequestId:o,result:t})})):r===E?w(n[r],void 0,i||null).then((function(){return e.send("appHookResult",{stage:r,installationRequestId:o})})):Promise.resolve()})),{setReady:function(){return e.call("callAppMethod","setReady")},isInstalled:function(){return e.call("callAppMethod","isInstalled")},getParameters:function(){return e.call("callAppMethod","getParameters")},getCurrentState:function(){return e.call("callAppMethod","getCurrentState")},onConfigure:function(e){r(m,e)},onConfigurationCompleted:function(e){r(E,e)}}}var b,L={LOCATION_ENTRY_FIELD:"entry-field",LOCATION_ENTRY_FIELD_SIDEBAR:"entry-field-sidebar",LOCATION_ENTRY_SIDEBAR:"entry-sidebar",LOCATION_DIALOG:"dialog",LOCATION_ENTRY_EDITOR:"entry-editor",LOCATION_PAGE:"page",LOCATION_APP_CONFIG:"app-config"},O=function(e){return function(t){return e.call("CMAAdapterCall",t)}};function S(e){return{makeRequest:O(e)}}var D=[N,k,function(e,t){var n=t.field;if(!n)throw new Error('FieldAPI called for location without "field" property defined.');return{field:new l(e,n)}},R,P],H=((b={})[L.LOCATION_ENTRY_FIELD]=D,b[L.LOCATION_ENTRY_FIELD_SIDEBAR]=D,b[L.LOCATION_ENTRY_SIDEBAR]=[N,k,R,P],b[L.LOCATION_ENTRY_EDITOR]=[N,k,R],b[L.LOCATION_DIALOG]=[N,function(e){return{close:function(t){return e.send("closeDialog",t)}}},P],b[L.LOCATION_PAGE]=[N],b[L.LOCATION_APP_CONFIG]=[N,function(e){return{app:I(e)}}],b);function N(e,t){var n=t.user,r=t.parameters,o=t.locales,i=t.ids,a=t.initialContentTypes,s=t.location||L.LOCATION_ENTRY_FIELD;return{cmaAdapter:S(e),location:{is:function(e){return s===e}},user:n,parameters:r,locales:{available:o.available,default:o.default,names:o.names,fallbacks:o.fallbacks,optional:o.optional,direction:o.direction},space:h(e,a),dialogs:v(e,i),navigator:_(e,i),notifier:{success:function(t){return e.send("notify",{type:"success",message:t})},error:function(t){return e.send("notify",{type:"error",message:t})}},ids:i,access:{can:function(t,n,r){return e.call("checkAccess",t,n,r)},canEditAppConfig:function(){return e.call("checkAppConfigAccess")}}}}function P(e,t,n){return{window:c(n,e)}}function R(e,t){return{editor:y(e,t.editorInterface)}}function k(e,t){var n=t.locales,r=t.contentType,o=t.entry,i=t.fieldInfo;return{contentType:r,entry:p(e,o,i,(function(t){return new u(e,t,n.default)}))}}var x,F,M,V,j=(x=window,F=function(e,t,n){return(H[t.location]||D).reduce((function(o,i){return r(r({},o),i(e,t,n))}),{})},(M={promise:null,resolve:null}).promise=new Promise((function(e){M.resolve=e})),(V=M).promise.then((function(e){var t=e[0],n=x.document;n.addEventListener("focus",(function(){return t.send("setActive",!0)}),!0),n.addEventListener("blur",(function(){return t.send("setActive",!1)}),!0)})),function(e,t){!function(e,t){function n(r){var o=r.data;"connect"===o.method&&(e.removeEventListener("message",n),t.apply(void 0,o.params))}e.addEventListener("message",n)}(e,(function(n,r){var o=new s(n.id,e);t(o,n,r)}))}(x,(function(){for(var e=[],t=0;t<arguments.length;t++)e[t]=arguments[t];return V.resolve(e)})),function(e,t){var n=void 0===t?{supressIframeWarning:!1}:t,r=n.makeCustomApi;n.supressIframeWarning||x.self!==x.top||console.error("Cannot use ui-extension-sdk outside of Contenful:\n\nIn order for the ui-extension-sdk to function correctly, your app needs to be run in an iframe in the Contentful Web App.\n\nLearn more about local development with the ui-extension-sdk here:\n  https://www.contentful.com/developers/docs/extensibility/ui-extensions/faq/#how-can-i-use-the-ui-extension-sdk-locally"),V.promise.then((function(t){var n,o=t[0],i=t[1],a=t[2],s=F(o,i,x);"function"==typeof r&&(n=r(o,i)),a.forEach((function(e){o._handleMessage(e)})),e(s,n)}))});e.init=j,e.locations=L,Object.defineProperty(e,"__esModule",{value:!0})})),window.contentfulApp=window.contentfulExtension;

package/dist/cf-extension.css

@@ -14,6 +14,8 @@ body {
   font-size: 14px;
   line-height: 18px;
   color: #2d2f31;
+  
+  background-image: url("https://api.contentful.com/uie-tracking");
 }
 b,
 strong {

package/dist/cmaAdapter.d.ts

@@ -0,0 +1,3 @@
+import { Channel } from './channel';
+import { Adapter } from 'contentful-management/types';
+export declare function createAdapter(channel: Channel): Adapter;

package/dist/types/api.types.d.ts

@@ -1,13 +1,14 @@
-import { ContentType, EditorInterface, SpaceMembership, Role } from './entities';
+import { ContentType, EditorInterface, SpaceMembership, Role, ContentTypeField, Metadata, Entry, Task, Asset } from './entities';
 import { EntryAPI } from './entry.types';
 import { SpaceAPI } from './space.types';
 import { WindowAPI } from './window.types';
-import { ContentEntitySys, Metadata } from './utils';
+import { ContentEntitySys, Link } from './utils';
 import { FieldAPI } from './field-locale.types';
 import { DialogsAPI } from './dialogs.types';
 import { AppConfigAPI } from './app.types';
 import { NavigatorAPI } from './navigator.types';
 import { EntryFieldInfo, FieldInfo } from './field.types';
+import { Adapter } from 'contentful-management/types';
 export interface UserAPI {
     sys: {
         id: string;
@@ -52,7 +53,7 @@ export interface NotifierAPI {
     error: (message: string) => void;
 }
 export interface LocationAPI {
-    /** Checks the location in which your extension is running */
+    /** Checks the location in which your app is running */
     is: (type: string) => boolean;
 }
 export interface ParametersAPI {
@@ -71,6 +72,22 @@ export interface IdsAPI {
     entry: string;
     contentType: string;
 }
+/** Content API */
+export interface ContentTypeAPI {
+    sys: {
+        id: string;
+        type: 'ContentType';
+        revision: number;
+        space: Link<'Space', 'Link'>;
+        environment: Link<'Environment', 'Link'>;
+        createdAt?: string;
+        updatedAt?: string;
+    };
+    fields: ContentTypeField[];
+    name: string;
+    displayField: string;
+    description: string;
+}
 export interface EditorLocaleSettings {
     mode: 'multi' | 'single';
     focused?: string;
@@ -85,21 +102,31 @@ export interface SharedEditorSDK {
     /** Allows to read and update the value of any field of the current entry and to get the entry's metadata */
     entry: EntryAPI;
     /** Information about the content type of the entry. */
-    contentType: ContentType;
+    contentType: ContentTypeAPI;
 }
 declare type CrudAction = 'create' | 'read' | 'update' | 'delete';
 declare type PublishableAction = 'publish' | 'unpublish';
 declare type ArchiveableAction = 'archive' | 'unarchive';
+export declare type JSONPatchItem = {
+    op: 'remove' | 'replace' | 'add';
+    path: string;
+    value?: any;
+};
+declare type PatchEntity = Entry | Task | Asset;
 export interface AccessAPI {
     can(action: 'read' | 'update', entity: 'EditorInterface' | EditorInterface): Promise<boolean>;
     can<T = Object>(action: CrudAction, entity: 'ContentType' | ContentType | 'Asset' | 'Entry' | T): Promise<boolean>;
     can<T = Object>(action: PublishableAction, entity: 'ContentType' | ContentType | 'Asset' | 'Entry' | T): Promise<boolean>;
     can<T = Object>(action: ArchiveableAction, entity: 'Asset' | 'Entry' | T): Promise<boolean>;
+    can(action: 'update', entity: PatchEntity, patch: JSONPatchItem[]): Promise<boolean>;
     /** Whether the current user can edit app config */
     canEditAppConfig: () => Promise<boolean>;
 }
+declare type EntryScopedIds = 'field' | 'entry' | 'contentType';
 export interface BaseExtensionSDK {
-    /** Exposes methods that allow the extension to read and manipulate a wide range of objects in the space. */
+    /** @deprecated since version 4.0.0 consider using the CMA instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     space: SpaceAPI;
     /** Information about the current user and roles */
     user: UserAPI;
@@ -111,46 +138,48 @@ export interface BaseExtensionSDK {
     navigator: NavigatorAPI;
     /** Methods for displaying notifications. */
     notifier: NotifierAPI;
-    /** Exposes extension configuration parameters */
+    /** Exposes app configuration parameters */
     parameters: ParametersAPI;
-    /** Exposes method to identify extension's location */
+    /** Exposes method to identify app's location */
     location: LocationAPI;
     /** Exposes methods for checking user's access level */
     access: AccessAPI;
     /** Exposes relevant ids, keys may be ommited based on location */
-    ids: IdsAPI;
+    ids: Omit<IdsAPI, EntryScopedIds>;
+    /** Adapter to be injected in contentful-management client */
+    cmaAdapter: Adapter;
 }
 export declare type EditorExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & {
-    /** A set of IDs actual for the extension */
+    /** A set of IDs actual for the app */
     ids: Omit<IdsAPI, 'field'>;
 };
 export declare type SidebarExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & {
-    /** A set of IDs actual for the extension */
+    /** A set of IDs actual for the app */
     ids: Omit<IdsAPI, 'field'>;
-    /** Methods to update the size of the iframe the extension is contained within.  */
+    /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
 export declare type FieldExtensionSDK = BaseExtensionSDK & SharedEditorSDK & {
-    /** Gives you access to the value and metadata of the field the extension is attached to. */
+    /** Gives you access to the value and metadata of the field the app is attached to. */
     field: FieldAPI;
-    /** Methods to update the size of the iframe the extension is contained within.  */
+    /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
 export declare type DialogExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
-    /** A set of IDs actual for the extension */
-    ids: Omit<IdsAPI, 'field' | 'entry' | 'contentType'>;
-    /** Closes the dialog and resolves openExtension promise with data */
+    /** A set of IDs actual for the app */
+    ids: Omit<IdsAPI, EntryScopedIds>;
+    /** Closes the dialog and resolves openCurrentApp promise with data */
     close: (data?: any) => void;
-    /** Methods to update the size of the iframe the extension is contained within.  */
+    /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
 export declare type PageExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
-    /** A set of IDs actual for the extension */
-    ids: Omit<IdsAPI, 'field' | 'entry' | 'contentType'>;
+    /** A set of IDs actual for the app */
+    ids: Omit<IdsAPI, EntryScopedIds>;
 };
 export declare type AppExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
     /** A set of IDs actual for the app */
-    ids: Omit<IdsAPI, 'extension' | 'field' | 'entry' | 'contentType' | 'app'> & {
+    ids: Omit<IdsAPI, EntryScopedIds | 'extension' | 'app'> & {
         app: string;
     };
     app: AppConfigAPI;
@@ -173,7 +202,7 @@ export interface ConnectMessage {
     user: UserAPI;
     initialContentTypes: ContentType[];
     ids: IdsAPI;
-    contentType: ContentType;
+    contentType: ContentTypeAPI;
     editorInterface?: EditorInterface;
     entry: {
         sys: ContentEntitySys;

package/dist/types/app.types.d.ts

@@ -1,4 +1,4 @@
-import { ContentType } from './entities';
+import { ContentType, KeyValueMap } from './entities';
 interface AppStateEditorInterfaceItem {
     controls?: Array<{
         fieldId: string;
@@ -20,6 +20,11 @@ interface AppStateEditorInterfaceItem {
 export interface AppState {
     EditorInterface: Record<ContentType['sys']['id'], AppStateEditorInterfaceItem>;
 }
+export declare type OnConfigureHandlerReturn = {
+    parameters?: KeyValueMap | null;
+    targetState?: AppState | null;
+} | false;
+export declare type OnConfigureHandler = () => OnConfigureHandlerReturn | Promise<OnConfigureHandlerReturn>;
 export interface AppConfigAPI {
     /** Tells the web app that the app is loaded */
     setReady: () => Promise<void>;
@@ -28,10 +33,12 @@ export interface AppConfigAPI {
     /** Returns current state of an App */
     getCurrentState: () => Promise<AppState | null>;
     /** Returns parameters of an App, null otherwise */
-    getParameters: <T = Object>() => Promise<null | T>;
+    getParameters: <T extends KeyValueMap = KeyValueMap>() => Promise<null | T>;
     /** Registers a handler to be called to produce parameters for an App */
-    onConfigure: (handler: Function) => void;
+    onConfigure: (handler: OnConfigureHandler) => void;
     /** Registers a handler to be called once configuration was finished */
-    onConfigurationCompleted: (handler: Function) => void;
+    onConfigurationCompleted: (handler: (err: null | {
+        message: string;
+    }) => void) => void;
 }
 export {};

package/dist/types/dialogs.types.d.ts

@@ -39,7 +39,7 @@ export interface DialogsAPI {
     openExtension: (options: OpenCustomWidgetOptions) => Promise<any>;
     /** Opens the current app in a dialog */
     openCurrentApp: (options?: Omit<OpenCustomWidgetOptions, 'id'>) => Promise<any>;
-    /** Opens the current extension or app in a dialog */
+    /** Opens the current app or extension in a dialog */
     openCurrent: (options?: Omit<OpenCustomWidgetOptions, 'id'> | OpenCustomWidgetOptions) => Promise<any>;
     /** Opens a dialog for selecting a single entry. */
     selectSingleEntry: <T = Object>(options?: {

package/dist/types/entities.d.ts

@@ -1,4 +1,4 @@
-export type { TagProps as Tag, TagVisibility, UserProps as User, AssetProps as Asset, TaskProps as Task, ScheduledActionProps as ScheduledAction, ContentTypeProps as ContentType, EditorInterfaceProps as EditorInterface, SpaceMembershipProps as SpaceMembership, ContentFields as ContentTypeField, EntryProps as Entry, RoleProps as Role, KeyValueMap, } from 'contentful-management/types';
+export type { TagProps as Tag, TeamProps as Team, UserProps as User, AssetProps as Asset, TaskProps as Task, ScheduledActionProps as ScheduledAction, ContentTypeProps as ContentType, EditorInterfaceProps as EditorInterface, SpaceMembershipProps as SpaceMembership, ContentFields as ContentTypeField, ContentTypeFieldValidation, EntryProps as Entry, RoleProps as Role, KeyValueMap, QueryOptions, TagVisibility, MetadataProps as Metadata, UploadProps as Upload, } from 'contentful-management/types';
 export interface CanonicalRequest {
     method: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
     path: string;

package/dist/types/entry.types.d.ts

@@ -1,11 +1,13 @@
-import { Task } from './entities';
+import { Metadata, Task } from './entities';
 import { EntryFieldAPI } from './field.types';
-import { CollectionResponse, ContentEntitySys, Metadata } from './utils';
+import { CollectionResponse, ContentEntitySys } from './utils';
 declare type TaskState = 'active' | 'resolved';
 export interface TaskInputData {
     assignedToId: string;
+    assignedToType?: 'User' | 'Team';
     body: string;
     status: TaskState;
+    dueDate?: string;
 }
 /** Allows accessing the Task API for the current entry. */
 export interface TaskAPI {
@@ -19,7 +21,7 @@ export interface EntryAPI extends TaskAPI {
     /** Returns sys for an entry. */
     getSys: () => ContentEntitySys;
     /** Calls the callback with sys every time that sys changes. */
-    onSysChanged: (callback: (sys: ContentEntitySys) => void) => Function;
+    onSysChanged: (callback: (sys: ContentEntitySys) => void) => () => void;
     /** Allows to control the values of all other fields in the current entry. */
     fields: {
         [key: string]: EntryFieldAPI;
@@ -29,5 +31,7 @@ export interface EntryAPI extends TaskAPI {
      * @deprecated
      */
     metadata?: Metadata;
+    getMetadata: () => Metadata | undefined;
+    onMetadataChanged: (callback: (metadata?: Metadata) => void) => VoidFunction;
 }
 export {};

package/dist/types/field-locale.types.d.ts

@@ -1,32 +1,37 @@
-import type { Items } from './utils';
+import { ContentTypeFieldValidation } from './entities';
+import type { Items, SerializedJSONValue } from './utils';
+import { ValidationError } from './validation-error';
 export interface FieldAPI {
     /** The ID of a field is defined in an entry's content type. */
     id: string;
-    /** The current locale of a field the extension is attached to. */
+    /** The current locale of a field the app is attached to. */
     locale: string;
-    /** Holds the type of the field the extension is attached to. */
+    /** Holds the type of the field the app is attached to. */
     type: string;
     /** Indicates if a value for this field is required */
     required: boolean;
     /** A list of validations for this field that are defined in the content type. */
-    validations: Object[];
+    validations: ContentTypeFieldValidation[];
     /** Defines the shape of array items */
     items?: Items;
     /** Gets the current value of the field and locale. */
     getValue: () => any;
     /** Sets the value for the field and locale.  */
-    setValue: (value: any) => Promise<any>;
+    setValue: <Value = any>(value: Value) => Promise<SerializedJSONValue | undefined>;
     /** Removes the value for the field and locale. */
     removeValue: () => Promise<void>;
     /** Communicates to the web application if the field is in a valid state or not. */
     setInvalid: (value: boolean) => void;
     /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called.
-     *  the returned function can be called to remove the handler function */
+     *  the returned function can be called to remove the handler function
+     **/
     onValueChanged: (callback: (value: any) => void) => () => void;
     /** Calls the callback when the disabled status of the field changes.
-     *  the returned function can be called to remove the handler function */
+     *  the returned function can be called to remove the handler function
+     **/
     onIsDisabledChanged: (callback: (isDisabled: boolean) => void) => () => void;
     /** Calls the callback immediately with the current validation errors and whenever the field is re-validated.
-     *  the returned function can be called to remove the handler function */
-    onSchemaErrorsChanged: (callback: (errors: Error[]) => void) => () => void;
+     *  the returned function can be called to remove the handler function
+     **/
+    onSchemaErrorsChanged: (callback: (errors: ValidationError[]) => void) => () => void;
 }

package/dist/types/field.types.d.ts

@@ -1,11 +1,12 @@
-import { Items } from './utils';
+import { Items, SerializedJSONValue } from './utils';
 import { FieldAPI } from './field-locale.types';
+import { ContentTypeFieldValidation } from './entities';
 export interface FieldInfo {
     id: string;
     locale: string;
     type: string;
     required: boolean;
-    validations: Object[];
+    validations: ContentTypeFieldValidation[];
     items?: Items;
     value: any;
 }
@@ -14,7 +15,7 @@ export interface EntryFieldInfo {
     locales: string[];
     type: string;
     required: boolean;
-    validations: Object[];
+    validations: ContentTypeFieldValidation[];
     items?: Items;
     values: {
         [locale: string]: any;
@@ -30,29 +31,31 @@ export interface EntryFieldAPI {
     /** Indicates if a value for this field is required */
     required: boolean;
     /** A list of validations for this field that are defined in the content type. */
-    validations: Object[];
+    validations: ContentTypeFieldValidation[];
     /** Defines the shape of array items */
     items?: Items;
     /** Gets the current value of the field and locale. */
     getValue: (locale?: string) => any;
     /** Sets the value for the field and locale.  */
-    setValue: (value: any, locale?: string) => Promise<any>;
+    setValue: <Value = any>(value: Value, locale?: string) => Promise<SerializedJSONValue | undefined>;
     /** Removes the value for the field and locale. */
     removeValue: (locale?: string) => Promise<void>;
     /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called.
-     *  the returned function can be called to remove the handler function */
+     *  the returned function can be called to remove the handler function
+     **/
     onValueChanged: {
         (callback: (value: any) => void): () => void;
         (locale: string, callback: (value: any) => void): () => void;
     };
     /** Calls the callback when the disabled status of the field changes.
-     *  the returned function can be called to remove the handler function */
+     *  the returned function can be called to remove the handler function
+     **/
     onIsDisabledChanged: {
         (callback: (isDisabled: boolean) => void): () => void;
         (locale: string, callback: (isDisabled: boolean) => void): () => void;
-        (...args: any[]): () => void;
     };
     /** Get an instance of FieldAPI for this field, specific to the locale that is
-     * passed as an argument */
+     * passed as an argument
+     **/
     getForLocale: (locale: string) => FieldAPI;
 }

package/dist/types/index.d.ts

@@ -1,11 +1,11 @@
-export type { AccessAPI, AppExtensionSDK, BaseExtensionSDK, ConnectMessage, DialogExtensionSDK, EditorExtensionSDK, EditorLocaleSettings, FieldExtensionSDK, IdsAPI, KnownSDK, LocalesAPI, LocationAPI, Locations, NotifierAPI, PageExtensionSDK, ParametersAPI, SharedEditorSDK, SidebarExtensionSDK, UserAPI, } from './api.types';
-export type { AppConfigAPI, AppState } from './app.types';
+export type { AccessAPI, AppExtensionSDK, BaseExtensionSDK, ConnectMessage, ContentTypeAPI, DialogExtensionSDK, EditorExtensionSDK, EditorLocaleSettings, FieldExtensionSDK, IdsAPI, KnownSDK, LocalesAPI, LocationAPI, Locations, NotifierAPI, PageExtensionSDK, ParametersAPI, SharedEditorSDK, SidebarExtensionSDK, UserAPI, JSONPatchItem, } from './api.types';
+export type { AppConfigAPI, AppState, OnConfigureHandler, OnConfigureHandlerReturn, } from './app.types';
 export type { DialogsAPI, EntityDialogOptions, OpenAlertOptions, OpenConfirmOptions, OpenCustomWidgetOptions, } from './dialogs.types';
-export type { User, Asset, ContentType, CanonicalRequest, EditorInterface, ContentTypeField, ScheduledAction, SpaceMembership, Tag, TagVisibility, Task, Entry, Role, } from './entities';
+export type { User, Asset, ContentType, CanonicalRequest, EditorInterface, ContentTypeField, ScheduledAction, SpaceMembership, Tag, TagVisibility, Task, Entry, Role, Metadata, } from './entities';
 export type { EntryAPI, TaskAPI, TaskInputData } from './entry.types';
 export type { FieldInfo, EntryFieldInfo, EntryFieldAPI } from './field.types';
 export type { FieldAPI } from './field-locale.types';
 export type { NavigatorAPI, AppPageLocationOptions, NavigatorAPIOptions, NavigatorOpenResponse, NavigatorPageResponse, NavigatorSlideInfo, PageExtensionOptions, } from './navigator.types';
 export type { SpaceAPI } from './space.types';
-export type { SearchQuery, Metadata, CollectionResponse, ContentEntitySys, ContentEntityType, Items, Link, WithOptionalId, WithId, } from './utils';
+export type { SearchQuery, CollectionResponse, ContentEntitySys, ContentEntityType, Items, Link, WithOptionalId, WithId, SerializedJSONValue, } from './utils';
 export type { WindowAPI } from './window.types';

package/dist/types/space.types.d.ts

@@ -1,5 +1,5 @@
-import { Asset, CanonicalRequest, ContentType, EditorInterface, ScheduledAction, Tag, User, TagVisibility, KeyValueMap, Entry } from './entities';
-import { CollectionResponse, ContentEntityType, Link, WithOptionalId, SearchQuery, WithId } from './utils';
+import { Asset, CanonicalRequest, ContentType, EditorInterface, ScheduledAction, Tag, Team, User, TagVisibility, KeyValueMap, Entry, QueryOptions, Upload } from './entities';
+import { CollectionResponse, ContentEntityType, Link, WithOptionalId, SearchQuery } from './utils';
 declare type Snapshot<T> = {
     sys: {
         space?: Link;
@@ -17,48 +17,256 @@ declare type Snapshot<T> = {
     snapshot: T;
 };
 export interface SpaceAPI {
+    /**
+     * @deprecated since version 4.0.0
+     * Please using `cma.contentType.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getCachedContentTypes: () => ContentType[];
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.contentType.get` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getContentType: (id: string) => Promise<ContentType>;
-    getContentTypes: () => Promise<CollectionResponse<ContentType>>;
-    createContentType: (data: WithId<ContentType>) => Promise<ContentType>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.contentType.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
+    getContentTypes: <Query extends SearchQuery = SearchQuery>(query?: Query) => Promise<CollectionResponse<ContentType>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.contentType.create` or `cma.contentType.createWithId` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
+    createContentType: (data: WithOptionalId<ContentType>) => Promise<ContentType>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.contentType.update` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     updateContentType: (data: ContentType) => Promise<ContentType>;
-    deleteContentType: (data: ContentType) => Promise<void>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.contentType.delete` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
+    deleteContentType: (contentTypeId: string) => Promise<void>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.get` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getEntry: <Fields extends KeyValueMap = KeyValueMap>(id: string) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.snapshot.getForEntry` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getEntrySnapshots: <Fields extends KeyValueMap = KeyValueMap>(id: string) => Promise<CollectionResponse<Snapshot<Entry<Fields>>>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getEntries: <Fields, Query extends SearchQuery = SearchQuery>(query?: Query) => Promise<CollectionResponse<Entry<Fields>>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.create` or `cma.entry.createWithId` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     createEntry: <Fields>(contentTypeId: string, data: WithOptionalId<Entry<Fields>>) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.update` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     updateEntry: <Fields extends KeyValueMap = KeyValueMap>(data: Entry<Fields>) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.publish` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     publishEntry: <Fields extends KeyValueMap = KeyValueMap>(data: Entry<Fields>) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.unpublish` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     unpublishEntry: <Fields extends KeyValueMap = KeyValueMap>(data: Entry<Fields>) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.archive` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     archiveEntry: <Fields extends KeyValueMap = KeyValueMap>(data: Entry<Fields>) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.unarchive` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     unarchiveEntry: <Fields extends KeyValueMap = KeyValueMap>(data: Entry<Fields>) => Promise<Entry<Fields>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.delete` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     deleteEntry: <Fields extends KeyValueMap = KeyValueMap>(data: Entry<Fields>) => Promise<void>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.entry.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getPublishedEntries: <Fields, Query extends SearchQuery = SearchQuery>(query?: Query) => Promise<CollectionResponse<Entry<Fields>>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.get` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getAsset: (id: string) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getAssets: <Query extends SearchQuery = SearchQuery>(query?: Query) => Promise<CollectionResponse<Asset>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.create` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     createAsset: (data: WithOptionalId<Asset>) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.update` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     updateAsset: (data: Asset) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.delete` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     deleteAsset: (data: Asset) => Promise<void>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.publish` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     publishAsset: (data: Asset) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.unpublish` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     unpublishAsset: (data: Asset) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.archive` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     archiveAsset: (data: Asset) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.processForLocale` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     processAsset: (data: Asset, locale: string) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.unarchive` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     unarchiveAsset: (data: Asset) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.asset.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     getPublishedAssets: <Query extends SearchQuery = SearchQuery>(query?: Query) => Promise<CollectionResponse<Asset>>;
-    createUpload: (base64data: string) => Promise<void>;
-    waitUntilAssetProcessed: (assetId: string, locale: string) => Promise<void>;
-    /** Returns all users who belong to the space. */
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.upload.create` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
+    createUpload: (base64data: string) => Promise<Upload>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider polling `cma.asset.get` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
+    waitUntilAssetProcessed: (assetId: string, locale: string) => Promise<Asset>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.user.getManyForSpace` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     * Returns all users who belong to the space.
+     */
     getUsers: () => Promise<CollectionResponse<User>>;
-    /** Returns editor interface for a given content type */
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.editorInterface.get` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     * Returns editor interface for a given content type
+     */
     getEditorInterface: (contentTypeId: string) => Promise<EditorInterface>;
-    /** Returns editor interfaces for a given environment */
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.editorInterface.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     * Returns editor interfaces for a given environment
+     */
     getEditorInterfaces: () => Promise<CollectionResponse<EditorInterface>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.scheduledActions.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     * Returns a list of scheduled actions for a given entity
+     */
     getEntityScheduledActions: (entityType: ContentEntityType, entityId: string) => Promise<ScheduledAction[]>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.scheduledActions.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     * Returns a list of scheduled actions for the currenst space & environment
+     */
     getAllScheduledActions: () => Promise<ScheduledAction[]>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.appSignedRequest.create` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     signRequest: (request: CanonicalRequest) => Promise<Record<string, string>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.tag.create` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     createTag: (id: string, name: string, visibility?: TagVisibility) => Promise<Tag>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.tag.getMany` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     readTags: (skip: number, limit: number) => Promise<CollectionResponse<Tag>>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.tag.update` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     updateTag: (id: string, name: string, version: number) => Promise<Tag>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.tag.delete` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
     deleteTag: (id: string, version: number) => Promise<boolean>;
+    /**
+     * @deprecated since version 4.0.0
+     * Consider using `cma.team.get` instead
+     * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
+     */
+    getTeams: (query: QueryOptions) => Promise<CollectionResponse<Team>>;
 }
 export {};

package/dist/types/utils.d.ts

@@ -1,3 +1,4 @@
+import { ContentTypeFieldValidation } from './entities';
 declare type Sys = {
     id: string;
     type: string;
@@ -52,13 +53,10 @@ export interface ContentEntitySys {
     publishedBy?: Link;
     contentType: Link;
 }
-export declare type Metadata = {
-    tags: Link<'Tag', 'Link'>[];
-};
 export interface Items {
     type: string;
     linkType?: string;
-    validations?: Object[];
+    validations?: ContentTypeFieldValidation[];
 }
 export interface SearchQuery {
     order?: string;
@@ -66,4 +64,7 @@ export interface SearchQuery {
     limit?: number;
     [key: string]: any;
 }
+export declare type SerializedJSONValue = null | string | number | boolean | Array<SerializedJSONValue> | {
+    [key: string]: SerializedJSONValue;
+};
 export {};

package/dist/types/validation-error.d.ts

@@ -0,0 +1,62 @@
+export interface BaseValidationError {
+    name: string;
+    message?: string;
+    details?: string;
+    value?: any;
+    customMessage?: string;
+    path: string[];
+}
+export interface SizeValidationError extends BaseValidationError {
+    name: 'size';
+    max: number;
+    min: number;
+}
+export interface RangeValidationError extends BaseValidationError {
+    name: 'range';
+    min?: number;
+    max?: number;
+}
+export interface InValidationError extends BaseValidationError {
+    name: 'in';
+    expected: string[];
+}
+export interface RequiredValidationError extends BaseValidationError {
+    name: 'required';
+}
+export interface UniqueValidationError extends BaseValidationError {
+    name: 'unique';
+    conflicting: string[];
+}
+export interface ProhibitRegexpValidationError extends BaseValidationError {
+    name: 'prohibitRegexp';
+}
+export interface RegexpValidationError extends BaseValidationError {
+    name: 'regexp';
+}
+export interface LinkMimetypeGroupValidationError extends BaseValidationError {
+    name: 'linkMimetypeGroup';
+    mimetypeGroupName: string[];
+}
+export interface LinkContentTypeValidationError extends BaseValidationError {
+    name: 'linkContentType';
+    contentTypeId: string;
+}
+export interface DateRangeValidationError extends BaseValidationError {
+    name: 'dateRange';
+    min: number;
+    max: number;
+}
+export interface NotResolvableValidationError extends BaseValidationError {
+    name: 'notResolvable';
+    link: {
+        linkType: string;
+    };
+}
+export interface UnknownValidationError extends BaseValidationError {
+    name: 'unknown';
+}
+export interface TypeValidationError extends BaseValidationError {
+    name: 'type';
+    type: string;
+}
+export declare type ValidationError = SizeValidationError | RangeValidationError | InValidationError | RequiredValidationError | UniqueValidationError | RegexpValidationError | ProhibitRegexpValidationError | LinkMimetypeGroupValidationError | LinkContentTypeValidationError | DateRangeValidationError | NotResolvableValidationError | UnknownValidationError | TypeValidationError | BaseValidationError;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentful/app-sdk",
   "description": "SDK to develop custom UI Extension for the Contentful Web App",
-  "version": "4.0.0-alpha.7",
+  "version": "4.0.1",
   "author": "Contentful GmbH",
   "license": "MIT",
   "repository": {
@@ -21,7 +21,7 @@
     "test": "ts-mocha -p tsconfig.test.json 'test/unit/*.[jt]s' --reporter mocha-multi-reporters --reporter-options configFile=mocha.unit-reporters.json",
     "lint": "eslint '{lib,test}/**/*.{t,j}s'",
     "lint:fix": "npm run lint -- --fix",
-    "build": "rollup -c --compact",
+    "build": "npm run check-types && rollup -c --compact",
     "build:debug": "npm run build -- --sourcemap",
     "prepublishOnly": "npm run build",
     "size": "echo \"Gzipped, estimate: $(gzip -9 -c dist/cf-extension-api.js | wc -c) bytes\"",
@@ -34,63 +34,67 @@
     "generate-report": "npx mochawesome-report-generator --reportDir test/cypress/reports test/cypress/reports/full_report.json",
     "semantic-release": "semantic-release",
     "publish-all": "node ./scripts/publish.js",
-    "verify": "node ./scripts/verify.js"
+    "verify": "node ./scripts/verify.js",
+    "check-types": "tsc --noEmit -m commonjs"
   },
   "devDependencies": {
     "@semantic-release/changelog": "5.0.1",
     "@semantic-release/exec": "5.0.0",
-    "@semantic-release/git": "9.0.0",
-    "@testing-library/cypress": "7.0.6",
-    "@testing-library/dom": "7.31.0",
-    "@types/async-retry": "1.4.2",
+    "@semantic-release/git": "9.0.1",
+    "@testing-library/cypress": "8.0.1",
+    "@testing-library/dom": "8.7.2",
+    "@types/async-retry": "1.4.3",
     "@types/chai-as-promised": "7.1.4",
     "@types/cross-spawn": "6.0.2",
-    "@types/fs-extra": "9.0.11",
-    "@types/jsdom": "16.2.10",
-    "@types/nanoid": "2.1.0",
+    "@types/fs-extra": "9.0.13",
+    "@types/jsdom": "16.2.13",
+    "@types/nanoid": "3.0.0",
     "@types/sinon": "^10.0.0",
     "@types/sinon-chai": "^3.2.5",
-    "@typescript-eslint/eslint-plugin": "4.24.0",
-    "@typescript-eslint/parser": "4.24.0",
-    "async-retry": "1.3.1",
+    "@typescript-eslint/eslint-plugin": "4.32.0",
+    "@typescript-eslint/parser": "4.32.0",
+    "async-retry": "1.3.3",
     "babel-eslint": "10.1.0",
     "chai": "4.3.4",
     "chai-as-promised": "7.1.1",
+    "contentful-management": "7.41.1",
     "cross-spawn": "7.0.3",
-    "cypress": "7.3.0",
+    "cypress": "8.5.0",
     "cypress-multi-reporters": "1.5.0",
-    "dotenv": "9.0.2",
-    "eslint": "7.26.0",
+    "cypress-terminal-report": "^3.3.2",
+    "dotenv": "10.0.0",
+    "eslint": "7.32.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-config-standard": "16.0.2",
-    "eslint-plugin-cypress": "2.11.3",
-    "eslint-plugin-import": "2.23.2",
+    "eslint-config-standard": "16.0.3",
+    "eslint-plugin-cypress": "2.12.1",
+    "eslint-plugin-import": "2.24.2",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "3.4.0",
-    "eslint-plugin-promise": "4.3.1",
-    "eslint-plugin-react": "7.23.2",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-promise": "5.1.0",
+    "eslint-plugin-react": "7.26.1",
     "eslint-plugin-standard": "5.0.0",
     "fs-extra": "10.0.0",
     "husky": "4.3.8",
-    "jsdom": "16.5.3",
-    "lint-staged": "11.0.0",
+    "jsdom": "17.0.0",
+    "lint-staged": "11.2.0",
     "mocha": "8.4.0",
     "mocha-junit-reporter": "2.0.0",
     "mocha-multi-reporters": "1.5.1",
-    "mochawesome": "6.2.2",
+    "mochawesome": "6.3.0",
     "mochawesome-merge": "4.2.0",
     "mochawesome-report-generator": "5.2.0",
-    "nanoid": "3.1.23",
-    "prettier": "2.2.1",
-    "rollup": "2.48.0",
+    "nanoid": "3.1.28",
+    "prettier": "2.4.1",
+    "rollup": "2.58.0",
     "rollup-plugin-terser": "7.0.2",
     "rollup-plugin-typescript2": "0.30.0",
     "semantic-release": "17.4.2",
-    "sinon": "10.0.1",
-    "sinon-chai": "3.6.0",
+    "sinon": "11.1.2",
+    "sinon-chai": "3.7.0",
     "ts-mocha": "8.0.0",
-    "ts-node": "9.1.1",
-    "typescript": "4.1.5"
+    "ts-node": "10.2.1",
+    "tslib": "2.3.1",
+    "typescript": "4.4.3"
   },
   "husky": {
     "hooks": {
@@ -148,7 +152,7 @@
       "@semantic-release/github"
     ]
   },
-  "dependencies": {
-    "contentful-management": "^7.22.0"
+  "peerDependencies": {
+    "contentful-management": "^7.30.0"
   }
 }