@algolia/client-common 5.0.0-alpha.10 → 5.0.0-alpha.100

package/src/transporter/errors.ts

@@ -25,7 +25,7 @@ export class ErrorWithStackTrace extends AlgoliaError {
 export class RetryError extends ErrorWithStackTrace {
   constructor(stackTrace: StackFrame[]) {
     super(
-      'Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.',
+      'Unreachable hosts - your application id may be incorrect. If the error persists, please create a ticket at https://support.algolia.com/ sharing steps we can use to reproduce the issue.',
       stackTrace,
       'RetryError'
     );
@@ -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;
@@ -49,11 +49,11 @@ export function serializeQueryParameters(parameters: QueryParameters): string {
   return Object.keys(parameters)
     .map(
       (key) =>
-        `${key}=${
+        `${key}=${encodeURIComponent(
           isObjectOrArray(parameters[key])
             ? JSON.stringify(parameters[key])
             : parameters[key]
-        }`
+        )}`
     )
     .join('&');
 }
@@ -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);
 }

package/src/types/cache.ts

@@ -47,12 +47,29 @@ export type BrowserLocalStorageOptions = {
    */
   key: string;
 
+  /**
+   * The time to live for each cached item in seconds.
+   */
+  timeToLive?: number;
+
   /**
    * The native local storage implementation.
    */
   localStorage?: Storage;
 };
 
+export type BrowserLocalStorageCacheItem = {
+  /**
+   * The cache item creation timestamp.
+   */
+  timestamp: number;
+
+  /**
+   * The cache item value.
+   */
+  value: any;
+};
+
 export type FallbackableCacheOptions = {
   /**
    * List of caches order by priority.