@algolia/client-common 5.8.1 → 5.9.0

package/src/types/host.ts

@@ -1,43 +0,0 @@
-export type Host = {
-  /**
-   * The host URL.
-   */
-  url: string;
-
-  /**
-   * The accepted transporter.
-   */
-  accept: 'read' | 'readWrite' | 'write';
-
-  /**
-   * The protocol of the host URL.
-   */
-  protocol: 'http' | 'https';
-
-  /**
-   * The port of the host URL.
-   */
-  port?: number;
-};
-
-export type StatefulHost = Host & {
-  /**
-   * The status of the host.
-   */
-  status: 'down' | 'timed out' | 'up';
-
-  /**
-   * The last update of the host status, used to compare with the expiration delay.
-   */
-  lastUpdate: number;
-
-  /**
-   * Returns whether the host is up or not.
-   */
-  isUp: () => boolean;
-
-  /**
-   * Returns whether the host is timed out or not.
-   */
-  isTimedOut: () => boolean;
-};

package/src/types/index.ts

@@ -1,7 +0,0 @@
-export * from './cache';
-export * from './createClient';
-export * from './createIterablePromise';
-export * from './host';
-export * from './logger';
-export * from './requester';
-export * from './transporter';

package/src/types/logger.ts

@@ -1,24 +0,0 @@
-export const LogLevelEnum: Readonly<Record<string, LogLevelType>> = {
-  Debug: 1,
-  Info: 2,
-  Error: 3,
-};
-
-export type LogLevelType = 1 | 2 | 3;
-
-export type Logger = {
-  /**
-   * Logs debug messages.
-   */
-  debug: (message: string, args?: any) => Promise<void>;
-
-  /**
-   * Logs info messages.
-   */
-  info: (message: string, args?: any) => Promise<void>;
-
-  /**
-   * Logs error messages.
-   */
-  error: (message: string, args?: any) => Promise<void>;
-};

package/src/types/requester.ts

@@ -1,67 +0,0 @@
-export type Headers = Record<string, string>;
-
-export type QueryParameters = Record<string, any>;
-
-/**
- * The method of the request.
- */
-export type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
-
-export type Request = {
-  method: Method;
-  /**
-   * The path of the REST API to send the request to.
-   */
-  path: string;
-  queryParameters: QueryParameters;
-  data?: Array<Record<string, any>> | Record<string, any>;
-  headers: Headers;
-  /**
-   * If the given request should persist on the cache. Keep in mind,
-   * that some methods may have this option enabled by default.
-   */
-  cacheable?: boolean;
-  /**
-   * Some POST methods in the Algolia REST API uses the `read` transporter.
-   * This information is defined at the spec level.
-   */
-  useReadTransporter?: boolean;
-};
-
-export type EndRequest = Pick<Request, 'headers' | 'method'> & {
-  /**
-   * The full URL of the REST API.
-   */
-  url: string;
-  /**
-   * The connection timeout, in milliseconds.
-   */
-  connectTimeout: number;
-  /**
-   * The response timeout, in milliseconds.
-   */
-  responseTimeout: number;
-  data?: string;
-};
-
-export type Response = {
-  /**
-   * The body of the response.
-   */
-  content: string;
-  /**
-   * Whether the API call is timed out or not.
-   */
-  isTimedOut: boolean;
-  /**
-   * The HTTP status code of the response.
-   */
-  status: number;
-};
-
-export type Requester = {
-  /**
-   * Sends the given `request` to the server.
-   */
-  send: (request: EndRequest) => Promise<Response>;
-};

package/src/types/transporter.ts

@@ -1,153 +0,0 @@
-import type { Cache } from './cache';
-import type { Host } from './host';
-import type { Logger } from './logger';
-import type { EndRequest, Headers, QueryParameters, Request, Requester, Response } from './requester';
-
-export type RequestOptions = Pick<Request, 'cacheable'> & {
-  /**
-   * Custom timeout for the request. Note that, in normal situations
-   * the given timeout will be applied. But the transporter layer may
-   * increase this timeout if there is need for it.
-   */
-  timeouts?: Partial<Timeouts>;
-
-  /**
-   * Custom headers for the request. This headers are
-   * going to be merged the transporter headers.
-   */
-  headers?: Headers;
-
-  /**
-   * Custom query parameters for the request. This query parameters are
-   * going to be merged the transporter query parameters.
-   */
-  queryParameters?: QueryParameters;
-
-  /**
-   * Custom data for the request. This data is
-   * going to be merged the transporter data.
-   */
-  data?: Array<Record<string, any>> | Record<string, any>;
-};
-
-export type StackFrame = {
-  request: EndRequest;
-  response: Response;
-  host: Host;
-  triesLeft: number;
-};
-
-export type AlgoliaAgentOptions = {
-  /**
-   * The segment. Usually the integration name.
-   */
-  segment: string;
-
-  /**
-   * The version. Usually the integration version.
-   */
-  version?: string;
-};
-
-export type AlgoliaAgent = {
-  /**
-   * The raw value of the user agent.
-   */
-  value: string;
-
-  /**
-   * Mutates the current user agent adding the given user agent options.
-   */
-  add: (options: AlgoliaAgentOptions) => AlgoliaAgent;
-};
-
-export type Timeouts = {
-  /**
-   * Timeout in milliseconds before the connection is established.
-   */
-  connect: number;
-
-  /**
-   * Timeout in milliseconds before reading the response on a read request.
-   */
-  read: number;
-
-  /**
-   * Timeout in milliseconds before reading the response on a write request.
-   */
-  write: number;
-};
-
-export type TransporterOptions = {
-  /**
-   * The cache of the hosts. Usually used to persist
-   * the state of the host when its down.
-   */
-  hostsCache: Cache;
-
-  /**
-   * The logger instance to send events of the transporter.
-   */
-  logger: Logger;
-
-  /**
-   * The underlying requester used. Should differ
-   * depending of the environment where the client
-   * will be used.
-   */
-  requester: Requester;
-
-  /**
-   * The cache of the requests. When requests are
-   * `cacheable`, the returned promised persists
-   * in this cache to shared in similar requests
-   * before being resolved.
-   */
-  requestsCache: Cache;
-
-  /**
-   * The cache of the responses. When requests are
-   * `cacheable`, the returned responses persists
-   * in this cache to shared in similar requests.
-   */
-  responsesCache: Cache;
-
-  /**
-   * The timeouts used by the requester. The transporter
-   * layer may increase this timeouts as defined on the
-   * retry strategy.
-   */
-  timeouts: Timeouts;
-
-  /**
-   * The hosts used by the requester.
-   */
-  hosts: Host[];
-
-  /**
-   * The headers used by the requester. The transporter
-   * layer may add some extra headers during the request
-   * for the user agent, and others.
-   */
-  baseHeaders: Headers;
-
-  /**
-   * The query parameters used by the requester. The transporter
-   * layer may add some extra headers during the request
-   * for the user agent, and others.
-   */
-  baseQueryParameters: QueryParameters;
-
-  /**
-   * The user agent used. Sent on query parameters.
-   */
-  algoliaAgent: AlgoliaAgent;
-};
-
-export type Transporter = TransporterOptions & {
-  /**
-   * Performs a request.
-   * The `baseRequest` and `baseRequestOptions` will be merged accordingly.
-   */
-  request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
-};