parreq-client 1.0.0 → 1.1.0

package/README.md

@@ -1,16 +1,16 @@
 # parreq
 
-Клиент [ParReq](https://req.akuraq.dev) — поисковая выдача Google и Яндекса в
+Клиент [Parreq](https://req.akuraq.dev) — поисковая выдача Google и Яндекса в
 JSON. Без зависимостей, на встроенном `fetch` (нужен Node 18+). Типы в комплекте.
 
 ```bash
-npm i parreq
+npm i parreq-client
 ```
 
 ```js
-import { ParReq } from "parreq";
+import { Parreq } from "parreq-client";
 
-const client = new ParReq({ apiKey: "pr_ВАШКЛЮЧ" });
+const client = new Parreq({ apiKey: "pr_ВАШКЛЮЧ" });
 
 const res = await client.yandex({ q: "кофемашина", gl: "by", hl: "ru",
                                   include: ["ads", "shopping"] });
@@ -49,14 +49,14 @@ res.ads; res.shopping; res.videos; res.related;
 ## Ошибки
 
 ```js
-import { ParReq, ParReqError, NoWorkers, RateLimited } from "parreq";
+import { Parreq, ParreqError, NoWorkers, RateLimited } from "parreq-client";
 
 try {
   const res = await client.google({ q: "coffee", gl: "us" });
 } catch (err) {
   if (err instanceof NoWorkers) console.log("повторить через", err.retryAfter);
   else if (err instanceof RateLimited) console.log(err.code, err.retryAfter);
-  else if (err instanceof ParReqError) console.log(err.status, err.code, err.requestId);
+  else if (err instanceof ParreqError) console.log(err.status, err.code, err.requestId);
   else throw err;
 }
 ```
@@ -65,8 +65,8 @@ try {
 столько, сколько просит сервер в `Retry-After`. По умолчанию три попытки:
 
 ```js
-new ParReq({ apiKey: "pr_…", retries: 0 });        // выключить повторы
-new ParReq({ apiKey: "pr_…", timeoutMs: 240_000 }); // запрос с капчей бывает долгим
+new Parreq({ apiKey: "pr_…", retries: 0 });        // выключить повторы
+new Parreq({ apiKey: "pr_…", timeoutMs: 240_000 }); // запрос с капчей бывает долгим
 ```
 
 ## Свой расход

package/index.d.ts

@@ -56,7 +56,7 @@ export declare class SearchResult {
   readonly totalResults: number | null;
 }
 
-export declare class ParReqError extends Error {
+export declare class ParreqError extends Error {
   status: number;
   code: string;
   detail: string;
@@ -65,14 +65,14 @@ export declare class ParReqError extends Error {
   details: Record<string, any>;
   readonly retriable: boolean;
 }
-export declare class BadRequest extends ParReqError {}
-export declare class AuthError extends ParReqError {}
-export declare class RateLimited extends ParReqError {}
-export declare class NoWorkers extends ParReqError {}
-export declare class SearchBlocked extends ParReqError {}
-export declare class ServerError extends ParReqError {}
+export declare class BadRequest extends ParreqError {}
+export declare class AuthError extends ParreqError {}
+export declare class RateLimited extends ParreqError {}
+export declare class NoWorkers extends ParreqError {}
+export declare class SearchBlocked extends ParreqError {}
+export declare class ServerError extends ParreqError {}
 
-export declare class ParReq {
+export declare class Parreq {
   constructor(options: ClientOptions | string);
   search(options: SearchOptions): Promise<SearchResult>;
   google(options: EngineOptions): Promise<SearchResult>;
@@ -83,4 +83,7 @@ export declare class ParReq {
 
 export declare const DEFAULT_BASE_URL: string;
 export declare const DEFAULT_TIMEOUT_MS: number;
-export default ParReq;
+export default Parreq;
+
+/** Имена из 1.0.0, оставлены псевдонимами. */
+export { Parreq as ParReq, ParreqError as ParReqError };

package/index.js

@@ -1,5 +1,5 @@
 /**
- * ParReq — клиент поисковой выдачи Google и Яндекса.
+ * Parreq — клиент поисковой выдачи Google и Яндекса.
  *
  * Зависимостей нет: используется встроенный fetch, поэтому нужен Node 18+.
  * Тянуть axios ради одного запроса значит навязывать чужому проекту лишнее.
@@ -12,13 +12,13 @@ export const DEFAULT_TIMEOUT_MS = 180_000;
 // Коды, которые лечатся повтором. Остальные повторять бессмысленно: неверный
 // параметр и отозванный ключ от этого не исправятся.
 const RETRIABLE = new Set([429, 502, 503, 504]);
-const USER_AGENT = "parreq-node/1.0";
+const USER_AGENT = "parreq-node/1.1";
 
 /** Ошибка API. Разбирайте `code`, а не текст: текст переписывается. */
-export class ParReqError extends Error {
+export class ParreqError extends Error {
   constructor(status, code, message, { requestId = "", retryAfter = null, details = {} } = {}) {
     super(`${code}: ${message}`);
-    this.name = "ParReqError";
+    this.name = "ParreqError";
     this.status = status;
     this.code = code;
     this.detail = message;
@@ -33,12 +33,12 @@ export class ParReqError extends Error {
   }
 }
 
-export class BadRequest extends ParReqError {}
-export class AuthError extends ParReqError {}
-export class RateLimited extends ParReqError {}
-export class NoWorkers extends ParReqError {}
-export class SearchBlocked extends ParReqError {}
-export class ServerError extends ParReqError {}
+export class BadRequest extends ParreqError {}
+export class AuthError extends ParreqError {}
+export class RateLimited extends ParreqError {}
+export class NoWorkers extends ParreqError {}
+export class SearchBlocked extends ParreqError {}
+export class ServerError extends ParreqError {}
 
 const BY_CODE = {
   invalid_request: BadRequest,
@@ -92,7 +92,7 @@ export class SearchResult {
   get totalResults() { return this.raw.total_results ?? null; }
 }
 
-export class ParReq {
+export class Parreq {
   /**
    * @param {object|string} options ключ строкой либо объект настроек
    * @param {string} options.apiKey ключ вида `pr_…`
@@ -102,7 +102,7 @@ export class ParReq {
    */
   constructor(options) {
     const opts = typeof options === "string" ? { apiKey: options } : options || {};
-    if (!opts.apiKey) throw new Error("нужен ключ ParReq");
+    if (!opts.apiKey) throw new Error("нужен ключ Parreq");
     this.apiKey = opts.apiKey;
     this.baseUrl = (opts.baseUrl || DEFAULT_BASE_URL).replace(/\/+$/, "");
     this.timeoutMs = opts.timeoutMs ?? DEFAULT_TIMEOUT_MS;
@@ -146,7 +146,7 @@ export class ParReq {
       try {
         return await this.#once(method, url);
       } catch (err) {
-        if (!(err instanceof ParReqError) || !err.retriable || attempt === this.retries) throw err;
+        if (!(err instanceof ParreqError) || !err.retriable || attempt === this.retries) throw err;
         last = err;
         // ждём столько, сколько попросил сервер: у суточной квоты это время до
         // полуночи, и «подождать 5 секунд» там ничего не изменит
@@ -192,4 +192,9 @@ export class ParReq {
   }
 }
 
-export default ParReq;
+export default Parreq;
+
+// --- совместимость с 1.0.0 -------------------------------------------------
+// Тогда класс назывался ParReq — с заглавной R. Написание бренда изменилось на
+// Parreq, но ломать чужой импорт из-за этого нельзя.
+export { Parreq as ParReq, ParreqError as ParReqError };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "parreq-client",
-  "version": "1.0.0",
-  "description": "Клиент ParReq: поисковая выдача Google и Яндекса в JSON",
+  "version": "1.1.0",
+  "description": "Клиент Parreq: поисковая выдача Google и Яндекса в JSON",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",