@onlist/sdk 0.1.0 → 0.2.0

package/dist/index.d.cts

@@ -1,21 +1,25 @@
 import OpenAI, { ClientOptions } from 'openai';
 
+/** Model pricing in USD per million tokens. */
 interface Pricing {
     prompt: string;
     completion: string;
     request?: string | null;
 }
+/** Model architecture metadata. */
 interface Architecture {
     modality?: string | null;
     input_modalities?: string[] | null;
     output_modalities?: string[] | null;
     tokenizer?: string | null;
 }
+/** Top-provider context limits for a model. */
 interface TopProvider {
     context_length?: number | null;
     max_completion_tokens?: number | null;
     is_moderated?: boolean | null;
 }
+/** A model listed in the marketplace catalog. */
 interface Model {
     id: string;
     name?: string | null;
@@ -32,8 +36,8 @@ interface Model {
     quantization?: string | null;
     top_provider?: TopProvider | null;
     is_ready?: boolean | null;
-    [key: string]: unknown;
 }
+/** A provider's offer for a specific model. */
 interface ProviderOffer {
     listing_id?: number | null;
     provider_id?: number | null;
@@ -44,8 +48,8 @@ interface ProviderOffer {
     price_input_usd?: string | null;
     price_output_usd?: string | null;
     availability_7d?: number | null;
-    [key: string]: unknown;
 }
+/** Detailed model info including all provider offers. */
 interface ModelDetail {
     id: string;
     name?: string | null;
@@ -57,8 +61,8 @@ interface ModelDetail {
     pricing?: Pricing | null;
     description?: string | null;
     providers: ProviderOffer[];
-    [key: string]: unknown;
 }
+/** Paginated list of models. */
 interface ModelListResponse {
     data: Model[];
     total?: number | null;
@@ -66,6 +70,7 @@ interface ModelListResponse {
     limit?: number | null;
 }
 
+/** A provider (seller) on the marketplace. */
 interface Provider {
     id?: number | null;
     slug: string;
@@ -79,59 +84,159 @@ interface Provider {
     sample_count?: number | null;
     max_rpm?: number | null;
     availability_7d?: number | null;
-    [key: string]: unknown;
 }
+/** Detailed provider info including their listings. */
 interface ProviderDetail extends Provider {
     listings: Record<string, unknown>[];
 }
+/** Paginated list of providers. */
 interface ProviderListResponse {
     items: Provider[];
 }
 
+/** A single entry in the model usage leaderboard. */
+interface ModelRanking {
+    rank: number;
+    model_name: string;
+    author: string;
+    author_icon: string | null;
+    total_tokens: string;
+    total_requests: number;
+    growth_pct: number | null;
+}
+/** A single data point in the model usage chart series. */
+interface ModelSeriesPoint {
+    bucket: string;
+    value: number;
+    type: string;
+}
+/** Response from GET /api/mkt/rankings/models. */
+interface ModelRankingsResponse {
+    leaderboard: ModelRanking[];
+    series: ModelSeriesPoint[];
+    top_models: string[];
+    sort: string;
+    window: string;
+    start_date: string;
+    end_date: string;
+}
+/** Query parameters for the model rankings endpoint. */
+interface ModelRankingsParams {
+    sort?: "popular" | "trending";
+    window?: "day" | "week" | "month";
+    limit?: number;
+    offset?: number;
+}
+/** A single entry in the app rankings list. */
+interface AppRanking {
+    app_id: number;
+    url_key: string;
+    slug: string | null;
+    title: string;
+    description: string | null;
+    domain: string;
+    icon_url: string | null;
+    categories: string[];
+    rank: number;
+    total_requests: number;
+    total_tokens: string;
+    growth_pct: number | null;
+}
+/** Response from GET /api/mkt/apps. */
+interface AppRankingsResponse {
+    apps: AppRanking[];
+    page: number;
+    limit: number;
+    has_more: boolean;
+    sort: string;
+    window: string;
+    start_date: string;
+    end_date: string;
+}
+/** Query parameters for the app rankings endpoint. */
+interface AppRankingsParams {
+    sort?: "popular" | "trending";
+    window?: "day" | "week" | "month";
+    category?: string;
+    subcategory?: string;
+    page?: number;
+    limit?: number;
+}
+
+/** Options for creating a Marketplace client. */
 interface MarketplaceOptions {
     apiKey?: string | null;
     baseURL: string;
     timeout?: number;
+    /** Maximum retry attempts for failed requests. Defaults to 2. */
+    maxRetries?: number;
 }
+/** Access to marketplace model data. */
 declare class MarketplaceModels {
     private readonly _opts;
     constructor(_opts: MarketplaceOptions);
+    /** List models in the marketplace catalog. */
     list(params?: {
         limit?: number;
         offset?: number;
         q?: string;
     }): Promise<ModelListResponse>;
+    /** Get detailed info for a specific model, including provider offers. */
     get(modelId: string): Promise<ModelDetail>;
-    private _fetch;
 }
+/** Access to marketplace provider data. */
 declare class MarketplaceProviders {
     private readonly _opts;
     constructor(_opts: MarketplaceOptions);
+    /** List providers on the marketplace. */
     list(params?: {
         sort?: string;
         q?: string;
     }): Promise<ProviderListResponse>;
+    /** Get detailed info for a specific provider. */
     get(slug: string): Promise<ProviderDetail>;
-    private _fetch;
 }
+/** Access to marketplace rankings (models and apps). */
+declare class MarketplaceRankings {
+    private readonly _opts;
+    constructor(_opts: MarketplaceOptions);
+    /** Get the model usage leaderboard and chart series. */
+    models(params?: ModelRankingsParams): Promise<ModelRankingsResponse>;
+    /** Get the app rankings list. */
+    apps(params?: AppRankingsParams): Promise<AppRankingsResponse>;
+}
+/** Client for the Onlist marketplace public API. */
 declare class Marketplace {
+    /** Browse and search models. */
     readonly models: MarketplaceModels;
+    /** Browse and search providers. */
     readonly providers: MarketplaceProviders;
+    /** Model and app usage rankings. */
+    readonly rankings: MarketplaceRankings;
     constructor(opts: MarketplaceOptions);
 }
 
+/** Options for creating an Onlist client. */
 interface OnlistOptions extends Omit<ClientOptions, "apiKey" | "baseURL"> {
+    /** API key. Falls back to ONLIST_API_KEY then OPENAI_API_KEY env vars. */
     apiKey?: string | null;
+    /** Base URL for the API. Defaults to https://onlist.io/v1. */
     baseURL?: string | null;
+    /** Maximum retry attempts for marketplace API calls. Defaults to 2. */
+    maxRetries?: number;
 }
+/** Onlist API client, extending the OpenAI SDK with marketplace features. */
 declare class Onlist extends OpenAI {
+    /** Access to marketplace data: models, providers, and rankings. */
     readonly marketplace: Marketplace;
     constructor(opts?: OnlistOptions);
 }
 
+/** Base error class for all Onlist SDK errors. */
 declare class OnlistError extends Error {
     constructor(message: string);
 }
+/** Error thrown when an API request fails. */
 declare class APIError extends OnlistError {
     readonly status: number;
     readonly type: string | null;
@@ -146,23 +251,33 @@ declare class APIError extends OnlistError {
         body?: unknown;
     });
 }
+/** Error thrown when the API key is invalid or missing. */
 declare class AuthenticationError extends APIError {
     constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
 }
+/** Error thrown when the account balance is insufficient. */
 declare class InsufficientBalanceError extends APIError {
     constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
 }
+/** Error thrown when the request is rate-limited. */
 declare class RateLimitError extends APIError {
     constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
 }
+/** Error thrown when no matching provider is available. */
 declare class ProviderError extends APIError {
     constructor(message: string, opts: ConstructorParameters<typeof APIError>[1]);
 }
+/** Error thrown when a requested resource is not found. */
+declare class NotFoundError extends APIError {
+    constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
+}
 
+/** Maximum price limits per token type (USD per million tokens). */
 interface MaxPrice {
     prompt?: number;
     completion?: number;
 }
+/** Provider routing configuration for the Onlist marketplace. */
 interface ProviderRouting {
     only?: string[];
     sort?: "price" | "throughput";
@@ -173,6 +288,13 @@ interface ProviderRouting {
     max_price?: MaxPrice;
 }
 
-declare const VERSION = "0.1.0";
+declare module "openai/resources/chat/completions/completions" {
+    interface ChatCompletionCreateParamsBase {
+        /** Onlist provider routing configuration. */
+        provider?: ProviderRouting;
+    }
+}
+
+declare const VERSION = "0.2.0";
 
-export { APIError, type Architecture, AuthenticationError, InsufficientBalanceError, Marketplace, MarketplaceModels, type MarketplaceOptions, MarketplaceProviders, type MaxPrice, type Model, type ModelDetail, type ModelListResponse, Onlist, OnlistError, type OnlistOptions, type Pricing, type Provider, type ProviderDetail, ProviderError, type ProviderListResponse, type ProviderOffer, type ProviderRouting, RateLimitError, type TopProvider, VERSION };
+export { APIError, type AppRanking, type AppRankingsParams, type AppRankingsResponse, type Architecture, AuthenticationError, InsufficientBalanceError, Marketplace, MarketplaceModels, type MarketplaceOptions, MarketplaceProviders, MarketplaceRankings, type MaxPrice, type Model, type ModelDetail, type ModelListResponse, type ModelRanking, type ModelRankingsParams, type ModelRankingsResponse, type ModelSeriesPoint, NotFoundError, Onlist, OnlistError, type OnlistOptions, type Pricing, type Provider, type ProviderDetail, ProviderError, type ProviderListResponse, type ProviderOffer, type ProviderRouting, RateLimitError, type TopProvider, VERSION };

package/dist/index.d.ts

@@ -1,21 +1,25 @@
 import OpenAI, { ClientOptions } from 'openai';
 
+/** Model pricing in USD per million tokens. */
 interface Pricing {
     prompt: string;
     completion: string;
     request?: string | null;
 }
+/** Model architecture metadata. */
 interface Architecture {
     modality?: string | null;
     input_modalities?: string[] | null;
     output_modalities?: string[] | null;
     tokenizer?: string | null;
 }
+/** Top-provider context limits for a model. */
 interface TopProvider {
     context_length?: number | null;
     max_completion_tokens?: number | null;
     is_moderated?: boolean | null;
 }
+/** A model listed in the marketplace catalog. */
 interface Model {
     id: string;
     name?: string | null;
@@ -32,8 +36,8 @@ interface Model {
     quantization?: string | null;
     top_provider?: TopProvider | null;
     is_ready?: boolean | null;
-    [key: string]: unknown;
 }
+/** A provider's offer for a specific model. */
 interface ProviderOffer {
     listing_id?: number | null;
     provider_id?: number | null;
@@ -44,8 +48,8 @@ interface ProviderOffer {
     price_input_usd?: string | null;
     price_output_usd?: string | null;
     availability_7d?: number | null;
-    [key: string]: unknown;
 }
+/** Detailed model info including all provider offers. */
 interface ModelDetail {
     id: string;
     name?: string | null;
@@ -57,8 +61,8 @@ interface ModelDetail {
     pricing?: Pricing | null;
     description?: string | null;
     providers: ProviderOffer[];
-    [key: string]: unknown;
 }
+/** Paginated list of models. */
 interface ModelListResponse {
     data: Model[];
     total?: number | null;
@@ -66,6 +70,7 @@ interface ModelListResponse {
     limit?: number | null;
 }
 
+/** A provider (seller) on the marketplace. */
 interface Provider {
     id?: number | null;
     slug: string;
@@ -79,59 +84,159 @@ interface Provider {
     sample_count?: number | null;
     max_rpm?: number | null;
     availability_7d?: number | null;
-    [key: string]: unknown;
 }
+/** Detailed provider info including their listings. */
 interface ProviderDetail extends Provider {
     listings: Record<string, unknown>[];
 }
+/** Paginated list of providers. */
 interface ProviderListResponse {
     items: Provider[];
 }
 
+/** A single entry in the model usage leaderboard. */
+interface ModelRanking {
+    rank: number;
+    model_name: string;
+    author: string;
+    author_icon: string | null;
+    total_tokens: string;
+    total_requests: number;
+    growth_pct: number | null;
+}
+/** A single data point in the model usage chart series. */
+interface ModelSeriesPoint {
+    bucket: string;
+    value: number;
+    type: string;
+}
+/** Response from GET /api/mkt/rankings/models. */
+interface ModelRankingsResponse {
+    leaderboard: ModelRanking[];
+    series: ModelSeriesPoint[];
+    top_models: string[];
+    sort: string;
+    window: string;
+    start_date: string;
+    end_date: string;
+}
+/** Query parameters for the model rankings endpoint. */
+interface ModelRankingsParams {
+    sort?: "popular" | "trending";
+    window?: "day" | "week" | "month";
+    limit?: number;
+    offset?: number;
+}
+/** A single entry in the app rankings list. */
+interface AppRanking {
+    app_id: number;
+    url_key: string;
+    slug: string | null;
+    title: string;
+    description: string | null;
+    domain: string;
+    icon_url: string | null;
+    categories: string[];
+    rank: number;
+    total_requests: number;
+    total_tokens: string;
+    growth_pct: number | null;
+}
+/** Response from GET /api/mkt/apps. */
+interface AppRankingsResponse {
+    apps: AppRanking[];
+    page: number;
+    limit: number;
+    has_more: boolean;
+    sort: string;
+    window: string;
+    start_date: string;
+    end_date: string;
+}
+/** Query parameters for the app rankings endpoint. */
+interface AppRankingsParams {
+    sort?: "popular" | "trending";
+    window?: "day" | "week" | "month";
+    category?: string;
+    subcategory?: string;
+    page?: number;
+    limit?: number;
+}
+
+/** Options for creating a Marketplace client. */
 interface MarketplaceOptions {
     apiKey?: string | null;
     baseURL: string;
     timeout?: number;
+    /** Maximum retry attempts for failed requests. Defaults to 2. */
+    maxRetries?: number;
 }
+/** Access to marketplace model data. */
 declare class MarketplaceModels {
     private readonly _opts;
     constructor(_opts: MarketplaceOptions);
+    /** List models in the marketplace catalog. */
     list(params?: {
         limit?: number;
         offset?: number;
         q?: string;
     }): Promise<ModelListResponse>;
+    /** Get detailed info for a specific model, including provider offers. */
     get(modelId: string): Promise<ModelDetail>;
-    private _fetch;
 }
+/** Access to marketplace provider data. */
 declare class MarketplaceProviders {
     private readonly _opts;
     constructor(_opts: MarketplaceOptions);
+    /** List providers on the marketplace. */
     list(params?: {
         sort?: string;
         q?: string;
     }): Promise<ProviderListResponse>;
+    /** Get detailed info for a specific provider. */
     get(slug: string): Promise<ProviderDetail>;
-    private _fetch;
 }
+/** Access to marketplace rankings (models and apps). */
+declare class MarketplaceRankings {
+    private readonly _opts;
+    constructor(_opts: MarketplaceOptions);
+    /** Get the model usage leaderboard and chart series. */
+    models(params?: ModelRankingsParams): Promise<ModelRankingsResponse>;
+    /** Get the app rankings list. */
+    apps(params?: AppRankingsParams): Promise<AppRankingsResponse>;
+}
+/** Client for the Onlist marketplace public API. */
 declare class Marketplace {
+    /** Browse and search models. */
     readonly models: MarketplaceModels;
+    /** Browse and search providers. */
     readonly providers: MarketplaceProviders;
+    /** Model and app usage rankings. */
+    readonly rankings: MarketplaceRankings;
     constructor(opts: MarketplaceOptions);
 }
 
+/** Options for creating an Onlist client. */
 interface OnlistOptions extends Omit<ClientOptions, "apiKey" | "baseURL"> {
+    /** API key. Falls back to ONLIST_API_KEY then OPENAI_API_KEY env vars. */
     apiKey?: string | null;
+    /** Base URL for the API. Defaults to https://onlist.io/v1. */
     baseURL?: string | null;
+    /** Maximum retry attempts for marketplace API calls. Defaults to 2. */
+    maxRetries?: number;
 }
+/** Onlist API client, extending the OpenAI SDK with marketplace features. */
 declare class Onlist extends OpenAI {
+    /** Access to marketplace data: models, providers, and rankings. */
     readonly marketplace: Marketplace;
     constructor(opts?: OnlistOptions);
 }
 
+/** Base error class for all Onlist SDK errors. */
 declare class OnlistError extends Error {
     constructor(message: string);
 }
+/** Error thrown when an API request fails. */
 declare class APIError extends OnlistError {
     readonly status: number;
     readonly type: string | null;
@@ -146,23 +251,33 @@ declare class APIError extends OnlistError {
         body?: unknown;
     });
 }
+/** Error thrown when the API key is invalid or missing. */
 declare class AuthenticationError extends APIError {
     constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
 }
+/** Error thrown when the account balance is insufficient. */
 declare class InsufficientBalanceError extends APIError {
     constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
 }
+/** Error thrown when the request is rate-limited. */
 declare class RateLimitError extends APIError {
     constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
 }
+/** Error thrown when no matching provider is available. */
 declare class ProviderError extends APIError {
     constructor(message: string, opts: ConstructorParameters<typeof APIError>[1]);
 }
+/** Error thrown when a requested resource is not found. */
+declare class NotFoundError extends APIError {
+    constructor(message?: string, opts?: Partial<ConstructorParameters<typeof APIError>[1]>);
+}
 
+/** Maximum price limits per token type (USD per million tokens). */
 interface MaxPrice {
     prompt?: number;
     completion?: number;
 }
+/** Provider routing configuration for the Onlist marketplace. */
 interface ProviderRouting {
     only?: string[];
     sort?: "price" | "throughput";
@@ -173,6 +288,13 @@ interface ProviderRouting {
     max_price?: MaxPrice;
 }
 
-declare const VERSION = "0.1.0";
+declare module "openai/resources/chat/completions/completions" {
+    interface ChatCompletionCreateParamsBase {
+        /** Onlist provider routing configuration. */
+        provider?: ProviderRouting;
+    }
+}
+
+declare const VERSION = "0.2.0";
 
-export { APIError, type Architecture, AuthenticationError, InsufficientBalanceError, Marketplace, MarketplaceModels, type MarketplaceOptions, MarketplaceProviders, type MaxPrice, type Model, type ModelDetail, type ModelListResponse, Onlist, OnlistError, type OnlistOptions, type Pricing, type Provider, type ProviderDetail, ProviderError, type ProviderListResponse, type ProviderOffer, type ProviderRouting, RateLimitError, type TopProvider, VERSION };
+export { APIError, type AppRanking, type AppRankingsParams, type AppRankingsResponse, type Architecture, AuthenticationError, InsufficientBalanceError, Marketplace, MarketplaceModels, type MarketplaceOptions, MarketplaceProviders, MarketplaceRankings, type MaxPrice, type Model, type ModelDetail, type ModelListResponse, type ModelRanking, type ModelRankingsParams, type ModelRankingsResponse, type ModelSeriesPoint, NotFoundError, Onlist, OnlistError, type OnlistOptions, type Pricing, type Provider, type ProviderDetail, ProviderError, type ProviderListResponse, type ProviderOffer, type ProviderRouting, RateLimitError, type TopProvider, VERSION };