@pinata/sdk 1.1.26 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinata/sdk",
-  "version": "1.1.26",
+  "version": "1.2.1",
   "description": "Official SDK for the Pinata IPFS platform",
   "main": "lib/pinata-sdk.js",
   "types": "types/index.d.ts",
@@ -36,7 +36,8 @@
   "devDependencies": {
     "@babel/cli": "^7.8.4",
     "@babel/core": "^7.8.4",
-    "@babel/preset-env": "^7.9.0",
+    "@babel/plugin-transform-runtime": "^7.19.1",
+    "@babel/preset-env": "^7.19.4",
     "@babel/register": "^7.8.3",
     "@types/node": "^15.6.1",
     "acorn": "^7.1.0",

package/src/commands/data/getFilesByCount/getFilesByCount.js

@@ -0,0 +1,67 @@
+import pinList from '../pinList/pinList';
+
+export default function getFilesByCount(
+    config,
+
+    filters = {},
+    maxCount = -1
+) {
+    if (maxCount === 0) {
+        throw Error("Max count can't be 0");
+    }
+
+    const asyncIterable = {
+        [Symbol.asyncIterator]: () => {
+            let i = 0;
+            const pageLimit = 10;
+            let pageOffset = 0;
+            let cache = [];
+            let keepLooping = false;
+
+            return {
+                next() {
+                    return new Promise((resolve, reject) => {
+                        if (i === 0 || (i % pageLimit === 0 && keepLooping)) {
+                            resolve(
+                                pinList(config, {
+                                    filters,
+                                    ...{ pageOffset, pageLimit }
+                                }).then((resp) => {
+                                    cache = resp.rows;
+                                    pageOffset = pageOffset + cache.length;
+
+                                    // If the user requested all pins we have to keep looping if the limit page was not fulfill
+                                    keepLooping =
+                                        cache.length !== 0 &&
+                                        (maxCount === -1 ?
+                                            cache.length === pageLimit :
+                                            i < maxCount);
+                                })
+                            );
+                        }
+                        resolve();
+                    }).then(() => {
+                        const valueToReturn = cache[i % pageLimit];
+
+                        const done = !(
+                            (maxCount === -1 ? i < pageOffset : i < maxCount) &&
+                            keepLooping
+                        );
+
+                        i++;
+                        return Promise.resolve({
+                            value: valueToReturn,
+                            done
+                        });
+                    });
+                },
+                return() {
+                    // This will be reached if the consumer called 'break' or 'return' early in the loop.
+                    return Promise.resolve({ value: i, done: true });
+                }
+            };
+        }
+    };
+
+    return asyncIterable;
+}

package/src/commands/data/pinList/pinList.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../../constants';
-import { validateApiKeys } from '../../../util/validators';
+import { createConfigForAxiosHeaders } from '../../../util/validators';
 import { handleError } from '../../../util/errorResponse';
 import queryBuilder from './queryBuilder';
 
@@ -8,11 +8,11 @@ import queryBuilder from './queryBuilder';
  * Pin List
  * @param {string} pinataApiKey
  * @param {string} pinataSecretApiKey
- * @param {string} filters
+ * @param {any} filters
  * @returns {Promise<unknown>}
  */
-export default function pinList(pinataApiKey, pinataSecretApiKey, filters) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
+export default function pinList(config, filters = {}) {
+    filters = {...filters, ...{includeCount: 'false' }};
 
     const baseEndpoint = `${baseUrl}/data/pinList`;
     const endpoint = queryBuilder(baseEndpoint, filters);
@@ -20,13 +20,8 @@ export default function pinList(pinataApiKey, pinataSecretApiKey, filters) {
     return new Promise((resolve, reject) => {
         axios.get(
             endpoint,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while attempting to retrieve user pin list: ${result}`));
             }

package/src/commands/data/pinList/queryBuilder.js

@@ -35,6 +35,10 @@ export default function queryBuilder(baseUrl, filters) {
 
     if (filters) {
         //  now we need to construct the actual URL based on the given filters provided
+        if (filters.includeCount) {
+            filterQuery = filterQuery + `includeCount=${filters.includeCount}&`;
+        }
+
         if (filters.hashContains) {
             if (typeof filters.hashContains !== 'string') {
                 throw new Error('hashContains value is not a string');

package/src/commands/data/testAuthentication.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import {validateApiKeys} from '../../util/validators';
+import {createConfigForAxiosHeaders} from '../../util/validators';
 import { handleError } from '../../util/errorResponse';
 
 /**
@@ -9,22 +9,15 @@ import { handleError } from '../../util/errorResponse';
  * @param {string} pinataSecretApiKey
  * @returns {Promise<unknown>}
  */
-export default function testAuthentication(pinataApiKey, pinataSecretApiKey) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
-
+export default function testAuthentication(config) {
     //  test authentication to make sure that the user's provided keys are legit
     const endpoint = `${baseUrl}/data/testAuthentication`;
 
     return new Promise((resolve, reject) => {
         axios.get(
             endpoint,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while authenticating: ${result}`));
             }

package/src/commands/data/userPinnedDataTotal.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys } from '../../util/validators';
+import { createConfigForAxiosHeaders } from '../../util/validators';
 import { handleError } from '../../util/errorResponse';
 
 /**
@@ -9,21 +9,14 @@ import { handleError } from '../../util/errorResponse';
  * @param {string} pinataSecretApiKey
  * @returns {Promise<unknown>}
  */
-export default function userPinnedDataTotal(pinataApiKey, pinataSecretApiKey) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
-
+export default function userPinnedDataTotal(config) {
     let endpoint = `${baseUrl}/data/userPinnedDataTotal`;
 
     return new Promise((resolve, reject) => {
         axios.get(
             endpoint,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while attempting to retrieve pinned data total: ${result}`));
             }

package/src/commands/pinning/hashMetadata.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys, validateMetadata } from '../../util/validators';
+import { createConfigForAxiosHeaders, validateMetadata } from '../../util/validators';
 import isIPFS from 'is-ipfs';
 import { handleError } from '../../util/errorResponse';
 
@@ -12,9 +12,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {*} metadata
  * @returns {Promise<unknown>}
  */
-export default function hashMetadata(pinataApiKey, pinataSecretApiKey, ipfsPinHash, metadata) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
-
+export default function hashMetadata(config, ipfsPinHash, metadata) {
     if (!ipfsPinHash) {
         throw new Error('ipfsPinHash value is required for changing the pin policy of a pin');
     }
@@ -46,13 +44,8 @@ export default function hashMetadata(pinataApiKey, pinataSecretApiKey, ipfsPinHa
         axios.put(
             endpoint,
             body,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+            .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while changing metadata for hash: ${result}`));
             }

package/src/commands/pinning/hashPinPolicy.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys, validatePinPolicyStructure } from '../../util/validators';
+import { createConfigForAxiosHeaders, validatePinPolicyStructure } from '../../util/validators';
 import isIPFS from 'is-ipfs';
 import { handleError } from '../../util/errorResponse';
 
@@ -12,8 +12,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {*} newPinPolicy
  * @returns {Promise<unknown>}
  */
-export default function hashPinPolicy(pinataApiKey, pinataSecretApiKey, ipfsPinHash, newPinPolicy) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
+export default function hashPinPolicy(config, ipfsPinHash, newPinPolicy) {
     validatePinPolicyStructure(newPinPolicy);
 
     if (!ipfsPinHash) {
@@ -38,13 +37,8 @@ export default function hashPinPolicy(pinataApiKey, pinataSecretApiKey, ipfsPinH
         axios.put(
             endpoint,
             body,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+            .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while changing pin policy for hash: ${result}`));
             }

package/src/commands/pinning/pinByHash.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys, validateMetadata } from '../../util/validators';
+import { createConfigForAxiosHeaders, validateMetadata } from '../../util/validators';
 import isIPFS from 'is-ipfs';
 import { handleError } from '../../util/errorResponse';
 
@@ -12,9 +12,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {*} options
  * @returns {Promise<unknown>}
  */
-export default function pinByHash(pinataApiKey, pinataSecretApiKey, hashToPin, options) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
-
+export default function pinByHash(config, hashToPin, options) {
     if (!hashToPin) {
         throw new Error('hashToPin value is required for pinning by hash');
     }
@@ -42,13 +40,8 @@ export default function pinByHash(pinataApiKey, pinataSecretApiKey, hashToPin, o
         axios.post(
             endpoint,
             body,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while adding to pin queue: ${result}`));
             }

package/src/commands/pinning/pinFileToIPFS.js

@@ -2,7 +2,7 @@ import axios from 'axios';
 import { baseUrl } from './../../constants';
 import NodeFormData from 'form-data';
 import stream from 'stream';
-import {validateApiKeys, validateMetadata, validatePinataOptions} from '../../util/validators';
+import {createConfigForAxiosHeadersWithFormData, validateMetadata, validatePinataOptions} from '../../util/validators';
 import { handleError } from '../../util/errorResponse';
 
 /**
@@ -13,9 +13,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {*} options
  * @returns {Promise<unknown>}
  */
-export default function pinFileToIPFS(pinataApiKey, pinataSecretApiKey, readStream, options) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
-
+export default function pinFileToIPFS(config, readStream, options) {
     return new Promise((resolve, reject) => {
 
         const data = new NodeFormData();
@@ -38,20 +36,11 @@ export default function pinFileToIPFS(pinataApiKey, pinataSecretApiKey, readStre
                 data.append('pinataOptions', JSON.stringify(options.pinataOptions));
             }
         }
-
-        axios.post(
+           axios.post(
             endpoint,
             readStream instanceof NodeFormData ? readStream : data,
-            {
-                withCredentials: true,
-                maxContentLength: 'Infinity', //this is needed to prevent axios from erroring out with large files
-                maxBodyLength: 'Infinity',
-                headers: {
-                    'Content-type': `multipart/form-data; boundary= ${data._boundary}`,
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            createConfigForAxiosHeadersWithFormData(config, data._boundary)
+        ).then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while pinning File to IPFS: ${result}`));
             }

package/src/commands/pinning/pinFromFS.js

@@ -1,7 +1,7 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
 import NodeFormData from 'form-data';
-import {validateApiKeys, validateMetadata, validatePinataOptions} from '../../util/validators';
+import {createConfigForAxiosHeadersWithFormData, validateMetadata, validatePinataOptions} from '../../util/validators';
 import basePathConverter from 'base-path-converter';
 import { handleError } from '../../util/errorResponse';
 const fs = require('fs');
@@ -15,8 +15,7 @@ const recursive = require('recursive-fs');
  * @param {*} options
  * @returns {Promise<unknown>}
  */
-export default function pinFromFS(pinataApiKey, pinataSecretApiKey, sourcePath, options) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
+export default function pinFromFS(config, sourcePath, options) {
 
     return new Promise((resolve, reject) => {
         const endpoint = `${baseUrl}/pinning/pinFileToIPFS`;
@@ -45,16 +44,8 @@ export default function pinFromFS(pinataApiKey, pinataSecretApiKey, sourcePath,
                 axios.post(
                     endpoint,
                     data,
-                    {
-                        withCredentials: true,
-                        maxContentLength: 'Infinity', //this is needed to prevent axios from erroring out with large directories
-                        maxBodyLength: 'Infinity',
-                        headers: {
-                            'Content-type': `multipart/form-data; boundary= ${data._boundary}`,
-                            'pinata_api_key': pinataApiKey,
-                            'pinata_secret_api_key': pinataSecretApiKey
-                        }
-                    }).then(function (result) {
+                    createConfigForAxiosHeadersWithFormData(config, data._boundary))
+                .then(function (result) {
                     if (result.status !== 200) {
                         reject(new Error(`unknown server response while pinning File to IPFS: ${result}`));
                     }
@@ -92,16 +83,8 @@ export default function pinFromFS(pinataApiKey, pinataSecretApiKey, sourcePath,
                     axios.post(
                         endpoint,
                         data,
-                        {
-                            withCredentials: true,
-                            maxContentLength: 'Infinity',
-                            maxBodyLength: 'Infinity', //this is needed to prevent axios from erroring out with large directories
-                            headers: {
-                                'Content-type': `multipart/form-data; boundary= ${data._boundary}`,
-                                'pinata_api_key': pinataApiKey,
-                                'pinata_secret_api_key': pinataSecretApiKey
-                            }
-                        }).then(function (result) {
+                        createConfigForAxiosHeadersWithFormData(config, data._boundary))
+                    .then(function (result) {
                         if (result.status !== 200) {
                             reject(new Error(`unknown server response while pinning File to IPFS: ${result}`));
                         }

package/src/commands/pinning/pinJSONToIPFS.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys, validateMetadata, validatePinataOptions } from '../../util/validators';
+import { createConfigForAxiosHeaders, validateMetadata, validatePinataOptions } from '../../util/validators';
 import { handleError } from '../../util/errorResponse';
 
 /**
@@ -11,8 +11,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {*} options
  * @returns {Promise<unknown>}
  */
-export default function pinJSONToIPFS(pinataApiKey, pinataSecretApiKey, body, options) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
+export default function pinJSONToIPFS(config, body, options) {
 
     let requestBody = body;
 
@@ -40,13 +39,8 @@ export default function pinJSONToIPFS(pinataApiKey, pinataSecretApiKey, body, op
         axios.post(
             endpoint,
             requestBody,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while pinning JSON to IPFS: ${result}`));
             }

package/src/commands/pinning/pinJobs/pinJobs.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../../constants';
-import { validateApiKeys } from '../../../util/validators';
+import { createConfigForAxiosHeaders } from '../../../util/validators';
 import queryBuilder from './queryBuilder';
 import { handleError } from '../../../util/errorResponse';
 
@@ -11,8 +11,7 @@ import { handleError } from '../../../util/errorResponse';
  * @param {*} filters
  * @returns {Promise<unknown>}
  */
-export default function pinJobs(pinataApiKey, pinataSecretApiKey, filters) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
+export default function pinJobs(config, filters) {
 
     let endpoint = `${baseUrl}/pinning/pinJobs`;
 
@@ -23,13 +22,8 @@ export default function pinJobs(pinataApiKey, pinataSecretApiKey, filters) {
     return new Promise((resolve, reject) => {
         axios.get(
             endpoint,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while attempting to retrieve pin jobs: ${result}`));
             }

package/src/commands/pinning/unpin.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys } from '../../util/validators';
+import { createConfigForAxiosHeaders } from '../../util/validators';
 import isIPFS from 'is-ipfs';
 import { handleError } from '../../util/errorResponse';
 
@@ -11,9 +11,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {string} hashToUnpin
  * @returns {Promise<unknown>}
  */
-export default function unpin(pinataApiKey, pinataSecretApiKey, hashToUnpin) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
-
+export default function unpin(config, hashToUnpin) {
     if (!hashToUnpin) {
         throw new Error('hashToUnpin value is required for removing a pin from Pinata');
     }
@@ -26,13 +24,8 @@ export default function unpin(pinataApiKey, pinataSecretApiKey, hashToUnpin) {
     return new Promise((resolve, reject) => {
         axios.delete(
             endpoint,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+        .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while removing pin from IPFS: ${result}`));
             }

package/src/commands/pinning/userPinPolicy.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { baseUrl } from './../../constants';
-import { validateApiKeys, validatePinPolicyStructure } from '../../util/validators';
+import { createConfigForAxiosHeaders, validatePinPolicyStructure } from '../../util/validators';
 import { handleError } from '../../util/errorResponse';
 
 /**
@@ -10,8 +10,7 @@ import { handleError } from '../../util/errorResponse';
  * @param {*} newPinPolicy
  * @returns {Promise<unknown>}
  */
-export default function userPinPolicy(pinataApiKey, pinataSecretApiKey, newPinPolicy) {
-    validateApiKeys(pinataApiKey, pinataSecretApiKey);
+export default function userPinPolicy(config, newPinPolicy) {
     validatePinPolicyStructure(newPinPolicy);
 
     if (!newPinPolicy) {
@@ -27,13 +26,8 @@ export default function userPinPolicy(pinataApiKey, pinataSecretApiKey, newPinPo
         axios.put(
             endpoint,
             body,
-            {
-                withCredentials: true,
-                headers: {
-                    'pinata_api_key': pinataApiKey,
-                    'pinata_secret_api_key': pinataSecretApiKey
-                }
-            }).then(function (result) {
+            {...createConfigForAxiosHeaders(config)})
+            .then(function (result) {
             if (result.status !== 200) {
                 reject(new Error(`unknown server response while changing pin policy for user: ${result}`));
             }

package/src/constants.js

@@ -1 +1,4 @@
 export const baseUrl = 'https://api.pinata.cloud';
+
+export const ERROR_NO_CREDENTIALS_PROVIDED =
+    'No credentials provided! Please provide your pinata api key and pinata secret api key or your pinata JWT key as an argument when you start this script';