@algolia/client-search 5.0.0-beta.4 → 5.0.0-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/builds/browser.d.ts +73 -70
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +73 -70
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-search.cjs +67 -4
- package/dist/client-search.esm.browser.js +51 -5
- package/dist/client-search.esm.node.js +67 -4
- package/dist/client-search.umd.js +2 -2
- package/dist/model/baseIndexSettings.d.ts +2 -2
- package/dist/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/model/baseSearchResponse.d.ts +2 -2
- package/dist/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/model/clientMethodProps.d.ts +15 -2
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/fetchedIndex.d.ts +4 -0
- package/dist/model/fetchedIndex.d.ts.map +1 -1
- package/dist/model/index.d.ts +1 -1
- package/dist/model/{securedAPIKeyRestrictions.d.ts → securedApiKeyRestrictions.d.ts} +2 -2
- package/dist/model/{securedAPIKeyRestrictions.d.ts.map → securedApiKeyRestrictions.d.ts.map} +1 -1
- package/dist/model/value.d.ts +4 -0
- package/dist/model/value.d.ts.map +1 -1
- package/dist/src/searchClient.d.ts +40 -9
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/baseIndexSettings.ts +2 -2
- package/model/baseSearchResponse.ts +2 -2
- package/model/clientMethodProps.ts +24 -2
- package/model/fetchedIndex.ts +5 -0
- package/model/index.ts +1 -1
- package/model/{securedAPIKeyRestrictions.ts → securedApiKeyRestrictions.ts} +1 -1
- package/model/value.ts +5 -0
- package/package.json +10 -7
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2013-Present Algolia
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/builds/browser.d.ts
CHANGED
|
@@ -10,82 +10,85 @@ export declare function searchClient(appId: string, apiKey: string, options?: Cl
|
|
|
10
10
|
appId: string;
|
|
11
11
|
clearCache(): Promise<void>;
|
|
12
12
|
readonly _ua: string;
|
|
13
|
-
addAlgoliaAgent(segment: string, version?: string
|
|
14
|
-
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
15
|
-
waitForAppTask({ taskID, maxRetries, timeout, }: import("../model").WaitForAppTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
16
|
-
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
17
|
-
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }:
|
|
18
|
-
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }:
|
|
19
|
-
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }:
|
|
20
|
-
searchForHits<
|
|
21
|
-
results: import("../model").SearchResponse<
|
|
13
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
14
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
15
|
+
waitForAppTask({ taskID, maxRetries, timeout, }: import("../model").WaitForAppTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
16
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
|
|
17
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("../model").BrowseOptions<import("../model").BrowseResponse<T>> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
|
|
18
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("../model").BrowseOptions<import("../model").SearchRulesResponse> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
|
|
19
|
+
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("../model").BrowseOptions<import("../model").SearchSynonymsResponse> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
|
|
20
|
+
searchForHits<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
|
|
21
|
+
results: Array<import("../model").SearchResponse<T>>;
|
|
22
22
|
}>;
|
|
23
|
-
searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
23
|
+
searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
|
|
24
24
|
results: import("../model").SearchForFacetValuesResponse[];
|
|
25
25
|
}>;
|
|
26
|
-
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
26
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
27
|
+
saveObjects({ indexName, objects }: import("../model").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
28
|
+
deleteObjects({ indexName, objectIDs }: import("../model").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
29
|
+
partialUpdateObjects({ indexName, objects, createIfNotExists }: import("../model").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
30
|
+
replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceAllObjectsResponse>;
|
|
31
|
+
addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
|
|
32
|
+
addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
33
|
+
appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
|
|
34
|
+
assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
|
|
35
|
+
batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse>;
|
|
36
|
+
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
|
|
37
|
+
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
38
|
+
browse<T>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
|
|
39
|
+
clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
40
|
+
clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
41
|
+
clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
42
|
+
customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
43
|
+
customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
44
|
+
customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
45
|
+
customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
46
|
+
deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteApiKeyResponse>;
|
|
47
|
+
deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
48
|
+
deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
49
|
+
deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
50
|
+
deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
51
|
+
deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteSourceResponse>;
|
|
52
|
+
deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
53
|
+
getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetApiKeyResponse>;
|
|
54
|
+
getAppTask({ taskID }: import("../model").GetAppTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
55
|
+
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, import("../model").Languages>>;
|
|
56
|
+
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetDictionarySettingsResponse>;
|
|
54
57
|
getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
|
|
55
|
-
getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
56
|
-
getObjects<
|
|
57
|
-
getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
58
|
-
getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
59
|
-
getSources(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
60
|
-
getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
61
|
-
getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
62
|
-
getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
63
|
-
getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
58
|
+
getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, string>>;
|
|
59
|
+
getObjects<T>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetObjectsResponse<T>>;
|
|
60
|
+
getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Rule>;
|
|
61
|
+
getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").IndexSettings>;
|
|
62
|
+
getSources(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source[]>;
|
|
63
|
+
getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SynonymHit>;
|
|
64
|
+
getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
65
|
+
getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopUserIdsResponse>;
|
|
66
|
+
getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UserId>;
|
|
64
67
|
hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
|
|
65
|
-
listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
66
|
-
listClusters(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
68
|
+
listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListApiKeysResponse>;
|
|
69
|
+
listClusters(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListClustersResponse>;
|
|
67
70
|
listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
|
|
68
71
|
listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
|
|
69
|
-
multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
70
|
-
operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
71
|
-
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
72
|
-
removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
73
|
-
replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
74
|
-
restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
75
|
-
saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
76
|
-
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
77
|
-
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
78
|
-
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
79
|
-
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
80
|
-
search<
|
|
81
|
-
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
82
|
-
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
83
|
-
searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
84
|
-
searchSingleIndex<
|
|
85
|
-
searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
86
|
-
searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
87
|
-
setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
88
|
-
setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
89
|
-
updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
72
|
+
multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").MultipleBatchResponse>;
|
|
73
|
+
operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
74
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
75
|
+
removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").RemoveUserIdResponse>;
|
|
76
|
+
replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceSourceResponse>;
|
|
77
|
+
restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
|
|
78
|
+
saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveObjectResponse>;
|
|
79
|
+
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedRuleResponse>;
|
|
80
|
+
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
81
|
+
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveSynonymResponse>;
|
|
82
|
+
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
83
|
+
search<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponses<T>>;
|
|
84
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchDictionaryEntriesResponse>;
|
|
85
|
+
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchForFacetValuesResponse>;
|
|
86
|
+
searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
|
|
87
|
+
searchSingleIndex<T>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponse<T>>;
|
|
88
|
+
searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
|
|
89
|
+
searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchUserIdsResponse>;
|
|
90
|
+
setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
91
|
+
setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
92
|
+
updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdateApiKeyResponse>;
|
|
90
93
|
};
|
|
91
94
|
//# sourceMappingURL=browser.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BxB"}
|
package/dist/builds/node.d.ts
CHANGED
|
@@ -28,82 +28,85 @@ export declare function searchClient(appId: string, apiKey: string, options?: Cl
|
|
|
28
28
|
appId: string;
|
|
29
29
|
clearCache(): Promise<void>;
|
|
30
30
|
_ua: string;
|
|
31
|
-
addAlgoliaAgent(segment: string, version?: string
|
|
32
|
-
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
33
|
-
waitForAppTask({ taskID, maxRetries, timeout, }: import("../model").WaitForAppTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
34
|
-
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
35
|
-
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }:
|
|
36
|
-
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }:
|
|
37
|
-
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }:
|
|
38
|
-
searchForHits<
|
|
39
|
-
results: import("../model").SearchResponse<
|
|
31
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
32
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
33
|
+
waitForAppTask({ taskID, maxRetries, timeout, }: import("../model").WaitForAppTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
34
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
|
|
35
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("../model").BrowseOptions<import("../model").BrowseResponse<T>> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
|
|
36
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("../model").BrowseOptions<import("../model").SearchRulesResponse> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
|
|
37
|
+
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("../model").BrowseOptions<import("../model").SearchSynonymsResponse> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
|
|
38
|
+
searchForHits<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
|
|
39
|
+
results: Array<import("../model").SearchResponse<T>>;
|
|
40
40
|
}>;
|
|
41
|
-
searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
41
|
+
searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
|
|
42
42
|
results: import("../model").SearchForFacetValuesResponse[];
|
|
43
43
|
}>;
|
|
44
|
-
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
44
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
45
|
+
saveObjects({ indexName, objects }: import("../model").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
46
|
+
deleteObjects({ indexName, objectIDs }: import("../model").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
47
|
+
partialUpdateObjects({ indexName, objects, createIfNotExists }: import("../model").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse[]>;
|
|
48
|
+
replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceAllObjectsResponse>;
|
|
49
|
+
addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
|
|
50
|
+
addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
51
|
+
appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
|
|
52
|
+
assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
|
|
53
|
+
batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BatchResponse>;
|
|
54
|
+
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").CreatedAtResponse>;
|
|
55
|
+
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
56
|
+
browse<T>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BrowseResponse<T>>;
|
|
57
|
+
clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
58
|
+
clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
59
|
+
clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
60
|
+
customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
61
|
+
customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
62
|
+
customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
63
|
+
customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
64
|
+
deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteApiKeyResponse>;
|
|
65
|
+
deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
66
|
+
deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
67
|
+
deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
68
|
+
deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
69
|
+
deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteSourceResponse>;
|
|
70
|
+
deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeletedAtResponse>;
|
|
71
|
+
getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetApiKeyResponse>;
|
|
72
|
+
getAppTask({ taskID }: import("../model").GetAppTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
73
|
+
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, import("../model").Languages>>;
|
|
74
|
+
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetDictionarySettingsResponse>;
|
|
72
75
|
getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
|
|
73
|
-
getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
74
|
-
getObjects<
|
|
75
|
-
getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
76
|
-
getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
77
|
-
getSources(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
78
|
-
getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
79
|
-
getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
80
|
-
getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
81
|
-
getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
76
|
+
getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, string>>;
|
|
77
|
+
getObjects<T>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetObjectsResponse<T>>;
|
|
78
|
+
getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Rule>;
|
|
79
|
+
getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").IndexSettings>;
|
|
80
|
+
getSources(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source[]>;
|
|
81
|
+
getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SynonymHit>;
|
|
82
|
+
getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTaskResponse>;
|
|
83
|
+
getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopUserIdsResponse>;
|
|
84
|
+
getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UserId>;
|
|
82
85
|
hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
|
|
83
|
-
listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
84
|
-
listClusters(requestOptions?: import("@algolia/client-common").RequestOptions
|
|
86
|
+
listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListApiKeysResponse>;
|
|
87
|
+
listClusters(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListClustersResponse>;
|
|
85
88
|
listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
|
|
86
89
|
listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
|
|
87
|
-
multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
88
|
-
operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
89
|
-
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
90
|
-
removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
91
|
-
replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
92
|
-
restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
93
|
-
saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
94
|
-
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
95
|
-
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
96
|
-
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
97
|
-
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
98
|
-
search<
|
|
99
|
-
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
100
|
-
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
101
|
-
searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
102
|
-
searchSingleIndex<
|
|
103
|
-
searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
104
|
-
searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
105
|
-
setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
106
|
-
setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
107
|
-
updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
90
|
+
multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").MultipleBatchResponse>;
|
|
91
|
+
operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
92
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
93
|
+
removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").RemoveUserIdResponse>;
|
|
94
|
+
replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ReplaceSourceResponse>;
|
|
95
|
+
restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AddApiKeyResponse>;
|
|
96
|
+
saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveObjectResponse>;
|
|
97
|
+
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedRuleResponse>;
|
|
98
|
+
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
99
|
+
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SaveSynonymResponse>;
|
|
100
|
+
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
101
|
+
search<T>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponses<T>>;
|
|
102
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchDictionaryEntriesResponse>;
|
|
103
|
+
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchForFacetValuesResponse>;
|
|
104
|
+
searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchRulesResponse>;
|
|
105
|
+
searchSingleIndex<T>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchResponse<T>>;
|
|
106
|
+
searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchSynonymsResponse>;
|
|
107
|
+
searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SearchUserIdsResponse>;
|
|
108
|
+
setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
109
|
+
setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdatedAtResponse>;
|
|
110
|
+
updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").UpdateApiKeyResponse>;
|
|
108
111
|
};
|
|
109
112
|
//# sourceMappingURL=node.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;
|
|
1
|
+
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IA+BxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}
|
package/dist/client-search.cjs
CHANGED
|
@@ -5,7 +5,7 @@ var clientCommon = require('@algolia/client-common');
|
|
|
5
5
|
var requesterNodeHttp = require('@algolia/requester-node-http');
|
|
6
6
|
|
|
7
7
|
// 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.
|
|
8
|
-
const apiClientVersion = '5.0.0-beta.
|
|
8
|
+
const apiClientVersion = '5.0.0-beta.6';
|
|
9
9
|
function getDefaultHosts(appId) {
|
|
10
10
|
return [
|
|
11
11
|
{
|
|
@@ -330,6 +330,53 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
330
330
|
}
|
|
331
331
|
return responses;
|
|
332
332
|
},
|
|
333
|
+
/**
|
|
334
|
+
* Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
335
|
+
*
|
|
336
|
+
* @summary Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
337
|
+
* @param saveObjects - The `saveObjects` object.
|
|
338
|
+
* @param saveObjects.indexName - The `indexName` to save `objects` in.
|
|
339
|
+
* @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
|
|
340
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
|
|
341
|
+
*/
|
|
342
|
+
async saveObjects({ indexName, objects }, requestOptions) {
|
|
343
|
+
return await this.chunkedBatch({ indexName, objects, action: 'addObject' }, requestOptions);
|
|
344
|
+
},
|
|
345
|
+
/**
|
|
346
|
+
* Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
|
|
347
|
+
*
|
|
348
|
+
* @summary Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
|
|
349
|
+
* @param deleteObjects - The `deleteObjects` object.
|
|
350
|
+
* @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
|
|
351
|
+
* @param deleteObjects.objectIDs - The objectIDs to delete.
|
|
352
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
|
|
353
|
+
*/
|
|
354
|
+
async deleteObjects({ indexName, objectIDs }, requestOptions) {
|
|
355
|
+
return await this.chunkedBatch({
|
|
356
|
+
indexName,
|
|
357
|
+
objects: objectIDs.map((objectID) => ({ objectID })),
|
|
358
|
+
action: 'deleteObject',
|
|
359
|
+
}, requestOptions);
|
|
360
|
+
},
|
|
361
|
+
/**
|
|
362
|
+
* Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
363
|
+
*
|
|
364
|
+
* @summary Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
|
|
365
|
+
* @param partialUpdateObjects - The `partialUpdateObjects` object.
|
|
366
|
+
* @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
|
|
367
|
+
* @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
|
|
368
|
+
* @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
|
|
369
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
370
|
+
*/
|
|
371
|
+
async partialUpdateObjects({ indexName, objects, createIfNotExists }, requestOptions) {
|
|
372
|
+
return await this.chunkedBatch({
|
|
373
|
+
indexName,
|
|
374
|
+
objects,
|
|
375
|
+
action: createIfNotExists
|
|
376
|
+
? 'partialUpdateObject'
|
|
377
|
+
: 'partialUpdateObjectNoCreate',
|
|
378
|
+
}, requestOptions);
|
|
379
|
+
},
|
|
333
380
|
/**
|
|
334
381
|
* Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
|
|
335
382
|
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
|
|
@@ -339,10 +386,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
339
386
|
* @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
|
|
340
387
|
* @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
|
|
341
388
|
* @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
|
|
342
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
389
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
|
|
343
390
|
*/
|
|
344
391
|
async replaceAllObjects({ indexName, objects, batchSize }, requestOptions) {
|
|
345
|
-
const randomSuffix = Math.
|
|
392
|
+
const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
|
|
346
393
|
const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
|
|
347
394
|
let copyOperationResponse = await this.operationIndex({
|
|
348
395
|
indexName,
|
|
@@ -2260,7 +2307,23 @@ function searchClient(appId, apiKey, options) {
|
|
|
2260
2307
|
* @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
|
|
2261
2308
|
*/
|
|
2262
2309
|
generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
|
|
2263
|
-
|
|
2310
|
+
let mergedRestrictions = restrictions;
|
|
2311
|
+
if (restrictions.searchParams) {
|
|
2312
|
+
// merge searchParams with the root restrictions
|
|
2313
|
+
mergedRestrictions = {
|
|
2314
|
+
...restrictions,
|
|
2315
|
+
...restrictions.searchParams,
|
|
2316
|
+
};
|
|
2317
|
+
delete mergedRestrictions.searchParams;
|
|
2318
|
+
}
|
|
2319
|
+
mergedRestrictions = Object.keys(mergedRestrictions)
|
|
2320
|
+
.sort()
|
|
2321
|
+
.reduce((acc, key) => {
|
|
2322
|
+
// eslint-disable-next-line no-param-reassign
|
|
2323
|
+
acc[key] = mergedRestrictions[key];
|
|
2324
|
+
return acc;
|
|
2325
|
+
}, {});
|
|
2326
|
+
const queryParameters = clientCommon.serializeQueryParameters(mergedRestrictions);
|
|
2264
2327
|
return Buffer.from(crypto.createHmac('sha256', parentApiKey)
|
|
2265
2328
|
.update(queryParameters)
|
|
2266
2329
|
.digest('hex') + queryParameters).toString('base64');
|