Clean up some deprecated type in our npm package (#23044)

sshader · Convex, Inc. · commit b0e5a41a5f02 · 2024-03-27T18:24:39.000Z
These are things like `DatabaseReader` which have been replaced with `GenericDatabaseReader` (and the codegen-ed data model specific `DatabaseReader`).

This is a breaking change, but one I believe we should be fine with (some TS users will have to update their types as part of upgrading, the types have been marked deprecated for several months).

GitOrigin-RevId: 4326460172b5f8435a3e567f01ac57a2d1206c1b
diff --git a/npm-packages/convex/src/browser/index.ts b/npm-packages/convex/src/browser/index.ts
@@ -18,7 +18,6 @@
  */
 export { BaseConvexClient } from "./sync/client.js";
 export type {
-  ClientOptions,
   BaseConvexClientOptions,
   MutationOptions,
   SubscribeOptions,
diff --git a/npm-packages/convex/src/browser/sync/client.ts b/npm-packages/convex/src/browser/sync/client.ts
@@ -39,15 +39,6 @@ import { getMarksReport, mark, MarkName } from "./metrics.js";
 import { parseArgs, validateDeploymentUrl } from "../../common/index.js";
 import { ConvexError } from "../../values/errors.js";
 
-/**
- * Options for {@link BaseConvexClient}.
- *
- * @deprecated Use ConvexReactClientOptions, ConvexClientOptions, or BaseConvexClientOptions.
- *
- * @public
- */
-export interface ClientOptions extends BaseConvexClientOptions {}
-
 /**
  * Options for {@link BaseConvexClient}.
  *
@@ -680,12 +671,6 @@ export class BaseConvexClient {
     return this.webSocketManager.stop();
   }
 
-  private _logVerbose(message: string) {
-    if (this.verbose) {
-      console.debug(`${new Date().toISOString()} ${message}`);
-    }
-  }
-
   // Instance property so that `mark()` doesn't need to be called as a method.
   private mark = (name: MarkName) => {
     if (this.debug) {
diff --git a/npm-packages/convex/src/server/database.ts b/npm-packages/convex/src/server/database.ts
@@ -12,17 +12,6 @@ import {
   WithoutSystemFields,
 } from "./system_fields.js";
 
-/**
- *
- * @deprecated If you're using code generation, use the `DatabaseReader` type in
- * `convex/_generated/server.d.ts` which is typed for your data model.
- * If you need an unparameterized DatabaseReader use GenericDatabaseReader.
- *
- * @public
- */
-export interface DatabaseReader<DataModel extends GenericDataModel>
-  extends BaseDatabaseReader<DataModel> {}
-
 interface BaseDatabaseReader<DataModel extends GenericDataModel> {
   /**
    * Fetch a single document from the database by its {@link values.GenericId}.
@@ -79,7 +68,7 @@ interface BaseDatabaseReader<DataModel extends GenericDataModel> {
  * @public
  */
 export interface GenericDatabaseReader<DataModel extends GenericDataModel>
-  extends DatabaseReader<DataModel> {
+  extends BaseDatabaseReader<DataModel> {
   /**
    * An interface to read from the system tables within Convex query functions
    *
@@ -94,13 +83,20 @@ export interface GenericDatabaseReader<DataModel extends GenericDataModel>
 }
 
 /**
- * @deprecated If you're using code generation, use the `DatabaseWriter` type in
+ * An interface to read from and write to the database within Convex mutation
+ * functions.
+ *
+ * Convex guarantees that all writes within a single mutation are
+ * executed atomically, so you never have to worry about partial writes leaving
+ * your data in an inconsistent state. See [the Convex Guide](https://docs.convex.dev/understanding/convex-fundamentals/functions#atomicity-and-optimistic-concurrency-control)
+ * for the guarantees Convex provides your functions.
+ *
+ *  If you're using code generation, use the `DatabaseReader` type in
  * `convex/_generated/server.d.ts` which is typed for your data model.
- * If you need an unparameterized DatabaseWriter use GenericDatabaseWriter.
  *
  * @public
  */
-export interface DatabaseWriter<DataModel extends GenericDataModel>
+export interface GenericDatabaseWriter<DataModel extends GenericDataModel>
   extends GenericDatabaseReader<DataModel> {
   /**
    * Insert a new document into a table.
@@ -149,20 +145,3 @@ export interface DatabaseWriter<DataModel extends GenericDataModel>
    */
   delete(id: GenericId<TableNamesInDataModel<DataModel>>): Promise<void>;
 }
-
-/**
- * An interface to read from and write to the database within Convex mutation
- * functions.
- *
- * Convex guarantees that all writes within a single mutation are
- * executed atomically, so you never have to worry about partial writes leaving
- * your data in an inconsistent state. See [the Convex Guide](https://docs.convex.dev/understanding/convex-fundamentals/functions#atomicity-and-optimistic-concurrency-control)
- * for the guarantees Convex provides your functions.
- *
- *  If you're using code generation, use the `DatabaseReader` type in
- * `convex/_generated/server.d.ts` which is typed for your data model.
- *
- * @public
- */
-export interface GenericDatabaseWriter<DataModel extends GenericDataModel>
-  extends DatabaseWriter<DataModel> {}
diff --git a/npm-packages/convex/src/server/index.ts b/npm-packages/convex/src/server/index.ts
@@ -101,7 +101,6 @@ export * from "./pagination.js";
 export type { OrderedQuery, Query, QueryInitializer } from "./query.js";
 export type {
   ActionBuilder,
-  ActionCtx,
   ArgsArray,
   DefaultFunctionArgs,
   HttpActionBuilder,
@@ -111,12 +110,10 @@ export type {
   GenericQueryCtx,
   MutationBuilder,
   PublicHttpAction,
-  MutationCtx,
   RegisteredAction,
   RegisteredMutation,
   RegisteredQuery,
   QueryBuilder,
-  QueryCtx,
   UnvalidatedFunction,
   ValidatedFunction,
 } from "./registration.js";
diff --git a/npm-packages/convex/src/server/registration.ts b/npm-packages/convex/src/server/registration.ts
@@ -56,18 +56,6 @@ export interface GenericMutationCtx<DataModel extends GenericDataModel> {
   scheduler: Scheduler;
 }
 
-/**
- * If you're using code generation, use the `MutationCtx` type in
- * `convex/_generated/server.d.ts` which is typed for your data model.
- *
- * If you need an unparameterized MutationCtx use GenericMutationCtx.
- *
- * @public
- * @deprecated
- */
-export interface MutationCtx<DataModel extends GenericDataModel>
-  extends GenericMutationCtx<DataModel> {}
-
 /**
  * A set of services for use within Convex query functions.
  *
@@ -97,18 +85,6 @@ export interface GenericQueryCtx<DataModel extends GenericDataModel> {
   storage: StorageReader;
 }
 
-/**
- * If you're using code generation, use the `QueryCtx` type in
- * `convex/_generated/server.d.ts` which is typed for your data model.
- *
- * If you need an unparameterized QueryCtx use GenericQueryCtx.
- *
- * @public
- * @deprecated
- */
-export interface QueryCtx<DataModel extends GenericDataModel>
-  extends GenericQueryCtx<DataModel> {}
-
 /**
  * A set of services for use within Convex action functions.
  *
@@ -205,19 +181,6 @@ export interface GenericActionCtx<DataModel extends GenericDataModel> {
   ): Promise<Array<{ _id: Id<TableName>; _score: number }>>;
 }
 
-/**
- * If you're using code generation, use the `ActionCtx` type in
- * `convex/_generated/server.d.ts` which is typed for your data model.
- *
- * If you need an unparameterized ActionCtx use GenericActionCtx.
- *
- * @public
- * @deprecated
- */
-export interface ActionCtx<
-  DataModel extends GenericDataModel = GenericDataModel,
-> extends GenericActionCtx<DataModel> {}
-
 /**
  * The default arguments type for a Convex query, mutation, or action function.
  *
