@gleanwork/api-client 0.1.0-beta → 0.1.0-beta.2

package/FUNCTIONS.md

@@ -20,7 +20,7 @@ specific category of applications.
 
 ```typescript
 import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientActivityReport } from "@gleanwork/api-client/funcs/clientActivityReport.js";
+import { clientChatStart } from "@gleanwork/api-client/funcs/clientChatStart.js";
 import { SDKValidationError } from "@gleanwork/api-client/models/errors/sdkvalidationerror.js";
 
 // Use `GleanCore` for best tree-shaking performance.
@@ -30,29 +30,14 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientActivityReport(glean, {
-    events: [
+  const res = await clientChatStart(glean, {
+    messages: [
       {
-        action: "HISTORICAL_VIEW",
-        timestamp: new Date("2000-01-23T04:56:07.000Z"),
-        url: "https://example.com/",
-      },
-      {
-        action: "SEARCH",
-        params: {
-          query: "query",
-        },
-        timestamp: new Date("2000-01-23T04:56:07.000Z"),
-        url: "https://example.com/search?q=query",
-      },
-      {
-        action: "VIEW",
-        params: {
-          duration: 20,
-          referrer: "https://example.com/document",
-        },
-        timestamp: new Date("2000-01-23T04:56:07.000Z"),
-        url: "https://example.com/",
+        fragments: [
+          {
+            text: "What are the company holidays this year?",
+          },
+        ],
       },
     ],
   });
@@ -76,7 +61,8 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();

package/REACT_QUERY.md

@@ -16,86 +16,6 @@ To get started using React hooks, you will need to inject TanStack query and an
 SDK instance into your application. Typically, this will be done high up in
 your React app at the root or layout component. For example:
 
-```tsx
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import { GleanCore } from "@gleanwork/api-client";
-import { GleanProvider } from "@gleanwork/api-client/react-query";
-
-const queryClient = new QueryClient();
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-// Retries are handled by the underlying SDK.
-queryClient.setQueryDefaults(["@gleanwork/api-client"], { retry: false });
-queryClient.setMutationDefaults(["@gleanwork/api-client"], { retry: false });
-
-export function App() {
-  return (
-    <QueryClientProvider client={queryClient}>
-      <GleanProvider client={glean}> 
-        {/* Your app logic starts here */}
-      </GleanProvider>
-    </QueryClientProvider>
-  );
-}
-```
-
-## Queries
-
-Query hooks are the basic building block for fetching data. In addition to
-request data, they take the same options as the [`useQuery` hook][use-query]
-from TanStack Query.
-
-[use-query]: https://tanstack.com/query/v5/docs/framework/react/reference/useQuery
-
-```tsx
-import { useClientImagesGet } from "@gleanwork/api-client/react-query/clientImagesGet.js";
-
-export function Example() {
-  const { data, error, status } = useClientImagesGet({});
-
-  // Render the UI here...
-}
-``` 
-
-### Query timeouts and retries
-
-Since the underlying SDK handles request timeouts and retries, there are a few
-more options provided by the query hooks to control these behaviors.
-
-```tsx
-import { useState } from "react";
-import { useClientImagesGet } from "@gleanwork/api-client/react-query/clientImagesGet.js";
-
-export function ExampleWithOptions() {
-  const [enabled, setEnabled] = useState(true);
-  const { data, error, status } = useClientImagesGet(
-    {},
-    {
-      // TanStack Query options:
-      enabled,
-      staleTime: 60 * 1000, // 1 minute
-      gcTime: 5 * 60 * 1000, // 5 minutes
-
-      // Request options for the underlying API call:
-      timeoutMs: 1000,
-      retryCodes: ["5XX"],
-      retries: {
-        strategy: "backoff",
-        backoff: {
-          initialInterval: 500,
-          maxInterval: 10 * 1000, // 10 seconds
-          exponent: 1.5,
-          maxElapsedTime: 60 * 1000, // 1 minute
-        },
-      },
-    }
-  );
-
-  // Render the UI here...
-}
-```
 
 
 ## Mutations
@@ -188,135 +108,4 @@ export function ExampleWithOptions() {
 ```
 
 
-## Cache invalidation
-
-In many instances, triggering a mutation hook requires invalidating specific
-query data currently residing in the TanStack Query's cache. Alongside every
-query hook there are two functions that help invalidate cached data:
-
-```tsx
-import { useQueryClient } from "@tanstack/react-query";
-import { invalidateClientImagesGet, invalidateAllClientImagesGet } from "@gleanwork/api-client/react-query/clientImagesGet.js";
-// Replace this with a real mutation
-import { useExampleMutation } from "@gleanwork/api-client/react-query/example.js";
-
-export function Example() {
-  const { queryClient } = useQueryClient();
-  const { mutate, status } = useExampleMutation();
-
-  return (
-    <form
-      onSubmit={(e) => {
-        e.preventDefault();
-
-        const formData = new FormData(e.target);
-
-        mutate(formData, {
-          onSuccess: () => {
-            // Invalidate a single cache entry:
-            invalidateClientImagesGet(queryClient, /* ... arguments ... */);
-            // OR, invalidate all cache entries for the query targets:
-            invalidateAllClientImagesGet(queryClient);
-          },
-        });
-      }}
-    >
-      {/* Form fields go here... */} 
-
-      <button type="submit" disabled={status === "pending"}>Submit</button>
-    </form>
-  );
-}
-```
-
-
-## Integration with React Suspense
-
-TanStack Query predates React Suspense and out of the box it does a great job at
-exposing the lifecycle of asynchronous tasks. However, if you are already using
-Suspense in your app, the default hooks will not trigger suspense boundaries.
-This is why the library and, by extension, this SDK also provide equivalent
-hooks that integrate neatly with React Suspense.
-
-```tsx
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import { ErrorBoundary } from "react-error-boundary";
-
-import { GleanCore } from "@gleanwork/api-client";
-import { GleanProvider } from "@gleanwork/api-client/react-query";
-import { useClientImagesGetSuspense } from "@gleanwork/api-client/react-query/clientImagesGet.js";
-
-const queryClient = new QueryClient();
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-export function App() {
-  return (
-    <QueryClientProvider client={queryClient}>
-      <GleanProvider client={glean}> 
-        <QueryErrorResetBoundary>
-          {({ reset }) => (
-            <ErrorBoundary
-              fallbackRender={({ error, resetErrorBoundary }) => (
-                <div>
-                  There was an error!{' '}
-                  <Button onClick={() => resetErrorBoundary()}>Try again</Button>
-                  <pre>{error.message}</pre>
-                </div>
-              )}
-              onReset={reset}
-            >
-              <React.Suspense fallback={<h1>Loading...</h1>}>
-                <Example />
-              </React.Suspense>
-            </ErrorBoundary>
-          )}
-        </QueryErrorResetBoundary>
-      </GleanProvider>
-    </QueryClientProvider>
-  );
-}
-
-function Example() {
-  const { data } = useClientImagesGetSuspense({});
-
-  // Render the UI here...
-}
-```
-
-
-## Server-rendering and React Server Components
-
-Query hooks are also side-loaded with prefetch helper functions. These functions
-can be used to fetch data from the API during server-rendering and in React
-Server Components so that it can be available immediately on page load to any
-components that use the corresponding hooks:
-```tsx
-import {
-  dehydrate,
-  HydrationBoundary,
-  QueryClient,
-} from "@tanstack/react-query";
-import { GleanCore } from "@gleanwork/api-client";
-import { prefetchClientImagesGet } from "@gleanwork/api-client/react-query/clientImagesGet.js";
-
-export default async function Page() {
-  const queryClient = new QueryClient();
-  const glean = new GleanCore({
-    bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-  });
-
-  await prefetchClientImagesGet(queryClient, glean, {});
-
-  return (
-    // HydrationBoundary is a Client Component, so hydration will happen there.
-    <HydrationBoundary state={dehydrate(queryClient)}>
-      {/* Client components under this point will also have data on page load. */}
-    </HydrationBoundary>
-  );
-}
-```
-
-
 [rq]: https://tanstack.com/query/v5/docs/framework/react/overview