Update to Convex 0.13.0

Author: sshader

convex/_generated/api.d.ts

@@ -4,7 +4,7 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */

convex/_generated/dataModel.d.ts

@@ -4,7 +4,7 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */
@@ -24,7 +24,7 @@ export type TableNames = TableNamesInDataModel<DataModel>;
  *
  * @typeParam TableName - A string literal type of the table name (like "users").
  */
-export type Document<TableName extends TableNames> = DocumentByName<
+export type Doc<TableName extends TableNames> = DocumentByName<
   DataModel,
   TableName
 >;

convex/_generated/dataModel.js

@@ -4,7 +4,7 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */

convex/_generated/react.d.ts

@@ -4,7 +4,7 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */
@@ -85,7 +85,8 @@ export declare const useConvex: UseConvexForAPI<API>;
  *
  * This hook must be used with Convex query functions that match
  * {@link PaginatedQueryFunction}. This means they must:
- * 1. Have a first argument must be an object containing `numItems` and `cursor`.
+ * 1. Have a single arguments object with a `paginationOpts` property
+ * of type {@link server.PaginationOptions}.
  * 2. Return a {@link PaginationResult}.
  *
  * `usePaginatedQuery` concatenates all the pages
@@ -96,15 +97,23 @@ export declare const useConvex: UseConvexForAPI<API>;
  * ```typescript
  * const { results, status, loadMore } = usePaginatedQuery(
  *   "listMessages",
- *   { initialNumItems: 5 },
- *   "#general"
+ *   { channel: "#general" },
+ *   { initialNumItems: 5 }
  * );
  * ```
  *
+ * If the query `name` or `args` change, the pagination state will be reset
+ * to the first page. Similarly, if any of the pages result in an InvalidCursor
+ * or QueryScannedTooManyDocuments error, the pagination state will also reset
+ * to the first page.
+ *
+ * To learn more about pagination, see [Paginated Queries](https://docs.convex.dev/using/pagination).
+ *
  * @param name - The name of the query function.
+ * @param args - The arguments object for the query function, excluding
+ * the `paginationOpts` property. That property is injected by this hook.
  * @param options - An object specifying the `initialNumItems` to be loaded in
  * the first page.
- * @param args - The arguments to the query function, excluding the first.
  * @returns A {@link UsePaginatedQueryResult} that includes the currently loaded
  * items, the status of the pagination, and a `loadMore` function.
  */

convex/_generated/react.js

@@ -4,7 +4,7 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */
@@ -83,7 +83,8 @@ export const useConvex = useConvexGeneric;
  *
  * This hook must be used with Convex query functions that match
  * {@link PaginatedQueryFunction}. This means they must:
- * 1. Have a first argument must be an object containing `numItems` and `cursor`.
+ * 1. Have a single arguments object with a `paginationOpts` property
+ * of type {@link server.PaginationOptions}.
  * 2. Return a {@link PaginationResult}.
  *
  * `usePaginatedQuery` concatenates all the pages
@@ -94,8 +95,8 @@ export const useConvex = useConvexGeneric;
  * ```typescript
  * const { results, status, loadMore } = usePaginatedQuery(
  *   "listMessages",
- *   { initialNumItems: 5 },
- *   "#general"
+ *   { channel: "#general" },
+ *   { initialNumItems: 5 }
  * );
  * ```
  *
@@ -107,9 +108,10 @@ export const useConvex = useConvexGeneric;
  * To learn more about pagination, see [Paginated Queries](https://docs.convex.dev/using/pagination).
  *
  * @param name - The name of the query function.
+ * @param args - The arguments object for the query function, excluding
+ * the `paginationOpts` property. That property is injected by this hook.
  * @param options - An object specifying the `initialNumItems` to be loaded in
  * the first page.
- * @param args - The arguments to the query function, excluding the first.
  * @returns A {@link UsePaginatedQueryResult} that includes the currently loaded
  * items, the status of the pagination, and a `loadMore` function.
  */

convex/_generated/server.d.ts

@@ -4,18 +4,18 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */
 
 import {
-  ActionBuilderForAPI,
-  HttpEndpointBuilderForAPI,
+  ActionBuilder,
+  HttpActionBuilderForAPI,
   MutationBuilder,
-  QueryBuilderForDataModel,
+  QueryBuilder,
+  CronJobsForAPI,
   ActionCtx as GenericActionCtx,
-  HttpEndpointCtx as GenericHttpEndpointCtx,
   MutationCtx as GenericMutationCtx,
   QueryCtx as GenericQueryCtx,
   DatabaseReader as GenericDatabaseReader,
@@ -24,6 +24,30 @@ import {
 import type { DataModel } from "./dataModel.js";
 import type { API } from "./api.js";
 
+/**
+ * Returns a cron job scheduler, used to schedule Convex functions to run on a recurring basis.
+ *
+ * ```js
+ * // convex/crons.js
+ * import { cronJobs } from './_generated/server';
+ *
+ * const crons = cronJobs();
+ * crons.weekly(
+ *   "weekly re-engagement email",
+ *   {
+ *     hourUTC: 17, // (9:30am Pacific/10:30am Daylight Savings Pacific)
+ *     minuteUTC: 30,
+ *   },
+ *   "sendEmails"
+ * )
+ * export default crons;
+ * ```
+ *
+ * @returns The cron job scheduler object. Create this object in `convex/crons.js` and export it
+ * as the default export.
+ */
+export declare const cronJobs: CronJobsForAPI<API>;
+
 /**
  * Define a query in this Convex app's public API.
  *
@@ -32,7 +56,17 @@ import type { API } from "./api.js";
  * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
  * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
  */
-export declare const query: QueryBuilderForDataModel<DataModel>;
+export declare const query: QueryBuilder<DataModel, "public">;
+
+/**
+ * Define a query that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to read from your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
+ * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalQuery: QueryBuilder<DataModel, "internal">;
 
 /**
  * Define a mutation in this Convex app's public API.
@@ -42,34 +76,54 @@ export declare const query: QueryBuilderForDataModel<DataModel>;
  * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
  * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
  */
-export declare const mutation: MutationBuilder<DataModel, API>;
+export declare const mutation: MutationBuilder<DataModel, API, "public">;
+
+/**
+ * Define a mutation that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to modify your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
+ * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalMutation: MutationBuilder<
+  DataModel,
+  API,
+  "internal"
+>;
 
 /**
  * Define an action in this Convex app's public API.
  *
  * An action is a function which can execute any JavaScript code, including non-deterministic
- * code and code with side-effects. Actions are often used to call into third-party services.
- * Actions execute in a Node.js environment and can interact with the database indirectly by
- * calling queries and mutations via the provided {@link ActionCtx} object. Actions need to be defined
- * in the `/convex/actions  directory`. Queries and mutations, on the other hand, must be defined
- * outside of the `/convex/actions directory`.
+ * code and code with side-effects, like calling third-party services.
+ * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
+ * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
  *
- * @param func - The action. It receives a {@link ActionCtx} as its first argument.
+ * @param func - The action. It receives an {@link ActionCtx} as its first argument.
  * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
  */
-export declare const action: ActionBuilderForAPI<API>;
+export declare const action: ActionBuilder<API, "public">;
+
+/**
+ * Define an action that is only accessible from other Convex functions (but not from the client).
+ *
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalAction: ActionBuilder<API, "internal">;
 
 /**
- * Define an HTTP endpoint.
+ * Define an HTTP action.
  *
  * This function will be used to respond to HTTP requests received by a Convex
- * deployment if the requests matches the path and method where this endpoint
- * is routed. Be sure to route your endpoint in `convex/http.js`.
+ * deployment if the requests matches the path and method where this action
+ * is routed. Be sure to route your action in `convex/http.js`.
  *
- * @param func - The endpoint function. It receives a {@link HttpEndpointCtx} as its first argument.
- * @returns The wrapped endpoint function. Import this function from `convex/http.js` and route it to hook it up.
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped function. Import this function from `convex/http.js` and route it to hook it up.
  */
-export declare const httpEndpoint: HttpEndpointBuilderForAPI<API>;
+export declare const httpAction: HttpActionBuilderForAPI<API>;
 
 /**
  * A set of services for use within Convex query functions.
@@ -98,14 +152,6 @@ export type MutationCtx = GenericMutationCtx<DataModel, API>;
  */
 export type ActionCtx = GenericActionCtx<API>;
 
-/**
- * A set of services for use within Convex HTTP endpoints.
- *
- * The HttpEndpointCtx is passed as the first argument to any Convex HTTP
- * endpoint run on the server.
- */
-export type HttpEndpointCtx = GenericHttpEndpointCtx<API>;
-
 /**
  * An interface to read from the database within Convex query functions.
  *

convex/_generated/server.js

@@ -4,16 +4,20 @@
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
- * Generated by convex@0.9.2.
+ * Generated by convex@0.13.0.
  * To regenerate, run `npx convex codegen`.
  * @module
  */
 
 import {
   actionGeneric,
-  httpEndpointGeneric,
+  httpActionGeneric,
   queryGeneric,
   mutationGeneric,
+  internalActionGeneric,
+  internalMutationGeneric,
+  internalQueryGeneric,
+  cronJobsGeneric,
 } from "convex/server";
 
 /**
@@ -26,6 +30,16 @@ import {
  */
 export const query = queryGeneric;
 
+/**
+ * Define a query that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to read from your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
+ * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
+ */
+export const internalQuery = internalQueryGeneric;
+
 /**
  * Define a mutation in this Convex app's public API.
  *
@@ -36,26 +50,66 @@ export const query = queryGeneric;
  */
 export const mutation = mutationGeneric;
 
+/**
+ * Define a mutation that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to modify your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
+ * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
+ */
+export const internalMutation = internalMutationGeneric;
+
 /**
  * Define an action in this Convex app's public API.
  *
  * An action is a function which can execute any JavaScript code, including non-deterministic
- * code and code with side-effects. Actions are often used to call into third-party services.
- * Actions execute in a Node.js environment and can interact with the database indirectly by
- * calling queries and mutations via the provided {@link ActionCtx} object. Actions need to be defined
- * in the `/convex/actions  directory`. Queries and mutations, on the other hand, must be defined
- * outside of the `/convex/actions directory`.
+ * code and code with side-effects, like calling third-party services.
+ * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
+ * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
  *
- * @param func - The action. It receives a {@link ActionCtx} as its first argument.
+ * @param func - The action. It receives an {@link ActionCtx} as its first argument.
  * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
  */
 export const action = actionGeneric;
 
 /**
- * Define a Convex HTTP endpoint.
+ * Define an action that is only accessible from other Convex functions (but not from the client).
+ *
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
+ */
+export const internalAction = internalActionGeneric;
+
+/**
+ * Define a Convex HTTP action.
  *
- * @param func - The function. It receives an {@link HttpEndpointCtx} as its first argument, and a `Request` object
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument, and a `Request` object
  * as its second.
  * @returns The wrapped endpoint function. Route a URL path to this function in `convex/http.js`.
  */
-export const httpEndpoint = httpEndpointGeneric;
+export const httpAction = httpActionGeneric;
+
+/**
+ * Returns a cron job scheduler, used to schedule Convex functions to run on a recurring basis.
+ *
+ * ```js
+ * // convex/crons.js
+ * import { cronJobs } from './_generated/server';
+ *
+ * const crons = cronJobs();
+ * crons.weekly(
+ *   "weekly re-engagement email",
+ *   {
+ *     hourUTC: 17, // (9:30am Pacific/10:30am Daylight Savings Pacific)
+ *     minuteUTC: 30,
+ *   },
+ *   "sendEmails"
+ * )
+ * export default crons;
+ * ```
+ *
+ * @returns The cron job scheduler object. Create this object in `convex/crons.js` and export it
+ * as the default export.
+ */
+export const cronJobs = cronJobsGeneric;