@algolia/client-search 4.14.1 → 5.0.0-alpha.2

package/dist/model/condition.d.ts

@@ -0,0 +1,17 @@
+import type { Anchoring } from './anchoring';
+export declare type Condition = {
+    /**
+     * Query pattern syntax.
+     */
+    pattern?: string;
+    anchoring?: Anchoring;
+    /**
+     * Whether the pattern matches on plurals, synonyms, and typos.
+     */
+    alternatives?: boolean;
+    /**
+     * Rule context format: [A-Za-z0-9_-]+).
+     */
+    context?: string;
+};
+//# sourceMappingURL=condition.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/consequence.d.ts

@@ -0,0 +1,26 @@
+import type { ConsequenceHide } from './consequenceHide';
+import type { ConsequenceParams } from './consequenceParams';
+import type { Promote } from './promote';
+/**
+ * Consequence of the Rule.
+ */
+export declare type Consequence = {
+    params?: ConsequenceParams;
+    /**
+     * Objects to promote as hits.
+     */
+    promote?: Promote[];
+    /**
+     * Only use in combination with the promote consequence. When true, promoted results will be restricted to match the filters of the current search. When false, the promoted results will show up regardless of the filters.
+     */
+    filterPromotes?: boolean;
+    /**
+     * Objects to hide from hits. Each object must contain an objectID field. By default, you can hide up to 50 items per rule.
+     */
+    hide?: ConsequenceHide[];
+    /**
+     * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
+     */
+    userData?: Record<string, any>;
+};
+//# sourceMappingURL=consequence.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC,CAAC"}

package/dist/model/consequenceHide.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Unique identifier of the object to hide.
+ */
+export declare type ConsequenceHide = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+};
+//# sourceMappingURL=consequenceHide.d.ts.map

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

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

package/dist/model/consequenceParams.d.ts

@@ -0,0 +1,5 @@
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+export declare type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
+//# sourceMappingURL=consequenceParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/consequenceParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,iBAAiB,GAAG,4BAA4B,GAC1D,2BAA2B,GAC3B,MAAM,CAAC"}

package/dist/model/consequenceQuery.d.ts

@@ -0,0 +1,6 @@
+import type { ConsequenceQueryObject } from './consequenceQueryObject';
+/**
+ * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
+ */
+export declare type ConsequenceQuery = ConsequenceQueryObject | string;
+//# sourceMappingURL=consequenceQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceQuery.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/consequenceQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,oBAAY,gBAAgB,GAAG,sBAAsB,GAAG,MAAM,CAAC"}

package/dist/model/consequenceQueryObject.d.ts

@@ -0,0 +1,12 @@
+import type { Edit } from './edit';
+export declare type ConsequenceQueryObject = {
+    /**
+     * Words to remove.
+     */
+    remove?: string[];
+    /**
+     * Edits to apply.
+     */
+    edits?: Edit[];
+};
+//# sourceMappingURL=consequenceQueryObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceQueryObject.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/consequenceQueryObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB,CAAC"}

package/dist/model/createdAtObject.d.ts

@@ -0,0 +1,7 @@
+export declare type CreatedAtObject = {
+    /**
+     * Date of creation (ISO-8601 format).
+     */
+    createdAt: string;
+};
+//# sourceMappingURL=createdAtObject.d.ts.map

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

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

package/dist/model/createdAtResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The response with a createdAt timestamp.
+ */
+export declare type CreatedAtResponse = {
+    /**
+     * Date of creation (ISO-8601 format).
+     */
+    createdAt: string;
+};
+//# sourceMappingURL=createdAtResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createdAtResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/createdAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/deleteApiKeyResponse.d.ts

@@ -0,0 +1,7 @@
+export declare type DeleteApiKeyResponse = {
+    /**
+     * Date of deletion (ISO-8601 format).
+     */
+    deletedAt: string;
+};
+//# sourceMappingURL=deleteApiKeyResponse.d.ts.map

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

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

package/dist/model/deleteSourceResponse.d.ts

@@ -0,0 +1,7 @@
+export declare type DeleteSourceResponse = {
+    /**
+     * Date of deletion (ISO-8601 format).
+     */
+    deletedAt: string;
+};
+//# sourceMappingURL=deleteSourceResponse.d.ts.map

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

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

package/dist/model/deletedAtResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The response with a taskID and a deletedAt timestamp.
+ */
+export declare type DeletedAtResponse = {
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+    /**
+     * Date of deletion (ISO-8601 format).
+     */
+    deletedAt: string;
+};
+//# sourceMappingURL=deletedAtResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deletedAtResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/deletedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/dictionaryAction.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Actions to perform.
+ */
+export declare type DictionaryAction = 'addEntry' | 'deleteEntry';
+//# sourceMappingURL=dictionaryAction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dictionaryAction.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/dictionaryAction.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAC"}

package/dist/model/dictionaryEntry.d.ts

@@ -0,0 +1,28 @@
+import type { DictionaryEntryState } from './dictionaryEntryState';
+/**
+ * A dictionary entry.
+ */
+export declare type DictionaryEntry = Record<string, any> & {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * Language ISO code supported by the dictionary (e.g., \"en\" for English).
+     */
+    language: string;
+    /**
+     * The word of the dictionary entry.
+     */
+    word?: string;
+    /**
+     * The words of the dictionary entry.
+     */
+    words?: string[];
+    /**
+     * A decomposition of the word of the dictionary entry.
+     */
+    decomposition?: string[];
+    state?: DictionaryEntryState;
+};
+//# sourceMappingURL=dictionaryEntry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dictionaryEntry.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/dictionaryEntry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAClD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC"}

package/dist/model/dictionaryEntryState.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The state of the dictionary entry.
+ */
+export declare type DictionaryEntryState = 'disabled' | 'enabled';
+//# sourceMappingURL=dictionaryEntryState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dictionaryEntryState.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/dictionaryEntryState.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAAG,UAAU,GAAG,SAAS,CAAC"}

package/dist/model/dictionaryLanguage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Custom entries for a dictionary.
+ */
+export declare type DictionaryLanguage = {
+    /**
+     * When nbCustomEntries is set to 0, the user didn\'t customize the dictionary. The dictionary is still supported with standard, Algolia-provided entries.
+     */
+    nbCustomEntires?: number;
+};
+//# sourceMappingURL=dictionaryLanguage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dictionaryLanguage.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/dictionaryLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC"}

package/dist/model/dictionarySettingsParams.d.ts

@@ -0,0 +1,8 @@
+import type { StandardEntries } from './standardEntries';
+/**
+ * Disable the builtin Algolia entries for a type of dictionary per language.
+ */
+export declare type DictionarySettingsParams = {
+    disableStandardEntries: StandardEntries;
+};
+//# sourceMappingURL=dictionarySettingsParams.d.ts.map

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

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

package/dist/model/dictionaryType.d.ts

@@ -0,0 +1,2 @@
+export declare type DictionaryType = 'compounds' | 'plurals' | 'stopwords';
+//# sourceMappingURL=dictionaryType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dictionaryType.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/dictionaryType.ts"],"names":[],"mappings":"AAEA,oBAAY,cAAc,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,CAAC"}

package/dist/model/edit.d.ts

@@ -0,0 +1,13 @@
+import type { EditType } from './editType';
+export declare type Edit = {
+    type?: EditType;
+    /**
+     * Text or patterns to remove from the query string.
+     */
+    delete?: string;
+    /**
+     * Text that should be inserted in place of the removed text inside the query string.
+     */
+    insert?: string;
+};
+//# sourceMappingURL=edit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/edit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,oBAAY,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/editType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Type of edit.
+ */
+export declare type EditType = 'remove' | 'replace';
+//# sourceMappingURL=editType.d.ts.map

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

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

package/dist/model/errorBase.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/exactOnSingleWordQuery.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Controls how the exact ranking criterion is computed when the query contains only one word.
+ */
+export declare type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
+//# sourceMappingURL=exactOnSingleWordQuery.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/facetFilters.d.ts

@@ -0,0 +1,6 @@
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter hits by facet value.
+ */
+export declare type FacetFilters = MixedSearchFilters[] | string;
+//# sourceMappingURL=facetFilters.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/facetHits.d.ts

@@ -0,0 +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;
+};
+//# sourceMappingURL=facetHits.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/facetOrdering.d.ts

@@ -0,0 +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>;
+};
+//# sourceMappingURL=facetOrdering.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/facets.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/facetsStats.d.ts

@@ -0,0 +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;
+};
+//# sourceMappingURL=facetsStats.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/fetchedIndex.d.ts

@@ -0,0 +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[];
+};
+//# sourceMappingURL=fetchedIndex.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/getDictionarySettingsResponse.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/getLogsResponse.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/getObjectsParams.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/getObjectsResponse.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/getTaskResponse.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/getTopUserIdsResponse.d.ts

@@ -0,0 +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[]>>;
+};
+//# sourceMappingURL=getTopUserIdsResponse.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/hasPendingMappingsResponse.d.ts

@@ -0,0 +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[]>;
+};
+//# sourceMappingURL=hasPendingMappingsResponse.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/highlightResult.d.ts

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

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

@@ -0,0 +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"}

package/dist/model/highlightResultOption.d.ts

@@ -0,0 +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;
+};
+//# sourceMappingURL=highlightResultOption.d.ts.map

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

@@ -0,0 +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"}

package/dist/model/hit.d.ts

@@ -0,0 +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;
+};
+//# sourceMappingURL=hit.d.ts.map