feat: Remove member-finding aliases from Org instances and simplify t…

…he names of said methods in the Client. BREAKING

README.md

@@ -47,7 +47,7 @@ const bravoClient = new BravoClient({
 });
 
 async function doFavroStuff() {
-  const org = await bravoClient.getCurrentOrganization();
+  await bravoClient.getCurrentOrganization();
 
   // Find a Widget (a.k.a. Board)
   const widget = await bravoClient.findWidgetByName('My To Do List');
@@ -59,7 +59,7 @@ async function doFavroStuff() {
   });
 
   // Find the userId for an assignee
-  const assignee = await org.findMemberByName('Scam Likely');
+  const assignee = await bravoClient.findMemberByName('Scam Likely');
 
   // Use the update-builder to create and send an update
   // that covers multiple fields.

src/lib/BravoClient.ts

@@ -45,7 +45,7 @@ import { basename } from 'path';
  * The `BravoClient` class should be singly-instanced for a given
  * set of credentials and a target organization. Once the organizationId
  * is set (either out of the gate via env var or construct args, or
- * by using `client.setOrganizationIdByName` when the org name is known
+ * by using `client.chooseOrganizationByName` when the org name is known
  * but the id is not).
  *
  * All Favro API fetching and caching is centralized and managed in
@@ -140,7 +140,7 @@ export class BravoClient extends FavroClient {
   /**
    * Full user info for the org (includes emails and names).
    */
-  async listOrganizationMembers() {
+  async listMembers() {
     const org = await this.getCurrentOrganization();
     assertBravoClaim(org, 'Organization not set');
     if (!this.cache.users) {
@@ -154,30 +154,28 @@ export class BravoClient extends FavroClient {
     return this.cache.users;
   }
 
-  async findOrganizationMember(match: (user: BravoUser) => any) {
-    const members = await this.listOrganizationMembers();
+  async findMember(match: (user: BravoUser) => any) {
+    const members = await this.listMembers();
     return members.find((user) => match(user));
   }
 
-  async findOrganizationMemberByEmail(email: string | RegExp) {
-    return await this.findOrganizationMemberByField('email', email);
+  async findMemberByEmail(email: string | RegExp) {
+    return await this.findMemberByField('email', email);
   }
 
-  async findOrganizationMemberByName(name: string | RegExp) {
-    return await this.findOrganizationMemberByField('name', name);
+  async findMemberByName(name: string | RegExp) {
+    return await this.findMemberByField('name', name);
   }
 
-  async findOrganizationMemberByUserId(userId: string) {
-    return await this.findOrganizationMemberByField('userId', userId);
+  async findMemberByUserId(userId: string) {
+    return await this.findMemberByField('userId', userId);
   }
 
-  private async findOrganizationMemberByField(
+  private async findMemberByField(
     field: 'email' | 'name' | 'userId',
     value: string | RegExp,
   ) {
-    return await this.findOrganizationMember((user) =>
-      user[field]?.match(value),
-    );
+    return await this.findMember((user) => user[field]?.match(value));
   }
 
   //#endregion

src/lib/entities/BravoOrganization.ts

@@ -1,10 +1,8 @@
-import type {
-  DataFavroOrganization,
-  DataFavroUser,
-} from '$types/FavroApiTypes';
+import type { DataFavroOrganization } from '$types/FavroApiTypes';
 import { BravoEntity } from '$lib/BravoEntity.js';
-import { BravoOrganizationMember, BravoUser } from './users.js';
+import { BravoOrganizationMember } from './users.js';
 
+/** Hydrated Favro Organization. */
 export class BravoOrganization extends BravoEntity<DataFavroOrganization> {
   get name() {
     return this._data.name;
@@ -20,26 +18,6 @@ export class BravoOrganization extends BravoEntity<DataFavroOrganization> {
     return this._data.organizationId;
   }
 
-  async listMembers() {
-    return await this._client.listOrganizationMembers();
-  }
-
-  async findMember(match: (user: BravoUser) => any) {
-    return await this._client.findOrganizationMember(match);
-  }
-
-  async findMemberByEmail(email: string | RegExp) {
-    return await this._client.findOrganizationMemberByEmail(email);
-  }
-
-  async findMemberByName(name: string | RegExp) {
-    return await this._client.findOrganizationMemberByName(name);
-  }
-
-  async findMemberByUserId(userId: string) {
-    return await this._client.findOrganizationMemberByUserId(userId);
-  }
-
   equals(org: BravoOrganization) {
     return (
       this.hasSameConstructor(org) && this.organizationId === org.organizationId

src/test/client.test.ts

@@ -176,9 +176,7 @@ describe('BravoClient', function () {
   });
 
   it('can find a specific user by email', async function () {
-    const me = await (await client.getCurrentOrganization())!.findMemberByEmail(
-      myUserEmail,
-    )!;
+    const me = await client.findOrganizationMemberByEmail(myUserEmail)!;
     expect(me).to.exist;
     expect(me!.email).to.equal(myUserEmail);
   });