@radsoft/markbase 2026.11.2 → 2026.11.3

package/README.md

@@ -157,15 +157,26 @@ Keep the key server-side. It's a secret; don't ship it to the browser.
 
 ---
 
-## Unreleased: opt-in phonetic clearance
-
-The source client accepts an optional `phonetic` boolean in `clearance` and
-`clearanceBatch` options. The API mode is not enabled in production yet; client
-support alone does not make it available. Omit the option for current spelling-only
-behavior. An unavailable opt-in request returns 503, and batches are never retried
-automatically. See the [unreleased contract](../docs/phonetic-clearance.md) for
-response evidence, ranking, and input limits. Existing spelling scores and risk
-thresholds remain unchanged; phonetic evidence is not a legal availability decision.
+## Opt-in phonetic clearance
+
+Starting with SDK `2026.11.2`, pass `phonetic: true` in `clearance` or
+`clearanceBatch` options to add whole-name ASCII phonetic matching. Omit it or use
+`false` for spelling-only behavior. One name still uses one monthly request;
+batches require Launch or Scale.
+
+Read `matching.phonetic_status` and each match's `signals.phonetic` separately from
+`similarity` and `risk`, which retain their spelling-based meaning. Names with
+digits, non-ASCII characters, more than 12 tokens, or no token of at least four
+letters return `not_evaluated` and retain spelling results. A changed token must
+have at least four letters; short tokens must match literally in the same position.
+`matching.truncated` reports a phonetic retrieval cap or hydration budget being
+reached; `false` does not establish exhaustive coverage.
+
+An unavailable opt-in request returns 503 without silently switching modes.
+Admission failures do not consume monthly quota. Accepted batches count even if a
+search fails and are never retried automatically. See the
+[phonetic contract](../docs/phonetic-clearance.md) for response evidence, ranking,
+and limits. Phonetic evidence does not establish legal availability.
 
 ## Reference
 

package/dist/types.d.ts

@@ -55,7 +55,7 @@ export interface Suggestion {
 export interface ClearanceOptions {
     trademarkClass?: string | number;
     limit?: number;
-    /** Unreleased opt-in; unavailable mode returns 503. Omit for spelling-only matching. */
+    /** Opt-in whole-name ASCII phonetic matching; unavailable mode returns 503. Omit for spelling-only matching. */
     phonetic?: boolean;
 }
 export interface ClearanceMatching {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radsoft/markbase",
-  "version": "2026.11.2",
+  "version": "2026.11.3",
   "description": "Official Node client for the Markbase USPTO trademark API — search, screen, and look up 14M+ US trademarks.",
   "license": "MIT",
   "type": "module",