Add support for collections.list endpoint (#66)

* Add support for collections.list endpoint

* Remove models field from response

Author: mattt

index.d.ts

@@ -12,7 +12,7 @@ declare module 'replicate' {
     name: string;
     slug: string;
     description: string;
-    models: Model[];
+    models?: Model[];
   }
 
   export interface Model {
@@ -90,6 +90,7 @@ declare module 'replicate' {
     ): Promise<Prediction>;
 
     collections: {
+      list(): Promise<Page<Collection>>;
       get(collection_slug: string): Promise<Collection>;
     };
 

index.js

@@ -40,6 +40,7 @@ class Replicate {
     this.fetch = options.fetch || globalThis.fetch;
 
     this.collections = {
+      list: collections.list.bind(this),
       get: collections.get.bind(this),
     };
 

index.test.ts

@@ -35,13 +35,39 @@ describe('Replicate client', () => {
     });
   });
 
+  describe('collections.list', () => {
+    test('Calls the correct API route', async () => {
+      nock(BASE_URL)
+        .get('/collections')
+        .reply(200, {
+          results: [
+            {
+              name: 'Super resolution',
+              slug: 'super-resolution',
+              description: 'Upscaling models that create high-quality images from low-quality images.',
+            },
+            {
+              name: 'Image classification',
+              slug: 'image-classification',
+              description: 'Models that classify images.',
+            },
+          ],
+          next: null,
+          previous: null,
+        });
+
+      const collections = await client.collections.list();
+      expect(collections.results.length).toBe(2);
+    });
+    // Add more tests for error handling, edge cases, etc.
+  });
+
   describe('collections.get', () => {
     test('Calls the correct API route', async () => {
       nock(BASE_URL).get('/collections/super-resolution').reply(200, {
         name: 'Super resolution',
         slug: 'super-resolution',
-        description:
-          'Upscaling models that create high-quality images from low-quality images.',
+        description: 'Upscaling models that create high-quality images from low-quality images.',
         models: [],
       });
 

lib/collections.js

@@ -10,4 +10,14 @@ async function getCollection(collection_slug) {
   });
 }
 
-module.exports = { get: getCollection };
+/**
+ * Fetch a list of model collections
+ * @returns {Promise<object>} - Resolves with the collections data
+ */
+async function listCollections() {
+  return this.request('/collections', {
+    method: 'GET',
+  });
+}
+
+module.exports = { get: getCollection, list: listCollections };