bx-rest 0.21.1 → 0.21.2

package/functions/errors.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Thrown by `.res()` when called with `{ throwOnApiError: true }` and the
+ * Bitrix REST call resolves as a Bitrix-level API error, e.g.
+ * `INSUFFICIENT_SCOPE` or `expired_token`.
+ *
+ * By default `.res()` resolves such responses as `undefined` instead of
+ * throwing — see the "Error handling" section of the README.
+ */
+export declare class BXRestApiError extends Error {
+    error: string | undefined;
+    error_description: string | undefined;
+    constructor(error: string | undefined, error_description: string | undefined);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.21.1",
+  "version": "0.21.2",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",

package/public-api.d.ts

@@ -9,6 +9,8 @@ export { Navvy } from './services/navvy';
 export { HttpBXServices as BXRestRequest } from './services/http/HttpBX';
 export { SessionKeyServices, SessionKeyError } from './services/http/sessionKey';
 export { instanceOfiBXRestAnswerSuccess as isBXRestAnswerSuccess } from './functions/mapResult';
+export { BXRestApiError } from './functions/errors';
+export { BXRestResOptions } from './services/navvy/extends/navvy-pag-base';
 export { HttpNavvyServices } from './services/http/httpNavvy';
 export * as partNameMethods from './consts/part-name-methods';
 export * as BXBaseServices from './services/base';

package/services/navvy/extends/navvy-pag-base.d.ts

@@ -2,6 +2,17 @@ import { Observable } from 'rxjs';
 import { iBXRestAnswer } from '../../../typification/rest/base/answer';
 import { HttpBXServices } from '../../http/HttpBX';
 import { ReturnTypeNavvy } from '../navvy-support';
+export interface BXRestResOptions {
+    /**
+     * When `true`, a Bitrix-level API error (`{ error, error_description }`,
+     * e.g. `INSUFFICIENT_SCOPE`, `expired_token`) makes the `Observable`
+     * returned by `.res()` error out with a `BXRestApiError` instead of
+     * resolving with `undefined`.
+     *
+     * Default: `false` (preserves the historical `.res()` behaviour).
+     */
+    throwOnApiError?: boolean;
+}
 export declare abstract class NavvyPagBase<T, R, P> {
     protected url: string[];
     protected param: P;
@@ -12,6 +23,6 @@ export declare abstract class NavvyPagBase<T, R, P> {
     constructor(url: string[], param: P, map?: ((param: T | undefined) => R | undefined) | undefined, restApi?: boolean);
     resVanilla(): Observable<iBXRestAnswer<T> | undefined>;
     mapForVanilla(): Observable<iBXRestAnswer<ReturnTypeNavvy<T, R>> | undefined>;
-    res(): Observable<ReturnTypeNavvy<T, R> | undefined>;
-    mapAndError<T>(request: Observable<iBXRestAnswer<T> | undefined>): Observable<T | undefined>;
+    res(options?: BXRestResOptions): Observable<ReturnTypeNavvy<T, R> | undefined>;
+    mapAndError<T>(request: Observable<iBXRestAnswer<T> | undefined>, options?: BXRestResOptions): Observable<T | undefined>;
 }