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

package/dist/model/index.d.ts

@@ -1,14 +0,0 @@
-export * from './appID';
-export * from './baseResponse';
-export * from './configStatus';
-export * from './configuration';
-export * from './configurationResponse';
-export * from './configurationWithIndex';
-export * from './errorBase';
-export * from './facet';
-export * from './languages';
-export * from './logFile';
-export * from './logLevel';
-export * from './sourceIndex';
-export * from './clientMethodProps';
-//# sourceMappingURL=index.d.ts.map

package/dist/model/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC"}

package/dist/model/languages.d.ts

@@ -1,5 +0,0 @@
-/**
- * Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
- */
-export type Languages = string[] | boolean;
-//# sourceMappingURL=languages.d.ts.map

package/dist/model/languages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../model/languages.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC"}

package/dist/model/logFile.d.ts

@@ -1,17 +0,0 @@
-import type { LogLevel } from './logLevel';
-export 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;
-};
-//# sourceMappingURL=logFile.d.ts.map

package/dist/model/logFile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logFile.d.ts","sourceRoot":"","sources":["../../model/logFile.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC"}

package/dist/model/logLevel.d.ts

@@ -1,5 +0,0 @@
-/**
- * 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.
- */
-export type LogLevel = 'ERROR' | 'INFO' | 'SKIP';
-//# sourceMappingURL=logLevel.d.ts.map

package/dist/model/logLevel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logLevel.d.ts","sourceRoot":"","sources":["../../model/logLevel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/model/sourceIndex.d.ts

@@ -1,27 +0,0 @@
-import type { Facet } from './facet';
-/**
- * Configuration of an Algolia index for Query Suggestions.
- */
-export 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;
-};
-//# sourceMappingURL=sourceIndex.d.ts.map

package/dist/model/sourceIndex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sourceIndex.d.ts","sourceRoot":"","sources":["../../model/sourceIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEhC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC;IAE7B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5B,CAAC"}

package/dist/src/querySuggestionsClient.d.ts

@@ -1,148 +0,0 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { BaseResponse } from '../model/baseResponse';
-import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteConfigProps, GetConfigProps, GetConfigStatusProps, GetLogFileProps, UpdateConfigProps } from '../model/clientMethodProps';
-import type { ConfigStatus } from '../model/configStatus';
-import type { ConfigurationResponse } from '../model/configurationResponse';
-import type { ConfigurationWithIndex } from '../model/configurationWithIndex';
-import type { LogFile } from '../model/logFile';
-export declare const apiClientVersion = "5.2.3";
-export declare const REGIONS: readonly ["eu", "us"];
-export type Region = (typeof REGIONS)[number];
-export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
-    region: Region;
-}): {
-    transporter: import("@algolia/client-common").Transporter;
-    /**
-     * The `appId` currently in use.
-     */
-    appId: string;
-    /**
-     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-     */
-    clearCache(): Promise<void>;
-    /**
-     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-     */
-    readonly _ua: string;
-    /**
-     * 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: string, version?: string): void;
-    /**
-     * 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: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<BaseResponse>;
-    /**
-     * 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 }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * 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 }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * 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 }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * 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 }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * 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](/specs/search#tag/Indices/operation/deleteIndex) 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 }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
-    /**
-     * 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?: RequestOptions): Promise<ConfigurationResponse[]>;
-    /**
-     * 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 }: GetConfigProps, requestOptions?: RequestOptions): Promise<ConfigurationResponse>;
-    /**
-     * 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 }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<ConfigStatus>;
-    /**
-     * 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 }: GetLogFileProps, requestOptions?: RequestOptions): Promise<LogFile>;
-    /**
-     * 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 }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
-};
-//# sourceMappingURL=querySuggestionsClient.d.ts.map

package/dist/src/querySuggestionsClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"querySuggestionsClient.d.ts","sourceRoot":"","sources":["../../src/querySuggestionsClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,eAAO,MAAM,gBAAgB,UAAU,CAAC;AAExC,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAS9C,wBAAgB,4BAA4B,CAAC,EAC3C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAI3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;yCAEuB,sBAAsB,mBAC7B,cAAc,GAC9B,OAAO,CAAC,YAAY,CAAC;IAoBxB;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmBnC;;;;;;;OAOG;oCAC6B,cAAc,mBAAmB,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmBlH;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoBnC;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoBnC;;;;;;;;;OASG;gCACyB,iBAAiB,mBAAmB,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAmBtG;;;;;;;OAOG;mCAC4B,cAAc,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAehF;;;;;;;;;OASG;6BACsB,cAAc,mBAAmB,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmBzG;;;;;;;;;OASG;mCAC4B,oBAAoB,mBAAmB,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAmB5G;;;;;;;;;OASG;8BACuB,eAAe,mBAAmB,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB7F;;;;;;;;;;OAUG;+CAE6B,iBAAiB,mBAC9B,cAAc,GAC9B,OAAO,CAAC,YAAY,CAAC;EA4B3B"}