@ipfs-shipyard/pinning-service-client - npm Package Compare versions

Comparing version 2.0.0 to 3.0.0

dist/dist.generated/apis/PinsApi.d.ts

@@ -15,6 +15,6 @@ /**
 export interface PinsGetRequest {
-    cid?: Set<string>;
+    cid?: Array<string>;
     name?: string;
     match?: TextMatchingStrategy;
-    status?: Set<Status>;
+    status?: Array<Status>;
     before?: Date;
@@ -50,6 +50,6 @@ after?: Date;
      * @summary List pin objects
-     * @param {Set<string>} [cid] Return pin objects responsible for pinning the specified CID(s); be aware that using longer hash functions introduces further constraints on the number of CIDs that will fit under the limit of 2000 characters per URL  in browser contexts
+     * @param {Array<string>} [cid] Return pin objects responsible for pinning the specified CID(s); be aware that using longer hash functions introduces further constraints on the number of CIDs that will fit under the limit of 2000 characters per URL  in browser contexts
      * @param {string} [name] Return pin objects with specified name (by default a case-sensitive, exact match)
      * @param {TextMatchingStrategy} [match] Customize the text matching strategy applied when name filter is present
-     * @param {Set<Status>} [status] Return pin objects for pins with the specified status
+     * @param {Array<Status>} [status] Return pin objects for pins with the specified status
      * @param {Date} [before] Return results created (queued) before provided timestamp
@@ -56,0 +56,0 @@ * @param {Date} [after] Return results created (queued) after provided timestamp

dist/dist.generated/apis/PinsApi.js

@@ -27,3 +27,3 @@ /* tslint:disable */
         if (requestParameters.cid) {
-            queryParameters['cid'] = Array.from(requestParameters.cid).join(runtime.COLLECTION_FORMATS["csv"]);
+            queryParameters['cid'] = requestParameters.cid.join(runtime.COLLECTION_FORMATS["csv"]);
         }
@@ -37,3 +37,3 @@ if (requestParameters.name !== undefined) {
         if (requestParameters.status) {
-            queryParameters['status'] = Array.from(requestParameters.status).join(runtime.COLLECTION_FORMATS["csv"]);
+            queryParameters['status'] = requestParameters.status.join(runtime.COLLECTION_FORMATS["csv"]);
         }
@@ -40,0 +40,0 @@ if (requestParameters.before !== undefined) {

dist/dist.generated/models/Pin.d.ts

@@ -32,6 +32,6 @@ /**
      * Optional list of multiaddrs known to provide the data
-     * @type {Set<string>}
+     * @type {Array<string>}
      * @memberof Pin
      */
-    origins?: Set<string>;
+    origins?: Array<string>;
     /**
@@ -38,0 +38,0 @@ * Optional metadata for pin object

dist/dist.generated/models/PinResults.d.ts

@@ -27,6 +27,6 @@ /**
      * An array of PinStatus results
-     * @type {Set<PinStatus>}
+     * @type {Array<PinStatus>}
      * @memberof PinResults
      */
-    results: Set<PinStatus>;
+    results: Array<PinStatus>;
 }
@@ -33,0 +33,0 @@ export declare function PinResultsFromJSON(json: any): PinResults;

dist/dist.generated/models/PinResults.js

@@ -24,3 +24,3 @@ /* tslint:disable */
         'count': json['count'],
-        'results': (new Set(json['results'].map(PinStatusFromJSON))),
+        'results': (json['results'].map(PinStatusFromJSON)),
     };
@@ -37,5 +37,5 @@ }
         'count': value.count,
-        'results': (Array.from(value.results).map(PinStatusToJSON)),
+        'results': (value.results.map(PinStatusToJSON)),
     };
 }
 //# sourceMappingURL=PinResults.js.map

dist/dist.generated/models/PinStatus.d.ts

@@ -46,6 +46,6 @@ /**
      * List of multiaddrs designated by pinning service for transferring any new data from external peers
-     * @type {Set<string>}
+     * @type {Array<string>}
      * @memberof PinStatus
      */
-    delegates: Set<string>;
+    delegates: Array<string>;
     /**
@@ -52,0 +52,0 @@ * Optional info for PinStatus response

package.json

 {
   "name": "@ipfs-shipyard/pinning-service-client",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "A lightweight client generated from the ipfs-pinning-service-spec defined at https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/main/ipfs-pinning-service.yaml",
@@ -5,0 +5,0 @@ "author": "Russell Dempsey <[e-mail]>",

README.md

@@ -32,3 +32,3 @@ ## IPFS Pinning Service API Client for JS
     limit: 10,
-    status: new Set([Status.Failed]) // requires a set, and not an array
+    status: [Status.Failed]
   }
@@ -57,2 +57,4 @@ const {count, results}: PinResults = await client.pinsGet(pinsGetOptions)
 
+It also uses `Set`s for all collection types though it cannot serialize or deserialize these types to/from JSON. They must be manually changed to be `Array`s.
+
 If you need to modify the generated code's import paths, you will have to run `npm run postgen` manually.
@@ -59,0 +61,0 @@

No alert changes

Improved metrics

Number of lines in readme file

78

increased by2.63%

Worsened metrics

Total package byte prevSize

221062

No dependency changes