@human-protocol/sdk 5.2.0 → 6.1.0

package/dist/storage.js

@@ -1,319 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageClient = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const axios_1 = __importDefault(require("axios"));
-const crypto_1 = __importDefault(require("crypto"));
-const Minio = __importStar(require("minio"));
-const error_1 = require("./error");
-const utils_1 = require("./utils");
-const constants_1 = require("./constants");
-/**
- *
- * @deprecated StorageClient is deprecated. Use Minio.Client directly.
- *
- * ## Introduction
- *
- * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
- *
- * The instance creation of `StorageClient` should be made using its constructor:
- *
- * ```ts
- * constructor(params: StorageParams, credentials?: StorageCredentials)
- * ```
- *
- * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
- *
- * ## Installation
- *
- * ### npm
- * ```bash
- * npm install @human-protocol/sdk
- * ```
- *
- * ### yarn
- * ```bash
- * yarn install @human-protocol/sdk
- * ```
- *
- * ## Code example
- *
- * ```ts
- * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
- *
- * const credentials: StorageCredentials = {
- *   accessKey: 'ACCESS_KEY',
- *   secretKey: 'SECRET_KEY',
- * };
- * const params: StorageParams = {
- *   endPoint: 'http://localhost',
- *   port: 9000,
- *   useSSL: false,
- *   region: 'us-east-1'
- * };
- *
- * const storageClient = new StorageClient(params, credentials);
- * ```
- */
-class StorageClient {
-    /**
-     * **Storage client constructor**
-     *
-     * @param {StorageParams} params - Cloud storage params
-     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
-     */
-    constructor(params, credentials) {
-        try {
-            this.clientParams = params;
-            this.client = new Minio.Client({
-                ...params,
-                accessKey: credentials?.accessKey ?? '',
-                secretKey: credentials?.secretKey ?? '',
-            });
-        }
-        catch {
-            throw error_1.ErrorStorageClientNotInitialized;
-        }
-    }
-    /**
-     * This function downloads files from a bucket.
-     *
-     * @param {string[]} keys Array of filenames to download.
-     * @param {string} bucket Bucket name.
-     * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-     *
-     * const params: StorageParams = {
-     *   endPoint: 'http://localhost',
-     *   port: 9000,
-     *   useSSL: false,
-     *   region: 'us-east-1'
-     * };
-     *
-     * const storageClient = new StorageClient(params);
-     *
-     * const keys = ['file1.json', 'file2.json'];
-     * const files = await storageClient.downloadFiles(keys, 'bucket-name');
-     * ```
-     */
-    async downloadFiles(keys, bucket) {
-        const isBucketExists = await this.client.bucketExists(bucket);
-        if (!isBucketExists) {
-            throw error_1.ErrorStorageBucketNotFound;
-        }
-        return Promise.all(keys.map(async (key) => {
-            try {
-                const response = await this.client.getObject(bucket, key);
-                const content = response?.read();
-                return { key, content: JSON.parse(content?.toString('utf-8') || '') };
-            }
-            catch {
-                throw error_1.ErrorStorageFileNotFound;
-            }
-        }));
-    }
-    /**
-     * This function downloads files from a URL.
-     *
-     * @param {string} url URL of the file to download.
-     * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { StorageClient } from '@human-protocol/sdk';
-     *
-     * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
-     * ```
-     */
-    static async downloadFileFromUrl(url) {
-        if (!(0, utils_1.isValidUrl)(url)) {
-            throw error_1.ErrorInvalidUrl;
-        }
-        try {
-            const { data, status } = await axios_1.default.get(url, {
-                headers: {
-                    'Content-Type': 'application/json',
-                },
-            });
-            if (status !== constants_1.HttpStatus.OK) {
-                throw error_1.ErrorStorageFileNotFound;
-            }
-            return data;
-        }
-        catch {
-            throw error_1.ErrorStorageFileNotFound;
-        }
-    }
-    /**
-     * This function uploads files to a bucket.
-     *
-     * @param {any[]} files Array of objects to upload serialized into JSON.
-     * @param {string} bucket Bucket name.
-     * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-     *
-     * const credentials: StorageCredentials = {
-     *   accessKey: 'ACCESS_KEY',
-     *   secretKey: 'SECRET_KEY',
-     * };
-     * const params: StorageParams = {
-     *   endPoint: 'http://localhost',
-     *   port: 9000,
-     *   useSSL: false,
-     *   region: 'us-east-1'
-     * };
-     *
-     * const storageClient = new StorageClient(params, credentials);
-     * const file1 = { name: 'file1', description: 'description of file1' };
-     * const file2 = { name: 'file2', description: 'description of file2' };
-     * const files = [file1, file2];
-     * const uploadedFiles = await storageClient.uploadFiles(files, 'bucket-name');
-     * ```
-     */
-    async uploadFiles(files, bucket) {
-        const isBucketExists = await this.client.bucketExists(bucket);
-        if (!isBucketExists) {
-            throw error_1.ErrorStorageBucketNotFound;
-        }
-        return Promise.all(files.map(async (file) => {
-            const content = JSON.stringify(file);
-            const hash = crypto_1.default.createHash('sha1').update(content).digest('hex');
-            const key = `s3${hash}.json`;
-            try {
-                await this.client.putObject(bucket, key, content, {
-                    'Content-Type': 'application/json',
-                    'Cache-Control': 'no-store',
-                });
-                return {
-                    key,
-                    url: `${this.clientParams.useSSL ? 'https' : 'http'}://${this.clientParams.endPoint}${this.clientParams.port ? `:${this.clientParams.port}` : ''}/${bucket}/${key}`,
-                    hash,
-                };
-            }
-            catch {
-                throw error_1.ErrorStorageFileNotUploaded;
-            }
-        }));
-    }
-    /**
-     * This function checks if a bucket exists.
-     *
-     * @param {string} bucket Bucket name.
-     * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-     *
-     * const credentials: StorageCredentials = {
-     *   accessKey: 'ACCESS_KEY',
-     *   secretKey: 'SECRET_KEY',
-     * };
-     * const params: StorageParams = {
-     *   endPoint: 'http://localhost',
-     *   port: 9000,
-     *   useSSL: false,
-     *   region: 'us-east-1'
-     * };
-     *
-     * const storageClient = new StorageClient(params, credentials);
-     * const exists = await storageClient.bucketExists('bucket-name');
-     * ```
-     */
-    async bucketExists(bucket) {
-        return this.client.bucketExists(bucket);
-    }
-    /**
-     * This function lists all file names contained in the bucket.
-     *
-     * @param {string} bucket Bucket name.
-     * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-     *
-     * const credentials: StorageCredentials = {
-     *   accessKey: 'ACCESS_KEY',
-     *   secretKey: 'SECRET_KEY',
-     * };
-     * const params: StorageParams = {
-     *   endPoint: 'http://localhost',
-     *   port: 9000,
-     *   useSSL: false,
-     *   region: 'us-east-1'
-     * };
-     *
-     * const storageClient = new StorageClient(params, credentials);
-     * const fileNames = await storageClient.listObjects('bucket-name');
-     * ```
-     */
-    async listObjects(bucket) {
-        const isBucketExists = await this.client.bucketExists(bucket);
-        if (!isBucketExists) {
-            throw error_1.ErrorStorageBucketNotFound;
-        }
-        try {
-            return new Promise((resolve, reject) => {
-                const keys = [];
-                const stream = this.client.listObjectsV2(bucket, '', true, '');
-                stream.on('data', (obj) => keys.push(obj.name));
-                stream.on('error', reject);
-                stream.on('end', () => {
-                    resolve(keys);
-                });
-            });
-        }
-        catch (e) {
-            throw new Error(String(e));
-        }
-    }
-}
-exports.StorageClient = StorageClient;

package/src/storage.ts

@@ -1,313 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import axios from 'axios';
-import crypto from 'crypto';
-import * as Minio from 'minio';
-import {
-  ErrorInvalidUrl,
-  ErrorStorageBucketNotFound,
-  ErrorStorageClientNotInitialized,
-  ErrorStorageFileNotFound,
-  ErrorStorageFileNotUploaded,
-} from './error';
-import { UploadFile, StorageCredentials, StorageParams } from './types';
-import { isValidUrl } from './utils';
-import { HttpStatus } from './constants';
-
-/**
- *
- * @deprecated StorageClient is deprecated. Use Minio.Client directly.
- *
- * ## Introduction
- *
- * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
- *
- * The instance creation of `StorageClient` should be made using its constructor:
- *
- * ```ts
- * constructor(params: StorageParams, credentials?: StorageCredentials)
- * ```
- *
- * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
- *
- * ## Installation
- *
- * ### npm
- * ```bash
- * npm install @human-protocol/sdk
- * ```
- *
- * ### yarn
- * ```bash
- * yarn install @human-protocol/sdk
- * ```
- *
- * ## Code example
- *
- * ```ts
- * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
- *
- * const credentials: StorageCredentials = {
- *   accessKey: 'ACCESS_KEY',
- *   secretKey: 'SECRET_KEY',
- * };
- * const params: StorageParams = {
- *   endPoint: 'http://localhost',
- *   port: 9000,
- *   useSSL: false,
- *   region: 'us-east-1'
- * };
- *
- * const storageClient = new StorageClient(params, credentials);
- * ```
- */
-export class StorageClient {
-  private client: Minio.Client;
-  private clientParams: StorageParams;
-
-  /**
-   * **Storage client constructor**
-   *
-   * @param {StorageParams} params - Cloud storage params
-   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
-   */
-  constructor(params: StorageParams, credentials?: StorageCredentials) {
-    try {
-      this.clientParams = params;
-
-      this.client = new Minio.Client({
-        ...params,
-        accessKey: credentials?.accessKey ?? '',
-        secretKey: credentials?.secretKey ?? '',
-      });
-    } catch {
-      throw ErrorStorageClientNotInitialized;
-    }
-  }
-
-  /**
-   * This function downloads files from a bucket.
-   *
-   * @param {string[]} keys Array of filenames to download.
-   * @param {string} bucket Bucket name.
-   * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-   *
-   * const params: StorageParams = {
-   *   endPoint: 'http://localhost',
-   *   port: 9000,
-   *   useSSL: false,
-   *   region: 'us-east-1'
-   * };
-   *
-   * const storageClient = new StorageClient(params);
-   *
-   * const keys = ['file1.json', 'file2.json'];
-   * const files = await storageClient.downloadFiles(keys, 'bucket-name');
-   * ```
-   */
-  public async downloadFiles(keys: string[], bucket: string): Promise<any[]> {
-    const isBucketExists = await this.client.bucketExists(bucket);
-    if (!isBucketExists) {
-      throw ErrorStorageBucketNotFound;
-    }
-
-    return Promise.all(
-      keys.map(async (key) => {
-        try {
-          const response = await this.client.getObject(bucket, key);
-          const content = response?.read();
-
-          return { key, content: JSON.parse(content?.toString('utf-8') || '') };
-        } catch {
-          throw ErrorStorageFileNotFound;
-        }
-      })
-    );
-  }
-
-  /**
-   * This function downloads files from a URL.
-   *
-   * @param {string} url URL of the file to download.
-   * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StorageClient } from '@human-protocol/sdk';
-   *
-   * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
-   * ```
-   */
-  public static async downloadFileFromUrl(url: string): Promise<any> {
-    if (!isValidUrl(url)) {
-      throw ErrorInvalidUrl;
-    }
-
-    try {
-      const { data, status } = await axios.get(url, {
-        headers: {
-          'Content-Type': 'application/json',
-        },
-      });
-
-      if (status !== HttpStatus.OK) {
-        throw ErrorStorageFileNotFound;
-      }
-
-      return data;
-    } catch {
-      throw ErrorStorageFileNotFound;
-    }
-  }
-
-  /**
-   * This function uploads files to a bucket.
-   *
-   * @param {any[]} files Array of objects to upload serialized into JSON.
-   * @param {string} bucket Bucket name.
-   * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-   *
-   * const credentials: StorageCredentials = {
-   *   accessKey: 'ACCESS_KEY',
-   *   secretKey: 'SECRET_KEY',
-   * };
-   * const params: StorageParams = {
-   *   endPoint: 'http://localhost',
-   *   port: 9000,
-   *   useSSL: false,
-   *   region: 'us-east-1'
-   * };
-   *
-   * const storageClient = new StorageClient(params, credentials);
-   * const file1 = { name: 'file1', description: 'description of file1' };
-   * const file2 = { name: 'file2', description: 'description of file2' };
-   * const files = [file1, file2];
-   * const uploadedFiles = await storageClient.uploadFiles(files, 'bucket-name');
-   * ```
-   */
-  public async uploadFiles(
-    files: any[],
-    bucket: string
-  ): Promise<UploadFile[]> {
-    const isBucketExists = await this.client.bucketExists(bucket);
-    if (!isBucketExists) {
-      throw ErrorStorageBucketNotFound;
-    }
-
-    return Promise.all(
-      files.map(async (file) => {
-        const content = JSON.stringify(file);
-
-        const hash = crypto.createHash('sha1').update(content).digest('hex');
-        const key = `s3${hash}.json`;
-
-        try {
-          await this.client.putObject(bucket, key, content, {
-            'Content-Type': 'application/json',
-            'Cache-Control': 'no-store',
-          });
-
-          return {
-            key,
-            url: `${this.clientParams.useSSL ? 'https' : 'http'}://${
-              this.clientParams.endPoint
-            }${
-              this.clientParams.port ? `:${this.clientParams.port}` : ''
-            }/${bucket}/${key}`,
-            hash,
-          };
-        } catch {
-          throw ErrorStorageFileNotUploaded;
-        }
-      })
-    );
-  }
-
-  /**
-   * This function checks if a bucket exists.
-   *
-   * @param {string} bucket Bucket name.
-   * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-   *
-   * const credentials: StorageCredentials = {
-   *   accessKey: 'ACCESS_KEY',
-   *   secretKey: 'SECRET_KEY',
-   * };
-   * const params: StorageParams = {
-   *   endPoint: 'http://localhost',
-   *   port: 9000,
-   *   useSSL: false,
-   *   region: 'us-east-1'
-   * };
-   *
-   * const storageClient = new StorageClient(params, credentials);
-   * const exists = await storageClient.bucketExists('bucket-name');
-   * ```
-   */
-  public async bucketExists(bucket: string): Promise<boolean> {
-    return this.client.bucketExists(bucket);
-  }
-
-  /**
-   * This function lists all file names contained in the bucket.
-   *
-   * @param {string} bucket Bucket name.
-   * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
-   *
-   * const credentials: StorageCredentials = {
-   *   accessKey: 'ACCESS_KEY',
-   *   secretKey: 'SECRET_KEY',
-   * };
-   * const params: StorageParams = {
-   *   endPoint: 'http://localhost',
-   *   port: 9000,
-   *   useSSL: false,
-   *   region: 'us-east-1'
-   * };
-   *
-   * const storageClient = new StorageClient(params, credentials);
-   * const fileNames = await storageClient.listObjects('bucket-name');
-   * ```
-   */
-  public async listObjects(bucket: string): Promise<string[]> {
-    const isBucketExists = await this.client.bucketExists(bucket);
-    if (!isBucketExists) {
-      throw ErrorStorageBucketNotFound;
-    }
-
-    try {
-      return new Promise((resolve, reject) => {
-        const keys: string[] = [];
-        const stream = this.client.listObjectsV2(bucket, '', true, '');
-
-        stream.on('data', (obj: { name: string }) => keys.push(obj.name));
-        stream.on('error', reject);
-        stream.on('end', () => {
-          resolve(keys);
-        });
-      });
-    } catch (e) {
-      throw new Error(String(e));
-    }
-  }
-}