add method for listing public models

Author: zeke

README.md

@@ -199,6 +199,39 @@ const response = await replicate.models.get(model_owner, model_name);
 }
 ```
 
+### `replicate.models.list`
+
+```js
+const response = await replicate.models.list();
+```
+
+```jsonc
+{
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "url": "https://replicate.com/replicate/hello-world",
+      "owner": "replicate",
+      "name": "hello-world",
+      "description": "A tiny model that says hello",
+      "visibility": "public",
+      "github_url": "https://github.com/replicate/cog-examples",
+      "paper_url": null,
+      "license_url": null,
+      "run_count": 5681081,
+      "cover_image_url": "...",
+      "default_example": {
+        /* ... */
+      },
+      "latest_version": {
+        /* ... */
+      }
+    }
+  ]
+}
+```
+
 ### `replicate.models.versions.list`
 
 ```js

index.d.ts

@@ -69,12 +69,7 @@ declare module 'replicate' {
   }
 
   export default class Replicate {
-    constructor(options?: {
-      auth?: string;
-      userAgent?: string;
-      baseUrl?: string;
-      fetch?: Function;
-    });
+    constructor(options?: { auth?: string; userAgent?: string; baseUrl?: string; fetch?: Function });
 
     auth: string;
     userAgent?: string;
@@ -93,14 +88,17 @@ declare module 'replicate' {
       progress?: (prediction: Prediction) => void
     ): Promise<object>;
 
-    request(route: string | URL, options: {
-      method?: string;
-      headers?: object | Headers;
-      params?: object;
-      data?: object;
-    }): Promise<Response>;
+    request(
+      route: string | URL,
+      options: {
+        method?: string;
+        headers?: object | Headers;
+        params?: object;
+        data?: object;
+      }
+    ): Promise<Response>;
 
-    paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[ T ]>;
+    paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 
     wait(
       prediction: Prediction,
@@ -117,24 +115,15 @@ declare module 'replicate' {
 
     models: {
       get(model_owner: string, model_name: string): Promise<Model>;
+      list(): Promise<Page<Model>>;
       versions: {
         list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
-        get(
-          model_owner: string,
-          model_name: string,
-          version_id: string
-        ): Promise<ModelVersion>;
+        get(model_owner: string, model_name: string, version_id: string): Promise<ModelVersion>;
       };
     };
 
     predictions: {
-      create(options: {
-        version: string;
-        input: object;
-        stream?: boolean;
-        webhook?: string;
-        webhook_events_filter?: WebhookEventType[];
-      }): Promise<Prediction>;
+      create(options: { version: string; input: object; stream?: boolean; webhook?: string; webhook_events_filter?: WebhookEventType[] }): Promise<Prediction>;
       get(prediction_id: string): Promise<Prediction>;
       cancel(prediction_id: string): Promise<Prediction>;
       list(): Promise<Page<Prediction>>;

index.js

@@ -39,8 +39,7 @@ class Replicate {
    */
   constructor(options = {}) {
     this.auth = options.auth || process.env.REPLICATE_API_TOKEN;
-    this.userAgent =
-      options.userAgent || `replicate-javascript/${packageJSON.version}`;
+    this.userAgent = options.userAgent || `replicate-javascript/${packageJSON.version}`;
     this.baseUrl = options.baseUrl || 'https://api.replicate.com/v1';
     this.fetch = options.fetch || globalThis.fetch;
 
@@ -51,6 +50,7 @@ class Replicate {
 
     this.models = {
       get: models.get.bind(this),
+      list: models.list.bind(this),
       versions: {
         list: models.versions.list.bind(this),
         get: models.versions.get.bind(this),
@@ -74,7 +74,7 @@ class Replicate {
     this.deployments = {
       predictions: {
         create: deployments.predictions.create.bind(this),
-      }
+      },
     };
   }
 
@@ -103,15 +103,11 @@ class Replicate {
 
     // Define a pattern for "owner/name:version" format with named capturing groups.
     // Example: "user123/repo_a:1a2b3c"
-    const pattern = new RegExp(
-      `^(?<owner>${namePattern.source})/(?<name>${namePattern.source}):(?<version>[0-9a-fA-F]+)$`
-    );
+    const pattern = new RegExp(`^(?<owner>${namePattern.source})/(?<name>${namePattern.source}):(?<version>[0-9a-fA-F]+)$`);
 
     const match = identifier.match(pattern);
     if (!match || !match.groups) {
-      throw new Error(
-        'Invalid version. It must be in the format "owner/name:version"'
-      );
+      throw new Error('Invalid version. It must be in the format "owner/name:version"');
     }
 
     const { version } = match.groups;
@@ -173,17 +169,10 @@ class Replicate {
     if (route instanceof URL) {
       url = route;
     } else {
-      url = new URL(
-        route.startsWith('/') ? route.slice(1) : route,
-        baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`
-      );
+      url = new URL(route.startsWith('/') ? route.slice(1) : route, baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`);
     }
 
-    const {
-      method = 'GET',
-      params = {},
-      data,
-    } = options;
+    const { method = 'GET', params = {}, data } = options;
 
     Object.entries(params).forEach(([key, value]) => {
       url.searchParams.append(key, value);
@@ -207,19 +196,13 @@ class Replicate {
       body: data ? JSON.stringify(data) : undefined,
     };
 
-    const shouldRetry = method === 'GET' ?
-      (response) => (response.status === 429 || response.status >= 500) :
-      (response) => (response.status === 429);
+    const shouldRetry = method === 'GET' ? (response) => response.status === 429 || response.status >= 500 : (response) => response.status === 429;
     const response = await withAutomaticRetries(async () => this.fetch(url, init), { shouldRetry });
 
     if (!response.ok) {
       const request = new Request(url, init);
       const responseText = await response.text();
-      throw new ApiError(
-        `Request to ${url} failed with status ${response.status} ${response.statusText}: ${responseText}.`,
-        request,
-        response,
-      );
+      throw new ApiError(`Request to ${url} failed with status ${response.status} ${response.statusText}: ${responseText}.`, request, response);
     }
 
     return response;
@@ -236,7 +219,7 @@ class Replicate {
    * @param {Function} endpoint - Function that returns a promise for the next page of results
    * @yields {object[]} Each page of results
    */
-  async * paginate(endpoint) {
+  async *paginate(endpoint) {
     const response = await endpoint();
     yield response.results;
     if (response.next) {
@@ -267,11 +250,7 @@ class Replicate {
       throw new Error('Invalid prediction');
     }
 
-    if (
-      prediction.status === 'succeeded' ||
-      prediction.status === 'failed' ||
-      prediction.status === 'canceled'
-    ) {
+    if (prediction.status === 'succeeded' || prediction.status === 'failed' || prediction.status === 'canceled') {
       return prediction;
     }
 
@@ -282,13 +261,9 @@ class Replicate {
 
     let updatedPrediction = await this.predictions.get(id);
 
-    while (
-      updatedPrediction.status !== 'succeeded' &&
-      updatedPrediction.status !== 'failed' &&
-      updatedPrediction.status !== 'canceled'
-    ) {
+    while (updatedPrediction.status !== 'succeeded' && updatedPrediction.status !== 'failed' && updatedPrediction.status !== 'canceled') {
       /* eslint-disable no-await-in-loop */
-      if (stop && await stop(updatedPrediction) === true) {
+      if (stop && (await stop(updatedPrediction)) === true) {
         break;
       }