@contentful/react-apps-toolkit 0.5.8 → 0.5.11

package/README.md

@@ -30,6 +30,8 @@ If it is not, the hook will throw an error.
 Here is an example of how you can use it:
 
 ```tsx
+import { useSDK } from '@contentful/react-apps-toolkit'
+
 function App() {
   const sdk = useSDK<FieldExtensionSDK>();
 
@@ -38,14 +40,31 @@ function App() {
 
 ```
 
+### `useCMA`
 
-#### SDKProvider
+Returns an initialized [plain client](https://github.com/contentful/contentful-management.js/#alternative-plain-api) for the Contentful Management API, which can immediately be used to communicate with the rest of your Contentful space. [Contentful Management API docs](https://www.contentful.com/developers/docs/references/content-management-api/).
 
-Wrapper component, which makes the Apps SDK available to children via React Context. To use any of the hooks contained in this package, an application must be wrapped in the SDK provider, as all hooks depend on the Apps SDK.
 
-#### useCMA
+```tsx
+import { useCMA } from '@contentful/react-apps-toolkit'
+
+function App() {
+  const cma = useCMA();
+
+  useEffect(() => {
+    cma.entry.get({ entryId: '2VO9yOaeSyAFA19e649SxG' }).then((entry) => {
+      console.log(entry);
+    });
+  }, []);
 
-Returns an initialized client for the Contentful Management API, which can immediately be used to communicate with the rest of your Contentful space. [Contentful Management API docs](https://www.contentful.com/developers/docs/references/content-management-api/).
+  return <>Hello world!</>
+}
+
+```
+
+#### SDKProvider
+
+Wrapper component, which makes the Apps SDK available to children via React Context. To use any of the hooks contained in this package, an application must be wrapped in the SDK provider, as all hooks depend on the Apps SDK.
 
 ### Resources
 

package/dist/useCMA.js

@@ -11,10 +11,11 @@ var useSDK_1 = require("./useSDK");
 function useCMA() {
     var sdk = (0, useSDK_1.useSDK)();
     var cma = (0, react_1.useMemo)(function () {
+        var _a;
         return (0, contentful_management_1.createClient)({ apiAdapter: sdk.cmaAdapter }, {
             type: 'plain',
             defaults: {
-                environmentId: sdk.ids.environment,
+                environmentId: (_a = sdk.ids.environmentAlias) !== null && _a !== void 0 ? _a : sdk.ids.environment,
                 spaceId: sdk.ids.space,
             },
         });

package/dist/useFieldValue.d.ts

@@ -1,6 +1,6 @@
 export declare type UseFieldValueReturnValue<Value = unknown> = [
-    value: Value,
-    setValue: (newValue: Value) => Promise<void>
+    value: Value | undefined,
+    setValue: (newValue: Value | undefined) => Promise<void>
 ];
 /**
  * Returns field value and a function to update it.

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@contentful/react-apps-toolkit",
-  "version": "0.5.8",
+  "version": "0.5.11",
   "description": "Toolkit for building a Contentful app in React",
   "keywords": [],
   "author": "Contentful GmbH",
   "license": "MIT",
   "main": "dist/index.js",
+  "sideEffects": false,
   "repository": {
     "type": "git",
     "url": "git+https://github.com/contentful/create-contentful-app.git",
@@ -49,5 +50,5 @@
     "@contentful/app-sdk": "^4.0.0",
     "contentful-management": ">=7.30.0"
   },
-  "gitHead": "8a9fb4096cbb6369d9638a302c342a8c9a021503"
+  "gitHead": "61e3382ccad0a4bfb72625f5681271667e15acd6"
 }