@pinata/sdk 1.1.26 → 1.2.1

package/.babelrc

@@ -1,4 +1,5 @@
 {
-  "presets": [["@babel/env", { "modules": "commonjs" }]],
-  "plugins": ["add-module-exports"]
-}
+  "presets": [["@babel/env", { "modules": "commonjs" , "useBuiltIns": "usage"}]  ],
+  "plugins": ["add-module-exports", "@babel/plugin-transform-runtime"]
+}
+

package/.nvmrc

@@ -1 +1 @@
-v6.10
+v10.24

package/README.md

@@ -14,12 +14,28 @@ npm install --save @pinata/sdk
 ```
 
 ## Setup
-To start, simply require the Pinata SDK and set up an instance with your Pinata API Keys. Don't know what your keys are? Check out your [Account Page](https://pinata.cloud/account).
+To start, simply require the Pinata SDK and set up an instance with your Pinata API Keys or your JWT key. Don't know what your keys are? Check out your [Account Page](https://pinata.cloud/account).
+In the example below we provided with 3 ways to call the pinata SDK.
+
 ```javascript
+// Use the api keys by providing the strings directly 
 const pinataSDK = require('@pinata/sdk');
 const pinata = pinataSDK('yourPinataApiKey', 'yourPinataSecretApiKey');
 ```
 
+```javascript
+// Use the api keys by specifying your api key and api secret
+const pinataSDK = require('@pinata/sdk');
+const pinata = pinataSDK({ pinataApiKey: 'yourPinataApiKey', pinataSecretApiKey: 'yourPinataSecretApiKey' });
+
+```
+
+```javascript
+// Use the JWT key
+const pinataSDK = require('@pinata/sdk');
+const pinata = pinataSDK({ pinataJWTKey: 'yourPinataJWTKey'});
+```
+
 Quickly test that you can connect to the API with the following call:
 ```javascript
 pinata.testAuthentication().then((result) => {
@@ -47,6 +63,7 @@ Once you've set up your instance, using the Pinata SDK is easy. Simply call your
 * Data
   * [testAuthentication](#testAuthentication-anchor)
   * [pinList](#pinList-anchor)
+  * [getFilesByCount](#getFilesByCount-anchor)
   * [userPinnedDataTotal](#userPinnedDataTotal-anchor)
 <br />
 
@@ -190,13 +207,13 @@ pinata.pinFileToIPFS(readableStreamForFile, options).then((result) => {
 });
 ```
 
-<a name="pinFromFs-anchor"></a>
+<a name="pinFromFS-anchor"></a>
 ### `pinFromFS`
 Read from a location on your local file system and recursively pin the contents to IPFS (node.js only).
 
 Both individual files, as well as directories can be read from.
 
-##### `pinata.pinFromFs(sourcePath, options)`
+##### `pinata.pinFromFS(sourcePath, options)`
 ##### Params
 * `sourcePath` - The location on your local filesystem that should be read from. 
 * `options` (optional): A JSON object that can contain the following keyvalues:
@@ -388,7 +405,7 @@ pinata.testAuthentication().then((result) => {
 
 <a name="pinList-anchor"></a>
 ### `pinList`
-Retrieve pin records for your Pinata account
+Retrieve pin records for your Pinata account. In order to get the next page you have to manipulate `pageLimit` and `pageOffset` filter to get the next page. This method no longer return the total count of pins. We highly encourage you to use the auto-pagination method [getFilesByCount](#getFilesByCount-anchor).
 
 ##### `pinata.pinList(filters)`
 ##### Params
@@ -462,14 +479,73 @@ As an example, the following filter would only find records whose name contains
 }
 ```
 
+Our libraries support auto-pagination. This feature easily handles fetching large lists of resources without having to manually paginate results and perform subsequent requests.
 
- 
-#### Response
+To use the auto-pagination feature in Node 10+, simply iterate over a "list" call with the parameters you need in a for await loop.
+
+<a name="getFilesByCount-anchor"></a>
+### `getFilesByCount`
+This method support auto-pagination. This feature easily handles fetching large lists of pin records for your Pinata account without having to manually paginate results and perform subsequent requests. To use the auto-pagination feature in Node 10+.
+
+##### `pinata.getFilesByCount(filters, count)`
+##### Params
+* `filters` (optional): An object that can consist of the following optional query parameters:
+  * `hashContains` (optional): A string of alphanumeric characters that desires hashes must contain
+  * `pinStart` (optional): The earliest date the content is allowed to have been pinned. Must be a valid [ISO_8601](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) date. 
+  * `pinEnd` (optional): The earliest date the content is allowed to have been pinned. Must be a valid [ISO_8601](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) date. 
+  * `unpinStart` (optional): The earlist date the content is allowed to have been unpinned. Must be a valid [ISO_8601](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) date. 
+  * `unpinEnd` (optional): The latest date the content is allowed to have been unpinned. Must be a valid [ISO_8601](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) date. 
+  * `pinSizeMin` (optional): The minimum byte size that pin record you're looking for can have
+  * `pinSizeMax` (optional): The maximum byte size that pin record you're looking for can have
+  * `status` (optional): Filter pins using one of the following options
+    * `'all'` (Records for both pinned and unpinned content will be returned)
+    * `'pinned'` (Only records for pinned content will be returned)
+    * `'unpinned'` (Only records for unpinned content will be returned)  
+  * `metadata` (optional): A JSON object that can be used to find records for content that had optional metadata included when it was added to Pinata. The metadata object is formatted as follows:
+* `count` (optional): A Number that specifies how many pins you want. if no number is provided then it will pull all the pins based on your filter
+
+##### Metadata filter object formatting
 ```
 {
-    count: (this is the total number of pin records that exist for the query filters you passed in),
-    rows: [
-        {
+    name: 'exampleName',
+    keyvalues: {
+        testKeyValue: {
+            value: 'exampleFilterValue',
+            op: 'exampleFilterOperation'
+        },
+        testKeyValue2: {
+            value: 'exampleFilterValue2',
+            op: 'exampleFilterOperation2'
+        }
+    }
+}
+```
+Filter explanations:
+* `name` (optional): If provided, any records returned must have a name that contains the string provided for the 'name'.
+* `keyvalues` (optional): Each keyvalue provided in this object have both a `value` and `op`
+  * `value` (required): This is the value which will be filtered on
+  * `op` (required): This is the filter operation that will be applied to the `value` that was provided. Valid op values are:
+     * `'gt'` (greater than the value provided)
+     * `'gte'` (greater than or equal to the value provided)
+     * `'lt'` (less than the value provided)
+     * `'lte'` (less than or equal to the value provided)
+     * `'ne'` (not equal to the value provided)
+     * `'eq'` (equal to the value provided)
+     * `'between'` (between the two values provided) - NOTE - This also requires a `secondValue` be provided as seen in the example below
+     * `'notBetween'` (not between the two values provided) - NOTE - This also requires a `secondValue` be provided as seen in the example below
+     * `'like'` (like the value provided)
+     * `'notLike'` (not like the value provided)
+     * `'iLike'` (case insensitive version of `like`)
+     * `'notILike'` (case insensitive version of `notLike`)
+     * `'regexp'` (filter the value provided based on a provided regular expression)
+     * `'iRegexp'` (case insensitive version of regexp)
+  
+```
+
+#### Response
+```
+[
+    {
             id: (the id of your pin instance record),
             ipfs_pin_hash: (the IPFS multi-hash for the content you pinned),
             size: (this is how large (in bytes) the content pinned is),
@@ -477,7 +553,7 @@ As an example, the following filter would only find records whose name contains
             date_pinned: (This is the timestamp for when this content was pinned - represented in ISO 8601 format),
             date_unpinned: (This is the timestamp for when this content was unpinned (if null, then you still have the content pinned on Pinata),
             metadata: {
-                name: (this will be the name of the file originally upuloaded, or the custom name you set),
+                name: (this will be the name of the file originally uploaded, or the custom name you set),
                 keyvalues: {
                     exampleCustomKey: "exampleCustomValue",
                     exampleCustomKey2: "exampleCustomValue2",
@@ -491,11 +567,15 @@ As an example, the following filter would only find records whose name contains
         .
         .
         .
-    ]
-}
+]
+
 ```
 ##### Example Code
+
 ```javascript
+const pinataSDK = require('@pinata/sdk');
+const pinata = pinataSDK('yourPinataApiKey', 'yourPinataSecretApiKey');
+
 const metadataFilter = {
     name: 'exampleName',
     keyvalues: {
@@ -516,13 +596,17 @@ const filters = {
     pageOffset: 0,
     metadata: metadataFilter
 };
-pinata.pinList(filters).then((result) => {
-    //handle results here
-    console.log(result);
-}).catch((err) => {
-    //handle error here
-    console.log(err);
-});
+
+ // more reference at [for await ...](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of)
+ for await (const item of pinata.getFilesByCount(filters, 35)) {
+    // ...(item) perform any task with the current item in the array of 35
+ }
+
+
+for await (const item of pinata.getFilesByCount(filters)) {
+    // ...(item) perform any task with the current item the array is determined by all your pins
+ }
+
 ```
 
 <a name="userPinnedDataTotal-anchor"></a>