@algolia/client-query-suggestions 5.0.0-alpha.8 → 5.0.0-alpha.81

package/model/querySuggestionsConfigurationWithIndex.ts

@@ -0,0 +1,10 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { QuerySuggestionsConfiguration } from './querySuggestionsConfiguration';
+import type { QuerySuggestionsConfigurationWithIndexAllOf } from './querySuggestionsConfigurationWithIndexAllOf';
+
+/**
+ * Query Suggestions configuration.
+ */
+export type QuerySuggestionsConfigurationWithIndex =
+  QuerySuggestionsConfiguration & QuerySuggestionsConfigurationWithIndexAllOf;

package/model/querySuggestionsConfigurationWithIndexAllOf.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type QuerySuggestionsConfigurationWithIndexAllOf = {
+  /**
+   * Query Suggestions index name.
+   */
+  indexName: string;
+};

package/model/sourceIndex.ts

@@ -1,40 +1,45 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { SourceIndexExternal } from './sourceIndexExternal';
+import type { Facet } from './facet';
 
+/**
+ * Configuration of an Algolia index for Query Suggestions.
+ */
 export type SourceIndex = {
   /**
-   * Source index name.
+   * Name of the Algolia index to use as source for query suggestions.
    */
   indexName: string;
 
   /**
-   * List of analytics tags to filter the popular searches per tag.
+   * If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the primary index is used.
    */
-  analyticsTags?: string[];
+  replicas?: boolean;
 
   /**
-   * List of facets to define as categories for the query suggestions.
+   * [Analytics tags](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) for filtering the popular searches.
    */
-  facets?: Array<Record<string, any>>;
+  analyticsTags?: string[] | null;
 
   /**
-   * Minimum number of hits (e.g., matching records in the source index) to generate a suggestions.
+   * Facets to use as top categories with your suggestions.  If provided, Query Suggestions adds the top facet values to each suggestion.
    */
-  minHits?: number;
+  facets?: Facet[] | null;
 
   /**
-   * Minimum number of required letters for a suggestion to remain.
+   * Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` hits to be included in the Query Suggestions index.
    */
-  minLetters?: number;
+  minHits?: number;
 
   /**
-   * List of facet attributes used to generate Query Suggestions. The resulting suggestions are every combination of the facets in the nested list (e.g., (facetA and facetB) and facetC).
+   * 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[][];
 
   /**
-   * List of external indices to use to generate custom Query Suggestions.
+   * Algolia indices with popular searches to use as query suggestions.  Records of these indices must have these attributes:    - `query`: search query which will be added as a suggestion   - `count`: measure of popularity of that search query  For example, you can export popular searches from an external analytics tool, such as Google Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index to generate query suggestions until your Algolia analytics has collected enough data.
    */
-  external?: SourceIndexExternal[];
+  external?: string[] | null;
 };

package/package.json

@@ -1,16 +1,33 @@
 {
   "name": "@algolia/client-query-suggestions",
-  "version": "5.0.0-alpha.8",
+  "version": "5.0.0-alpha.81",
   "description": "JavaScript client for client-query-suggestions",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
-  "main": "index.js",
-  "jsdelivr": "dist/client-query-suggestions.umd.js",
-  "unpkg": "dist/client-query-suggestions.umd.js",
-  "module": "dist/client-query-suggestions.esm.node.js",
-  "browser": "dist/client-query-suggestions.umd.js",
-  "types": "index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/client-query-suggestions.esm.node.js",
+        "module": "./dist/client-query-suggestions.esm.node.js",
+        "require": "./dist/client-query-suggestions.cjs",
+        "default": "./dist/client-query-suggestions.cjs"
+      },
+      "default": {
+        "umd": "./dist/client-query-suggestions.umd.js",
+        "module": "./dist/client-query-suggestions.esm.browser.js",
+        "import": "./dist/client-query-suggestions.esm.browser.js",
+        "default": "./dist/client-query-suggestions.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/client-query-suggestions.umd.js",
+  "unpkg": "./dist/client-query-suggestions.umd.js",
+  "browser": "./dist/client-query-suggestions.umd.js",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "model",
@@ -22,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.8",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.8",
-    "@algolia/requester-node-http": "5.0.0-alpha.8"
+    "@algolia/client-common": "5.0.0-alpha.81",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.81",
+    "@algolia/requester-node-http": "5.0.0-alpha.81"
   },
   "devDependencies": {
-    "@types/node": "16.11.47",
-    "rollup": "2.77.2",
-    "typescript": "4.7.4"
+    "@types/node": "18.17.12",
+    "rollup": "3.28.1",
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/indexName.d.ts

@@ -1,7 +0,0 @@
-export declare type IndexName = {
-    /**
-     * Index name to target.
-     */
-    indexName: string;
-};
-//# sourceMappingURL=indexName.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"indexName.d.ts","sourceRoot":"","sources":["../../model/indexName.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/logFile.d.ts

@@ -1,17 +0,0 @@
-import type { LogLevel } from './logLevel';
-export declare type LogFile = {
-    /**
-     * Date and time of creation of the record.
-     */
-    timestamp: string;
-    level: LogLevel;
-    /**
-     * Detailed description of what happened.
-     */
-    message: string;
-    /**
-     * Indicates the hierarchy of the records. For example, a record with contextLevel=1 belongs to a preceding record 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,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/querySuggestionsIndex.d.ts

@@ -1,20 +0,0 @@
-import type { SourceIndexWithReplicas } from './sourceIndexWithReplicas';
-export declare type QuerySuggestionsIndex = {
-    /**
-     * Index name to target.
-     */
-    indexName: string;
-    /**
-     * List of source indices used to generate a Query Suggestions index.
-     */
-    sourceIndices: SourceIndexWithReplicas[];
-    /**
-     * De-duplicate singular and plural suggestions. For example, let\'s say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.
-     */
-    languages: string[];
-    /**
-     * List of words and patterns to exclude from the Query Suggestions index.
-     */
-    exclude: string[];
-};
-//# sourceMappingURL=querySuggestionsIndex.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"querySuggestionsIndex.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,uBAAuB,EAAE,CAAC;IAEzC;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/dist/model/querySuggestionsIndexParam.d.ts

@@ -1,16 +0,0 @@
-import type { SourceIndex } from './sourceIndex';
-export declare type QuerySuggestionsIndexParam = {
-    /**
-     * List of source indices used to generate a Query Suggestions index.
-     */
-    sourceIndices: SourceIndex[];
-    /**
-     * De-duplicate singular and plural suggestions. For example, let\'s say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.
-     */
-    languages?: string[];
-    /**
-     * List of words and patterns to exclude from the Query Suggestions index.
-     */
-    exclude?: string[];
-};
-//# sourceMappingURL=querySuggestionsIndexParam.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"querySuggestionsIndexParam.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsIndexParam.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,aAAa,EAAE,WAAW,EAAE,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC"}

package/dist/model/querySuggestionsIndexWithIndexParam.d.ts

@@ -1,4 +0,0 @@
-import type { IndexName } from './indexName';
-import type { QuerySuggestionsIndexParam } from './querySuggestionsIndexParam';
-export declare type QuerySuggestionsIndexWithIndexParam = IndexName & QuerySuggestionsIndexParam;
-//# sourceMappingURL=querySuggestionsIndexWithIndexParam.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"querySuggestionsIndexWithIndexParam.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsIndexWithIndexParam.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E,oBAAY,mCAAmC,GAAG,SAAS,GACzD,0BAA0B,CAAC"}

package/dist/model/sourceIndexExternal.d.ts

@@ -1,11 +0,0 @@
-export declare type SourceIndexExternal = {
-    /**
-     * The suggestion you would like to add.
-     */
-    query: string;
-    /**
-     * The measure of the suggestion relative popularity.
-     */
-    count: number;
-};
-//# sourceMappingURL=sourceIndexExternal.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sourceIndexExternal.d.ts","sourceRoot":"","sources":["../../model/sourceIndexExternal.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/sourceIndexWithReplicas.d.ts

@@ -1,39 +0,0 @@
-import type { SourceIndexExternal } from './sourceIndexExternal';
-/**
- * Source index with replicas used to generate a Query Suggestions index.
- */
-export declare type SourceIndexWithReplicas = {
-    /**
-     * True if the Query Suggestions index is a replicas.
-     */
-    replicas: boolean;
-    /**
-     * Source index name.
-     */
-    indexName: string;
-    /**
-     * List of analytics tags to filter the popular searches per tag.
-     */
-    analyticsTags: string[];
-    /**
-     * List of facets to define as categories for the query suggestions.
-     */
-    facets: Array<Record<string, any>>;
-    /**
-     * Minimum number of hits (e.g., matching records in the source index) to generate a suggestions.
-     */
-    minHits: number;
-    /**
-     * Minimum number of required letters for a suggestion to remain.
-     */
-    minLetters: number;
-    /**
-     * List of facet attributes used to generate Query Suggestions. The resulting suggestions are every combination of the facets in the nested list (e.g., (facetA and facetB) and facetC).
-     */
-    generate: string[][];
-    /**
-     * List of external indices to use to generate custom Query Suggestions.
-     */
-    external: SourceIndexExternal[];
-};
-//# sourceMappingURL=sourceIndexWithReplicas.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sourceIndexWithReplicas.d.ts","sourceRoot":"","sources":["../../model/sourceIndexWithReplicas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;GAEG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC,CAAC"}

package/dist/model/status.d.ts

@@ -1,15 +0,0 @@
-export declare type Status = {
-    /**
-     * The targeted index name.
-     */
-    indexName: string;
-    /**
-     * True if the Query Suggestions index is running.
-     */
-    isRunning: boolean;
-    /**
-     * Date and time of the last build.
-     */
-    lastBuiltAt: string;
-};
-//# sourceMappingURL=status.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../model/status.ts"],"names":[],"mappings":"AAEA,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/successResponse.d.ts

@@ -1,11 +0,0 @@
-export declare type SuccessResponse = {
-    /**
-     * The status code.
-     */
-    status: number;
-    /**
-     * Message of the response.
-     */
-    message: string;
-};
-//# sourceMappingURL=successResponse.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"successResponse.d.ts","sourceRoot":"","sources":["../../model/successResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/model/indexName.ts

@@ -1,8 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-export type IndexName = {
-  /**
-   * Index name to target.
-   */
-  indexName: string;
-};

package/model/logFile.ts

@@ -1,22 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { LogLevel } from './logLevel';
-
-export type LogFile = {
-  /**
-   * Date and time of creation of the record.
-   */
-  timestamp: string;
-
-  level: LogLevel;
-
-  /**
-   * Detailed description of what happened.
-   */
-  message: string;
-
-  /**
-   * Indicates the hierarchy of the records. For example, a record with contextLevel=1 belongs to a preceding record with contextLevel=0.
-   */
-  contextLevel: number;
-};

package/model/querySuggestionsIndex.ts

@@ -1,25 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { SourceIndexWithReplicas } from './sourceIndexWithReplicas';
-
-export type QuerySuggestionsIndex = {
-  /**
-   * Index name to target.
-   */
-  indexName: string;
-
-  /**
-   * List of source indices used to generate a Query Suggestions index.
-   */
-  sourceIndices: SourceIndexWithReplicas[];
-
-  /**
-   * De-duplicate singular and plural suggestions. For example, let\'s say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.
-   */
-  languages: string[];
-
-  /**
-   * List of words and patterns to exclude from the Query Suggestions index.
-   */
-  exclude: string[];
-};

package/model/querySuggestionsIndexParam.ts

@@ -1,20 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { SourceIndex } from './sourceIndex';
-
-export type QuerySuggestionsIndexParam = {
-  /**
-   * List of source indices used to generate a Query Suggestions index.
-   */
-  sourceIndices: SourceIndex[];
-
-  /**
-   * De-duplicate singular and plural suggestions. For example, let\'s say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.
-   */
-  languages?: string[];
-
-  /**
-   * List of words and patterns to exclude from the Query Suggestions index.
-   */
-  exclude?: string[];
-};

package/model/querySuggestionsIndexWithIndexParam.ts

@@ -1,7 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { IndexName } from './indexName';
-import type { QuerySuggestionsIndexParam } from './querySuggestionsIndexParam';
-
-export type QuerySuggestionsIndexWithIndexParam = IndexName &
-  QuerySuggestionsIndexParam;

package/model/sourceIndexExternal.ts

@@ -1,13 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-export type SourceIndexExternal = {
-  /**
-   * The suggestion you would like to add.
-   */
-  query: string;
-
-  /**
-   * The measure of the suggestion relative popularity.
-   */
-  count: number;
-};

package/model/sourceIndexWithReplicas.ts

@@ -1,48 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { SourceIndexExternal } from './sourceIndexExternal';
-
-/**
- * Source index with replicas used to generate a Query Suggestions index.
- */
-export type SourceIndexWithReplicas = {
-  /**
-   * True if the Query Suggestions index is a replicas.
-   */
-  replicas: boolean;
-
-  /**
-   * Source index name.
-   */
-  indexName: string;
-
-  /**
-   * List of analytics tags to filter the popular searches per tag.
-   */
-  analyticsTags: string[];
-
-  /**
-   * List of facets to define as categories for the query suggestions.
-   */
-  facets: Array<Record<string, any>>;
-
-  /**
-   * Minimum number of hits (e.g., matching records in the source index) to generate a suggestions.
-   */
-  minHits: number;
-
-  /**
-   * Minimum number of required letters for a suggestion to remain.
-   */
-  minLetters: number;
-
-  /**
-   * List of facet attributes used to generate Query Suggestions. The resulting suggestions are every combination of the facets in the nested list (e.g., (facetA and facetB) and facetC).
-   */
-  generate: string[][];
-
-  /**
-   * List of external indices to use to generate custom Query Suggestions.
-   */
-  external: SourceIndexExternal[];
-};

package/model/status.ts

@@ -1,18 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-export type Status = {
-  /**
-   * The targeted index name.
-   */
-  indexName: string;
-
-  /**
-   * True if the Query Suggestions index is running.
-   */
-  isRunning: boolean;
-
-  /**
-   * Date and time of the last build.
-   */
-  lastBuiltAt: string;
-};

package/model/successResponse.ts

@@ -1,13 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-export type SuccessResponse = {
-  /**
-   * The status code.
-   */
-  status: number;
-
-  /**
-   * Message of the response.
-   */
-  message: string;
-};