@pinata/sdk 1.1.23 → 1.1.26

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinata/sdk",
-  "version": "1.1.23",
+  "version": "1.1.26",
   "description": "Official SDK for the Pinata IPFS platform",
   "main": "lib/pinata-sdk.js",
   "types": "types/index.d.ts",

package/src/commands/pinning/pinFileToIPFS.js

@@ -24,8 +24,8 @@ export default function pinFileToIPFS(pinataApiKey, pinataSecretApiKey, readStre
 
         const endpoint = `${baseUrl}/pinning/pinFileToIPFS`;
 
-        if (!(readStream instanceof stream.Readable)) {
-            reject(new Error('readStream is not a readable stream'));
+        if (!(readStream instanceof stream.Readable || readStream instanceof NodeFormData)) {
+            reject(new Error('readStream is not a readable stream or form data'));
         }
 
         if (options) {
@@ -41,7 +41,7 @@ export default function pinFileToIPFS(pinataApiKey, pinataSecretApiKey, readStre
 
         axios.post(
             endpoint,
-            data,
+            readStream instanceof NodeFormData ? readStream : data,
             {
                 withCredentials: true,
                 maxContentLength: 'Infinity', //this is needed to prevent axios from erroring out with large files

package/src/index.js

@@ -1,12 +1,10 @@
 import pinByHash from './commands/pinning/pinByHash';
 import hashMetadata from './commands/pinning/hashMetadata';
-import hashPinPolicy from './commands/pinning/hashPinPolicy';
 import pinFileToIPFS from './commands/pinning/pinFileToIPFS';
 import pinFromFS from './commands/pinning/pinFromFS';
 import pinJSONToIPFS from './commands/pinning/pinJSONToIPFS';
 import pinJobs from './commands/pinning/pinJobs/pinJobs';
 import unpin from './commands/pinning/unpin';
-import userPinPolicy from './commands/pinning/userPinPolicy';
 import testAuthentication from './commands/data/testAuthentication';
 import pinList from './commands/data/pinList/pinList';
 import userPinnedDataTotal from './commands/data/userPinnedDataTotal';
@@ -135,14 +133,6 @@ import userPinnedDataTotal from './commands/data/userPinnedDataTotal';
  * @returns {Promise<any>}
  */
 
-/**
- * Hash pin policy
- * @callback hashPinPolicy
- * @param {string} ipfsPinHash
- * @param {{regions: PinataPinPolicyItem[]}} newPinPolicy
- * @returns {Promise<any>}
- */
-
 /**
  * Pin by hash
  * @callback pinByHash
@@ -189,13 +179,6 @@ import userPinnedDataTotal from './commands/data/userPinnedDataTotal';
  * @returns {Promise<any>}
  */
 
-/**
- * User Pin Policy
- * @callback userPinPolicy
- * @param {{regions: PinataPinPolicyItem[]}} newPinPolicy
- * @returns {Promise<any>}
- */
-
 /**
  * Test Authentication
  * @callback testAuthentication
@@ -219,13 +202,11 @@ import userPinnedDataTotal from './commands/data/userPinnedDataTotal';
  * @typedef PinataClient
  * @property {pinByHash} pinByHash
  * @property {hashMetadata} hashMetadata
- * @property {hashPinPolicy} hashPinPolicy
  * @property {pinFileToIPFS} pinFileToIPFS
  * @property {pinFromFS} pinFromFS
  * @property {pinJSONToIPFS} pinJSONToIPFS
  * @property {pinJobs} pinJobs
  * @property {unpin} unpin
- * @property {userPinPolicy} userPinPolicy
  * @property {testAuthentication} testAuthentication
  * @property {pinList} pinList
  * @property {userPinnedDataTotal} userPinnedDataTotal
@@ -248,9 +229,6 @@ export default function pinataClient(pinataApiKey, pinataSecretApiKey) {
     client.hashMetadata = function (ipfsPinHash, metadata) {
         return hashMetadata(pinataApiKey, pinataSecretApiKey, ipfsPinHash, metadata);
     };
-    client.hashPinPolicy = function (ipfsPinHash, newPinPolicy) {
-        return hashPinPolicy(pinataApiKey, pinataSecretApiKey, ipfsPinHash, newPinPolicy);
-    };
     client.pinFileToIPFS = function (readableStream, options) {
         return pinFileToIPFS(pinataApiKey, pinataSecretApiKey, readableStream, options);
     };
@@ -266,9 +244,6 @@ export default function pinataClient(pinataApiKey, pinataSecretApiKey) {
     client.unpin = function (hashToUnpin) {
         return unpin(pinataApiKey, pinataSecretApiKey, hashToUnpin);
     };
-    client.userPinPolicy = function (newPinPolicy) {
-        return userPinPolicy(pinataApiKey, pinataSecretApiKey, newPinPolicy);
-    };
     client.testAuthentication = function () {
         return testAuthentication(pinataApiKey, pinataSecretApiKey);
     };

package/test/commands/pinning/pinFileToIPFS.test.js

@@ -1,20 +1,23 @@
 import axios from 'axios';
 import pinFileToIPFS from'../../../src/commands/pinning/pinFileToIPFS';
 import fs from 'fs';
+import NodeFormData from 'form-data';
 jest.mock('axios');
 
 //common values
 const nonStream = 'test';
 const validStream = fs.createReadStream('./pinata.png');
+const validFormData = new NodeFormData();
+validFormData.append('file', validStream, {filepath: 'test/filepath'});
 
 
-test('non-readableStream is passed in', () => {
-    expect(pinFileToIPFS('test', 'test', nonStream)).rejects.toEqual(Error('readStream is not a readable stream'));
+test('non-readableStream and non-formData is passed in', () => {
+    expect(pinFileToIPFS('test', 'test', nonStream)).rejects.toEqual(Error('readStream is not a readable stream or form data'));
 
     return undefined;
 });
 
-test('200 status is returned', () => {
+test('200 status is returned with valid stream', () => {
     const goodStatus = {
         status: 200,
         data: 'testData'
@@ -24,6 +27,16 @@ test('200 status is returned', () => {
     expect(pinFileToIPFS('test', 'test', validStream)).resolves.toEqual(goodStatus.data);
 });
 
+test('200 status is returned with valid form data', () => {
+    const goodStatus = {
+        status: 200,
+        data: 'testData'
+    };
+    axios.post.mockResolvedValue(goodStatus);
+    expect.assertions(1);
+    expect(pinFileToIPFS('test', 'test', validFormData)).resolves.toEqual(goodStatus.data);
+});
+
 test('Result other than 200 status is returned', () => {
     const badStatus = {
         status: 700

package/types/index.d.ts

@@ -100,13 +100,6 @@
  * @param {PinataMetadata} metadata
  * @returns {Promise<any>}
  */
-/**
- * Hash pin policy
- * @callback hashPinPolicy
- * @param {string} ipfsPinHash
- * @param {{regions: PinataPinPolicyItem[]}} newPinPolicy
- * @returns {Promise<any>}
- */
 /**
  * Pin by hash
  * @callback pinByHash
@@ -147,12 +140,6 @@
  * @param {string} hashToUnpin
  * @returns {Promise<any>}
  */
-/**
- * User Pin Policy
- * @callback userPinPolicy
- * @param {{regions: PinataPinPolicyItem[]}} newPinPolicy
- * @returns {Promise<any>}
- */
 /**
  * Test Authentication
  * @callback testAuthentication
@@ -173,13 +160,11 @@
  * @typedef PinataClient
  * @property {pinByHash} pinByHash
  * @property {hashMetadata} hashMetadata
- * @property {hashPinPolicy} hashPinPolicy
  * @property {pinFileToIPFS} pinFileToIPFS
  * @property {pinFromFS} pinFromFS
  * @property {pinJSONToIPFS} pinJSONToIPFS
  * @property {pinJobs} pinJobs
  * @property {unpin} unpin
- * @property {userPinPolicy} userPinPolicy
  * @property {testAuthentication} testAuthentication
  * @property {pinList} pinList
  * @property {userPinnedDataTotal} userPinnedDataTotal
@@ -284,12 +269,6 @@ export type PinataPinListResponse = {
  * Hash meta data
  */
 export type hashMetadata = (ipfsPinHash: string, metadata: PinataMetadata) => Promise<any>;
-/**
- * Hash pin policy
- */
-export type hashPinPolicy = (ipfsPinHash: string, newPinPolicy: {
-    regions: PinataPinPolicyItem[];
-}) => Promise<any>;
 /**
  * Pin by hash
  */
@@ -314,12 +293,6 @@ export type pinJSONToIPFS = (body: Object, options?: PinataPinOptions | undefine
  * Unpin
  */
 export type unpin = (hashToUnpin: string) => Promise<any>;
-/**
- * User Pin Policy
- */
-export type userPinPolicy = (newPinPolicy: {
-    regions: PinataPinPolicyItem[];
-}) => Promise<any>;
 /**
  * Test Authentication
  */
@@ -337,26 +310,22 @@ export type userPinnedDataTotal = () => Promise<number>;
 export type PinataClient = {
     pinByHash: pinByHash;
     hashMetadata: hashMetadata;
-    hashPinPolicy: hashPinPolicy;
     pinFileToIPFS: pinFileToIPFS;
     pinFromFS: pinFromFS;
     pinJSONToIPFS: pinJSONToIPFS;
     pinJobs: pinJobs;
     unpin: unpin;
-    userPinPolicy: userPinPolicy;
     testAuthentication: testAuthentication;
     pinList: pinList;
     userPinnedDataTotal: userPinnedDataTotal;
 };
 import pinByHash from "./commands/pinning/pinByHash";
 import hashMetadata from "./commands/pinning/hashMetadata";
-import hashPinPolicy from "./commands/pinning/hashPinPolicy";
 import pinFileToIPFS from "./commands/pinning/pinFileToIPFS";
 import pinFromFS from "./commands/pinning/pinFromFS";
 import pinJSONToIPFS from "./commands/pinning/pinJSONToIPFS";
 import pinJobs from "./commands/pinning/pinJobs/pinJobs";
 import unpin from "./commands/pinning/unpin";
-import userPinPolicy from "./commands/pinning/userPinPolicy";
 import testAuthentication from "./commands/data/testAuthentication";
 import pinList from "./commands/data/pinList/pinList";
 import userPinnedDataTotal from "./commands/data/userPinnedDataTotal";