Skip to content

Commit

Permalink
fix: Avoid unintuitive keyword like "facade"
Browse files Browse the repository at this point in the history
  • Loading branch information
neet committed Sep 11, 2021
1 parent 0bd98cd commit 7f6b9bf
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
7 changes: 6 additions & 1 deletion src/admin.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Http } from './http';
import { AdminRepositories } from './repositories';

export class AdminFacadeRepositories {
export class MastoAdminClient {
constructor(private readonly http: Http, private readonly version: string) {}

readonly account = new AdminRepositories.AccountRepository(
Expand All @@ -14,3 +14,8 @@ export class AdminFacadeRepositories {
this.version,
);
}

/**
* @deprecated This alias will be removed in v5.0.0
*/
export const AdminFacadeRepositories = MastoAdminClient;
17 changes: 10 additions & 7 deletions src/masto.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { AdminFacadeRepositories } from './admin';
import { MastoAdminClient } from './admin';
import { MastoConfig } from './config';
import { version } from './decorators';
import { Results } from './entities';
Expand Down Expand Up @@ -59,15 +59,15 @@ export interface SearchParams extends DefaultPaginationParams {
readonly following?: boolean | null;
}

export class FacadeRepositories {
export class MastoClient {
constructor(
private readonly http: Http,
private readonly ws: Ws,
readonly version: string,
private readonly config: MastoConfig,
) {}

readonly admin = new AdminFacadeRepositories(this.http, this.version);
readonly admin = new MastoAdminClient(this.http, this.version);

readonly stream = new StreamRepository(this.ws, this.version);

Expand Down Expand Up @@ -156,9 +156,7 @@ export class FacadeRepositories {
}
}

export const login = async (
config: MastoConfig,
): Promise<FacadeRepositories> => {
export const login = async (config: MastoConfig): Promise<MastoClient> => {
const serializer = new SerializerImpl();
const http = new HttpAxiosImpl(config, serializer);
const instance = await new InstanceRepository(http, '1.0.0').fetch();
Expand All @@ -169,5 +167,10 @@ export const login = async (
serializer,
);

return new FacadeRepositories(http, ws, instance.version, config);
return new MastoClient(http, ws, instance.version, config);
};

/**
* @deprecated This type alias will be removed in v5.x
*/
export const FacadeRepositories = MastoClient;
2 changes: 1 addition & 1 deletion src/repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface Repository<
CreateParams = never,
UpdateParams = never,
FetchParams = never,
PaginationParams = DefaultPaginationParams
PaginationParams = DefaultPaginationParams,
> {
readonly [Symbol.asyncIterator]?: () => AsyncIterable<Entity[]>;
readonly getIterator?: (params: PaginationParams) => AsyncIterable<Entity[]>;
Expand Down

0 comments on commit 7f6b9bf

Please sign in to comment.