Add get graph models to Faros client (#28)

src/client.ts

@@ -2,6 +2,7 @@ import {AxiosInstance, AxiosRequestConfig} from 'axios';
 import * as gql from 'graphql';
 import {get as traverse} from 'lodash';
 import pino, {Logger} from 'pino';
+import VError from 'verror';
 
 import {makeAxiosInstanceWithRetry} from './axios';
 import {wrapApiError} from './errors';
@@ -10,6 +11,7 @@ import {Schema} from './graphql/types';
 import {
   Account,
   FarosClientConfig,
+  Model,
   NamedQuery,
   SecretName,
   UpdateAccount,
@@ -20,9 +22,15 @@ export const DEFAULT_AXIOS_CONFIG: AxiosRequestConfig = {timeout: 60000};
 
 export const GRAPH_VERSION_HEADER = 'x-faros-graph-version';
 
+enum GraphVersion {
+  V1 = 'v1',
+  V2 = 'v2',
+}
+
 /** Faros API client **/
 export class FarosClient {
   private readonly api: AxiosInstance;
+  private readonly graphVersion: GraphVersion;
 
   constructor(
     cfg: FarosClientConfig,
@@ -43,6 +51,8 @@ export class FarosClient {
       },
       logger
     );
+
+    this.graphVersion = cfg.useGraphQLV2 ? GraphVersion.V2 : GraphVersion.V1;
   }
 
   async tenant(): Promise<string> {
@@ -89,6 +99,20 @@ export class FarosClient {
     }
   }
 
+  async models(graph: string): Promise<ReadonlyArray<Model>> {
+    if (this.graphVersion !== GraphVersion.V1) {
+      throw new VError(`listing models is not supported for ${this.graphVersion}
+      graphs`);
+    }
+
+    try {
+      const {data} = await this.api.get(`/graphs/${graph}/models`);
+      return data.models;
+    } catch (err: any) {
+      throw wrapApiError(err, `unable to list models: ${graph}`);
+    }
+  }
+
   async namedQuery(name: string): Promise<NamedQuery | undefined> {
     try {
       const {data} = await this.api.get(`/queries/${name}`);

src/index.ts

@@ -12,6 +12,7 @@ export {
   Coordinates,
   FarosClientConfig,
   Location,
+  Model,
   NamedQuery,
   SecretName,
   UpdateAccount,

src/types.ts

@@ -58,3 +58,12 @@ export interface Coordinates {
   lat: number;
   lon: number;
 }
+
+export interface Model {
+  name: string;
+  key: ReadonlyArray<string>;
+  forwardReferences: any;
+  backwardReferences: any;
+  keySchema: any;
+  dataSchema: any;
+}

test/client.test.ts

@@ -66,6 +66,23 @@ describe('client', () => {
     expect(res).toBe(false);
   });
 
+  test('get models', async () => {
+    const mock = nock(apiUrl)
+      .get('/graphs/g1/models')
+      .reply(200, {
+        models: [
+          {name: 'model1', key: ['key1A', 'key1B']},
+          {name: 'model2', key: ['key2A', 'key2B']},
+        ],
+      });
+    const res = await client.models('g1');
+    mock.done();
+    expect(res).toEqual([
+      {name: 'model1', key: ['key1A', 'key1B']},
+      {name: 'model2', key: ['key2A', 'key2B']},
+    ]);
+  });
+
   test('get query', async () => {
     const mock = nock(apiUrl)
       .get('/queries/my-query')