curtain-web-api 1.0.4 → 1.0.6

package/.idea/.name

@@ -0,0 +1 @@
+curtain-web-api

package/.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/curtain-login.iml" filepath="$PROJECT_DIR$/.idea/curtain-login.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/curtain-web-api.iml" filepath="$PROJECT_DIR$/.idea/curtain-web-api.iml" />
     </modules>
   </component>
 </project>

package/README.md

@@ -0,0 +1,63 @@
+# Curtain Web API
+---
+
+This is a node.js package used to interact with the Curtain Web REST API.
+
+## Installation
+
+```bash
+npm install curtain-web-api pouchdb -s
+npm install @types/pouchdb -D
+```
+
+## Usage
+
+```typescript
+import { CurtainWebApi } from 'curtain-web-api';
+
+const curtainAPI = new CurtainWebApi("https://curtain-api-location/")
+
+
+// Login to the API 
+
+curtainAPI.login("username", "password").then((result) => {
+    console.log(result);
+    // The result is an object containing the user's information
+}).catch((error) => {
+    console.log(error);
+});
+
+// Get the user's information
+curtainAPI.getUser().then((result) => {
+    console.log(result);
+    // The result is an object containing the user's information similar to the login but can only be performed after login have succeeded
+}).catch((error) => {
+    console.log(error);
+});
+
+// Get session information
+curtainAPI.getSessionSettings(sessionId).then((result) => {
+    console.log(result);
+    // The result is an object containing the session's basic information without any data
+}).catch((error) => {
+    console.log(error);
+});
+
+
+// Get session data
+curtainAPI.postSettings(sessionId, sessionToken).then((result) => {
+    console.log(result);
+    // The result is an object containing the session's data
+}).catch((error) => {
+    console.log(error);
+});
+
+
+// Upload session data
+curtainAPI.putSettings(settings, enableToPublic, description, sessionType).then((result) => {
+    console.log(result);
+    // The result is an object containing the session's data
+}).catch((error) => {
+    console.log(error);
+});
+```

package/build/classes/curtain-api.d.ts

@@ -31,7 +31,8 @@ export declare class CurtainWebAPI {
     getCurtainLinks(username: string, sessionDescription?: string, offset?: number, sessionType?: string): Promise<import("axios").AxiosResponse<any, any>>;
     getSiteProperties(): Promise<import("axios").AxiosResponse<any, any>>;
     saveDataFilterList(name: string, data: string): Promise<import("axios").AxiosResponse<any, any>>;
-    getDataFilterList(id: number): Promise<import("axios").AxiosResponse<any, any>>;
+    getDataFilterListByID(id: number): Promise<import("axios").AxiosResponse<any, any>>;
+    getDataFilterList(categoryName?: string): Promise<import("axios").AxiosResponse<any, any>>;
     deleteDataFilterList(id: number): Promise<import("axios").AxiosResponse<any, any>>;
     downloadStats(): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/build/classes/curtain-api.js

@@ -90,6 +90,7 @@ class CurtainWebAPI {
                     error.config.url !== this.loginURL &&
                     error.config.url !== this.orcidLoginURL) {
                     if (!this.checkIfRefreshTokenExpired() && this.user.loginStatus) {
+                        console.log("refreshing token");
                         if (!this.isRefreshing) {
                             return this.refresh().then((response) => {
                                 this.isRefreshing = false;
@@ -301,13 +302,21 @@ class CurtainWebAPI {
             return response;
         });
     }
-    getDataFilterList(id) {
+    getDataFilterListByID(id) {
         let headers = new axios_1.AxiosHeaders();
         headers["Accept"] = "application/json";
         return this.axiosInstance.get(this.baseURL + "data_filter_list/" + id + "/", { headers: headers, responseType: "json" }).then((response) => {
             return response;
         });
     }
+    getDataFilterList(categoryName = "") {
+        let params = new URLSearchParams();
+        if (categoryName != "") {
+            params.append("name", categoryName);
+        }
+        params.append("limit", `${99999999}`);
+        return this.axiosInstance.get(this.baseURL + "data_filter_list/", { responseType: "json", params });
+    }
     deleteDataFilterList(id) {
         let headers = new axios_1.AxiosHeaders();
         headers["Accept"] = "application/json";

package/build/index.d.ts

@@ -1,4 +1,4 @@
 import { CurtainWebAPI, replacer, reviver } from "./classes/curtain-api";
 import { User } from "./classes/curtain-user";
-import { getProteomicsData, getPrideData, getEBIAlpha } from "./utilities";
-export { CurtainWebAPI, User, getProteomicsData, getPrideData, getEBIAlpha, replacer, reviver };
+import { getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions } from "./utilities";
+export { CurtainWebAPI, User, getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions, replacer, reviver };

package/build/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reviver = exports.replacer = exports.getEBIAlpha = exports.getPrideData = exports.getProteomicsData = exports.User = exports.CurtainWebAPI = void 0;
+exports.reviver = exports.replacer = exports.getStringDBInteractions = exports.getInteractomeAtlas = exports.getEBIAlpha = exports.getPrideData = exports.getProteomicsData = exports.User = exports.CurtainWebAPI = void 0;
 const curtain_api_1 = require("./classes/curtain-api");
 Object.defineProperty(exports, "CurtainWebAPI", { enumerable: true, get: function () { return curtain_api_1.CurtainWebAPI; } });
 Object.defineProperty(exports, "replacer", { enumerable: true, get: function () { return curtain_api_1.replacer; } });
@@ -11,3 +11,5 @@ const utilities_1 = require("./utilities");
 Object.defineProperty(exports, "getProteomicsData", { enumerable: true, get: function () { return utilities_1.getProteomicsData; } });
 Object.defineProperty(exports, "getPrideData", { enumerable: true, get: function () { return utilities_1.getPrideData; } });
 Object.defineProperty(exports, "getEBIAlpha", { enumerable: true, get: function () { return utilities_1.getEBIAlpha; } });
+Object.defineProperty(exports, "getInteractomeAtlas", { enumerable: true, get: function () { return utilities_1.getInteractomeAtlas; } });
+Object.defineProperty(exports, "getStringDBInteractions", { enumerable: true, get: function () { return utilities_1.getStringDBInteractions; } });

package/build/utilities.d.ts

@@ -2,4 +2,4 @@ export declare function getProteomicsData(acc: string, tissueType: string): Prom
 export declare function getPrideData(acc: string): Promise<import("axios").AxiosResponse<any, any>>;
 export declare function getEBIAlpha(id: string): Promise<import("axios").AxiosResponse<any, any>>;
 export declare function getStringDBInteractions(genes: string[], organism: string, score?: number, networkType?: string): Promise<import("axios").AxiosResponse<any, any>>;
-export declare function interactomeAtlas(genes: string[], filterParameter?: string): Promise<any>;
+export declare function getInteractomeAtlas(genes: string[], filterParameter?: string): Promise<any>;

package/build/utilities.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.interactomeAtlas = exports.getStringDBInteractions = exports.getEBIAlpha = exports.getPrideData = exports.getProteomicsData = void 0;
+exports.getInteractomeAtlas = exports.getStringDBInteractions = exports.getEBIAlpha = exports.getPrideData = exports.getProteomicsData = void 0;
 const axios_1 = __importStar(require("axios"));
 function getProteomicsData(acc, tissueType) {
     let headers = new axios_1.AxiosHeaders();
@@ -52,7 +52,7 @@ function getStringDBInteractions(genes, organism, score = 400, networkType = "fu
     return axios_1.default.get("https://string-db.org/api/tsv/network?", { responseType: "text", params: params });
 }
 exports.getStringDBInteractions = getStringDBInteractions;
-function interactomeAtlas(genes, filterParameter = "None") {
+function getInteractomeAtlas(genes, filterParameter = "None") {
     let params = new URLSearchParams();
     params.append("query_interactors", "query");
     params.append("query_id_array", genes.join("%2C"));
@@ -66,4 +66,4 @@ function interactomeAtlas(genes, filterParameter = "None") {
         return JSON.parse(res.data);
     });
 }
-exports.interactomeAtlas = interactomeAtlas;
+exports.getInteractomeAtlas = getInteractomeAtlas;

package/curtainuser/LOG

@@ -1 +1 @@
-2023/04/15-17:56:07.976 99c Delete type=3 #1
+2023/04/16-14:57:22.789 353c Delete type=3 #1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "curtain-web-api",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",

package/src/classes/curtain-api.ts

@@ -67,6 +67,7 @@ export class CurtainWebAPI {
                     error.config.url !== this.loginURL &&
                     error.config.url !== this.orcidLoginURL) {
                     if (!this.checkIfRefreshTokenExpired() && this.user.loginStatus) {
+                        console.log("refreshing token")
                         if (!this.isRefreshing) {
                             return this.refresh().then((response) => {
                                 this.isRefreshing = false;
@@ -304,7 +305,7 @@ export class CurtainWebAPI {
         });
     }
 
-    getDataFilterList(id: number) {
+    getDataFilterListByID(id: number) {
         let headers = new AxiosHeaders();
         headers["Accept"] = "application/json";
         return this.axiosInstance.get(this.baseURL + "data_filter_list/" + id + "/", {headers: headers, responseType:"json"}).then((response) => {
@@ -312,6 +313,15 @@ export class CurtainWebAPI {
         });
     }
 
+    getDataFilterList(categoryName: string = "") {
+        let params = new URLSearchParams();
+        if (categoryName != "") {
+            params.append("name", categoryName)
+        }
+        params.append("limit", `${99999999}`)
+        return this.axiosInstance.get(this.baseURL + "data_filter_list/", {responseType:"json", params})
+    }
+
     deleteDataFilterList(id: number) {
         let headers = new AxiosHeaders();
         headers["Accept"] = "application/json";

package/src/index.ts

@@ -1,5 +1,5 @@
 import {CurtainWebAPI, replacer, reviver} from "./classes/curtain-api";
 import {User} from "./classes/curtain-user";
-import {getProteomicsData, getPrideData, getEBIAlpha} from "./utilities";
+import {getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions} from "./utilities";
 
-export {CurtainWebAPI, User, getProteomicsData, getPrideData, getEBIAlpha, replacer, reviver};
+export {CurtainWebAPI, User, getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions, replacer, reviver};

package/src/tests/curtain-login.spec.ts

@@ -102,9 +102,20 @@ describe("Session data", () => {
         const curtainLogin = new CurtainWebAPI();
         await curtainLogin.login("testroot", "testpassword")
         const previousAccess = curtainLogin.user.access_token.slice()
+        curtainLogin.user.access_token = ""
+        expect(previousAccess).to.not.equal(curtainLogin.user.access_token)
         await curtainLogin.refresh()
         expect(previousAccess).to.not.equal(curtainLogin.user.access_token)
         const result = await curtainLogin.postSettings("546c9ed7-30a6-4a0f-aedb-880815eb7051", "")
+    });
+    it('should login, expire access, then try to retrieve data', async () => {
+        const curtainLogin = new CurtainWebAPI();
+        await curtainLogin.login("testroot", "testpassword")
+        const previousAccess = curtainLogin.user.access_token.slice()
+        curtainLogin.user.access_token = ""
+        expect(previousAccess).to.not.equal(curtainLogin.user.access_token)
+        const result = await curtainLogin.postSettings("546c9ed7-30a6-4a0f-aedb-880815eb7051", "")
+        expect(previousAccess).to.not.equal(curtainLogin.user.access_token)
     })
 });
 

package/src/utilities.ts

@@ -39,7 +39,7 @@ export function getStringDBInteractions(genes: string[], organism: string, score
     )
 }
 
-export function interactomeAtlas(genes: string[], filterParameter: string ="None") {
+export function getInteractomeAtlas(genes: string[], filterParameter: string ="None") {
     let params = new URLSearchParams();
     params.append("query_interactors", "query");
     params.append("query_id_array", genes.join("%2C"));