feat: Rename classes to be more consistent between use of 'Bravo' vs.…

… 'Favro'

src/lib/BravoClient.ts

@@ -7,10 +7,10 @@ import {
   findRequiredByField,
   stringsMatchIgnoringCase,
 } from './utility.js';
-import { FavroCollection } from './FavroCollection';
-import { FavroUser } from './FavroUser';
-import { FavroOrganization } from './FavroOrganization';
-import { FavroWidget } from './FavroWidget.js';
+import { BravoCollection } from './BravoCollection';
+import { BravoUser } from './users';
+import { BravoOrganization } from './BravoOrganization';
+import { BravoWidget } from './BravoWidget.js';
 import type { DataFavroWidget } from '$/types/FavroWidgetTypes.js';
 import type {
   OptionFavroCollectionVisibility,
@@ -54,10 +54,10 @@ export class BravoClient extends FavroClient {
         {
           excludeOrganizationId: true,
         },
-        FavroOrganization,
+        BravoOrganization,
       );
       this.cache.organizations =
-        (await res.getAllEntities()) as FavroOrganization[];
+        (await res.getAllEntities()) as BravoOrganization[];
     }
     return this.cache.organizations;
   }
@@ -101,9 +101,9 @@ export class BravoClient extends FavroClient {
       const res = await this.requestWithReturnedEntities(
         'users',
         { method: 'get' },
-        FavroUser,
+        BravoUser,
       );
-      this.cache.users = (await res.getAllEntities()) as FavroUser[];
+      this.cache.users = (await res.getAllEntities()) as BravoUser[];
     }
     return this.cache.users;
   }
@@ -180,10 +180,10 @@ export class BravoClient extends FavroClient {
           // ],
         },
       },
-      FavroCollection,
+      BravoCollection,
     );
     const collection = (await res.getAllEntities())[0] as
-      | FavroCollection
+      | BravoCollection
       | undefined;
     assertBravoClaim(collection, `Failed to create collection`);
     this.cache.addCollection(collection);
@@ -227,10 +227,10 @@ export class BravoClient extends FavroClient {
       const res = await this.requestWithReturnedEntities(
         'collections',
         { method: 'get' },
-        FavroCollection,
+        BravoCollection,
       );
       this.cache.collections =
-        (await res.getAllEntities()) as FavroCollection[];
+        (await res.getAllEntities()) as BravoCollection[];
     }
     return this.cache.collections;
   }
@@ -266,14 +266,14 @@ export class BravoClient extends FavroClient {
       const res = await this.requestWithReturnedEntities(
         `collections/${collectionId}`,
         { method: 'get' },
-        FavroCollection,
+        BravoCollection,
       );
       const collections = await res.getAllEntities();
       assertBravoClaim(
         collections.length == 1,
         `No collection found with id ${collectionId}`,
       );
-      collection = collections[0] as FavroCollection;
+      collection = collections[0] as BravoCollection;
     }
     return collection;
   }
@@ -293,8 +293,8 @@ export class BravoClient extends FavroClient {
       const res = (await this.requestWithReturnedEntities(
         'widgets',
         { method: 'get', query: { collectionId } },
-        FavroWidget,
-      )) as BravoResponseEntities<DataFavroWidget, FavroWidget>;
+        BravoWidget,
+      )) as BravoResponseEntities<DataFavroWidget, BravoWidget>;
       this.cache.addWidgets(res, collectionId);
     }
     return this.cache.getWidgets(collectionId)!;
@@ -307,18 +307,18 @@ export class BravoClient extends FavroClient {
    */
   async listWidgets(collectionId?: string) {
     const pager = await this.getWidgetsAsyncGenerator(collectionId);
-    const widgets = ((await pager?.getAllEntities()) || []) as FavroWidget[];
+    const widgets = ((await pager?.getAllEntities()) || []) as BravoWidget[];
     return widgets;
   }
 
   async findWidgetById(widgetCommonId: string) {
     const res = await this.requestWithReturnedEntities(
       `widgets/${widgetCommonId}`,
       { method: 'get' },
-      FavroWidget,
+      BravoWidget,
     );
     const [widget] = await res.getAllEntities();
-    return widget as FavroWidget;
+    return widget as BravoWidget;
   }
 
   /**
@@ -327,7 +327,7 @@ export class BravoClient extends FavroClient {
    * by the search are cached.
    */
   async findWidget(
-    matchFunction: (widget: FavroWidget, idx?: number) => any,
+    matchFunction: (widget: BravoWidget, idx?: number) => any,
     collectionId = '',
   ) {
     // Reduce API calls by non-exhaustively searching (when possible)

src/lib/FavroCollection.ts → src/lib/BravoCollection.ts

@@ -1,7 +1,7 @@
 import { DataFavroCollection } from '../types/FavroApiTypes';
-import { FavroEntity } from './FavroEntity.js';
+import { BravoEntity } from './BravoEntity.js';
 
-export class FavroCollection extends FavroEntity<DataFavroCollection> {
+export class BravoCollection extends BravoEntity<DataFavroCollection> {
   get name() {
     return this._data.name;
   }

src/lib/FavroEntity.ts → src/lib/BravoEntity.ts

@@ -3,7 +3,7 @@ import { BravoClient } from './BravoClient.js';
 /**
  * Base class for Favro Entities (wrapping raw API data)
  */
-export class FavroEntity<EntityData> {
+export class BravoEntity<EntityData> {
   constructor(protected _client: BravoClient, protected _data: EntityData) {}
 
   toJSON() {

src/lib/FavroOrganization.ts → src/lib/BravoOrganization.ts

@@ -1,15 +1,15 @@
 import type { DataFavroOrganization } from '../types/FavroApiTypes';
-import { FavroEntity } from './FavroEntity.js';
-import { FavroOrganizationMember } from './FavroUser.js';
+import { BravoEntity } from './BravoEntity.js';
+import { BravoOrganizationMember } from './users.js';
 
-export class FavroOrganization extends FavroEntity<DataFavroOrganization> {
+export class BravoOrganization extends BravoEntity<DataFavroOrganization> {
   get name() {
     return this._data.name;
   }
 
   get sharedToUsers() {
     return this._data.sharedToUsers.map(
-      (u) => new FavroOrganizationMember(this._client, u),
+      (u) => new BravoOrganizationMember(this._client, u),
     );
   }
 

src/lib/FavroWidget.ts → src/lib/BravoWidget.ts

@@ -1,7 +1,7 @@
 import { DataFavroWidget } from '$/types/FavroWidgetTypes.js';
-import { FavroEntity } from './FavroEntity';
+import { BravoEntity } from './BravoEntity';
 
-export class FavroWidget extends FavroEntity<DataFavroWidget> {
+export class BravoWidget extends BravoEntity<DataFavroWidget> {
   get widgetCommonId() {
     return this._data.widgetCommonId;
   }

src/lib/clientLib/BravoClientCache.ts

@@ -1,13 +1,13 @@
-import { FavroOrganization } from '@/FavroOrganization.js';
-import { FavroUser } from '@/FavroUser.js';
-import { FavroCollection } from '@/FavroCollection.js';
+import { BravoOrganization } from '@/BravoOrganization.js';
+import { BravoUser } from '@/users.js';
+import { BravoCollection } from '@/BravoCollection.js';
 import type { BravoResponseWidgets } from './BravoResponse.js';
 import { assertBravoClaim } from '@/errors.js';
 
 export class BravoClientCache {
-  protected _organizations?: FavroOrganization[];
-  protected _users?: FavroUser[];
-  protected _collections?: FavroCollection[];
+  protected _organizations?: BravoOrganization[];
+  protected _users?: BravoUser[];
+  protected _collections?: BravoCollection[];
   /**
    * Widget paging results keyed by collectionId, with the empty string `''`
    * used to key the paging result from not using a collectionId (global).
@@ -18,23 +18,23 @@ export class BravoClientCache {
     // @ts-expect-error
     return this._collections ? [...this._collections] : undefined;
   }
-  set collections(collections: FavroCollection[]) {
+  set collections(collections: BravoCollection[]) {
     this._collections = collections;
   }
 
   get users() {
     // @ts-expect-error
     return this._users ? [...this._users] : undefined;
   }
-  set users(users: FavroUser[]) {
+  set users(users: BravoUser[]) {
     this._users = users;
   }
 
   get organizations() {
     // @ts-expect-error
     return this._organizations ? [...this._organizations] : undefined;
   }
-  set organizations(orgs: FavroOrganization[]) {
+  set organizations(orgs: BravoOrganization[]) {
     this._organizations = orgs;
   }
 
@@ -65,7 +65,7 @@ export class BravoClientCache {
    * will be replaced by the one provided in this call (e.g. for
    * replacing the cached copy with an updated one).
    */
-  addCollection(collection: FavroCollection) {
+  addCollection(collection: BravoCollection) {
     if (!this._collections) {
       return;
     }

src/lib/clientLib/BravoResponse.ts

@@ -1,12 +1,12 @@
 import type { DataFavroWidget } from '$/types/FavroWidgetTypes.js';
-import type { FavroWidget } from '@/FavroWidget.js';
+import type { BravoWidget } from '@/BravoWidget.js';
 import { BravoClient } from '@/BravoClient';
-import { FavroEntity } from '@/FavroEntity';
+import { BravoEntity } from '@/BravoEntity';
 import { FavroResponse } from './FavroResponse';
 
 export type BravoResponseWidgets = BravoResponseEntities<
   DataFavroWidget,
-  FavroWidget
+  BravoWidget
 >;
 
 /**
@@ -15,7 +15,7 @@ export type BravoResponseWidgets = BravoResponseEntities<
  */
 export class BravoResponseEntities<
   EntityData,
-  Entity extends FavroEntity<EntityData>,
+  Entity extends BravoEntity<EntityData>,
 > {
   private _entitiesCache: Entity[] = [];
   private _hydratedLatestPage = false;

src/lib/clientLib/FavroClient.ts

@@ -3,7 +3,6 @@ import fetch from 'node-fetch';
 import { URL } from 'url';
 import type {
   DataAnyEntity,
-  ConstructorFavroEntity,
   OptionFavroHttpMethod,
 } from '$/types/FavroApiTypes';
 import { FavroResponse } from '@/clientLib/FavroResponse';

src/lib/FavroUser.ts → src/lib/users.ts

@@ -3,17 +3,17 @@ import type {
   DataFavroOrganizationMember,
   DataFavroUser,
 } from '../types/FavroApiTypes';
-import { FavroEntity } from './FavroEntity.js';
+import { BravoEntity } from './BravoEntity.js';
 
-export class FavroUserBase<
+export class BravoUserBase<
   UserData extends { userId: string },
-> extends FavroEntity<UserData> {
+> extends BravoEntity<UserData> {
   get userId() {
     return this._data.userId;
   }
 }
 
-export class FavroUser extends FavroUserBase<DataFavroUser> {
+export class BravoUser extends BravoUserBase<DataFavroUser> {
   get name() {
     return this._data.name;
   }
@@ -28,14 +28,14 @@ export class FavroUser extends FavroUserBase<DataFavroUser> {
   }
 }
 
-export class FavroOrganizationMember extends FavroUserBase<DataFavroOrganizationMember> {
+export class BravoOrganizationMember extends BravoUserBase<DataFavroOrganizationMember> {
   /** Role in the organization */
   get role() {
     return this._data.role;
   }
 }
 
-export class FavroCollectionMember extends FavroUserBase<DataFavroCollectionMember> {
+export class BravoCollectionMember extends BravoUserBase<DataFavroCollectionMember> {
   /** Role in the collection */
   get role() {
     return this._data.role;

src/test/client.ts

@@ -2,7 +2,7 @@ import { BravoClient } from '@/BravoClient.js';
 import { expect } from 'chai';
 import fs from 'fs-extra';
 import dotenv from 'dotenv';
-import { FavroCollection } from '@/FavroCollection.js';
+import { BravoCollection } from '@/BravoCollection.js';
 
 /**
  * @note A root .env file must be populated with the required
@@ -121,7 +121,7 @@ describe('BravoClient', function () {
   describe('Collections', function () {
     this.bail(true);
 
-    let testCollection: FavroCollection;
+    let testCollection: BravoCollection;
 
     it('can list all collections', async function () {
       const collections = await client.listCollections();

src/types/FavroApiTypes.ts

@@ -1,5 +1,5 @@
 import type { BravoClient } from '@/BravoClient.js';
-import type { FavroEntity } from '@/FavroEntity.js';
+import type { BravoEntity } from '@/BravoEntity.js';
 
 export type OptionFavroHttpMethod = 'get' | 'post' | 'put' | 'delete';
 export type OptionFavroCollectionColorBackground =
@@ -87,4 +87,4 @@ export type DataFavroResponse<DataEntity extends DataAnyEntity> =
 export type ConstructorFavroEntity<EntityData> = new (
   client: BravoClient,
   data: EntityData,
-) => FavroEntity<EntityData>;
+) => BravoEntity<EntityData>;