docs improvements

Author: hasanayan

docs/index.md

@@ -82,5 +82,14 @@ Client library for interacting with the Cerbos policy decision point service ove
 OpenTelemetry instrumentation for the [gRPC](./grpc.md) and [HTTP](./http.md) client libraries.
 
 
+</td></tr>
+<tr><td>
+
+[@cerbos/react](./react.md)
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>

docs/react.asyncresult.data.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [AsyncResult](./react.asyncresult.md) &gt; [data](./react.asyncresult.data.md)
+
+## AsyncResult.data property
+
+**Signature:**
+
+```typescript
+data: T | undefined;
+```

docs/react.asyncresult.error.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [AsyncResult](./react.asyncresult.md) &gt; [error](./react.asyncresult.error.md)
+
+## AsyncResult.error property
+
+**Signature:**
+
+```typescript
+error: Error | undefined;
+```

docs/react.asyncresult.isloading.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [AsyncResult](./react.asyncresult.md) &gt; [isLoading](./react.asyncresult.isloading.md)
+
+## AsyncResult.isLoading property
+
+**Signature:**
+
+```typescript
+isLoading: boolean;
+```

docs/react.asyncresult.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [AsyncResult](./react.asyncresult.md)
+
+## AsyncResult interface
+
+
+**Signature:**
+
+```typescript
+export interface AsyncResult<T> 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[data](./react.asyncresult.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+T \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[error](./react.asyncresult.error.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Error \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isLoading](./react.asyncresult.isloading.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

docs/react.cerbosprovider.md

@@ -0,0 +1,83 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [CerbosProvider](./react.cerbosprovider.md)
+
+## CerbosProvider() function
+
+Component to provide the Cerbos client to down the component tree, should be placed closer to the root of the application. The principal is required but can be an anonymous user in case your application requires authorization checks for unauthenticated users.
+
+**Signature:**
+
+```typescript
+export declare function CerbosProvider({ children, client, principal, auxData, }: CerbosProviderProps): ReactElement;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+{ children, client, principal, auxData, }
+
+
+</td><td>
+
+[CerbosProviderProps](./react.cerbosproviderprops.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+ReactElement
+
+## Example
+
+
+```typescript
+import { Embedded as Cerbos } from "@cerbos/embedded";
+
+// Initialize the Cerbos client using any of the client libraries
+// that fit the needs of your application. In this example we are
+// using `@cerbos/embedded`.
+const client = new Cerbos(...);
+
+function MyApp({ children }) {
+  const user = useUser();
+
+  return (
+    <CerbosProvider
+      client={client}
+      principal={
+      // Build and pass the principal object to the provider.
+        {
+          id: user ? user.id : "###ANONYMOUS_USER###", // We defined an arbitrary ID for anonymous users here, it will help us identify the checks for anonymous users in the Cerbos logs
+          roles: user ? user.roles : [], // Pass the roles of the user, it the user is not authenticated, pass an empty array
+          auxData: ... //optional
+        }
+      }
+    >
+      {children}
+    </CerbosProvider>
+  );
+}
+```
+

docs/react.cerbosproviderprops.auxdata.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [CerbosProviderProps](./react.cerbosproviderprops.md) &gt; [auxData](./react.cerbosproviderprops.auxdata.md)
+
+## CerbosProviderProps.auxData property
+
+**Signature:**
+
+```typescript
+auxData?: Pick<AuxData, "jwt"> | undefined;
+```

docs/react.cerbosproviderprops.children.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [CerbosProviderProps](./react.cerbosproviderprops.md) &gt; [children](./react.cerbosproviderprops.children.md)
+
+## CerbosProviderProps.children property
+
+**Signature:**
+
+```typescript
+children: ReactNode;
+```

docs/react.cerbosproviderprops.client.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [CerbosProviderProps](./react.cerbosproviderprops.md) &gt; [client](./react.cerbosproviderprops.client.md)
+
+## CerbosProviderProps.client property
+
+**Signature:**
+
+```typescript
+client: Client;
+```

docs/react.cerbosproviderprops.md

@@ -0,0 +1,107 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [CerbosProviderProps](./react.cerbosproviderprops.md)
+
+## CerbosProviderProps interface
+
+
+**Signature:**
+
+```typescript
+export interface CerbosProviderProps 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[auxData?](./react.cerbosproviderprops.auxdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Pick&lt;[AuxData](./core.auxdata.md)<!-- -->, "jwt"&gt; \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[children](./react.cerbosproviderprops.children.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ReactNode
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[client](./react.cerbosproviderprops.client.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Client](./core.client.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[principal](./react.cerbosproviderprops.principal.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Principal](./core.principal.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

docs/react.cerbosproviderprops.principal.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@cerbos/react](./react.md) &gt; [CerbosProviderProps](./react.cerbosproviderprops.md) &gt; [principal](./react.cerbosproviderprops.principal.md)
+
+## CerbosProviderProps.principal property
+
+**Signature:**
+
+```typescript
+principal: Principal;
+```