@audd/sdk 1.5.5 → 1.5.7

package/dist/index.d.cts

@@ -38,11 +38,15 @@ type Source = string | URL | Blob | Uint8Array;
  * - RECOGNITION — `recognize`, `recognizeEnterprise`, `advanced.findLyrics`:
  *                 retry on pre-upload connection failures + 5xx.
  *                 DO NOT retry on read-timeout-after-upload (cost protection).
- * - MUTATING    — `streams.add`, `streams.delete`, etc., `customCatalog.add`:
+ * - MUTATING    — `streams.add`, `streams.delete`, etc.:
  *                 retry only on pre-upload connection failures. DO NOT retry
  *                 5xx (the side effect may have happened).
+ * - NONE        — `customCatalog.add`: never retry. Custom-catalog upload is
+ *                 metered; auto-retry on transport failure could double-charge
+ *                 for the same audio fingerprinting. Surface a clean error and
+ *                 let the caller decide.
  */
-type RetryClass = "read" | "recognition" | "mutating";
+type RetryClass = "read" | "recognition" | "mutating" | "none";
 interface RetryPolicy {
     retryClass: RetryClass;
     maxAttempts: number;
@@ -228,6 +232,19 @@ interface LongpollOptions {
     timeout?: number;
     /** Bypass the default-on `getCallbackUrl` preflight. */
     skipCallbackCheck?: boolean;
+    /**
+     * Radio id to subscribe to — the SDK derives the 9-char category locally
+     * from `(api_token, radio_id)`. Mutually exclusive with `category`. Only
+     * meaningful on the object-form call site (`longpoll({ radioId: 42 })`).
+     */
+    radioId?: number;
+    /**
+     * Pre-derived 9-char longpoll category. Mutually exclusive with `radioId`.
+     * Only meaningful on the object-form call site
+     * (`longpoll({ category: "abc123def" })`); the positional string form
+     * `longpoll("abc123def")` is the more common way to pass a category.
+     */
+    category?: string;
 }
 declare class Streams {
     private readonly http;
@@ -266,6 +283,17 @@ declare class Streams {
     /**
      * Long-poll the AudD subscription endpoint.
      *
+     * Two call shapes:
+     *
+     * - **Common case** — pass an options object with `radioId`; the SDK
+     *   derives the 9-char category locally from `(api_token, radio_id)`:
+     *   `longpoll({ radioId: 42 })`.
+     * - **Tokenless / pre-derived category** — pass the category as a positional
+     *   string (`longpoll("abc123def")`) or via the object form
+     *   (`longpoll({ category: "abc123def" })`). Useful when the category was
+     *   shared with you (e.g. a browser/mobile client running without the
+     *   api_token).
+     *
      * Returns a {@link LongpollPoll} handle with three async-iterables —
      * `matches`, `notifications`, `errors` — that are filled by a background
      * loop. Iterate them independently or in parallel via `Promise.all([...])`.
@@ -275,8 +303,16 @@ declare class Streams {
      * callback URL, and the preflight surfaces that misconfiguration as an
      * actionable {@link AudDInvalidRequestError}. Pass `skipCallbackCheck: true`
      * to bypass.
+     *
+     * Throws {@link AudDInvalidRequestError} if the object form supplies both
+     * `radioId` and `category`, or neither.
      */
     longpoll(category: string, opts?: LongpollOptions): Promise<LongpollPoll>;
+    longpoll(opts: LongpollOptions & ({
+        radioId: number;
+    } | {
+        category: string;
+    })): Promise<LongpollPoll>;
     private preflightCallbackUrl;
 }
 
@@ -286,8 +322,8 @@ interface CustomCatalogAddOptions {
 }
 declare class CustomCatalog {
     private readonly http;
-    private readonly mutatingPolicy;
-    constructor(http: HttpClient, mutatingPolicy: RetryPolicy);
+    private readonly noRetryPolicy;
+    constructor(http: HttpClient, noRetryPolicy: RetryPolicy);
     /**
      * **This is NOT how you submit audio for music recognition.** For
      * recognition, use `audd.recognize()` (or `audd.recognizeEnterprise()` for
@@ -299,6 +335,11 @@ declare class CustomCatalog {
      * Calling this again with the same `audioId` re-fingerprints that slot.
      * There is no public list/delete endpoint; track `audioId` ↔ song
      * mappings on your side.
+     *
+     * **No automatic retry.** Custom-catalog upload is metered, and a transport
+     * failure could otherwise cause a silent re-upload that double-charges. Any
+     * 5xx or pre-upload connection error surfaces as a clean exception — the
+     * caller decides whether to retry.
      */
     add(opts: CustomCatalogAddOptions): Promise<void>;
 }

package/dist/index.d.ts

@@ -38,11 +38,15 @@ type Source = string | URL | Blob | Uint8Array;
  * - RECOGNITION — `recognize`, `recognizeEnterprise`, `advanced.findLyrics`:
  *                 retry on pre-upload connection failures + 5xx.
  *                 DO NOT retry on read-timeout-after-upload (cost protection).
- * - MUTATING    — `streams.add`, `streams.delete`, etc., `customCatalog.add`:
+ * - MUTATING    — `streams.add`, `streams.delete`, etc.:
  *                 retry only on pre-upload connection failures. DO NOT retry
  *                 5xx (the side effect may have happened).
+ * - NONE        — `customCatalog.add`: never retry. Custom-catalog upload is
+ *                 metered; auto-retry on transport failure could double-charge
+ *                 for the same audio fingerprinting. Surface a clean error and
+ *                 let the caller decide.
  */
-type RetryClass = "read" | "recognition" | "mutating";
+type RetryClass = "read" | "recognition" | "mutating" | "none";
 interface RetryPolicy {
     retryClass: RetryClass;
     maxAttempts: number;
@@ -228,6 +232,19 @@ interface LongpollOptions {
     timeout?: number;
     /** Bypass the default-on `getCallbackUrl` preflight. */
     skipCallbackCheck?: boolean;
+    /**
+     * Radio id to subscribe to — the SDK derives the 9-char category locally
+     * from `(api_token, radio_id)`. Mutually exclusive with `category`. Only
+     * meaningful on the object-form call site (`longpoll({ radioId: 42 })`).
+     */
+    radioId?: number;
+    /**
+     * Pre-derived 9-char longpoll category. Mutually exclusive with `radioId`.
+     * Only meaningful on the object-form call site
+     * (`longpoll({ category: "abc123def" })`); the positional string form
+     * `longpoll("abc123def")` is the more common way to pass a category.
+     */
+    category?: string;
 }
 declare class Streams {
     private readonly http;
@@ -266,6 +283,17 @@ declare class Streams {
     /**
      * Long-poll the AudD subscription endpoint.
      *
+     * Two call shapes:
+     *
+     * - **Common case** — pass an options object with `radioId`; the SDK
+     *   derives the 9-char category locally from `(api_token, radio_id)`:
+     *   `longpoll({ radioId: 42 })`.
+     * - **Tokenless / pre-derived category** — pass the category as a positional
+     *   string (`longpoll("abc123def")`) or via the object form
+     *   (`longpoll({ category: "abc123def" })`). Useful when the category was
+     *   shared with you (e.g. a browser/mobile client running without the
+     *   api_token).
+     *
      * Returns a {@link LongpollPoll} handle with three async-iterables —
      * `matches`, `notifications`, `errors` — that are filled by a background
      * loop. Iterate them independently or in parallel via `Promise.all([...])`.
@@ -275,8 +303,16 @@ declare class Streams {
      * callback URL, and the preflight surfaces that misconfiguration as an
      * actionable {@link AudDInvalidRequestError}. Pass `skipCallbackCheck: true`
      * to bypass.
+     *
+     * Throws {@link AudDInvalidRequestError} if the object form supplies both
+     * `radioId` and `category`, or neither.
      */
     longpoll(category: string, opts?: LongpollOptions): Promise<LongpollPoll>;
+    longpoll(opts: LongpollOptions & ({
+        radioId: number;
+    } | {
+        category: string;
+    })): Promise<LongpollPoll>;
     private preflightCallbackUrl;
 }
 
@@ -286,8 +322,8 @@ interface CustomCatalogAddOptions {
 }
 declare class CustomCatalog {
     private readonly http;
-    private readonly mutatingPolicy;
-    constructor(http: HttpClient, mutatingPolicy: RetryPolicy);
+    private readonly noRetryPolicy;
+    constructor(http: HttpClient, noRetryPolicy: RetryPolicy);
     /**
      * **This is NOT how you submit audio for music recognition.** For
      * recognition, use `audd.recognize()` (or `audd.recognizeEnterprise()` for
@@ -299,6 +335,11 @@ declare class CustomCatalog {
      * Calling this again with the same `audioId` re-fingerprints that slot.
      * There is no public list/delete endpoint; track `audioId` ↔ song
      * mappings on your side.
+     *
+     * **No automatic retry.** Custom-catalog upload is metered, and a transport
+     * failure could otherwise cause a silent re-upload that double-charges. Any
+     * 5xx or pre-upload connection error surfaces as a clean exception — the
+     * caller decides whether to retry.
      */
     add(opts: CustomCatalogAddOptions): Promise<void>;
 }

package/dist/index.js

@@ -662,6 +662,8 @@ function shouldRetryResponse(resp, retryClass) {
       return s >= HTTP_SERVER_ERROR_FLOOR;
     case "mutating":
       return false;
+    case "none":
+      return false;
   }
 }
 function shouldRetryError(err, retryClass) {
@@ -672,6 +674,8 @@ function shouldRetryError(err, retryClass) {
       return isPreUploadConnectionError(err);
     case "mutating":
       return isPreUploadConnectionError(err);
+    case "none":
+      return false;
   }
 }
 function sleep(ms) {
@@ -1147,30 +1151,42 @@ var Streams = class {
   parseCallback(body) {
     return parseCallback(body);
   }
-  /**
-   * Long-poll the AudD subscription endpoint.
-   *
-   * Returns a {@link LongpollPoll} handle with three async-iterables —
-   * `matches`, `notifications`, `errors` — that are filled by a background
-   * loop. Iterate them independently or in parallel via `Promise.all([...])`.
-   *
-   * Before the first request the SDK runs a one-time `getCallbackUrl`
-   * preflight: AudD silently discards events for accounts that haven't set a
-   * callback URL, and the preflight surfaces that misconfiguration as an
-   * actionable {@link AudDInvalidRequestError}. Pass `skipCallbackCheck: true`
-   * to bypass.
-   */
-  async longpoll(category, opts = {}) {
-    if (opts.skipCallbackCheck !== true) {
+  async longpoll(arg1, opts = {}) {
+    let category;
+    let effectiveOpts;
+    if (typeof arg1 === "string") {
+      category = arg1;
+      effectiveOpts = opts;
+    } else {
+      effectiveOpts = arg1;
+      const hasRadioId = arg1.radioId !== void 0;
+      const hasCategory = arg1.category !== void 0;
+      if (hasRadioId && hasCategory) {
+        throw new AudDInvalidRequestError({
+          errorCode: 0,
+          message: "longpoll(): pass exactly one of `radioId` or `category` \u2014 got both.",
+          httpStatus: 0
+        });
+      }
+      if (!hasRadioId && !hasCategory) {
+        throw new AudDInvalidRequestError({
+          errorCode: 0,
+          message: "longpoll(): pass exactly one of `radioId` or `category` \u2014 got neither.",
+          httpStatus: 0
+        });
+      }
+      category = hasRadioId ? this.deriveLongpollCategory(arg1.radioId) : arg1.category;
+    }
+    if (effectiveOpts.skipCallbackCheck !== true) {
       await this.preflightCallbackUrl();
     }
-    const timeoutSec = opts.timeout ?? 50;
+    const timeoutSec = effectiveOpts.timeout ?? 50;
     const httpClient = this.http;
     const readPolicy = this.readPolicy;
     return startLongpoll({
       category,
       timeout: timeoutSec,
-      sinceTime: opts.sinceTime,
+      sinceTime: effectiveOpts.sinceTime,
       fetchOnce: (params, signal) => runRetried(
         () => httpClient.get(`${API_BASE}/longpoll/`, params, { signal }),
         readPolicy
@@ -1232,12 +1248,12 @@ async function runRetried2(fn, policy) {
   }
 }
 var CustomCatalog = class {
-  constructor(http, mutatingPolicy) {
+  constructor(http, noRetryPolicy) {
     this.http = http;
-    this.mutatingPolicy = mutatingPolicy;
+    this.noRetryPolicy = noRetryPolicy;
   }
   http;
-  mutatingPolicy;
+  noRetryPolicy;
   /**
    * **This is NOT how you submit audio for music recognition.** For
    * recognition, use `audd.recognize()` (or `audd.recognizeEnterprise()` for
@@ -1249,6 +1265,11 @@ var CustomCatalog = class {
    * Calling this again with the same `audioId` re-fingerprints that slot.
    * There is no public list/delete endpoint; track `audioId` ↔ song
    * mappings on your side.
+   *
+   * **No automatic retry.** Custom-catalog upload is metered, and a transport
+   * failure could otherwise cause a silent re-upload that double-charges. Any
+   * 5xx or pre-upload connection error surfaces as a clean exception — the
+   * caller decides whether to retry.
    */
   async add(opts) {
     const reopen = prepareSource(opts.source);
@@ -1257,7 +1278,7 @@ var CustomCatalog = class {
       const prepared = await reopen();
       const fields = { ...prepared.fields, audio_id: audioId };
       return this.http.postForm(UPLOAD_URL, fields);
-    }, this.mutatingPolicy);
+    }, this.noRetryPolicy);
     decodeSuccess2(resp.jsonBody, resp.httpStatus, resp.requestId);
   }
 };
@@ -1501,7 +1522,7 @@ var AudD = class {
   /** Sub-namespace for the private fingerprint catalog. NOT for recognition. */
   get customCatalog() {
     if (this._customCatalog === void 0) {
-      this._customCatalog = new CustomCatalog(this._http, this.policyFor("mutating"));
+      this._customCatalog = new CustomCatalog(this._http, this.policyFor("none"));
     }
     return this._customCatalog;
   }