@algolia/client-query-suggestions 5.2.3 → 5.2.4-beta.2

package/dist/browser.d.ts

@@ -0,0 +1,282 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { ClientOptions } from '@algolia/client-common';
+
+type AppID = {
+    /**
+     * Algolia application ID to which this Query Suggestions configuration belongs.
+     */
+    appID?: string;
+};
+
+type BaseResponse = {
+    /**
+     * HTTP status code.
+     */
+    status?: number;
+    /**
+     * Details about the response, such as error messages.
+     */
+    message?: string;
+};
+
+type ConfigStatus = {
+    /**
+     * Name of the Query Suggestions index (case-sensitive).
+     */
+    indexName?: string;
+    /**
+     * Whether the creation or update of the Query Suggestions index is in progress.
+     */
+    isRunning?: boolean;
+    /**
+     * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
+     */
+    lastBuiltAt?: string;
+    /**
+     * Date and time when the Query Suggestions index was last updated successfully.
+     */
+    lastSuccessfulBuiltAt?: string;
+    /**
+     * Duration of the last successful build in seconds.
+     */
+    lastSuccessfulBuildDuration?: string;
+};
+
+/**
+ * Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
+ */
+type Languages = string[] | boolean;
+
+/**
+ * Facet to use as category.
+ */
+type Facet = {
+    /**
+     * Facet name.
+     */
+    attribute?: string;
+    /**
+     * Number of suggestions.
+     */
+    amount?: number;
+};
+
+/**
+ * Configuration of an Algolia index for Query Suggestions.
+ */
+type SourceIndex = {
+    /**
+     * Name of the Algolia index (case-sensitive) to use as source for query suggestions.
+     */
+    indexName: string;
+    /**
+     * If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
+     */
+    replicas?: boolean;
+    analyticsTags?: string[] | null;
+    facets?: Facet[] | null;
+    /**
+     * Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` search results to be included in the Query Suggestions index.
+     */
+    minHits?: number;
+    /**
+     * Minimum letters required to be included as a suggestion.  A search query must be at least `minLetters` long to be included in the Query Suggestions index.
+     */
+    minLetters?: number;
+    generate?: string[][] | null;
+    external?: string[] | null;
+};
+
+/**
+ * Query Suggestions configuration.
+ */
+type Configuration = {
+    /**
+     * Algolia indices from which to get the popular searches for query suggestions.
+     */
+    sourceIndices: SourceIndex[];
+    languages?: Languages;
+    exclude?: string[] | null;
+    /**
+     * Whether to turn on personalized query suggestions.
+     */
+    enablePersonalization?: boolean;
+    /**
+     * Whether to include suggestions with special characters.
+     */
+    allowSpecialCharacters?: boolean;
+};
+
+/**
+ * Query Suggestions configuration.
+ */
+type ConfigurationWithIndex = Configuration & Record<string, unknown>;
+
+/**
+ * API response for retrieving Query Suggestions configurations.
+ */
+type ConfigurationResponse = AppID & ConfigurationWithIndex;
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+/**
+ * Type of log entry.  - `SKIP`. A query is skipped because it doesn\'t match the conditions for successful inclusion. For example, when a query doesn\'t generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error.
+ */
+type LogLevel = 'ERROR' | 'INFO' | 'SKIP';
+
+type LogFile = {
+    /**
+     * Date and time of the log entry, in RFC 3339 format.
+     */
+    timestamp?: string;
+    level?: LogLevel;
+    /**
+     * Details about this log entry.
+     */
+    message?: string;
+    /**
+     * Level indicating the position of a suggestion in a hierarchy of records.  For example, a `contextLevel` of 1 indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
+     */
+    contextLevel?: number;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `deleteConfig` method.
+ */
+type DeleteConfigProps = {
+    /**
+     * Query Suggestions index name.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `getConfig` method.
+ */
+type GetConfigProps = {
+    /**
+     * Query Suggestions index name.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `getConfigStatus` method.
+ */
+type GetConfigStatusProps = {
+    /**
+     * Query Suggestions index name.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `getLogFile` method.
+ */
+type GetLogFileProps = {
+    /**
+     * Query Suggestions index name.
+     */
+    indexName: string;
+};
+/**
+ * Properties for the `updateConfig` method.
+ */
+type UpdateConfigProps = {
+    /**
+     * Query Suggestions index name.
+     */
+    indexName: string;
+    configuration: Configuration;
+};
+
+declare const apiClientVersion = "5.2.4";
+declare const REGIONS: readonly ["eu", "us"];
+type Region = (typeof REGIONS)[number];
+
+/**
+ * The client type.
+ */
+type QuerySuggestionsClient = ReturnType<typeof querySuggestionsClient>;
+declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    createConfig(configurationWithIndex: ConfigurationWithIndex, requestOptions?: _algolia_client_common.RequestOptions): Promise<BaseResponse>;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<BaseResponse>;
+    getAllConfigs(requestOptions?: _algolia_client_common.RequestOptions): Promise<ConfigurationResponse[]>;
+    getConfig({ indexName }: GetConfigProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ConfigurationResponse>;
+    getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ConfigStatus>;
+    getLogFile({ indexName }: GetLogFileProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<LogFile>;
+    updateConfig({ indexName, configuration }: UpdateConfigProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<BaseResponse>;
+};
+
+export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };

package/dist/builds/browser.js

@@ -0,0 +1,386 @@
+// builds/browser.ts
+import {
+  createMemoryCache,
+  createFallbackableCache,
+  createBrowserLocalStorageCache,
+  DEFAULT_CONNECT_TIMEOUT_BROWSER,
+  DEFAULT_READ_TIMEOUT_BROWSER,
+  DEFAULT_WRITE_TIMEOUT_BROWSER
+} from "@algolia/client-common";
+import { createXhrRequester } from "@algolia/requester-browser-xhr";
+
+// src/querySuggestionsClient.ts
+import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
+var apiClientVersion = "5.2.4";
+var REGIONS = ["eu", "us"];
+function getDefaultHosts(region) {
+  const url = "query-suggestions.{region}.algolia.com".replace("{region}", region);
+  return [{ url, accept: "readWrite", protocol: "https" }];
+}
+function createQuerySuggestionsClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  region: regionOption,
+  ...options
+}) {
+  const auth = createAuth(appIdOption, apiKeyOption, authMode);
+  const transporter = createTransporter({
+    hosts: getDefaultHosts(regionOption),
+    ...options,
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents,
+      client: "QuerySuggestions",
+      version: apiClientVersion
+    }),
+    baseHeaders: {
+      "content-type": "text/plain",
+      ...auth.headers(),
+      ...options.baseHeaders
+    },
+    baseQueryParameters: {
+      ...auth.queryParameters(),
+      ...options.baseQueryParameters
+    }
+  });
+  return {
+    transporter,
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache() {
+      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+    },
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua() {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment, version) {
+      transporter.algoliaAgent.add({ segment, version });
+    },
+    /**
+     * Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param configurationWithIndex - The configurationWithIndex object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    createConfig(configurationWithIndex, requestOptions) {
+      if (!configurationWithIndex) {
+        throw new Error("Parameter `configurationWithIndex` is required when calling `createConfig`.");
+      }
+      const requestPath = "/1/configs";
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: configurationWithIndex
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customDelete`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customGet`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customPost`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPut({ path, parameters, body }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customPut`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param deleteConfig - The deleteConfig object.
+     * @param deleteConfig.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteConfig({ indexName }, requestOptions) {
+      if (!indexName) {
+        throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");
+      }
+      const requestPath = "/1/configs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Retrieves all Query Suggestions configurations of your Algolia application.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getAllConfigs(requestOptions) {
+      const requestPath = "/1/configs";
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Retrieves a single Query Suggestions configuration by its index name.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param getConfig - The getConfig object.
+     * @param getConfig.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getConfig({ indexName }, requestOptions) {
+      if (!indexName) {
+        throw new Error("Parameter `indexName` is required when calling `getConfig`.");
+      }
+      const requestPath = "/1/configs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Reports the status of a Query Suggestions index.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param getConfigStatus - The getConfigStatus object.
+     * @param getConfigStatus.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getConfigStatus({ indexName }, requestOptions) {
+      if (!indexName) {
+        throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");
+      }
+      const requestPath = "/1/configs/{indexName}/status".replace("{indexName}", encodeURIComponent(indexName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Retrieves the logs for a single Query Suggestions index.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param getLogFile - The getLogFile object.
+     * @param getLogFile.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getLogFile({ indexName }, requestOptions) {
+      if (!indexName) {
+        throw new Error("Parameter `indexName` is required when calling `getLogFile`.");
+      }
+      const requestPath = "/1/logs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Updates a QuerySuggestions configuration.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param updateConfig - The updateConfig object.
+     * @param updateConfig.indexName - Query Suggestions index name.
+     * @param updateConfig.configuration - The configuration object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    updateConfig({ indexName, configuration }, requestOptions) {
+      if (!indexName) {
+        throw new Error("Parameter `indexName` is required when calling `updateConfig`.");
+      }
+      if (!configuration) {
+        throw new Error("Parameter `configuration` is required when calling `updateConfig`.");
+      }
+      if (!configuration.sourceIndices) {
+        throw new Error("Parameter `configuration.sourceIndices` is required when calling `updateConfig`.");
+      }
+      const requestPath = "/1/configs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: configuration
+      };
+      return transporter.request(request, requestOptions);
+    }
+  };
+}
+
+// builds/browser.ts
+function querySuggestionsClient(appId, apiKey, region, options) {
+  if (!appId || typeof appId !== "string") {
+    throw new Error("`appId` is missing.");
+  }
+  if (!apiKey || typeof apiKey !== "string") {
+    throw new Error("`apiKey` is missing.");
+  }
+  if (!region || region && (typeof region !== "string" || !REGIONS.includes(region))) {
+    throw new Error(`\`region\` is required and must be one of the following: ${REGIONS.join(", ")}`);
+  }
+  return createQuerySuggestionsClient({
+    appId,
+    apiKey,
+    region,
+    timeouts: {
+      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+      read: DEFAULT_READ_TIMEOUT_BROWSER,
+      write: DEFAULT_WRITE_TIMEOUT_BROWSER
+    },
+    requester: createXhrRequester(),
+    algoliaAgents: [{ segment: "Browser" }],
+    authMode: "WithinQueryParameters",
+    responsesCache: createMemoryCache(),
+    requestsCache: createMemoryCache({ serializable: false }),
+    hostsCache: createFallbackableCache({
+      caches: [createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }), createMemoryCache()]
+    }),
+    ...options
+  });
+}
+export {
+  apiClientVersion,
+  querySuggestionsClient
+};
+//# sourceMappingURL=browser.js.map