Merge pull request #33 from polyfact/feat/add-usage-email

✨ Add usage & email

lib/index.ts

@@ -24,6 +24,7 @@ import memoryClient, {
     MemoryClient,
 } from "./memory";
 import { splitString, tokenCount } from "./split";
+import userClient, { usage, UserClient } from "./user";
 import { InputClientOptions } from "./clientOpts";
 import kvClient, { get as KVGet, set as KVSet, KVClient } from "./kv";
 
@@ -54,13 +55,15 @@ export {
     Chat,
     Memory,
     kv,
+    usage,
 };
 
 type Client = GenerationClient &
     GenerationWithTypeClient &
     TranscribeClient &
     MemoryClient &
-    ChatClient & { kv: KVClient };
+    ChatClient &
+    UserClient & { kv: KVClient };
 
 function client(co: InputClientOptions): Client {
     return {
@@ -69,6 +72,7 @@ function client(co: InputClientOptions): Client {
         ...transcribeClient(co),
         ...memoryClient(co),
         ...chatClient(co),
+        ...userClient(co),
         kv: kvClient(co),
     };
 }
@@ -241,6 +245,7 @@ type Provider = "github" | "google";
 export function usePolyfact({ project, endpoint }: { project: string; endpoint?: string }): {
     polyfact: Client | undefined;
     login: ((input: { provider: Provider }) => Promise<void>) | undefined;
+    email?: string;
     loading: boolean;
 } {
     if (typeof window === "undefined") {
@@ -249,6 +254,7 @@ export function usePolyfact({ project, endpoint }: { project: string; endpoint?:
 
     const react = require("react"); // eslint-disable-line
     const [polyfact, setPolyfact] = react.useState();
+    const [email, setEmail] = react.useState();
     const [loading, setLoading] = react.useState(true);
     const [login, setLogin] = react.useState();
 
@@ -294,6 +300,10 @@ export function usePolyfact({ project, endpoint }: { project: string; endpoint?:
                         data.session?.refresh_token,
                     );
                 }
+
+                const { data } = await supabase.auth.getUser(token);
+
+                setEmail(data.user?.email);
                 const p = await Polyfact.endpoint(endpoint || "https://api2.polyfact.com")
                     .project(project)
                     .signInWithToken(token);
@@ -312,5 +322,5 @@ export function usePolyfact({ project, endpoint }: { project: string; endpoint?:
         })();
     }, []);
 
-    return { polyfact, login, loading };
+    return { polyfact, login, loading, email };
 }

lib/user.ts

@@ -0,0 +1,55 @@
+import axios, { AxiosError } from "axios";
+import * as t from "polyfact-io-ts";
+import { InputClientOptions, defaultOptions } from "./clientOpts";
+import { ApiError, ErrorData } from "./helpers/error";
+
+const UsageResultType = t.intersection([
+    t.type({
+        usage: t.number,
+    }),
+    t.partial({
+        rate_limit: t.union([t.undefined, t.null, t.number]),
+    }),
+]);
+
+export async function usage(
+    clientOptions: InputClientOptions = {},
+): Promise<{ usage: number; rateLimit?: number }> {
+    const { token, endpoint } = await defaultOptions(clientOptions);
+
+    try {
+        const res = await axios.get(`${endpoint}/usage`, {
+            headers: {
+                "Content-Type": "application/json",
+                "X-Access-Token": token,
+            },
+        });
+
+        if (!UsageResultType.is(res.data)) {
+            throw new ApiError({
+                code: "mismatched_response",
+                message: "The response from the API does not match the expected format",
+            });
+        }
+
+        return {
+            usage: res.data.usage,
+            rateLimit: res.data.rate_limit ?? undefined,
+        };
+    } catch (e: unknown) {
+        if (e instanceof AxiosError) {
+            throw new ApiError(e?.response?.data as ErrorData);
+        }
+        throw e;
+    }
+}
+
+export type UserClient = {
+    usage: () => Promise<{ usage: number; rateLimit?: number }>;
+};
+
+export default function client(clientOptions: InputClientOptions = {}): UserClient {
+    return {
+        usage: () => usage(clientOptions),
+    };
+}