@nimble-way/nimble-js 0.6.0 → 0.8.0

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -19,6 +20,8 @@ import * as TopLevelAPI from './resources/top-level';
 import {
   ExtractAsyncParams,
   ExtractAsyncResponse,
+  ExtractBatchParams,
+  ExtractBatchResponse,
   ExtractParams,
   ExtractResponse,
   MapParams,
@@ -258,6 +261,23 @@ export class Nimble {
     return this.post('/v1/extract/async', { body, ...options });
   }
 
+  /**
+   * Extract Batch Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.extractBatch({
+   *   params: [{ url: 'url' }],
+   * });
+   * ```
+   */
+  extractBatch(
+    body: TopLevelAPI.ExtractBatchParams,
+    options?: RequestOptions,
+  ): APIPromise<TopLevelAPI.ExtractBatchResponse> {
+    return this.post('/v1/extract/batch', { body, ...options });
+  }
+
   /**
    * Create map task
    *
@@ -309,21 +329,8 @@ export class Nimble {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.NimbleError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -355,12 +362,13 @@ export class Nimble {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -665,9 +673,9 @@ export class Nimble {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -799,7 +807,7 @@ export class Nimble {
     ) {
       return {
         bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
-        body: this.stringifyQuery(body as Record<string, unknown>),
+        body: this.stringifyQuery(body),
       };
     } else {
       return this.#encoder({ body, headers });
@@ -840,10 +848,12 @@ export declare namespace Nimble {
   export {
     type ExtractResponse as ExtractResponse,
     type ExtractAsyncResponse as ExtractAsyncResponse,
+    type ExtractBatchResponse as ExtractBatchResponse,
     type MapResponse as MapResponse,
     type SearchResponse as SearchResponse,
     type ExtractParams as ExtractParams,
     type ExtractAsyncParams as ExtractAsyncParams,
+    type ExtractBatchParams as ExtractBatchParams,
     type MapParams as MapParams,
     type SearchParams as SearchParams,
   };

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { NimbleError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new NimbleError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/agent.ts

@@ -79,7 +79,7 @@ export interface AgentGetResponse {
 
   managed_by?: string | null;
 
-  output_schema?: { [key: string]: unknown } | null;
+  output_schema?: unknown | null;
 
   vertical?: string | null;
 }
@@ -479,9 +479,9 @@ export interface AgentListParams {
   limit?: number;
 
   /**
-   * Filter public templates by attribution
+   * Filter templates by attribution
    */
-  managed_by?: 'nimble' | 'community' | null;
+  managed_by?: 'nimble' | 'community' | 'self_managed' | null;
 
   /**
    * Pagination offset
@@ -491,7 +491,12 @@ export interface AgentListParams {
   /**
    * Filter by privacy level
    */
-  privacy?: 'public' | 'private' | 'all';
+  privacy?: 'public' | 'private' | 'all' | null;
+
+  /**
+   * Search templates by name, domain, or vertical
+   */
+  search?: string | null;
 }
 
 export interface AgentRunParams {

package/src/resources/index.ts

@@ -30,10 +30,12 @@ export {
 export {
   type ExtractResponse,
   type ExtractAsyncResponse,
+  type ExtractBatchResponse,
   type MapResponse,
   type SearchResponse,
   type ExtractParams,
   type ExtractAsyncParams,
+  type ExtractBatchParams,
   type MapParams,
   type SearchParams,
 } from './top-level';

package/src/resources/tasks.ts

@@ -77,7 +77,7 @@ export namespace TaskListResponse {
      */
     account_name?: string;
 
-    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'agent' | 'extract';
+    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract';
 
     /**
      * Batch ID if this task is part of a batch.
@@ -174,7 +174,7 @@ export namespace TaskGetResponse {
      */
     account_name?: string;
 
-    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'agent' | 'extract';
+    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract';
 
     /**
      * Batch ID if this task is part of a batch.