@getanyapi/sdk 0.35.3 → 0.36.0

package/dist/index.d.cts

@@ -259,8 +259,13 @@ interface CatalogEntry {
     /** Detail-only successful end-to-end latency. Null when no sample is available. */
     latency?: DiscoveryLatency | null;
 }
+/**
+ * Ranked catalog search accepts any non-empty combination of query, category and
+ * platform, so a scope with no query at all ("every reddit API") is expressible.
+ * At least one of the three is required; see `AnyAPI.search`.
+ */
 interface SearchOptions {
-    query: string;
+    query?: string;
     category?: string;
     platform?: string;
     limit?: number;
@@ -369,7 +374,13 @@ declare class AnyAPI$1 implements ClientCore {
     me(): Promise<AccountProfile>;
     /** Browse catalog SKUs, optionally scoped by category. GET /v1/apis. */
     catalog(options?: CatalogOptions): Promise<CatalogEntry[]>;
-    /** Ranked catalog search. GET /catalog/search. Browse never accepts a query. */
+    /**
+     * Ranked catalog search. GET /catalog/search. Browse never accepts a query.
+     *
+     * The gateway needs at least one of query, category or platform, in any
+     * combination, so a scope with no query at all is a valid search. An absent or
+     * empty query omits `q` entirely, because an empty `q` is a different request.
+     */
     search(options: SearchOptions): Promise<CatalogSearchResults>;
     /** Describe a single SKU by slug. GET /v1/apis/{slug}. 404 -> NotFoundError. See SPEC 2.7. */
     describe(slug: string): Promise<CatalogEntry>;

package/dist/index.d.ts

@@ -259,8 +259,13 @@ interface CatalogEntry {
     /** Detail-only successful end-to-end latency. Null when no sample is available. */
     latency?: DiscoveryLatency | null;
 }
+/**
+ * Ranked catalog search accepts any non-empty combination of query, category and
+ * platform, so a scope with no query at all ("every reddit API") is expressible.
+ * At least one of the three is required; see `AnyAPI.search`.
+ */
 interface SearchOptions {
-    query: string;
+    query?: string;
     category?: string;
     platform?: string;
     limit?: number;
@@ -369,7 +374,13 @@ declare class AnyAPI$1 implements ClientCore {
     me(): Promise<AccountProfile>;
     /** Browse catalog SKUs, optionally scoped by category. GET /v1/apis. */
     catalog(options?: CatalogOptions): Promise<CatalogEntry[]>;
-    /** Ranked catalog search. GET /catalog/search. Browse never accepts a query. */
+    /**
+     * Ranked catalog search. GET /catalog/search. Browse never accepts a query.
+     *
+     * The gateway needs at least one of query, category or platform, in any
+     * combination, so a scope with no query at all is a valid search. An absent or
+     * empty query omits `q` entirely, because an empty `q` is a different request.
+     */
     search(options: SearchOptions): Promise<CatalogSearchResults>;
     /** Describe a single SKU by slug. GET /v1/apis/{slug}. 404 -> NotFoundError. See SPEC 2.7. */
     describe(slug: string): Promise<CatalogEntry>;

package/dist/index.js

@@ -782,9 +782,22 @@ var AnyAPI = class {
     );
     return mapCatalogList(raw);
   }
-  /** Ranked catalog search. GET /catalog/search. Browse never accepts a query. */
+  /**
+   * Ranked catalog search. GET /catalog/search. Browse never accepts a query.
+   *
+   * The gateway needs at least one of query, category or platform, in any
+   * combination, so a scope with no query at all is a valid search. An absent or
+   * empty query omits `q` entirely, because an empty `q` is a different request.
+   */
   async search(options) {
-    const search = new URLSearchParams({ q: options.query });
+    if (!options.query && !options.category && !options.platform) {
+      throw new AnyAPIError(
+        "search needs at least one of query, category, or platform",
+        0
+      );
+    }
+    const search = new URLSearchParams();
+    if (options.query) search.set("q", options.query);
     if (options.category) search.set("category", options.category);
     if (options.platform) search.set("platform", options.platform);
     if (options.limit !== void 0) search.set("limit", String(options.limit));