@contentful/react-apps-toolkit 1.2.15 → 1.2.19

package/README.md

@@ -67,6 +67,7 @@ function App() {
 ```
 
 ### useCMA
+> :warning: **DEPRECATED** If you are using App SDK v4.20 or greater use `sdk.cma` instead.
 
 `useCMA` returns an initialized [client for the Contentful Management API](https://www.npmjs.com/package/contentful-management). This can be used immediately to communicate with the environment the app is rendered in. [Contentful Management API docs](/developers/docs/references/content-management-api/).
 
@@ -107,13 +108,33 @@ If used in the [entry sidebar location](/developers/docs/extensibility/app-frame
 
 Usage:
 
+Field component:
+```tsx
+import { SDKProvider, useFieldValue } from '@contentful/react-apps-toolkit';
+
+function FieldComponentUsingFieldValue() {
+  const [localizedValue, setLocalizedValue] = useFieldValue(sdk.field.id, sdk.field.locale); // specifies the current field and locale
+
+  return <input value={localizedValue} onChange={(e) => setLocalizedValue(e.target.value)} />;
+}
+
+function App() {
+  return (
+    <SDKProvider>
+      <FieldComponentUsingFieldValue />
+    </SDKProvider>
+  );
+}
+```
+
+Sidebar or Entry Editor component:
 ```tsx
 import { SDKProvider, useFieldValue } from '@contentful/react-apps-toolkit';
 
 function ComponentUsingFieldValue() {
-  const [value, setValue] = useFieldValue('slug', 'en-US');
+  const [defaultValue, setDefaultValue] = useFieldValue('slug', sdk.locales.default); // specifies the "slug" field and the environment's default locale
 
-  return <input value={value} onChange={(e) => setValue(e.target.value)} />;
+  return <input value={defaultValue} onChange={(e) => setDefaultValue(e.target.value)} />;
 }
 
 function App() {

package/dist/useCMA.d.ts

@@ -2,6 +2,8 @@ import { PlainClientAPI } from 'contentful-management';
 import type { CMAClient } from '@contentful/app-sdk';
 type UseCMAReturnValue = (CMAClient extends never ? true : false) extends false ? CMAClient : PlainClientAPI;
 /**
+ * @deprecated if on App SDK v4.20 or greater use `sdk.cma` instead.
+ *
  * React hook returning a CMA plain client instance.
  * Must be used in the `SDKProvider` component. Will throw error, if called outside of `SDKProvider`.
  */

package/dist/useCMA.js

@@ -5,6 +5,8 @@ var contentful_management_1 = require("contentful-management");
 var react_1 = require("react");
 var useSDK_1 = require("./useSDK");
 /**
+ * @deprecated if on App SDK v4.20 or greater use `sdk.cma` instead.
+ *
  * React hook returning a CMA plain client instance.
  * Must be used in the `SDKProvider` component. Will throw error, if called outside of `SDKProvider`.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/react-apps-toolkit",
-  "version": "1.2.15",
+  "version": "1.2.19",
   "description": "Toolkit for building a Contentful app in React",
   "keywords": [],
   "author": "Contentful GmbH",
@@ -43,7 +43,7 @@
     "jest": "27.5.0",
     "react": "17.0.2",
     "react-dom": "17.0.2",
-    "ts-jest": "27.1.3",
+    "ts-jest": "29.4.6",
     "typescript": "4.9.5"
   },
   "publishConfig": {
@@ -52,5 +52,5 @@
   "dependencies": {
     "contentful-management": ">=7.30.0"
   },
-  "gitHead": "d2dac61d0116ef9df6fc95e4a4cb14bafc679378"
+  "gitHead": "4c3506be3f52c7a8aae17deaa75acefc9a805b42"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Contentful
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.