@algolia/client-common 5.0.0-alpha.33 → 5.0.0-alpha.34

package/dist/client-common.cjs.js

@@ -317,8 +317,8 @@ class RetryError extends ErrorWithStackTrace {
   }
 }
 class ApiError extends ErrorWithStackTrace {
-  constructor(message, status, stackTrace) {
-    super(message, stackTrace, 'ApiError');
+  constructor(message, status, stackTrace, name = 'ApiError') {
+    super(message, stackTrace, name);
     _defineProperty(this, "status", void 0);
     this.status = status;
   }
@@ -330,6 +330,14 @@ class DeserializationError extends AlgoliaError {
     this.response = response;
   }
 }
+// DetailedApiError is only used by the ingestion client to return more informative error, other clients will use ApiClient.
+class DetailedApiError extends ApiError {
+  constructor(message, status, error, stackTrace) {
+    super(message, status, stackTrace, 'DetailedApiError');
+    _defineProperty(this, "error", void 0);
+    this.error = error;
+  }
+}
 
 function shuffle(array) {
   const shuffledArray = array;
@@ -388,13 +396,16 @@ function deserializeFailure({
   content,
   status
 }, stackFrame) {
-  let message = content;
   try {
-    message = JSON.parse(content).message;
+    const parsed = JSON.parse(content);
+    if ('error' in parsed) {
+      return new DetailedApiError(parsed.message, status, parsed.error, stackFrame);
+    }
+    return new ApiError(parsed.message, status, stackFrame);
   } catch (e) {
     // ..
   }
-  return new ApiError(message, status, stackFrame);
+  return new ApiError(content, status, stackFrame);
 }
 
 function isNetworkError({
@@ -715,6 +726,7 @@ exports.DEFAULT_READ_TIMEOUT_NODE = DEFAULT_READ_TIMEOUT_NODE;
 exports.DEFAULT_WRITE_TIMEOUT_BROWSER = DEFAULT_WRITE_TIMEOUT_BROWSER;
 exports.DEFAULT_WRITE_TIMEOUT_NODE = DEFAULT_WRITE_TIMEOUT_NODE;
 exports.DeserializationError = DeserializationError;
+exports.DetailedApiError = DetailedApiError;
 exports.ErrorWithStackTrace = ErrorWithStackTrace;
 exports.RetryError = RetryError;
 exports.createAlgoliaAgent = createAlgoliaAgent;

package/dist/client-common.esm.node.js

@@ -313,8 +313,8 @@ class RetryError extends ErrorWithStackTrace {
   }
 }
 class ApiError extends ErrorWithStackTrace {
-  constructor(message, status, stackTrace) {
-    super(message, stackTrace, 'ApiError');
+  constructor(message, status, stackTrace, name = 'ApiError') {
+    super(message, stackTrace, name);
     _defineProperty(this, "status", void 0);
     this.status = status;
   }
@@ -326,6 +326,14 @@ class DeserializationError extends AlgoliaError {
     this.response = response;
   }
 }
+// DetailedApiError is only used by the ingestion client to return more informative error, other clients will use ApiClient.
+class DetailedApiError extends ApiError {
+  constructor(message, status, error, stackTrace) {
+    super(message, status, stackTrace, 'DetailedApiError');
+    _defineProperty(this, "error", void 0);
+    this.error = error;
+  }
+}
 
 function shuffle(array) {
   const shuffledArray = array;
@@ -384,13 +392,16 @@ function deserializeFailure({
   content,
   status
 }, stackFrame) {
-  let message = content;
   try {
-    message = JSON.parse(content).message;
+    const parsed = JSON.parse(content);
+    if ('error' in parsed) {
+      return new DetailedApiError(parsed.message, status, parsed.error, stackFrame);
+    }
+    return new ApiError(parsed.message, status, stackFrame);
   } catch (e) {
     // ..
   }
-  return new ApiError(message, status, stackFrame);
+  return new ApiError(content, status, stackFrame);
 }
 
 function isNetworkError({
@@ -702,4 +713,4 @@ const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
 const DEFAULT_READ_TIMEOUT_NODE = 5000;
 const DEFAULT_WRITE_TIMEOUT_NODE = 30000;
 
-export { AlgoliaError, ApiError, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, ErrorWithStackTrace, RetryError, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createEchoRequester, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials };
+export { AlgoliaError, ApiError, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, DetailedApiError, ErrorWithStackTrace, RetryError, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createEchoRequester, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials };

package/dist/src/transporter/errors.d.ts

@@ -12,10 +12,27 @@ export declare class RetryError extends ErrorWithStackTrace {
 }
 export declare class ApiError extends ErrorWithStackTrace {
     status: number;
-    constructor(message: string, status: number, stackTrace: StackFrame[]);
+    constructor(message: string, status: number, stackTrace: StackFrame[], name?: string);
 }
 export declare class DeserializationError extends AlgoliaError {
     response: Response;
     constructor(message: string, response: Response);
 }
+export declare type DetailedErrorWithMessage = {
+    message: string;
+    label: string;
+};
+export declare type DetailedErrorWithTypeID = {
+    id: string;
+    type: string;
+    name?: string;
+};
+export declare type DetailedError = {
+    code: string;
+    details?: DetailedErrorWithMessage[] | DetailedErrorWithTypeID[];
+};
+export declare class DetailedApiError extends ApiError {
+    error: DetailedError;
+    constructor(message: string, status: number, error: DetailedError, stackTrace: StackFrame[]);
+}
 //# sourceMappingURL=errors.d.ts.map

package/dist/src/transporter/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/transporter/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAErD,qBAAa,YAAa,SAAQ,KAAK;IACrC,IAAI,EAAE,MAAM,CAAkB;gBAElB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAO1C;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,UAAU,EAAE,UAAU,EAAE,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM;CAKpE;AAED,qBAAa,UAAW,SAAQ,mBAAmB;gBACrC,UAAU,EAAE,UAAU,EAAE;CAOrC;AAED,qBAAa,QAAS,SAAQ,mBAAmB;IAC/C,MAAM,EAAE,MAAM,CAAC;gBAEH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE;CAItE;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,QAAQ,EAAE,QAAQ,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAIhD"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/transporter/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAErD,qBAAa,YAAa,SAAQ,KAAK;IACrC,IAAI,EAAE,MAAM,CAAkB;gBAElB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAO1C;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,UAAU,EAAE,UAAU,EAAE,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM;CAKpE;AAED,qBAAa,UAAW,SAAQ,mBAAmB;gBACrC,UAAU,EAAE,UAAU,EAAE;CAOrC;AAED,qBAAa,QAAS,SAAQ,mBAAmB;IAC/C,MAAM,EAAE,MAAM,CAAC;gBAGb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EAAE,EACxB,IAAI,SAAa;CAKpB;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,QAAQ,EAAE,QAAQ,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAIhD;AAED,oBAAY,wBAAwB,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,wBAAwB,EAAE,GAAG,uBAAuB,EAAE,CAAC;CAClE,CAAC;AAGF,qBAAa,gBAAiB,SAAQ,QAAQ;IAC5C,KAAK,EAAE,aAAa,CAAC;gBAGnB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,aAAa,EACpB,UAAU,EAAE,UAAU,EAAE;CAK3B"}

package/dist/src/transporter/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/transporter/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,eAAe,EACf,OAAO,EACP,cAAc,EACd,QAAQ,EACR,UAAU,EACX,MAAM,UAAU,CAAC;AAIlB,wBAAgB,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAYtD;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,eAAe,GAC/B,MAAM,CAWR;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,eAAe,GAAG,MAAM,CAe5E;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAapB;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,OAAO,EACpB,cAAc,EAAE,OAAO,EACvB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAeT;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMvE;AAED,wBAAgB,kBAAkB,CAChC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAC7B,UAAU,EAAE,UAAU,EAAE,GACvB,KAAK,CAQP"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/transporter/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,eAAe,EACf,OAAO,EACP,cAAc,EACd,QAAQ,EACR,UAAU,EACX,MAAM,UAAU,CAAC;AAIlB,wBAAgB,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAYtD;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,eAAe,GAC/B,MAAM,CAWR;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,eAAe,GAAG,MAAM,CAe5E;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAapB;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,OAAO,EACpB,cAAc,EAAE,OAAO,EACvB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAeT;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMvE;AAED,wBAAgB,kBAAkB,CAChC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAC7B,UAAU,EAAE,UAAU,EAAE,GACvB,KAAK,CAgBP"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-common",
-  "version": "5.0.0-alpha.33",
+  "version": "5.0.0-alpha.34",
   "description": "Common package for the Algolia JavaScript API client.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",

package/src/transporter/errors.ts

@@ -35,8 +35,13 @@ export class RetryError extends ErrorWithStackTrace {
 export class ApiError extends ErrorWithStackTrace {
   status: number;
 
-  constructor(message: string, status: number, stackTrace: StackFrame[]) {
-    super(message, stackTrace, 'ApiError');
+  constructor(
+    message: string,
+    status: number,
+    stackTrace: StackFrame[],
+    name = 'ApiError'
+  ) {
+    super(message, stackTrace, name);
     this.status = status;
   }
 }
@@ -49,3 +54,34 @@ export class DeserializationError extends AlgoliaError {
     this.response = response;
   }
 }
+
+export type DetailedErrorWithMessage = {
+  message: string;
+  label: string;
+};
+
+export type DetailedErrorWithTypeID = {
+  id: string;
+  type: string;
+  name?: string;
+};
+
+export type DetailedError = {
+  code: string;
+  details?: DetailedErrorWithMessage[] | DetailedErrorWithTypeID[];
+};
+
+// DetailedApiError is only used by the ingestion client to return more informative error, other clients will use ApiClient.
+export class DetailedApiError extends ApiError {
+  error: DetailedError;
+
+  constructor(
+    message: string,
+    status: number,
+    error: DetailedError,
+    stackTrace: StackFrame[]
+  ) {
+    super(message, status, stackTrace, 'DetailedApiError');
+    this.error = error;
+  }
+}

package/src/transporter/helpers.ts

@@ -8,7 +8,7 @@ import type {
   StackFrame,
 } from '../types';
 
-import { ApiError, DeserializationError } from './errors';
+import { ApiError, DeserializationError, DetailedApiError } from './errors';
 
 export function shuffle<TData>(array: TData[]): TData[] {
   const shuffledArray = array;
@@ -109,11 +109,19 @@ export function deserializeFailure(
   { content, status }: Response,
   stackFrame: StackFrame[]
 ): Error {
-  let message = content;
   try {
-    message = JSON.parse(content).message;
+    const parsed = JSON.parse(content);
+    if ('error' in parsed) {
+      return new DetailedApiError(
+        parsed.message,
+        status,
+        parsed.error,
+        stackFrame
+      );
+    }
+    return new ApiError(parsed.message, status, stackFrame);
   } catch (e) {
     // ..
   }
-  return new ApiError(message, status, stackFrame);
+  return new ApiError(content, status, stackFrame);
 }