@nimble-way/nimble-js 0.12.0 → 0.13.0

package/src/internal/types.ts

@@ -40,7 +40,6 @@ type OverloadedParameters<T> =
   : T extends (...args: infer A) => unknown ? A
   : never;
 
-/* eslint-disable */
 /**
  * These imports attempt to get types from a parent package's dependencies.
  * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
@@ -63,19 +62,18 @@ type OverloadedParameters<T> =
  *
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
  */
-/** @ts-ignore For users with \@types/node */
+/** @ts-ignore For users with \@types/node */ /* prettier-ignore */
 type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
-/** @ts-ignore For users with undici */
+/** @ts-ignore For users with undici */ /* prettier-ignore */
 type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
-/** @ts-ignore For users with \@types/bun */
+/** @ts-ignore For users with \@types/bun */ /* prettier-ignore */
 type BunRequestInit = globalThis.FetchRequestInit;
-/** @ts-ignore For users with node-fetch@2 */
+/** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */
 type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
-/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
+/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */
 type NodeFetch3RequestInit =  NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
-/** @ts-ignore For users who use Deno */
+/** @ts-ignore For users who use Deno */ /* prettier-ignore */
 type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
-/* eslint-enable */
 
 type RequestInits =
   | NotAny<UndiciTypesRequestInit>

package/src/internal/utils/env.ts

@@ -9,10 +9,10 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return (globalThis as any).process.env?.[env]?.trim() || undefined;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/resources/agent.ts

@@ -8,6 +8,11 @@ import { path } from '../internal/utils/path';
 export class Agent extends APIResource {
   /**
    * List Agent Templates
+   *
+   * @example
+   * ```ts
+   * const agents = await client.agent.list();
+   * ```
    */
   list(
     query: AgentListParams | null | undefined = {},
@@ -18,6 +23,14 @@ export class Agent extends APIResource {
 
   /**
    * Create Agent Generation
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.generate({
+   *   prompt: 'prompt',
+   *   url: 'url',
+   * });
+   * ```
    */
   generate(body: AgentGenerateParams, options?: RequestOptions): APIPromise<AgentGenerateResponse> {
     return this._client.post('/v1/agents/generations', { body, ...options });
@@ -25,6 +38,11 @@ export class Agent extends APIResource {
 
   /**
    * Get Agent Template
+   *
+   * @example
+   * ```ts
+   * const agent = await client.agent.get('template_name');
+   * ```
    */
   get(templateName: string, options?: RequestOptions): APIPromise<AgentGetResponse> {
     return this._client.get(path`/v1/agents/${templateName}`, options);
@@ -32,6 +50,13 @@ export class Agent extends APIResource {
 
   /**
    * Get Agent Generation
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.getGeneration(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   getGeneration(generationID: string, options?: RequestOptions): APIPromise<AgentGetGenerationResponse> {
     return this._client.get(path`/v1/agents/generations/${generationID}`, options);
@@ -39,6 +64,8 @@ export class Agent extends APIResource {
 
   /**
    * Publish Agent Version
+   *
+   * @deprecated
    */
   publish(
     agentName: string,
@@ -50,6 +77,14 @@ export class Agent extends APIResource {
 
   /**
    * Execute WSA Realtime Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.run({
+   *   agent: 'agent',
+   *   params: { foo: 'bar' },
+   * });
+   * ```
    */
   run(body: AgentRunParams, options?: RequestOptions): APIPromise<AgentRunResponse> {
     return this._client.post('/v1/agents/run', { body, ...options });
@@ -57,6 +92,14 @@ export class Agent extends APIResource {
 
   /**
    * Execute WSA Async Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.runAsync({
+   *   agent: 'agent',
+   *   params: { foo: 'bar' },
+   * });
+   * ```
    */
   runAsync(body: AgentRunAsyncParams, options?: RequestOptions): APIPromise<AgentRunAsyncResponse> {
     return this._client.post('/v1/agents/async', { body, ...options });
@@ -64,6 +107,14 @@ export class Agent extends APIResource {
 
   /**
    * Execute WSA Batch Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.runBatch({
+   *   inputs: [{}],
+   *   shared_inputs: { agent: 'agent' },
+   * });
+   * ```
    */
   runBatch(body: AgentRunBatchParams, options?: RequestOptions): APIPromise<AgentRunBatchResponse> {
     return this._client.post('/v1/agents/batch', { body, ...options });
@@ -105,7 +156,7 @@ export interface AgentGenerateResponse {
 
   error?: string | null;
 
-  generated_version?: unknown | null;
+  generated_version?: AgentGenerateResponse.GeneratedVersion | null;
 
   generated_version_id?: string | null;
 
@@ -116,6 +167,46 @@ export interface AgentGenerateResponse {
   summary?: string | null;
 }
 
+export namespace AgentGenerateResponse {
+  export interface GeneratedVersion {
+    id: string;
+
+    agent_name: string;
+
+    created_at: string;
+
+    input_schema: unknown;
+
+    metadata: GeneratedVersion.Metadata;
+
+    output_schema: unknown;
+
+    steps: Array<unknown>;
+
+    version_number: number;
+
+    output_sample_data?: unknown;
+  }
+
+  export namespace GeneratedVersion {
+    export interface Metadata {
+      data_source?: string | null;
+
+      description?: string | null;
+
+      display_name?: string | null;
+
+      domain?: string | null;
+
+      entity_type?: string | null;
+
+      tags?: Array<string>;
+
+      vertical?: string | null;
+    }
+  }
+}
+
 export interface AgentGetResponse {
   display_name: string;
 
@@ -148,14 +239,16 @@ export namespace AgentGetResponse {
   }
 
   export interface InputProperty {
-    default?: string | null;
+    default?: string | boolean | number | null;
 
     description?: string | null;
 
-    examples?: Array<string> | null;
+    examples?: Array<unknown> | null;
 
     is_localization_param?: boolean;
 
+    is_pagination_param?: boolean;
+
     name?: string;
 
     required?: boolean;
@@ -179,7 +272,7 @@ export interface AgentGetGenerationResponse {
 
   error?: string | null;
 
-  generated_version?: unknown | null;
+  generated_version?: AgentGetGenerationResponse.GeneratedVersion | null;
 
   generated_version_id?: string | null;
 
@@ -190,6 +283,46 @@ export interface AgentGetGenerationResponse {
   summary?: string | null;
 }
 
+export namespace AgentGetGenerationResponse {
+  export interface GeneratedVersion {
+    id: string;
+
+    agent_name: string;
+
+    created_at: string;
+
+    input_schema: unknown;
+
+    metadata: GeneratedVersion.Metadata;
+
+    output_schema: unknown;
+
+    steps: Array<unknown>;
+
+    version_number: number;
+
+    output_sample_data?: unknown;
+  }
+
+  export namespace GeneratedVersion {
+    export interface Metadata {
+      data_source?: string | null;
+
+      description?: string | null;
+
+      display_name?: string | null;
+
+      domain?: string | null;
+
+      entity_type?: string | null;
+
+      tags?: Array<string>;
+
+      vertical?: string | null;
+    }
+  }
+}
+
 export interface AgentPublishResponse {
   agent_name: string;
 
@@ -267,6 +400,11 @@ export namespace AgentRunResponse {
      */
     html?: string;
 
+    /**
+     * List of all unique URLs found on the page.
+     */
+    links?: Array<string>;
+
     /**
      * The Markdown version of the HTML content.
      */
@@ -689,19 +827,29 @@ export type AgentGenerateParams =
 
 export declare namespace AgentGenerateParams {
   export interface CreateAgentGenerationRequest {
-    agent_name: string;
-
     prompt: string;
 
     url: string;
 
+    agent_name?: string | null;
+
     input_schema?: unknown;
 
-    metadata?: unknown | null;
+    metadata?: CreateAgentGenerationRequest.Metadata | null;
 
     output_schema?: unknown;
   }
 
+  export namespace CreateAgentGenerationRequest {
+    export interface Metadata {
+      description?: string | null;
+
+      display_name?: string | null;
+
+      tags?: Array<string>;
+    }
+  }
+
   export interface CreateAgentRefinementRequest {
     from_agent: string;
 
@@ -721,7 +869,7 @@ export interface AgentRunParams {
   /**
    * Response formats to include. All disabled by default.
    */
-  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
   localization?: boolean;
 }
@@ -739,7 +887,7 @@ export interface AgentRunAsyncParams {
   /**
    * Response formats to include. All disabled by default.
    */
-  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
   localization?: boolean;
 
@@ -775,7 +923,7 @@ export namespace AgentRunBatchParams {
     /**
      * Response formats to include. All disabled by default.
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     localization?: boolean;
 
@@ -788,7 +936,7 @@ export namespace AgentRunBatchParams {
     /**
      * Response formats to include. All disabled by default.
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     localization?: boolean;
 

package/src/resources/crawl.ts

@@ -9,6 +9,11 @@ import { path } from '../internal/utils/path';
 export class Crawl extends APIResource {
   /**
    * Crawl by Filter
+   *
+   * @example
+   * ```ts
+   * const crawls = await client.crawl.list();
+   * ```
    */
   list(
     query: CrawlListParams | null | undefined = {},
@@ -19,6 +24,11 @@ export class Crawl extends APIResource {
 
   /**
    * Create crawl task
+   *
+   * @example
+   * ```ts
+   * const response = await client.crawl.run({ url: 'url' });
+   * ```
    */
   run(body: CrawlRunParams, options?: RequestOptions): APIPromise<CrawlRunResponse> {
     return this._client.post('/v1/crawl', { body, ...options });
@@ -26,6 +36,13 @@ export class Crawl extends APIResource {
 
   /**
    * Get crawl data
+   *
+   * @example
+   * ```ts
+   * const response = await client.crawl.status(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
    */
   status(id: string, options?: RequestOptions): APIPromise<CrawlStatusResponse> {
     return this._client.get(path`/v1/crawl/${id}`, options);
@@ -33,6 +50,13 @@ export class Crawl extends APIResource {
 
   /**
    * Cancel Crawl
+   *
+   * @example
+   * ```ts
+   * const response = await client.crawl.terminate(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
    */
   terminate(id: string, options?: RequestOptions): APIPromise<CrawlTerminateResponse> {
     return this._client.delete(path`/v1/crawl/${id}`, options);
@@ -708,7 +732,7 @@ export namespace CrawlRunParams {
     /**
      * Browser driver to use
      */
-    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
 
     /**
      * Expected HTTP status codes for successful requests
@@ -718,7 +742,7 @@ export namespace CrawlRunParams {
     /**
      * List of acceptable response formats in order of preference
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     /**
      * Custom HTTP headers to include in the request
@@ -1273,6 +1297,13 @@ export namespace CrawlRunParams {
       | 'zu-ZA'
       | 'auto';
 
+    /**
+     * Selects which markdown conversion strategy to use. "full_page" converts the
+     * entire HTML page. "main_content" uses Mozilla Readability to extract the main
+     * article content before converting.
+     */
+    markdown_backend?: 'full_page' | 'main_content';
+
     /**
      * HTTP method for the request
      */

package/src/resources/top-level.ts

@@ -73,6 +73,11 @@ export namespace ExtractResponse {
      */
     html?: string;
 
+    /**
+     * List of all unique URLs found on the page.
+     */
+    links?: Array<string>;
+
     /**
      * The Markdown version of the HTML content.
      */
@@ -981,7 +986,7 @@ export interface ExtractParams {
   /**
    * Browser driver to use
    */
-  driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+  driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
 
   /**
    * Expected HTTP status codes for successful requests
@@ -991,7 +996,7 @@ export interface ExtractParams {
   /**
    * List of acceptable response formats in order of preference
    */
-  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
   /**
    * Custom HTTP headers to include in the request
@@ -1546,6 +1551,13 @@ export interface ExtractParams {
     | 'zu-ZA'
     | 'auto';
 
+  /**
+   * Selects which markdown conversion strategy to use. "full_page" converts the
+   * entire HTML page. "main_content" uses Mozilla Readability to extract the main
+   * article content before converting.
+   */
+  markdown_backend?: 'full_page' | 'main_content';
+
   /**
    * HTTP method for the request
    */
@@ -2062,7 +2074,7 @@ export interface ExtractAsyncParams {
   /**
    * Browser driver to use
    */
-  driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+  driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
 
   /**
    * Expected HTTP status codes for successful requests
@@ -2072,7 +2084,7 @@ export interface ExtractAsyncParams {
   /**
    * List of acceptable response formats in order of preference
    */
-  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
   /**
    * Custom HTTP headers to include in the request
@@ -2627,6 +2639,13 @@ export interface ExtractAsyncParams {
     | 'zu-ZA'
     | 'auto';
 
+  /**
+   * Selects which markdown conversion strategy to use. "full_page" converts the
+   * entire HTML page. "main_content" uses Mozilla Readability to extract the main
+   * article content before converting.
+   */
+  markdown_backend?: 'full_page' | 'main_content';
+
   /**
    * HTTP method for the request
    */
@@ -3173,7 +3192,7 @@ export namespace ExtractBatchParams {
     /**
      * Browser driver to use
      */
-    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
 
     /**
      * Expected HTTP status codes for successful requests
@@ -3183,7 +3202,7 @@ export namespace ExtractBatchParams {
     /**
      * List of acceptable response formats in order of preference
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     /**
      * Custom HTTP headers to include in the request
@@ -3738,6 +3757,13 @@ export namespace ExtractBatchParams {
       | 'zu-ZA'
       | 'auto';
 
+    /**
+     * Selects which markdown conversion strategy to use. "full_page" converts the
+     * entire HTML page. "main_content" uses Mozilla Readability to extract the main
+     * article content before converting.
+     */
+    markdown_backend?: 'full_page' | 'main_content';
+
     /**
      * HTTP method for the request
      */
@@ -4278,7 +4304,7 @@ export namespace ExtractBatchParams {
     /**
      * Browser driver to use
      */
-    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
 
     /**
      * Expected HTTP status codes for successful requests
@@ -4288,7 +4314,7 @@ export namespace ExtractBatchParams {
     /**
      * List of acceptable response formats in order of preference
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     /**
      * Custom HTTP headers to include in the request
@@ -4843,6 +4869,13 @@ export namespace ExtractBatchParams {
       | 'zu-ZA'
       | 'auto';
 
+    /**
+     * Selects which markdown conversion strategy to use. "full_page" converts the
+     * entire HTML page. "main_content" uses Mozilla Readability to extract the main
+     * article content before converting.
+     */
+    markdown_backend?: 'full_page' | 'main_content';
+
     /**
      * HTTP method for the request
      */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.12.0'; // x-release-please-version
+export const VERSION = '0.13.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.12.0";
+export declare const VERSION = "0.13.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.12.0";
+export declare const VERSION = "0.13.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.12.0'; // x-release-please-version
+exports.VERSION = '0.13.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.12.0'; // x-release-please-version
+export const VERSION = '0.13.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map