convex 0.12.0 → 0.12.2-nobin

package/README.md

@@ -25,8 +25,10 @@ This package includes several separate entry points for building apps on Convex:
   working with values stored in Convex.
 - [`convex/schema`](https://docs.convex.dev/api/modules/schema): Utilities for
   defining the schema of your Convex project.
-- [`convex/react-auth0`](https://docs.convex.dev/api/modules/values): A React
+- [`convex/react-auth0`](https://docs.convex.dev/api/modules/react_auth0): A React
   component for authenticating users with Auth0.
+- [`convex/react-clerk`](https://docs.convex.dev/api/modules/react_clerk): A React
+  component for authenticating users with Clerk.
 
 This package also includes [`convex`](https://docs.convex.dev/using/cli), a
 command-line interface for managing Convex projects.

package/api-extractor-configs/temp/api-tmp.api.md

@@ -0,0 +1,95 @@
+## API Report File for "convex"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ActionNames<API extends GenericAPI> = keyof API["allActions"] & string;
+
+// @public
+export type ApiFromModules<Modules extends Record<string, Record<string, any>>> = {
+    publicQueries: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isQuery: true;
+        isPublic: true;
+    }>>>;
+    allQueries: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isQuery: true;
+    }>>>;
+    publicMutations: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isMutation: true;
+        isPublic: true;
+    }>>>;
+    allMutations: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isMutation: true;
+    }>>>;
+    publicActions: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isAction: true;
+        isPublic: true;
+    }>>>;
+    allActions: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isAction: true;
+    }>>>;
+};
+
+// Warning: (ae-forgotten-export) The symbol "Value" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type ArgsAndOptions<F extends (args?: Record<string, Value>) => any, Options> = Parameters<F>["length"] extends 0 ? [
+args?: {},
+options?: Options
+] : [args: Parameters<F>[0], options?: Options];
+
+// @public
+export type ArgsObject<F extends (args?: Record<string, Value>) => any> = Parameters<F>["length"] extends 0 ? {} : Parameters<F>[0] & Record<string, Value>;
+
+// @public
+export type GenericAPI = {
+    publicQueries: Record<string, ConvexFunction>;
+    allQueries: Record<string, ConvexFunction>;
+    publicMutations: Record<string, ConvexFunction>;
+    allMutations: Record<string, ConvexFunction>;
+    publicActions: Record<string, ConvexFunction>;
+    allActions: Record<string, ConvexFunction>;
+};
+
+// @public
+export type MutationNames<API extends GenericAPI> = keyof API["allMutations"] & string;
+
+// @public
+export type NamedAction<API extends GenericAPI, Name extends ActionNames<API>> = API["allActions"][Name];
+
+// @public
+export type NamedMutation<API extends GenericAPI, Name extends MutationNames<API>> = API["allMutations"][Name];
+
+// @public
+export type NamedQuery<API extends GenericAPI, Name extends QueryNames<API>> = API["allQueries"][Name];
+
+// @public
+export type OptionalRestArgs<F extends (args?: Record<string, Value>) => any> = Parameters<F>["length"] extends 0 ? [
+args?: {}
+] : [args: Parameters<F>[0]];
+
+// @public
+export type PublicActionNames<API extends GenericAPI> = keyof API["publicActions"] & string;
+
+// @public
+export type PublicMutationNames<API extends GenericAPI> = keyof API["publicMutations"] & string;
+
+// @public
+export type PublicQueryNames<API extends GenericAPI> = keyof API["publicQueries"] & string;
+
+// @public
+export type QueryNames<API extends GenericAPI> = keyof API["allQueries"] & string;
+
+// Warnings were encountered during analysis:
+//
+// src/api/index.ts:20:3 - (ae-forgotten-export) The symbol "ConvexFunction" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "Expand" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "ConvertToClientFunctions" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "PickByValue" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "MergeAllExports" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-extractor-configs/temp/browser-tmp.api.md

@@ -0,0 +1,180 @@
+## API Report File for "convex"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ActionNames<API extends GenericAPI> = keyof API["allActions"] & string;
+
+// @public
+export type ApiFromModules<Modules extends Record<string, Record<string, any>>> = {
+    publicQueries: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isQuery: true;
+        isPublic: true;
+    }>>>;
+    allQueries: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isQuery: true;
+    }>>>;
+    publicMutations: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isMutation: true;
+        isPublic: true;
+    }>>>;
+    allMutations: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isMutation: true;
+    }>>>;
+    publicActions: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isAction: true;
+        isPublic: true;
+    }>>>;
+    allActions: Expand<ConvertToClientFunctions<PickByValue<MergeAllExports<Modules>, {
+        isAction: true;
+    }>>>;
+};
+
+// Warning: (ae-forgotten-export) The symbol "Value" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type ArgsAndOptions<F extends (args?: Record<string, Value>) => any, Options> = Parameters<F>["length"] extends 0 ? [
+args?: {},
+options?: Options
+] : [args: Parameters<F>[0], options?: Options];
+
+// @public
+export type ArgsObject<F extends (args?: Record<string, Value>) => any> = Parameters<F>["length"] extends 0 ? {} : Parameters<F>[0] & Record<string, Value>;
+
+// @public
+export interface ClientOptions {
+    unsavedChangesWarning?: boolean;
+    verbose?: boolean;
+    webSocketConstructor?: typeof WebSocket;
+}
+
+// @public
+export class ConvexHttpClient<API extends GenericAPI> {
+    constructor(address: string);
+    action<Name extends PublicActionNames<API>>(name: Name, ...args: OptionalRestArgs<NamedAction<API, Name>>): Promise<ReturnType<NamedAction<API, Name>>>;
+    backendUrl(): string;
+    clearAuth(): void;
+    mutation<Name extends PublicMutationNames<API>>(name: Name, ...args: OptionalRestArgs<NamedMutation<API, Name>>): Promise<ReturnType<NamedMutation<API, Name>>>;
+    query<Name extends PublicQueryNames<API>>(name: Name, ...args: OptionalRestArgs<NamedQuery<API, Name>>): Promise<ReturnType<NamedQuery<API, Name>>>;
+    setAuth(value: string): void;
+    // @internal
+    setDebug(debug: boolean): void;
+}
+
+// @public
+export type GenericAPI = {
+    publicQueries: Record<string, ConvexFunction>;
+    allQueries: Record<string, ConvexFunction>;
+    publicMutations: Record<string, ConvexFunction>;
+    allMutations: Record<string, ConvexFunction>;
+    publicActions: Record<string, ConvexFunction>;
+    allActions: Record<string, ConvexFunction>;
+};
+
+// @public
+export class InternalConvexClient {
+    constructor(address: string, onTransition: (updatedQueries: QueryToken[]) => void, options?: ClientOptions);
+    // (undocumented)
+    action(udfPath: string, args: Record<string, Value>): Promise<any>;
+    // (undocumented)
+    clearAuth(): void;
+    // (undocumented)
+    close(): Promise<void>;
+    // Warning: (ae-forgotten-export) The symbol "ConnectionState" needs to be exported by the entry point index.d.ts
+    connectionState(): ConnectionState;
+    // (undocumented)
+    hasAuth(): boolean;
+    localQueryResult(udfPath: string, args: Record<string, Value>): Value | undefined;
+    // (undocumented)
+    mutate<Args extends Record<string, Value>>(udfPath: string, args: Args, optimisticUpdate?: OptimisticUpdate<GenericAPI, Args> | null): Promise<any>;
+    queryJournal(name: string, args: Record<string, Value>): QueryJournal | undefined;
+    // @internal (undocumented)
+    setAdminAuth(value: string, fakeUserIdentity?: UserIdentityAttributes): void;
+    // Warning: (ae-forgotten-export) The symbol "AuthTokenFetcher" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    setAuth(fetchToken: AuthTokenFetcher): Promise<void>;
+    subscribe(name: string, args?: Record<string, Value>, journal?: QueryJournal): {
+        queryToken: QueryToken;
+        unsubscribe: () => void;
+    };
+}
+
+// @public
+export type MutationNames<API extends GenericAPI> = keyof API["allMutations"] & string;
+
+// @public
+export type NamedAction<API extends GenericAPI, Name extends ActionNames<API>> = API["allActions"][Name];
+
+// @public
+export type NamedMutation<API extends GenericAPI, Name extends MutationNames<API>> = API["allMutations"][Name];
+
+// @public
+export type NamedQuery<API extends GenericAPI, Name extends QueryNames<API>> = API["allQueries"][Name];
+
+// @public
+export interface OptimisticLocalStore<API extends GenericAPI = GenericAPI> {
+    getAllQueries<Name extends PublicQueryNames<API>>(name: Name): {
+        args: ArgsObject<NamedQuery<API, Name>>;
+        value: undefined | ReturnType<NamedQuery<API, Name>>;
+    }[];
+    getQuery<Name extends PublicQueryNames<API>>(name: Name, ...args: OptionalRestArgs<NamedQuery<API, Name>>): undefined | ReturnType<NamedQuery<API, Name>>;
+    setQuery<Name extends PublicQueryNames<API>>(name: Name, args: ArgsObject<NamedQuery<API, Name>>, value: undefined | ReturnType<NamedQuery<API, Name>>): void;
+}
+
+// @public
+export type OptimisticUpdate<API extends GenericAPI, Args extends Record<string, Value>> = (localQueryStore: OptimisticLocalStore<API>, args: Args) => void;
+
+// @public
+export type OptionalRestArgs<F extends (args?: Record<string, Value>) => any> = Parameters<F>["length"] extends 0 ? [
+args?: {}
+] : [args: Parameters<F>[0]];
+
+// @public
+export type PublicActionNames<API extends GenericAPI> = keyof API["publicActions"] & string;
+
+// @public
+export type PublicMutationNames<API extends GenericAPI> = keyof API["publicMutations"] & string;
+
+// @public
+export type PublicQueryNames<API extends GenericAPI> = keyof API["publicQueries"] & string;
+
+// @public
+export type QueryJournal = string | null;
+
+// @public
+export type QueryNames<API extends GenericAPI> = keyof API["allQueries"] & string;
+
+// @public
+export type QueryResult = {
+    success: true;
+    value: Value;
+} | {
+    success: false;
+    errorMessage: string;
+};
+
+// @public
+export type QueryToken = string;
+
+// Warning: (ae-forgotten-export) The symbol "UserIdentity" needs to be exported by the entry point index.d.ts
+// Warning: (ae-internal-missing-underscore) The name "UserIdentityAttributes" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export type UserIdentityAttributes = Omit<UserIdentity, "updatedAt" | "issuer"> & {
+    updatedAt?: string;
+};
+
+// Warnings were encountered during analysis:
+//
+// src/api/index.ts:20:3 - (ae-forgotten-export) The symbol "ConvexFunction" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "Expand" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "ConvertToClientFunctions" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "PickByValue" needs to be exported by the entry point index.d.ts
+// src/api/index.ts:227:3 - (ae-forgotten-export) The symbol "MergeAllExports" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-extractor-configs/temp/react-auth0-tmp.api.md

@@ -0,0 +1,21 @@
+## API Report File for "convex"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ReactNode } from 'react';
+
+// @public
+export function ConvexProviderWithAuth0({ children, client, }: {
+    children: ReactNode;
+    client: IConvexReactClient;
+}): JSX.Element;
+
+// Warnings were encountered during analysis:
+//
+// src/react-auth0/ConvexProviderWithAuth0.tsx:30:3 - (ae-forgotten-export) The symbol "IConvexReactClient" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-extractor-configs/temp/react-clerk-tmp.api.md

@@ -0,0 +1,21 @@
+## API Report File for "convex"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ReactNode } from 'react';
+
+// @public
+export function ConvexProviderWithClerk({ children, client, }: {
+    children: ReactNode;
+    client: IConvexReactClient;
+}): JSX.Element;
+
+// Warnings were encountered during analysis:
+//
+// src/react-clerk/ConvexProviderWithClerk.tsx:32:3 - (ae-forgotten-export) The symbol "IConvexReactClient" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-extractor-configs/temp/react-tmp.api.md

@@ -0,0 +1,227 @@
+## API Report File for "convex"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+
+// @public
+export function Authenticated({ children }: {
+    children: ReactNode;
+}): JSX.Element | null;
+
+// @public
+export function AuthLoading({ children }: {
+    children: ReactNode;
+}): JSX.Element | null;
+
+// @public
+export type AuthTokenFetcher = (args: {
+    forceRefreshToken: boolean;
+}) => Promise<string | null | undefined>;
+
+// @public
+export type ConvexAuthState = {
+    isLoading: boolean;
+    isAuthenticated: boolean;
+};
+
+// @public
+export const ConvexProvider: React_2.FC<{
+    client: ConvexReactClient<any>;
+    children?: React_2.ReactNode;
+}>;
+
+// @public
+export function ConvexProviderWithAuth({ children, client, useAuth, }: {
+    children?: ReactNode;
+    client: IConvexReactClient;
+    useAuth: () => {
+        isLoading: boolean;
+        isAuthenticated: boolean;
+        fetchAccessToken: (args: {
+            forceRefreshToken: boolean;
+        }) => Promise<string | null>;
+    };
+}): JSX.Element;
+
+// Warning: (ae-forgotten-export) The symbol "GenericAPI" needs to be exported by the entry point index.d.ts
+//
+// @public
+export class ConvexReactClient<API extends GenericAPI> {
+    constructor(address: string, options?: ReactClientOptions);
+    // Warning: (ae-forgotten-export) The symbol "PublicActionNames" needs to be exported by the entry point index.d.ts
+    action<Name extends PublicActionNames<API>>(name: Name): ReactAction<API, Name>;
+    clearAuth(): void;
+    close(): Promise<void>;
+    // Warning: (ae-forgotten-export) The symbol "ConnectionState" needs to be exported by the entry point index.d.ts
+    connectionState(): ConnectionState;
+    // Warning: (ae-forgotten-export) The symbol "PublicMutationNames" needs to be exported by the entry point index.d.ts
+    mutation<Name extends PublicMutationNames<API>>(name: Name): ReactMutation<API, Name>;
+    // Warning: (ae-forgotten-export) The symbol "UserIdentityAttributes" needs to be exported by the entry point index.d.ts
+    //
+    // @internal (undocumented)
+    setAdminAuth(token: string, identity?: UserIdentityAttributes): void;
+    setAuth(fetchToken: AuthTokenFetcher): Promise<void>;
+    // Warning: (ae-forgotten-export) The symbol "PublicQueryNames" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ArgsObject" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "NamedQuery" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "QueryJournal" needs to be exported by the entry point index.d.ts
+    watchQuery<Name extends PublicQueryNames<API>>(name: Name, args: ArgsObject<NamedQuery<API, Name>>, journal?: QueryJournal): Watch<ReturnType<NamedQuery<API, Name>>>;
+}
+
+// Warning: (ae-forgotten-export) The symbol "OptimisticLocalStore" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function optimisticallyUpdateValueInPaginatedQuery<API extends GenericAPI, Name extends PaginatedQueryNames<API>>(localStore: OptimisticLocalStore<API>, name: Name, args: PaginatedQueryArgs<NamedQuery<API, Name>>, updateValue: (currentValue: PaginatedQueryReturnType<NamedQuery<API, Name>>) => PaginatedQueryReturnType<NamedQuery<API, Name>>): void;
+
+// Warning: (ae-forgotten-export) The symbol "Expand" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "BetterOmit" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type PaginatedQueryArgs<Query extends PaginatedQueryFunction<any, any>> = Expand<BetterOmit<Parameters<Query>[0], "paginationOpts">>;
+
+// Warning: (ae-forgotten-export) The symbol "PaginationResult" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type PaginatedQueryFunction<Args extends object, ReturnType> = (args: {
+    paginationOpts: PaginationOptions;
+} & Args) => PaginationResult<ReturnType>;
+
+// Warning: (ae-forgotten-export) The symbol "PickByValue" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type PaginatedQueryNames<API extends GenericAPI> = keyof PickByValue<API["publicQueries"], PaginatedQueryFunction<any, any>> & string;
+
+// @public
+export type PaginatedQueryReturnType<Query extends PaginatedQueryFunction<any, any>> = Query extends PaginatedQueryFunction<any, infer ReturnType> ? ReturnType : never;
+
+// @public
+export interface ReactAction<API extends GenericAPI, Name extends PublicActionNames<API>> {
+    // Warning: (ae-forgotten-export) The symbol "OptionalRestArgs" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "NamedAction" needs to be exported by the entry point index.d.ts
+    (...args: OptionalRestArgs<NamedAction<API, Name>>): Promise<ReturnType<NamedAction<API, Name>>>;
+}
+
+// @public
+export interface ReactClientOptions {
+    unsavedChangesWarning?: boolean;
+    verbose?: boolean;
+    webSocketConstructor?: typeof WebSocket;
+}
+
+// @public
+export interface ReactMutation<API extends GenericAPI, Name extends PublicMutationNames<API>> {
+    // Warning: (ae-forgotten-export) The symbol "NamedMutation" needs to be exported by the entry point index.d.ts
+    (...args: OptionalRestArgs<NamedMutation<API, Name>>): Promise<ReturnType<NamedMutation<API, Name>>>;
+    // Warning: (ae-forgotten-export) The symbol "OptimisticUpdate" needs to be exported by the entry point index.d.ts
+    withOptimisticUpdate(optimisticUpdate: OptimisticUpdate<API, ArgsObject<NamedMutation<API, Name>>>): ReactMutation<API, Name>;
+}
+
+// @public
+export type RequestForQueries = Record<string, {
+    name: string;
+    args: Record<string, Value>;
+}>;
+
+// @public
+export function Unauthenticated({ children }: {
+    children: ReactNode;
+}): JSX.Element | null;
+
+// @public
+export type UseActionForAPI<API extends GenericAPI> = <Name extends PublicActionNames<API>>(name: Name) => ReactAction<API, Name>;
+
+// @public
+export function useActionGeneric<API extends GenericAPI, Name extends PublicActionNames<API>>(name: Name): ReactAction<API, Name>;
+
+// @public
+export function useConvexAuth(): {
+    isLoading: boolean;
+    isAuthenticated: boolean;
+};
+
+// @public
+export type UseConvexForAPI<API extends GenericAPI> = () => ConvexReactClient<API>;
+
+// @public
+export function useConvexGeneric<API extends GenericAPI>(): ConvexReactClient<API>;
+
+// @public
+export type UseMutationForAPI<API extends GenericAPI> = <Name extends PublicMutationNames<API>>(name: Name) => ReactMutation<API, Name>;
+
+// @public
+export function useMutationGeneric<API extends GenericAPI, Name extends PublicMutationNames<API>>(name: Name): ReactMutation<API, Name>;
+
+// @public
+export type UsePaginatedQueryForAPI<API extends GenericAPI> = <Name extends PaginatedQueryNames<API>>(name: Name, args: PaginatedQueryArgs<NamedQuery<API, Name>>, options: {
+    initialNumItems: number;
+}) => UsePaginatedQueryResult<PaginatedQueryReturnType<NamedQuery<API, Name>>>;
+
+// @public
+export function usePaginatedQueryGeneric(name: string, args: Record<string, Value>, options: {
+    initialNumItems: number;
+}): UsePaginatedQueryResult<any>;
+
+// @public
+export type UsePaginatedQueryResult<T> = {
+    results: T[];
+} & ({
+    status: "CanLoadMore";
+    loadMore: (numItems: number) => void;
+} | {
+    status: "LoadingMore";
+    loadMore: undefined;
+} | {
+    status: "Exhausted";
+    loadMore: undefined;
+});
+
+// @public
+export type UseQueriesForAPI<API extends GenericAPI> = <QueryNameMap extends Record<string, PublicQueryNames<API>>>(queries: {
+    [Identifier in keyof QueryNameMap]: {
+        name: QueryNameMap[Identifier];
+        args: ArgsObject<NamedQuery<API, QueryNameMap[Identifier]>>;
+    };
+}) => {
+    [Identifier in keyof QueryNameMap]: ReturnType<NamedQuery<API, QueryNameMap[Identifier]>> | undefined | Error;
+};
+
+// @public
+export function useQueriesGeneric(queries: RequestForQueries): Record<string, any | undefined | Error>;
+
+// Warning: (ae-forgotten-export) The symbol "ArgsAndOptions" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type UseQueryForAPI<API extends GenericAPI> = <Name extends PublicQueryNames<API>>(name: Name, ...argsAndOptions: ArgsAndOptions<NamedQuery<API, Name>, UseQueryOptions>) => ReturnType<NamedQuery<API, Name>> | undefined;
+
+// @public
+export function useQueryGeneric(name: string, args?: Record<string, Value>, _options?: UseQueryOptions): unknown | undefined;
+
+// Warning: (ae-internal-missing-underscore) The name "useQueryInternal" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function useQueryInternal(convex: ConvexReactClient<any>, name: string, args?: Record<string, Value>, _options?: UseQueryOptions): unknown | undefined;
+
+// @public
+export interface UseQueryOptions {
+}
+
+// @public
+export interface Watch<T> {
+    journal(): QueryJournal | undefined;
+    localQueryResult(): T | undefined;
+    onUpdate(callback: () => void): () => void;
+}
+
+// Warnings were encountered during analysis:
+//
+// src/react/ConvexAuthState.tsx:64:3 - (ae-forgotten-export) The symbol "IConvexReactClient" needs to be exported by the entry point index.d.ts
+// src/react/use_paginated_query.ts:283:5 - (ae-forgotten-export) The symbol "PaginationOptions" needs to be exported by the entry point index.d.ts
+// src/react/use_queries.ts:161:5 - (ae-forgotten-export) The symbol "Value" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-extractor-configs/temp/schema-tmp.api.md

@@ -0,0 +1,105 @@
+## API Report File for "convex"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// Warning: (ae-forgotten-export) The symbol "MaybeMakeLooseDataModel" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "MaybeMakeLooseTableInfo" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type DataModelFromSchemaDefinition<SchemaDef extends SchemaDefinition<any, boolean>> = MaybeMakeLooseDataModel<{
+    [TableName in keyof SchemaDef["tables"] & string]: SchemaDef["tables"][TableName] extends TableDefinition<infer Document, infer FieldPaths, infer Indexes, infer SearchIndexes> ? MaybeMakeLooseTableInfo<{
+        document: Expand<IdField<TableName> & Document>;
+        fieldPaths: keyof IdField<TableName> | FieldPaths;
+        indexes: Expand<Indexes & SystemIndexes>;
+        searchIndexes: SearchIndexes;
+    }, SchemaDef["isStrict"]> : never;
+}, SchemaDef["isStrict"]>;
+
+// @public
+export function defineSchema<Schema extends GenericSchema, IsStrict extends boolean = true>(schema: Schema, options?: DefineSchemaOptions<IsStrict>): SchemaDefinition<Schema, IsStrict>;
+
+// @public
+export interface DefineSchemaOptions<IsStrict extends boolean> {
+    // (undocumented)
+    exportDocumentType?: boolean;
+    strict?: IsStrict;
+}
+
+// Warning: (ae-forgotten-export) The symbol "Validator" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "ExtractDocument" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "ExtractFieldPaths" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function defineTable<DocumentSchema extends Validator<Record<string, any>, false, any>>(documentSchema: DocumentSchema): TableDefinition<ExtractDocument<DocumentSchema>, ExtractFieldPaths<DocumentSchema>>;
+
+// Warning: (ae-forgotten-export) The symbol "ObjectValidator" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function defineTable<DocumentSchema extends Record<string, Validator<any, any, any>>>(documentSchema: DocumentSchema): TableDefinition<ExtractDocument<ObjectValidator<DocumentSchema>>, ExtractFieldPaths<ObjectValidator<DocumentSchema>>>;
+
+// @public
+export type GenericSchema = Record<string, TableDefinition>;
+
+// @public
+export class SchemaDefinition<Schema extends GenericSchema, IsStrict extends boolean> {
+    // @internal
+    constructor(tables: Schema, options?: DefineSchemaOptions<IsStrict>);
+    // @internal
+    export(): string;
+    // (undocumented)
+    isStrict: IsStrict;
+    // (undocumented)
+    tables: Schema;
+}
+
+// @public
+export interface SearchIndexConfig<SearchField extends string, FilterFields extends string> {
+    filterFields?: FilterFields[];
+    searchField: SearchField;
+}
+
+// Warning: (ae-forgotten-export) The symbol "GenericDocument" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "GenericTableIndexes" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "GenericTableSearchIndexes" needs to be exported by the entry point index.d.ts
+//
+// @public
+export class TableDefinition<Document extends GenericDocument = GenericDocument, FieldPaths extends string = string, Indexes extends GenericTableIndexes = {}, SearchIndexes extends GenericTableSearchIndexes = {}> {
+    // @internal
+    constructor(documentType: Validator<any, any, any>);
+    // @internal
+    export(): {
+        indexes: {
+            indexDescriptor: string;
+            fields: string[];
+        }[];
+        searchIndexes: {
+            indexDescriptor: string;
+            searchField: string;
+            filterFields: string[];
+        }[];
+        referencedTableNames: Set<string>;
+        documentType: string;
+    };
+    // Warning: (ae-forgotten-export) The symbol "IndexTiebreakerField" needs to be exported by the entry point index.d.ts
+    index<IndexName extends string, FirstFieldPath extends FieldPaths, RestFieldPaths extends FieldPaths[]>(name: IndexName, fields: [FirstFieldPath, ...RestFieldPaths]): TableDefinition<Document, FieldPaths, Expand<Indexes & Record<IndexName, [
+    FirstFieldPath,
+    ...RestFieldPaths,
+    IndexTiebreakerField
+    ]>>, SearchIndexes>;
+    searchIndex<IndexName extends string, SearchField extends FieldPaths, FilterFields extends FieldPaths = never>(name: IndexName, indexConfig: Expand<SearchIndexConfig<SearchField, FilterFields>>): TableDefinition<Document, FieldPaths, Indexes, Expand<SearchIndexes & Record<IndexName, {
+        searchField: SearchField;
+        filterFields: FilterFields;
+    }>>>;
+}
+
+// Warnings were encountered during analysis:
+//
+// src/schema/index.ts:448:13 - (ae-forgotten-export) The symbol "Expand" needs to be exported by the entry point index.d.ts
+// src/schema/index.ts:448:13 - (ae-forgotten-export) The symbol "IdField" needs to be exported by the entry point index.d.ts
+// src/schema/index.ts:450:13 - (ae-forgotten-export) The symbol "SystemIndexes" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```