Merge pull request #30 from multinet-app/unabstract-axios

Revoke abstraction over axios

package.json

@@ -5,10 +5,6 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist/client.d.ts",
-    "dist/client.d.ts.map",
-    "dist/client.js",
-    "dist/client.js.map",
     "dist/index.d.ts",
     "dist/index.d.ts.map",
     "dist/index.js",

src/axios.ts

@@ -0,0 +1,230 @@
+import axios, { AxiosInstance, AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios';
+
+import {
+  CreateGraphOptionsSpec,
+  TableMetadata,
+  FileUploadOptionsSpec,
+  EdgesSpec,
+  EdgesOptionsSpec,
+  NodesSpec,
+  OffsetLimitSpec,
+  GraphSpec,
+  RowsSpec,
+  TablesOptionsSpec,
+  UserSpec,
+  WorkspacePermissionsSpec,
+} from './index';
+
+function fileToText(file: File): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onload = (e) => {
+      if (e.target === null || typeof e.target.result !== 'string') {
+        throw new Error();
+      }
+      resolve(e.target.result);
+    };
+    reader.onerror = (e) => {
+      reject();
+    };
+
+    reader.readAsText(file);
+  });
+}
+
+export interface MultinetAxiosInstance extends AxiosInstance {
+  logout(): void;
+  userInfo(): AxiosPromise<UserSpec | null>;
+  workspaces(): AxiosPromise<string[]>;
+  getWorkspacePermissions(workspace: string): AxiosPromise<WorkspacePermissionsSpec>;
+  setWorkspacePermissions(workspace: string, permissions: WorkspacePermissionsSpec): AxiosPromise<WorkspacePermissionsSpec>;
+  searchUsers(query: string): AxiosPromise<UserSpec[]>;
+  tables(workspace: string, options: TablesOptionsSpec): AxiosPromise<string[]>;
+  table(workspace: string, table: string, options: OffsetLimitSpec): AxiosPromise<RowsSpec>;
+  graphs(workspace: string): AxiosPromise<string[]>;
+  graph(workspace: string, graph: string): AxiosPromise<GraphSpec>;
+  nodes(workspace: string, graph: string, options: OffsetLimitSpec): AxiosPromise<NodesSpec>;
+  attributes(workspace: string, graph: string, nodeId: string): AxiosPromise<{}>;
+  edges(workspace: string, graph: string, nodeId: string, options: EdgesOptionsSpec): AxiosPromise<EdgesSpec>;
+  createWorkspace(workspace: string): AxiosPromise<string>;
+  deleteWorkspace(workspace: string): AxiosPromise<string>;
+  renameWorkspace(workspace: string, name: string): AxiosPromise<any>;
+  uploadTable(workspace: string, table: string, options: FileUploadOptionsSpec, config?: AxiosRequestConfig): AxiosPromise<Array<{}>>;
+  downloadTable(workspace: string, table: string): AxiosPromise<any>;
+  deleteTable(workspace: string, table: string): AxiosPromise<string>;
+  tableMetadata(workspace: string, table: string): AxiosPromise<TableMetadata>;
+  createGraph(workspace: string, graph: string, options: CreateGraphOptionsSpec): AxiosPromise<string>;
+  deleteGraph(workspace: string, graph: string): AxiosPromise<string>;
+  aql(workspace: string, query: string): AxiosPromise<any[]>;
+  createAQLTable(workspace: string, table: string, query: string): AxiosPromise<any[]>;
+  downloadGraph(workspace: string, graph: string): AxiosPromise<any>;
+}
+
+export function multinetAxiosInstance(config: AxiosRequestConfig): MultinetAxiosInstance {
+  const axiosInstance = axios.create(config);
+  const Proto = Object.getPrototypeOf(axiosInstance);
+
+  Proto.logout = function(): void {
+    this.get('/user/logout');
+  }
+
+  Proto.userInfo = function(): AxiosPromise<UserSpec | null> {
+    return this.get('/user/info');
+  }
+
+  Proto.workspaces = function(): AxiosPromise<string[]> {
+    return this.get('workspaces');
+  };
+
+  Proto.getWorkspacePermissions = function(workspace: string): AxiosPromise<WorkspacePermissionsSpec> {
+    return this.get(`workspaces/${workspace}/permissions`);
+  };
+
+  Proto.setWorkspacePermissions = function(workspace: string, permissions: WorkspacePermissionsSpec): AxiosPromise<WorkspacePermissionsSpec> {
+    return this.put(`workspaces/${workspace}/permissions`, {
+      params: permissions,
+    });
+  };
+
+  Proto.searchUsers = function(query: string): AxiosPromise<UserSpec[]> {
+    return this.get('/user/search', {
+      params: {
+        query,
+      },
+    });
+  };
+
+  Proto.tables = function(workspace: string, options: TablesOptionsSpec = {}): AxiosPromise<string[]> {
+    return this.get(`workspaces/${workspace}/tables`, {
+      params: options,
+    });
+  };
+
+  Proto.table = function(workspace: string, table: string, options: OffsetLimitSpec = {}): AxiosPromise<RowsSpec> {
+    return this.get(`workspaces/${workspace}/tables/${table}`, {
+      params: options,
+    });
+  };
+
+  Proto.graphs = function(workspace: string): AxiosPromise<string[]> {
+    return this.get(`workspaces/${workspace}/graphs`);
+  };
+
+  Proto.graph = function(workspace: string, graph: string): AxiosPromise<GraphSpec> {
+    return this.get(`workspaces/${workspace}/graphs/${graph}`);
+  };
+
+  Proto.nodes = function(workspace: string, graph: string, options: OffsetLimitSpec = {}): AxiosPromise<NodesSpec> {
+    return this.get(`workspaces/${workspace}/graphs/${graph}/nodes`, {
+      params: options,
+    });
+  };
+
+  Proto.attributes = function(workspace: string, graph: string, nodeId: string): AxiosPromise<{}> {
+    return this.get(`workspaces/${workspace}/graphs/${graph}/nodes/${nodeId}/attributes`);
+  };
+
+  Proto.edges = function(workspace: string, graph: string, nodeId: string, options: EdgesOptionsSpec = {}): AxiosPromise<EdgesSpec> {
+    return this.get(`workspaces/${workspace}/graphs/${graph}/nodes/${nodeId}/edges`, {
+      params: options,
+    });
+  };
+
+  Proto.createWorkspace = function(workspace: string): AxiosPromise<string> {
+    return this.post(`/workspaces/${workspace}`);
+  };
+
+  Proto.deleteWorkspace = function(workspace: string): AxiosPromise<string> {
+    return this.delete(`/workspaces/${workspace}`);
+  };
+
+  Proto.renameWorkspace = function(workspace: string, name: string): AxiosPromise<any> {
+    return this.put(`workspaces/${workspace}/name`, null, {
+      params: {
+        name,
+      },
+    });
+  };
+
+  Proto.uploadTable = async function(workspace: string, table: string, options: FileUploadOptionsSpec, config?: AxiosRequestConfig): Promise<AxiosResponse<Array<{}>>> {
+    const headers = config ? config.headers : undefined;
+    const params = config ? config.params : undefined;
+    const { type, data, key, overwrite, columnTypes } = options;
+
+    let text;
+
+    if (typeof data === 'string') {
+      text = data;
+    } else {
+      text = await fileToText(data);
+    }
+
+    let metadata;
+    if (columnTypes) {
+      const columns = Object.keys(columnTypes).map((column) => ({
+        key: column,
+        type: columnTypes[column],
+      }));
+
+      metadata = { columns };
+    }
+
+    return this.post(`/${type}/${workspace}/${table}`, text, {
+      ...config,
+      headers: { ...headers, 'Content-Type': 'text/plain' },
+      params: {
+        ...params,
+        key: key || undefined,
+        overwrite: overwrite || undefined,
+        metadata: metadata || undefined,
+      },
+    });
+  };
+
+  Proto.downloadTable = function(workspace: string, table: string): AxiosPromise<any> {
+    return this.get(`/workspaces/${workspace}/tables/${table}/download`);
+  };
+
+  Proto.deleteTable = function(workspace: string, table: string): AxiosPromise<string> {
+    return this.delete(`/workspaces/${workspace}/tables/${table}`);
+  };
+
+  Proto.tableMetadata = function(workspace: string, table: string): AxiosPromise<TableMetadata> {
+    return this.get(`/workspaces/${workspace}/tables/${table}/metadata`);
+  };
+
+  Proto.createGraph = function(workspace: string, graph: string, options: CreateGraphOptionsSpec): AxiosPromise<string> {
+    return this.post(`/workspaces/${workspace}/graphs/${graph}`, {
+      edge_table: options.edgeTable,
+    });
+  };
+
+  Proto.deleteGraph = function(workspace: string, graph: string): AxiosPromise<string> {
+    return this.delete(`/workspaces/${workspace}/graphs/${graph}`);
+  };
+
+  Proto.aql = function(workspace: string, query: string): AxiosPromise<any[]> {
+    return this.post(`/workspaces/${workspace}/aql`, query, {
+      headers: {
+        'Content-Type': 'text/plain',
+      },
+    });
+  };
+
+  Proto.createAQLTable = function(workspace: string, table: string, query: string): AxiosPromise<any[]> {
+    return this.post(`/workspaces/${workspace}/tables`, query, {
+      headers: {
+        'Content-Type': 'text/plain',
+      },
+      params: {
+        table,
+      },
+    });
+  }
+
+  Proto.downloadGraph = function(workspace: string, graph: string): AxiosPromise<any> {
+    return this.get(`/workspaces/${workspace}/graphs/${graph}/download`);
+  }
+
+  return axiosInstance as MultinetAxiosInstance;
+}