@human-protocol/sdk 1.1.10 → 1.1.12

package/src/storage.ts

@@ -13,6 +13,9 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
 import { isValidUrl } from './utils';
 import { HttpStatus } from './constants';
 
+/**
+ * @deprecated StorageClient is deprecated. Use Minio.Client directly.
+ */
 export class StorageClient {
   private client: Minio.Client;
   private clientParams: StorageParams;
@@ -20,17 +23,17 @@ export class StorageClient {
   /**
    * **Storage client constructor**
    *
-   * @param {StorageCredentials} credentials - Cloud storage access data
    * @param {StorageParams} params - Cloud storage params
+   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
    */
-  constructor(credentials: StorageCredentials, params: StorageParams) {
+  constructor(params: StorageParams, credentials?: StorageCredentials) {
     try {
       this.clientParams = params;
 
       this.client = new Minio.Client({
         ...params,
-        accessKey: credentials.accessKey,
-        secretKey: credentials.secretKey,
+        accessKey: credentials?.accessKey ?? '',
+        secretKey: credentials?.secretKey ?? '',
       });
     } catch (e) {
       throw ErrorStorageClientNotInitialized;

package/src/types.ts

@@ -33,6 +33,7 @@ export enum EscrowStatus {
 /**
  * AWS/GCP cloud storage access data
  * @readonly
+ * @deprecated StorageClient is deprecated. Use Minio.Client directly.
  */
 export type StorageCredentials = {
   /**
@@ -45,6 +46,9 @@ export type StorageCredentials = {
   secretKey: string;
 };
 
+/**
+ * @deprecated StorageClient is deprecated. Use Minio.Client directly.
+ */
 export type StorageParams = {
   /**
    * Request endPoint