rename interfaces to be more idiomatic (#12)

Author: parkerduckworth

src/backup/index.ts

@@ -4,25 +4,21 @@ import BackupRestorer from './backupRestorer';
 import BackupRestoreStatusGetter from './backupRestoreStatusGetter';
 import Connection from '../connection';
 
-// import BackupGetter from "./backupGetter";
-
-export interface IWeaviateClientBackup {
+export interface Backup {
   creator: () => BackupCreator;
   createStatusGetter: () => BackupCreateStatusGetter;
   restorer: () => BackupRestorer;
   restoreStatusGetter: () => BackupRestoreStatusGetter;
-  // getter: () => BackupGetter
 }
 
-const backup = (client: Connection): IWeaviateClientBackup => {
+const backup = (client: Connection): Backup => {
   return {
     creator: () =>
       new BackupCreator(client, new BackupCreateStatusGetter(client)),
     createStatusGetter: () => new BackupCreateStatusGetter(client),
     restorer: () =>
       new BackupRestorer(client, new BackupRestoreStatusGetter(client)),
     restoreStatusGetter: () => new BackupRestoreStatusGetter(client),
-    // getter: () => new BackupGetter(client),
   };
 };
 

src/backup/journey.test.ts

@@ -1,4 +1,4 @@
-import weaviate, { IWeaviateClient } from '../index';
+import weaviate, { WeaviateClient } from '../index';
 
 const {
   createTestFoodSchemaAndData,
@@ -886,16 +886,16 @@ describe('fail restoring backup for both include and exclude classes', () => {
 //   it("cleans up", () => cleanupTestFood(client));
 // });
 
-function assertThatAllPizzasExist(client: IWeaviateClient) {
+function assertThatAllPizzasExist(client: WeaviateClient) {
   return assertThatAllFoodObjectsExist(client, 'Pizza', 4);
 }
 
-function assertThatAllSoupsExist(client: IWeaviateClient) {
+function assertThatAllSoupsExist(client: WeaviateClient) {
   return assertThatAllFoodObjectsExist(client, 'Soup', 2);
 }
 
 function assertThatAllFoodObjectsExist(
-  client: IWeaviateClient,
+  client: WeaviateClient,
   className: string,
   number: number
 ) {

src/batch/index.ts

@@ -6,7 +6,7 @@ import { BeaconPath } from '../utils/beaconPath';
 import { DbVersionSupport } from '../utils/dbVersion';
 import Connection from '../connection';
 
-export interface IWeaviateClientBatch {
+export interface Batch {
   objectsBatcher: () => ObjectsBatcher;
   objectsBatchDeleter: () => ObjectsBatchDeleter;
   referencesBatcher: () => ReferencesBatcher;
@@ -16,7 +16,7 @@ export interface IWeaviateClientBatch {
 const batch = (
   client: Connection,
   dbVersionSupport: DbVersionSupport
-): IWeaviateClientBatch => {
+): Batch => {
   const beaconPath = new BeaconPath(dbVersionSupport);
 
   return {

src/batch/journey.test.ts

@@ -1,4 +1,4 @@
-import weaviate, { IWeaviateClient } from '../index';
+import weaviate, { WeaviateClient } from '../index';
 
 const thingClassName = 'BatchJourneyTestThing';
 const otherThingClassName = 'BatchJourneyTestOtherThing';
@@ -530,7 +530,7 @@ describe('batch deleting', () => {
   it('tears down and cleans up', () => cleanup(client));
 });
 
-const setup = async (client: IWeaviateClient) => {
+const setup = async (client: WeaviateClient) => {
   // first import the classes
   await Promise.all([
     client.schema
@@ -572,11 +572,11 @@ const setup = async (client: IWeaviateClient) => {
     .do();
 };
 
-const setupData = (client: IWeaviateClient) => {
+const setupData = (client: WeaviateClient) => {
   return client.batch.objectsBatcher().withObjects(someObjects).do();
 };
 
-const cleanup = (client: IWeaviateClient) =>
+const cleanup = (client: WeaviateClient) =>
   Promise.all([
     client.schema.classDeleter().withClassName(thingClassName).do(),
     client.schema.classDeleter().withClassName(otherThingClassName).do(),

src/c11y/index.ts

@@ -2,12 +2,12 @@ import ExtensionCreator from './extensionCreator';
 import ConceptsGetter from './conceptsGetter';
 import Connection from '../connection';
 
-export interface IWeaviateClientC11y {
+export interface C11y {
   conceptsGetter: () => ConceptsGetter;
   extensionCreator: () => ExtensionCreator;
 }
 
-const c11y = (client: Connection): IWeaviateClientC11y => {
+const c11y = (client: Connection): C11y => {
   return {
     conceptsGetter: () => new ConceptsGetter(client),
     extensionCreator: () => new ExtensionCreator(client),

src/classifications/index.ts

@@ -2,12 +2,12 @@ import Scheduler from './scheduler';
 import Getter from './getter';
 import Connection from '../connection';
 
-export interface IWeaviateClientClassifications {
+export interface Classifications {
   scheduler: () => Scheduler;
   getter: () => Getter;
 }
 
-const data = (client: Connection): IWeaviateClientClassifications => {
+const data = (client: Connection): Classifications => {
   return {
     scheduler: () => new Scheduler(client),
     getter: () => new Getter(client),

src/classifications/knn.journey.test.ts

@@ -1,4 +1,4 @@
-import weaviate, { IWeaviateClient } from '../index';
+import weaviate, { WeaviateClient } from '../index';
 import Connection from '../connection';
 
 const targetDessertId = 'cd54852a-209d-423b-bf1c-884468215237';
@@ -205,7 +205,7 @@ describe('a classification journey', () => {
   });
 });
 
-const setup = async (client: IWeaviateClient) => {
+const setup = async (client: WeaviateClient) => {
   let targetClass = {
     class: 'ClassificationJourneyTarget',
     properties: [
@@ -286,7 +286,7 @@ const setup = async (client: IWeaviateClient) => {
     .do();
 };
 
-const cleanup = (client: IWeaviateClient) => {
+const cleanup = (client: WeaviateClient) => {
   return Promise.all([
     client.schema
       .classDeleter()

src/cluster/index.ts

@@ -1,11 +1,11 @@
 import NodesStatusGetter from './nodesStatusGetter';
 import Connection from '../connection';
 
-export interface IWeaviateClientCluster {
+export interface Cluster {
   nodesStatusGetter: () => NodesStatusGetter;
 }
 
-const cluster = (client: Connection): IWeaviateClientCluster => {
+const cluster = (client: Connection): Cluster => {
   return {
     nodesStatusGetter: () => new NodesStatusGetter(client),
   };

src/connection/auth.ts

@@ -1,24 +1,24 @@
-import { IHttpClient } from './httpClient';
+import { HttpClient } from './httpClient';
 
-interface IAuthenticatorResult {
+interface AuthenticatorResult {
   accessToken: string;
   expiresAt: number;
   refreshToken: string;
 }
 
-interface IAuthenticator {
-  refresh: () => Promise<IAuthenticatorResult>;
+interface OIDCAuthFlow {
+  refresh: () => Promise<AuthenticatorResult>;
 }
 
 export class Authenticator {
-  private readonly http: IHttpClient;
+  private readonly http: HttpClient;
   private readonly creds: any;
   private accessToken: string;
   private refreshToken?: string;
   private expiresAt: number;
   private refreshRunning: boolean;
 
-  constructor(http: IHttpClient, creds: any) {
+  constructor(http: HttpClient, creds: any) {
     this.http = http;
     this.creds = creds;
     this.accessToken = '';
@@ -38,7 +38,7 @@ export class Authenticator {
   refresh = async (localConfig: any) => {
     const config = await this.getOpenidConfig(localConfig);
 
-    let authenticator: IAuthenticator;
+    let authenticator: OIDCAuthFlow;
     switch (this.creds.constructor) {
       case AuthUserPasswordCredentials:
         authenticator = new UserPasswordAuthenticator(
@@ -107,7 +107,7 @@ export class Authenticator {
   };
 }
 
-export interface IAuthUserPasswordCredentials {
+export interface UserPasswordCredentialsInput {
   username: string;
   password?: string;
   scopes?: any[];
@@ -117,20 +117,20 @@ export class AuthUserPasswordCredentials {
   private username: string;
   private password?: string;
   private scopes?: any[];
-  constructor(creds: IAuthUserPasswordCredentials) {
+  constructor(creds: UserPasswordCredentialsInput) {
     this.username = creds.username;
     this.password = creds.password;
     this.scopes = creds.scopes;
   }
 }
 
-interface IRequestAccessTokenResponse {
+interface RequestAccessTokenResponse {
   access_token: string;
   expires_in: number;
   refresh_token: string;
 }
 
-class UserPasswordAuthenticator implements IAuthenticator {
+class UserPasswordAuthenticator implements OIDCAuthFlow {
   private creds: any;
   private http: any;
   private openidConfig: any;
@@ -146,7 +146,7 @@ class UserPasswordAuthenticator implements IAuthenticator {
   refresh = () => {
     this.validateOpenidConfig();
     return this.requestAccessToken()
-      .then((tokenResp: IRequestAccessTokenResponse) => {
+      .then((tokenResp: RequestAccessTokenResponse) => {
         return {
           accessToken: tokenResp.access_token,
           expiresAt: calcExpirationEpoch(tokenResp.expires_in),
@@ -194,7 +194,7 @@ class UserPasswordAuthenticator implements IAuthenticator {
   };
 }
 
-export interface IAuthAccessTokenCredentials {
+export interface AccessTokenCredentialsInput {
   accessToken: string;
   expiresIn: number;
   refreshToken?: string;
@@ -205,14 +205,14 @@ export class AuthAccessTokenCredentials {
   public readonly expiresAt: number;
   public readonly refreshToken?: string;
 
-  constructor(creds: IAuthAccessTokenCredentials) {
+  constructor(creds: AccessTokenCredentialsInput) {
     this.validate(creds);
     this.accessToken = creds.accessToken;
     this.expiresAt = calcExpirationEpoch(creds.expiresIn);
     this.refreshToken = creds.refreshToken;
   }
 
-  validate = (creds: IAuthAccessTokenCredentials) => {
+  validate = (creds: AccessTokenCredentialsInput) => {
     if (creds.expiresIn === undefined) {
       throw new Error('AuthAccessTokenCredentials: expiresIn is required');
     }
@@ -222,7 +222,7 @@ export class AuthAccessTokenCredentials {
   };
 }
 
-class AccessTokenAuthenticator implements IAuthenticator {
+class AccessTokenAuthenticator implements OIDCAuthFlow {
   private creds: any;
   private http: any;
   private openidConfig: any;
@@ -247,7 +247,7 @@ class AccessTokenAuthenticator implements IAuthenticator {
     }
     this.validateOpenidConfig();
     return this.requestAccessToken()
-      .then((tokenResp: IRequestAccessTokenResponse) => {
+      .then((tokenResp: RequestAccessTokenResponse) => {
         return {
           accessToken: tokenResp.access_token,
           expiresAt: calcExpirationEpoch(tokenResp.expires_in),
@@ -284,7 +284,7 @@ class AccessTokenAuthenticator implements IAuthenticator {
   };
 }
 
-export interface IAuthClientCredentials {
+export interface ClientCredentialsInput {
   clientSecret: string;
   scopes?: any[];
 }
@@ -293,13 +293,13 @@ export class AuthClientCredentials {
   private clientSecret: any;
   private scopes?: any[];
 
-  constructor(creds: IAuthClientCredentials) {
+  constructor(creds: ClientCredentialsInput) {
     this.clientSecret = creds.clientSecret;
     this.scopes = creds.scopes;
   }
 }
 
-class ClientCredentialsAuthenticator implements IAuthenticator {
+class ClientCredentialsAuthenticator implements OIDCAuthFlow {
   private creds: any;
   private http: any;
   private openidConfig: any;
@@ -316,7 +316,7 @@ class ClientCredentialsAuthenticator implements IAuthenticator {
   refresh = () => {
     this.validateOpenidConfig();
     return this.requestAccessToken()
-      .then((tokenResp: IRequestAccessTokenResponse) => {
+      .then((tokenResp: RequestAccessTokenResponse) => {
         return {
           accessToken: tokenResp.access_token,
           expiresAt: calcExpirationEpoch(tokenResp.expires_in),

src/connection/gqlClient.ts

@@ -1,20 +1,20 @@
-import { GraphQLClient } from 'graphql-request';
-import { IConnectionParams } from '../index';
+import { GraphQLClient as Client } from 'graphql-request';
+import { ConnectionParams } from '../index';
 
 export type TQuery = any;
-export interface IGraphQLClient {
+export interface GraphQLClient {
   query: (query: TQuery, headers?: HeadersInit) => Promise<{ data: any }>;
 }
 
-export const gqlClient = (config: IConnectionParams): IGraphQLClient => {
+export const gqlClient = (config: ConnectionParams): GraphQLClient => {
   const scheme = config.scheme;
   const host = config.host;
   const defaultHeaders = config.headers;
   return {
     // for backward compatibility with replaced graphql-client lib,
     // results are wrapped into { data: data }
     query: (query: TQuery, headers?: HeadersInit) => {
-      return new GraphQLClient(`${scheme}://${host}/v1/graphql`, {
+      return new Client(`${scheme}://${host}/v1/graphql`, {
         headers: {
           ...defaultHeaders,
           ...headers,