curtain-web-api 1.0.65 → 1.0.66

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

@@ -50,6 +50,22 @@ export interface CurtainChunkedUploadCompletionResponse {
     message?: string;
     error?: string;
 }
+export interface Announcement {
+    id: number;
+    title: string;
+    content: string;
+    announcement_type: 'info' | 'warning' | 'success' | 'error' | 'maintenance';
+    priority: 'low' | 'medium' | 'high' | 'critical';
+    is_active: boolean;
+    created: string;
+    updated: string;
+    starts_at?: string;
+    expires_at?: string;
+    created_by_username?: string;
+    show_on_login: boolean;
+    dismissible: boolean;
+    is_visible: boolean;
+}
 export declare class CurtainWebAPI {
     loginURL: string;
     logoutURL: string;
@@ -129,4 +145,8 @@ export declare class CurtainWebAPI {
         upload_session_id?: string;
         onProgress?: (progress: number) => void;
     }): Promise<CurtainChunkedUploadCompletionResponse>;
+    getAnnouncements(limit?: number, offset?: number): Promise<import("axios").AxiosResponse<{
+        count: number;
+        results: Announcement[];
+    }, any, {}>>;
 }

package/build/classes/curtain-api.js

@@ -798,4 +798,12 @@ export class CurtainWebAPI {
             uploadNextChunk();
         });
     }
+    getAnnouncements(limit = 10, offset = 0) {
+        let headers = new AxiosHeaders();
+        headers["Accept"] = "application/json";
+        let params = new URLSearchParams();
+        params.append("limit", limit.toString());
+        params.append("offset", offset.toString());
+        return this.axiosInstance.get(this.baseURL + "announcements/", { headers: headers, params: params, responseType: "json" });
+    }
 }

package/build/index.d.ts

@@ -1,6 +1,6 @@
-import { CurtainWebAPI, replacer, reviver, SiteProperties, CurtainChunkedUploadStatus, CurtainChunkedUploadRequest, CurtainChunkedUploadResponse, CurtainChunkedUploadCompletionRequest, CurtainChunkedUploadCompletionResponse } from "./classes/curtain-api";
+import { CurtainWebAPI, replacer, reviver, SiteProperties, CurtainChunkedUploadStatus, CurtainChunkedUploadRequest, CurtainChunkedUploadResponse, CurtainChunkedUploadCompletionRequest, CurtainChunkedUploadCompletionResponse, Announcement } from "./classes/curtain-api";
 import { User } from "./classes/curtain-user";
 import { getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions } from "./utilities";
 import { importKey, importPrivateKey, exportPrivateKey, exportKeyString, exportPublicKey, importPublicKey, CurtainEncryption, generateKeyPair, encryptDataRSA, decryptDataRSA, loadFromLocalStorage, saveToLocalStorage, pemToArrayBuffer, base64ToArrayBuffer, arrayBufferToBase64String, removeLines, encryptAESData, decryptAESData, encryptAESKey, decryptAESKey, generateAESKey, exportAESKey, importAESKey } from "./classes/curtain-encryption";
 import PouchDB from "pouchdb";
-export { CurtainWebAPI, User, getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions, replacer, reviver, SiteProperties, CurtainChunkedUploadStatus, CurtainChunkedUploadRequest, CurtainChunkedUploadResponse, CurtainChunkedUploadCompletionRequest, CurtainChunkedUploadCompletionResponse, importKey, importPrivateKey, exportPrivateKey, exportKeyString, exportPublicKey, importPublicKey, CurtainEncryption, generateKeyPair, encryptDataRSA, decryptDataRSA, loadFromLocalStorage, saveToLocalStorage, pemToArrayBuffer, base64ToArrayBuffer, arrayBufferToBase64String, removeLines, encryptAESData, decryptAESData, encryptAESKey, decryptAESKey, generateAESKey, exportAESKey, importAESKey, PouchDB };
+export { CurtainWebAPI, User, getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions, replacer, reviver, SiteProperties, CurtainChunkedUploadStatus, CurtainChunkedUploadRequest, CurtainChunkedUploadResponse, CurtainChunkedUploadCompletionRequest, CurtainChunkedUploadCompletionResponse, Announcement, importKey, importPrivateKey, exportPrivateKey, exportKeyString, exportPublicKey, importPublicKey, CurtainEncryption, generateKeyPair, encryptDataRSA, decryptDataRSA, loadFromLocalStorage, saveToLocalStorage, pemToArrayBuffer, base64ToArrayBuffer, arrayBufferToBase64String, removeLines, encryptAESData, decryptAESData, encryptAESKey, decryptAESKey, generateAESKey, exportAESKey, importAESKey, PouchDB };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "curtain-web-api",
-  "version": "1.0.65",
+  "version": "1.0.66",
   "description": "",
   "type": "module",
   "main": "./build/index.js",

package/src/classes/curtain-api.ts

@@ -84,6 +84,23 @@ export interface CurtainChunkedUploadCompletionResponse {
     error?: string;
 }
 
+export interface Announcement {
+    id: number;
+    title: string;
+    content: string;
+    announcement_type: 'info' | 'warning' | 'success' | 'error' | 'maintenance';
+    priority: 'low' | 'medium' | 'high' | 'critical';
+    is_active: boolean;
+    created: string;
+    updated: string;
+    starts_at?: string;
+    expires_at?: string;
+    created_by_username?: string;
+    show_on_login: boolean;
+    dismissible: boolean;
+    is_visible: boolean;
+}
+
 export class CurtainWebAPI {
     loginURL: string = "";
     logoutURL: string = "";
@@ -954,5 +971,14 @@ export class CurtainWebAPI {
             uploadNextChunk();
         });
     }
+
+    getAnnouncements(limit: number = 10, offset: number = 0) {
+        let headers = new AxiosHeaders();
+        headers["Accept"] = "application/json";
+        let params = new URLSearchParams();
+        params.append("limit", limit.toString());
+        params.append("offset", offset.toString());
+        return this.axiosInstance.get<{count: number, results: Announcement[]}>(this.baseURL + "announcements/", {headers: headers, params: params, responseType: "json"});
+    }
 }
 

package/src/index.ts

@@ -7,7 +7,8 @@ import {
   CurtainChunkedUploadRequest,
   CurtainChunkedUploadResponse,
   CurtainChunkedUploadCompletionRequest,
-  CurtainChunkedUploadCompletionResponse
+  CurtainChunkedUploadCompletionResponse,
+  Announcement
 } from "./classes/curtain-api";
 import {User} from "./classes/curtain-user";
 import {getProteomicsData, getPrideData, getEBIAlpha, getInteractomeAtlas, getStringDBInteractions} from "./utilities";
@@ -53,6 +54,7 @@ export {
   CurtainChunkedUploadResponse,
   CurtainChunkedUploadCompletionRequest,
   CurtainChunkedUploadCompletionResponse,
+  Announcement,
   importKey,
   importPrivateKey,
   exportPrivateKey,