@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.100

package/dist/model/errorBase.d.ts

@@ -1,7 +1,7 @@
-/**
- * Error.
- */
-export declare type ErrorBase = Record<string, any> & {
-    message?: string;
-};
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+    message?: string;
+};
 //# sourceMappingURL=errorBase.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/exactOnSingleWordQuery.d.ts

@@ -1,5 +1,5 @@
-/**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
- */
-export declare type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
+/**
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the query contains only one word.
+ */
+export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
 //# sourceMappingURL=exactOnSingleWordQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"exactOnSingleWordQuery.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/exactOnSingleWordQuery.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,sBAAsB,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"exactOnSingleWordQuery.d.ts","sourceRoot":"","sources":["../../model/exactOnSingleWordQuery.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/model/exhaustive.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+export type Exhaustive = {
+    /**
+     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    facetsCount?: boolean;
+    /**
+     * The value is `false` if not all facet values are retrieved.
+     */
+    facetValues?: boolean;
+    /**
+     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+     */
+    nbHits?: boolean;
+    /**
+     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+     */
+    rulesMatch?: boolean;
+    /**
+     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+     */
+    typo?: boolean;
+};
+//# sourceMappingURL=exhaustive.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exhaustive.d.ts","sourceRoot":"","sources":["../../model/exhaustive.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC"}

package/dist/model/facetFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter hits by facet value.
- */
-export declare type FacetFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * [Filter hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
+ */
+export type FacetFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=facetFilters.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"facetFilters.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/facetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,YAAY,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"facetFilters.d.ts","sourceRoot":"","sources":["../../model/facetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/facetHits.d.ts

@@ -1,15 +1,15 @@
-export declare type FacetHits = {
-    /**
-     * Raw value of the facet.
-     */
-    value: string;
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    highlighted: string;
-    /**
-     * How many objects contain this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the counts may not be exhaustive.
-     */
-    count: number;
-};
+export type FacetHits = {
+    /**
+     * Facet value.
+     */
+    value: string;
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    highlighted: string;
+    /**
+     * Number of records containing this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the [counts may not be exhaustive](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    count: number;
+};
 //# sourceMappingURL=facetHits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"facetHits.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/facetHits.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"facetHits.d.ts","sourceRoot":"","sources":["../../model/facetHits.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/facetOrdering.d.ts

@@ -1,13 +1,13 @@
-import type { Facets } from './facets';
-import type { Value } from './value';
-/**
- * Defining how facets should be ordered.
- */
-export declare type FacetOrdering = {
-    facets?: Facets;
-    /**
-     * The ordering of facet values, within an individual list.
-     */
-    values?: Record<string, Value>;
-};
+import type { Facets } from './facets';
+import type { Value } from './value';
+/**
+ * Defines the ordering of facets (widgets).
+ */
+export type FacetOrdering = {
+    facets?: Facets;
+    /**
+     * Ordering of facet values within an individual facet.
+     */
+    values?: Record<string, Value>;
+};
 //# sourceMappingURL=facetOrdering.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,oBAAY,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}
+{"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}

package/dist/model/facets.d.ts

@@ -1,10 +1,10 @@
-/**
- * The ordering of facets (widgets).
- */
-export declare type Facets = {
-    /**
-     * Pinned order of facet lists.
-     */
-    order?: string[];
-};
+/**
+ * Ordering of facets (widgets).
+ */
+export type Facets = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+};
 //# sourceMappingURL=facets.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"facets.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/facets.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}
+{"version":3,"file":"facets.d.ts","sourceRoot":"","sources":["../../model/facets.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}

package/dist/model/facetsStats.d.ts

@@ -1,19 +1,19 @@
-export declare type FacetsStats = {
-    /**
-     * The minimum value in the result set.
-     */
-    min?: number;
-    /**
-     * The maximum value in the result set.
-     */
-    max?: number;
-    /**
-     * The average facet value in the result set.
-     */
-    avg?: number;
-    /**
-     * The sum of all values in the result set.
-     */
-    sum?: number;
-};
+export type FacetsStats = {
+    /**
+     * Minimum value in the results.
+     */
+    min?: number;
+    /**
+     * Maximum value in the results.
+     */
+    max?: number;
+    /**
+     * Average facet value in the results.
+     */
+    avg?: number;
+    /**
+     * Sum of all values in the results.
+     */
+    sum?: number;
+};
 //# sourceMappingURL=facetsStats.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/facetsStats.ts"],"names":[],"mappings":"AAEA,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../model/facetsStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/model/fetchedIndex.d.ts

@@ -1,47 +1,47 @@
-export declare type FetchedIndex = {
-    /**
-     * Index name.
-     */
-    name: string;
-    /**
-     * Index creation date. An empty string means that the index has no records.
-     */
-    createdAt: string;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-    /**
-     * Number of records contained in the index.
-     */
-    entries: number;
-    /**
-     * Number of bytes of the index in minified format.
-     */
-    dataSize: number;
-    /**
-     * Number of bytes of the index binary file.
-     */
-    fileSize: number;
-    /**
-     * Last build time.
-     */
-    lastBuildTimeS: number;
-    /**
-     * Number of pending indexing operations. This value is deprecated and should not be used.
-     */
-    numberOfPendingTask?: number;
-    /**
-     * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
-     */
-    pendingTask: boolean;
-    /**
-     * Only present if the index is a replica. Contains the name of the related primary index.
-     */
-    primary?: string;
-    /**
-     * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
-     */
-    replicas?: string[];
-};
+export type FetchedIndex = {
+    /**
+     * Index name.
+     */
+    name: string;
+    /**
+     * Index creation date. An empty string means that the index has no records.
+     */
+    createdAt: string;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+    /**
+     * Number of records contained in the index.
+     */
+    entries: number;
+    /**
+     * Number of bytes of the index in minified format.
+     */
+    dataSize: number;
+    /**
+     * Number of bytes of the index binary file.
+     */
+    fileSize: number;
+    /**
+     * Last build time.
+     */
+    lastBuildTimeS: number;
+    /**
+     * Number of pending indexing operations. This value is deprecated and should not be used.
+     */
+    numberOfPendingTasks: number;
+    /**
+     * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
+     */
+    pendingTask: boolean;
+    /**
+     * Only present if the index is a replica. Contains the name of the related primary index.
+     */
+    primary?: string;
+    /**
+     * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
+     */
+    replicas?: string[];
+};
 //# sourceMappingURL=fetchedIndex.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fetchedIndex.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/fetchedIndex.ts"],"names":[],"mappings":"AAEA,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
+{"version":3,"file":"fetchedIndex.d.ts","sourceRoot":"","sources":["../../model/fetchedIndex.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}

package/dist/model/getApiKeyResponse.d.ts

@@ -0,0 +1,4 @@
+import type { ApiKey } from './apiKey';
+import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
+export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
+//# sourceMappingURL=getApiKeyResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getApiKeyResponse.d.ts","sourceRoot":"","sources":["../../model/getApiKeyResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,qBAAqB,CAAC"}

package/dist/model/getDictionarySettingsResponse.d.ts

@@ -1,5 +1,5 @@
-import type { StandardEntries } from './standardEntries';
-export declare type GetDictionarySettingsResponse = {
-    disableStandardEntries: StandardEntries;
-};
+import type { StandardEntries } from './standardEntries';
+export type GetDictionarySettingsResponse = {
+    disableStandardEntries: StandardEntries;
+};
 //# sourceMappingURL=getDictionarySettingsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getDictionarySettingsResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/getDictionarySettingsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,6BAA6B,GAAG;IAC1C,sBAAsB,EAAE,eAAe,CAAC;CACzC,CAAC"}
+{"version":3,"file":"getDictionarySettingsResponse.d.ts","sourceRoot":"","sources":["../../model/getDictionarySettingsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,6BAA6B,GAAG;IAC1C,sBAAsB,EAAE,eAAe,CAAC;CACzC,CAAC"}

package/dist/model/getLogsResponse.d.ts

@@ -1,5 +1,5 @@
-import type { Log } from './log';
-export declare type GetLogsResponse = {
-    logs: Log[];
-};
+import type { Log } from './log';
+export type GetLogsResponse = {
+    logs: Log[];
+};
 //# sourceMappingURL=getLogsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getLogsResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/getLogsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,EAAE,CAAC;CACb,CAAC"}
+{"version":3,"file":"getLogsResponse.d.ts","sourceRoot":"","sources":["../../model/getLogsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,EAAE,CAAC;CACb,CAAC"}

package/dist/model/getObjectsParams.d.ts

@@ -1,8 +1,8 @@
-import type { MultipleGetObjectsParams } from './multipleGetObjectsParams';
-/**
- * The `getObjects` parameters.
- */
-export declare type GetObjectsParams = {
-    requests?: MultipleGetObjectsParams[];
-};
+import type { GetObjectsRequest } from './getObjectsRequest';
+/**
+ * Request parameters.
+ */
+export type GetObjectsParams = {
+    requests: GetObjectsRequest[];
+};
 //# sourceMappingURL=getObjectsParams.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getObjectsParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/getObjectsParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACvC,CAAC"}
+{"version":3,"file":"getObjectsParams.d.ts","sourceRoot":"","sources":["../../model/getObjectsParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B,CAAC"}

package/dist/model/getObjectsRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Record retrieval operation.
+ */
+export type GetObjectsRequest = {
+    /**
+     * Attributes to retrieve. If not specified, all retrievable attributes are returned.
+     */
+    attributesToRetrieve?: string[];
+    /**
+     * Record\'s objectID.
+     */
+    objectID: string;
+    /**
+     * Name of the index containing the required records.
+     */
+    indexName: string;
+};
+//# sourceMappingURL=getObjectsRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getObjectsRequest.d.ts","sourceRoot":"","sources":["../../model/getObjectsRequest.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/getObjectsResponse.d.ts

@@ -1,7 +1,7 @@
-export declare type GetObjectsResponse = {
-    /**
-     * List of results fetched.
-     */
-    results?: Array<Record<string, any>>;
-};
+export type GetObjectsResponse<T = Record<string, any>> = {
+    /**
+     * Retrieved results.
+     */
+    results: T[];
+};
 //# sourceMappingURL=getObjectsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getObjectsResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/getObjectsResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACtC,CAAC"}
+{"version":3,"file":"getObjectsResponse.d.ts","sourceRoot":"","sources":["../../model/getObjectsResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACxD;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAC;CACd,CAAC"}

package/dist/model/getTaskResponse.d.ts

@@ -1,5 +1,5 @@
-import type { TaskStatus } from './taskStatus';
-export declare type GetTaskResponse = {
-    status: TaskStatus;
-};
+import type { TaskStatus } from './taskStatus';
+export type GetTaskResponse = {
+    status: TaskStatus;
+};
 //# sourceMappingURL=getTaskResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTaskResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/getTaskResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,eAAe,GAAG;IAC5B,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC"}
+{"version":3,"file":"getTaskResponse.d.ts","sourceRoot":"","sources":["../../model/getTaskResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC"}

package/dist/model/getTopUserIdsResponse.d.ts

@@ -1,11 +1,11 @@
-import type { UserId } from './userId';
-/**
- * Array of userIDs and clusters.
- */
-export declare type GetTopUserIdsResponse = {
-    /**
-     * Mapping of cluster names to top users.
-     */
-    topUsers: Array<Record<string, UserId[]>>;
-};
+import type { UserId } from './userId';
+/**
+ * User IDs and clusters.
+ */
+export type GetTopUserIdsResponse = {
+    /**
+     * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
+     */
+    topUsers: Array<Record<string, UserId[]>>;
+};
 //# sourceMappingURL=getTopUserIdsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTopUserIdsResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/getTopUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC3C,CAAC"}
+{"version":3,"file":"getTopUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC3C,CAAC"}

package/dist/model/hasPendingMappingsResponse.d.ts

@@ -1,11 +1,11 @@
-export declare type HasPendingMappingsResponse = {
-    /**
-     * If there is any clusters with pending mapping state.
-     */
-    pending: boolean;
-    /**
-     * Describe cluster pending (migrating, creating, deleting) mapping state.
-     */
-    clusters?: Record<string, string[]>;
-};
+export type HasPendingMappingsResponse = {
+    /**
+     * Indicates whether there are clusters undergoing migration, creation, or deletion.
+     */
+    pending: boolean;
+    /**
+     * Cluster pending mapping state: migrating, creating, deleting.
+     */
+    clusters?: Record<string, string[]>;
+};
 //# sourceMappingURL=hasPendingMappingsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"hasPendingMappingsResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/hasPendingMappingsResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACrC,CAAC"}
+{"version":3,"file":"hasPendingMappingsResponse.d.ts","sourceRoot":"","sources":["../../model/hasPendingMappingsResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACrC,CAAC"}

package/dist/model/highlightResult.d.ts

@@ -1,3 +1,3 @@
-import type { HighlightResultOption } from './highlightResultOption';
-export declare type HighlightResult = HighlightResultOption | HighlightResultOption[];
+import type { HighlightResultOption } from './highlightResultOption';
+export type HighlightResult = HighlightResultOption | HighlightResultOption[] | Record<string, HighlightResultOption>;
 //# sourceMappingURL=highlightResult.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,oBAAY,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,eAAe,GACvB,qBAAqB,GACrB,qBAAqB,EAAE,GACvB,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC"}

package/dist/model/highlightResultOption.d.ts

@@ -1,20 +1,20 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Show highlighted section and words matched on a query.
- */
-export declare type HighlightResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-    /**
-     * List of words from the query that matched the object.
-     */
-    matchedWords: string[];
-    /**
-     * Whether the entire attribute value is highlighted.
-     */
-    fullyHighlighted?: boolean;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+    /**
+     * List of words from the query that matched the object.
+     */
+    matchedWords: string[];
+    /**
+     * Whether the entire attribute value is highlighted.
+     */
+    fullyHighlighted?: boolean;
+};
 //# sourceMappingURL=highlightResultOption.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}

package/dist/model/hit.d.ts

@@ -1,23 +1,23 @@
-import type { HighlightResult } from './highlightResult';
-import type { RankingInfo } from './rankingInfo';
-import type { SnippetResult } from './snippetResult';
-/**
- * A single hit.
- */
-export declare type Hit<T> = T & {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    _highlightResult?: Record<string, HighlightResult>;
-    /**
-     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
-     */
-    _snippetResult?: Record<string, SnippetResult>;
-    _rankingInfo?: RankingInfo;
-    _distinctSeqID?: number;
-};
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+/**
+ * A single hit.
+ */
+export type Hit<T = Record<string, any>> = T & {
+    /**
+     * Unique object identifier.
+     */
+    objectID: string;
+    /**
+     * Show highlighted section and words matched on a query.
+     */
+    _highlightResult?: Record<string, HighlightResult>;
+    /**
+     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+     */
+    _snippetResult?: Record<string, SnippetResult>;
+    _rankingInfo?: RankingInfo;
+    _distinctSeqID?: number;
+};
 //# sourceMappingURL=hit.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"hit.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/hit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}
+{"version":3,"file":"hit.d.ts","sourceRoot":"","sources":["../../model/hit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}