storx-storage-sdk

StorX Storage Node SDK

StorX SDK to access all storage based APIs

Installation

npm install --save storx-storage-sdk

Setup

const StorxStorage = require('storx-storage-sdk');
const storxStorageFunctions = StorxStorage();

Quickly test that you can connect to the API with the following call:

storxStorageFunctions
  .welcome({
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

API functions

Get Folder By ID

storxStorageFunctions
  .getFolderById({
    folderId: '<folderId>', // string
    token: 'Bearer <token>',
    teamId: '<teamId>', // string (optional)
  })
  .then(result => {
    console.log(result); // Folder details
  })
  .catch(err => {
    console.log(err);
  });

Create Folder

storxStorageFunctions
  .createFolder({
    folderName: '<folderName>',   // string
    parentFolderId: '<parentFolderId>',  // string
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  .catch(err => {
    console.log(err);
  });

Update Folder Metadata

storxStorageFunctions
  .updateFolderMetadata({
    folderId: '<folderId>', // string
    metadata: '<metadata>', // object
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Delete Folder

storxStorageFunctions
  .deleteFolder({
    folderId: '<folderId>', // string
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Move Folder

storxStorageFunctions
  .moveFolder({
    folderId: '<folderId>', // string
    destination: '<destinationId>', // string
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Create File

storxStorageFunctions
  .createFile({
    file : {
      fileId: '<file Id>',
      bucket: '<bucket Id>',
      size: '<file size>',
      folder_id: '<folder Id>',
      name: '<file Name>'
    },
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  .catch(err => {
    console.log(err);
  });

Upload File to Folder

storxStorageFunctions
  .uploadFileToFolder({
    data: '<file>', // file object
    folderId: '<folderId>', // string
    mnemonic: '<account mnemonic paraphrase>', // string
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  .catch(err => {
    console.log(err);
  });

Update File Metadata

storxStorageFunctions
  .updateFileMetadata({
    fileId: '<fileId>', // string
    metadata: '<metadata>', // object
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Move File

storxStorageFunctions
  .moveFile({
    fileId: '<fileId>', // string
    destination: '<destinationId>',
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Delete File from Folder

storxStorageFunctions
  .deleteFileFromFolder({
    fileId: '<fileId>', // string
    folderId: '<folderId>', // string
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Delete File from Bucket

storxStorageFunctions
  .deleteFileFromBucket({
    fileId: '<fileId>', // string
    bucketId: '<bucketId>', // string
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

Create Share Token

storxStorageFunctions
  .generateShareToken({
    isFolder: '<isFolder>', // boolean
    itemId: '<itemId>', // string
    mnemonic: '<mnemonic>', // string
    views: '<views>', // integer
    token: 'Bearer <token>',
  })
  .then(result => {
    console.log(result);
  })
  .catch(err => {
    console.log(err);
  });

NOTE: getFileById and downloadEntityByToken are both download APIs. Hence, they wont have their functions and using those functions will return you empty object.

More to continue......

Dev Installation

Step 1 : Clone the repository.

Step 2 : Go to the project where you want to use this package.

Step 3 : npm install 'path of the cloned repository' and you should be able to access all functions in your project.

Step 4 : Once you make any changes in the repo, run 'npm run build'. This will update the functions you changed and also update the package in your project.