feat(NODE-4795): deprecate addUser helper (#3624)

Author: durran

src/admin.ts

@@ -106,6 +106,8 @@ export class Admin {
    * @param username - The username for the new user
    * @param passwordOrOptions - An optional password for the new user, or the options for the command
    * @param options - Optional settings for the command
+   * @deprecated Use the createUser command in `db.command()` instead.
+   * @see https://www.mongodb.com/docs/manual/reference/command/createUser/
    */
   async addUser(
     username: string,

src/db.ts

@@ -405,6 +405,8 @@ export class Db {
    * @param username - The username for the new user
    * @param passwordOrOptions - An optional password for the new user, or the options for the command
    * @param options - Optional settings for the command
+   * @deprecated Use the createUser command in `db.command()` instead.
+   * @see https://www.mongodb.com/docs/manual/reference/command/createUser/
    */
   async addUser(
     username: string,

src/operations/add_user.ts

@@ -9,7 +9,10 @@ import { Callback, emitWarningOnce, getTopology } from '../utils';
 import { CommandOperation, CommandOperationOptions } from './command';
 import { Aspect, defineAspects } from './operation';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use the createUser command directly instead.
+ */
 export interface RoleSpecification {
   /**
    * A role grants privileges to perform sets of actions on defined resources.
@@ -20,7 +23,10 @@ export interface RoleSpecification {
   db: string;
 }
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use the createUser command directly instead.
+ */
 export interface AddUserOptions extends CommandOperationOptions {
   /** Roles associated with the created user */
   roles?: string | string[] | RoleSpecification | RoleSpecification[];